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/21 14:07:21 UTC
[50/50] docs commit: [CB-3820] sort pref listings by importance
[CB-3820] sort pref listings by importance
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/70a42700
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/70a42700
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/70a42700
Branch: refs/heads/master
Commit: 70a4270093d64c7897a9ba2499ca96306c356a4f
Parents: 0c22d9b
Author: Mike Sierra <ms...@adobe.com>
Authored: Fri Sep 20 12:37:10 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Sat Sep 21 14:06:19 2013 +0200
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 16 +++---
docs/en/edge/guide/platforms/android/config.md | 36 ++++++------
.../edge/guide/platforms/blackberry10/config.md | 6 +-
docs/en/edge/guide/platforms/ios/config.md | 60 ++++++++++----------
4 files changed, 59 insertions(+), 59 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/70a42700/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 99f1c4a..eab4545 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -95,6 +95,11 @@ platforms:
The following global preferences apply to all platforms:
+- `Fullscreen` allows you to hide the status bar at the top of the
+ screen. The default value is `false`. Example:
+
+ <preference name="Fullscreen" value="true" />
+
- `Orientation` allows you to lock orientation and prevent the
interface from rotating in response to changes in orientation.
Possible values are `default`, `landscape`, or `portrait`. Example:
@@ -108,17 +113,12 @@ The following global preferences apply to all platforms:
in its `config.xml` file. If you specify `default` in the global
`config.xml`, it translates to `auto` in the BlackBerry build.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
-
- <preference name="Fullscreen" value="true" />
-
## Multi-platform Preferences
The following preferences apply to more than one platform, but not to
all of them:
-* `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
+- `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
if you don't want the interface to display any feedback when users
scroll past the beginning or end of content.
@@ -129,7 +129,7 @@ all of them:
produce a more subtle glowing effect along the top or bottom edge of
the content.
-* `BackgroundColor`: Set the app's background color. Supports a
+- `BackgroundColor`: Set the app's background color. Supports a
four-byte hex value, with the first byte representing the alpha
channel, and standard RGB values for the following three bytes. This
example specifies blue:
@@ -139,7 +139,7 @@ all of them:
Applies to Android and BlackBerry. Overrides CSS otherwise available
across _all_ platforms, for example: `body{background-color:blue}`.
-* `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
+- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
to `true` to hide the additional toolbar that appears above the
keyboard, helping users navigate from one form input to another.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/70a42700/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 61ae1a6..f30886c 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -24,42 +24,42 @@ across each application and CordovaWebView instance. This section
details preferences that only apply to Android builds. See The
config.xml File for information on global configuration options.
-* `LoadingDialog`: Display a native dialog when loading the app. The
- value's format is _Title, Message_
-
- <preference name="LoadingDialog" value="Please wait, the app is loading"/>
-
-* `LoadingPageDialog`: Display a native dialog when loading sub-pages
- within an app. The value's format is _Title, Message_
+- `KeepRunning` (boolean, defaults to `true`): Determines whether the
+ application stays running in the background even after a `pause`
+ event fires.
- <preference name="LoadingPageDialog" value="Please wait, the data is loading"/>
+ <preference name="KeepRunning" value="false"/>
-* `ErrorUrl`: Specifies an error page that displays in response to
+- `ErrorUrl`: Specifies an error page that displays in response to
standard HTTP errors in the 400-500 range. Place the specified file
in the top-level directory containing the home page and other web
assets.
<preference name="ErrorUrl" value="error.html"/>
-* `LoadUrlTimeoutValue` (number, default is `20000`): When loading a
+- `LoadingDialog`: Display a native dialog when loading the app. The
+ value's format is _Title, Message_
+
+ <preference name="LoadingDialog" value="Please wait, the app is loading"/>
+
+- `LoadingPageDialog`: Display a native dialog when loading sub-pages
+ within an app. The value's format is _Title, Message_
+
+ <preference name="LoadingPageDialog" value="Please wait, the data is loading"/>
+
+- `LoadUrlTimeoutValue` (number, default is `20000`): When loading a
page, the amount of time to wait before throwing a timeout error.
This example specifies 10 seconds rather than 20:
<preference name="LoadUrlTimeoutValue" value="10000"/>
-* `KeepRunning` (boolean, defaults to `true`): Determines whether the
- application stays running in the background even after a `pause`
- event fires.
-
- <preference name="KeepRunning" value="false"/>
-
-* `SplashScreen`: The name of the file minus its extension in the
+- `SplashScreen`: The name of the file minus its extension in the
`res/drawable` directory. Various assets must share this common
name in various subdirectories.
<preference name="SplashScreen" value="splash"/>
-* `SplashScreenDelay` (number, defaults to `5000`): The amount of
+- `SplashScreenDelay` (number, defaults to `5000`): The amount of
time the splash screen image displays.
<preference name="SplashScreenDelay" value="10000"/>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/70a42700/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 8abaffe..61b1a09 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -24,7 +24,7 @@ across each application and CordovaWebView instance. This section
details preferences that only apply to BlackBerry 10 builds. See The
config.xml File for information on global configuration options.
-* `ChildBrowser` (`disable` or the default `enable`): Disables child
+- `ChildBrowser` (`disable` or the default `enable`): Disables child
browser windows. By default, apps launch a secondary browser window
to display resources accessed via `window.open()` or by specifying a
`_blank` anchor target. Specify `disable` to override this default
@@ -32,14 +32,14 @@ config.xml File for information on global configuration options.
<preference name="ChildBrowser" value="disable"/>
-* `PopupBlocker` (`enable` or the default `disable`): Enables the
+- `PopupBlocker` (`enable` or the default `disable`): Enables the
popup blocker, which prevents calls to `window.open()`. By default,
popups display in a child browser window. Setting the preference to
`enable` prevents it from displaying at all.
<preference name="PopupBlocker" value="enable"/>
-* `WebSecurity` (`disable` or the default `enable`): Set to `disable`
+- `WebSecurity` (`disable` or the default `enable`): Set to `disable`
to override web security settings, allowing access to remote content
from unknown sources. This preference is intended as a development
convenience only, so remove it before packaging your app for
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/70a42700/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 c0197a3..8b70c75 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -24,43 +24,20 @@ across each application and CordovaWebView instance. This section
details preferences that only apply to iOS builds. See The config.xml
File for information on global configuration options.
-* `TopActivityIndicator` (string, defaults to `gray`): Controls the
- appearance of the small spinning icon in the status bar that
- indicates significant processor activity. Valid values are
- `whiteLarge`, `white`, and `gray`.
-
- <preference name="TopActivityIndicator" value="white"/>
-
-* `EnableViewportScale` (boolean, defaults to `false`): Set to `true`
+- `EnableViewportScale` (boolean, defaults to `false`): Set to `true`
to use a viewport meta tag to either disable or restrict the range
of user scaling.
<preference name="EnableViewportScale" value="true"/>
-* `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to
- prevent the splash screen from fading in and out when its display
- state changes.
-
- <preference name="FadeSplashScreen" value="false"/>
-
-* `FadeSplashScreenDuration` (float, defaults to `2`): Specifies the
- number of seconds for the splash screen fade effect to execute.
-
- <preference name="FadeSplashScreenDuration" value="4"/>
-
-* `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false`
- to hide the splash-screen spinner.
-
- <preference name="ShowSplashScreenSpinner" value="false"/>
-
-* `MediaPlaybackRequiresUserAction` (boolean, defaults to `false`):
+- `MediaPlaybackRequiresUserAction` (boolean, defaults to `false`):
Set to `true` to prevent HTML5 videos from playing automatically
with the `autoplay` attribute. Does not apply when calling `play()`
on a video object.
<preference name="MediaPlaybackRequiresUserAction" value="true"/>
-* `AllowInlineMediaPlayback` (boolean, defaults to `false`): Set to
+- `AllowInlineMediaPlayback` (boolean, defaults to `false`): Set to
`true` to allow HTML5 media playback to appear _inline_ within the
screen layout, using browser-supplied controls rather than native
controls. For this to work, add the `webkit-playsinline` attribute
@@ -68,26 +45,49 @@ File for information on global configuration options.
<preference name="AllowInlineMediaPlayback" value="true"/>
-* `BackupWebStorage` (string, either `none`, `local`, or the default
+- `BackupWebStorage` (string, either `none`, `local`, or the default
`cloud`): Set to `cloud` to allow web storage data to backup via
iCloud. Set to `local` to allow only local backups via iTunes
sync. Set to `none` prevent web storage backups.
<preference name="BackupWebStorage" value="local"/>
-* `KeyboardDisplayRequiresUserAction` (boolean, defaults to `true`):
+- `TopActivityIndicator` (string, defaults to `gray`): Controls the
+ appearance of the small spinning icon in the status bar that
+ indicates significant processor activity. Valid values are
+ `whiteLarge`, `white`, and `gray`.
+
+ <preference name="TopActivityIndicator" value="white"/>
+
+- `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to
+ prevent the splash screen from fading in and out when its display
+ state changes.
+
+ <preference name="FadeSplashScreen" value="false"/>
+
+- `FadeSplashScreenDuration` (float, defaults to `2`): Specifies the
+ number of seconds for the splash screen fade effect to execute.
+
+ <preference name="FadeSplashScreenDuration" value="4"/>
+
+- `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false`
+ to hide the splash-screen spinner.
+
+ <preference name="ShowSplashScreenSpinner" value="false"/>
+
+- `KeyboardDisplayRequiresUserAction` (boolean, defaults to `true`):
Set to `false` to allow the keyboard to appear when calling
`focus()` on form inputs.
<preference name="KeyboardDisplayRequiresUserAction" value="false"/>
-* `SuppressesIncrementalRendering` (boolean, defaults to `false`): Set
+- `SuppressesIncrementalRendering` (boolean, defaults to `false`): Set
to `true` to wait until all content has been received before it
renders to the screen.
<preference name="SuppressesIncrementalRendering" value="true"/>
-* `KeyboardShrinksView` (boolean, defaults to `false`): Set to `true`
+- `KeyboardShrinksView` (boolean, defaults to `false`): Set to `true`
to scale down the webview when the keyboard appears, overriding the
default beavior that shrinks the viewport vertically. This matches
the default behaviour for Android apps.