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:15 UTC
[44/50] docs commit: [CB-3820] reimplemented changes accidentally
overwritten
[CB-3820] reimplemented changes accidentally overwritten
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/61a4b975
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/61a4b975
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/61a4b975
Branch: refs/heads/master
Commit: 61a4b9750b3450bc39186121dfe50140779a75b0
Parents: fa58d41
Author: Mike Sierra <ms...@adobe.com>
Authored: Fri Sep 20 11:50:24 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Sat Sep 21 14:05:40 2013 +0200
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 22 +-
.../edge/guide/platforms/blackberry10/config.md | 6 +-
docs/en/edge/guide/platforms/ios/config.md | 209 -------------------
3 files changed, 15 insertions(+), 222 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/61a4b975/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 71f4647..56fac38 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -56,8 +56,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" />
+ <preference name="Fullscreen" value="true" />
+ <preference name="WebViewBounce" value="true" />
</widget>
The following configuration elements appear in the top-level
@@ -83,19 +83,21 @@ platforms:
allowed to communicate with. The default value shown above allows it
to access any server. See the Domain Whitelist Guide for details.
-- The `<preference>` tag sets various options, many of which are
- unique to specific platforms. The following sections detail
- preferences that apply to more than one platform.
+- The `<preference>` tag sets various options as pairs of
+ `name`/`value` attributes. Each preference's `name` is
+ case-insensitive. Many preferences are unique to specific
+ platforms, as listed at the top of this page. The following sections
+ detail preferences that apply to more than one platform.
## Global Preferences
The following global preferences apply to all platforms:
-- `orientation` allows you to lock orientation and prevent the
+- `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:
- <preference name="orientation" value="landscape" />
+ <preference name="Orientation" value="landscape" />
__NOTE:__ The `default` value means _both_ landscape and portrait
orientations are enabled. If you want to use each platform's
@@ -104,10 +106,10 @@ 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
+- `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" />
+ <preference name="Fullscreen" value="true" />
## Multi-platform Preferences
@@ -130,7 +132,7 @@ all of them:
channel, and standard RGB values for the following three bytes. This
example specifies blue:
- <preference name="backgroundColor" value="0xff0000ff"/>
+ <preference name="BackgroundColor" value="0xff0000ff"/>
Applies to Android and BlackBerry. Overrides CSS otherwise available
across _all_ platforms, for example: `body{background-color:blue}`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/61a4b975/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 d1d82c8..2199f63 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -29,14 +29,14 @@ config.xml File for information on global configuration options.
`window.open()` or by specifying a `_blank` anchor target. Specify
`disable` to override this default behavior.
- <preference name="childBrowser" value="disable"/>
+ <preference name="ChildBrowser" value="disable"/>
* `PopupBlocker`: 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"/>
+ <preference name="PopupBlocker" value="enable"/>
* `WebSecurity`: Disables web security. Disabling web security allows
you to access remote content from unknown sources during
@@ -46,5 +46,5 @@ config.xml File for information on global configuration options.
be whitelisted using the `<access>` element. To disable, specify
value as `disable`.
- <preference name="webSecurity" value="disable"/>
+ <preference name="WebSecurity" value="disable"/>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/61a4b975/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 5a7ac61..f81b6b1 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -24,53 +24,12 @@ 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.
-## Icons and Splash Screens
-
-Cordova supports icons for _classic_, _retina_, _iPad_, and _retina
-iPad_ displays (the latter as of Cordova 2.5). The following defines
-icons for each type of screen:
-
- <icon src="icons/ios/icon.png" gap:platform="ios" width="57" height="57" />
- <icon src="icons/ios/icon-72.png" gap:platform="ios" width="72" height="72" />
- <icon src="icons/ios/icon_at_2x.png" gap:platform="ios" width="114" height="114" />
- <!-- retina iPad -->
- <icon src="icons/ios/icon-72_at_2x.png" gap:platform="ios" width="144" height="144" />
-
-Cordova supports splash screens for _classic_, _retina_, _iPhone 5_,
-and _iPad_ displays. Standard iPads have two different splash screens
-for portrait and landscape orientation. Retina iPads have two
-additional splash screens: retina portrait and retina landscape. The
-following defines splash screens for each type of screen:
-
- <gap:splash src="splash/ios/Default.png" gap:platform="ios" width="320" height="480" />
- <gap:splash src="splash/ios/Default_at_2x.png" gap:platform="ios" width="640" height="960" />
- <gap:splash src="splash/ios/Default_iphone5.png" gap:platform="ios" width="640" height="1136" />
- <gap:splash src="splash/ios/Default-Landscape.png" gap:platform="ios" width="1024" height="748" />
- <gap:splash src="splash/ios/Default-Portrait.png" gap:platform="ios" width="768" height="1004" />
- <!-- retina iPad -->
- <gap:splash src="splash/ios/Default-Landscape_at_2x.png" gap:platform="ios" width="2048" height="1496" />
- <gap:splash src="splash/ios/Default-Portrait_at_2x.png" gap:platform="ios" width="1536" height="2008" />
-
-## iOS Preferences
-
* `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="white"/>
-<!-- QUERY I: describe TopActivityIndicator top spinning throbber -->
-
-* `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) __DEPRECATED__: please set the
- `onload` attribute of the `Geolocation` plugin to `true`
- instead.
-
- <preference name="EnableLocation" value="true"/>
-
-<!-- QUERY I: is deprecated EnableLocation still functional? -->
-
* `EnableViewportScale` (boolean, defaults to `false`): set to `true` to
prevent viewport scaling through a meta tag.
@@ -78,8 +37,6 @@ following defines splash screens for each type of screen:
<!-- QUERY I: confirm EnableViewportScale allows viewport metatag to control range of scale, including disabling? -->
-<!-- QUERY: Do viewport meta tags work as expected in other environments? -->
-
* `FadeSplashScreen` (boolean, defaults to `true`): set to `false` to
prevent the splash-screen to fade in and out when showing or hiding
it.
@@ -96,15 +53,11 @@ following defines splash screens for each type of screen:
<preference name="ShowSplashScreenSpinner" value="false"/>
-<!-- QUERY I: for ShowSplashScreenSpinner describe spinner -->
-
* `MediaPlaybackRequiresUserAction` (boolean, defaults to `false`): set
to `true` to not allow autoplayed HTML5 video.
<preference name="MediaPlaybackRequiresUserAction" value="true"/>
-<!-- QUERY I: does MediaPlaybackRequiresUserAction also apply to audio? -->
-
* `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
@@ -141,167 +94,5 @@ following defines splash screens for each type of screen:
<preference name="KeyboardShrinksView" value="true"/>
-<!-- QUERY I: describe KeyboardShrinksView; shrink webview when keyboard appears -->
-
-<!-- QUERY I: is target-device OK?
-
- #### Target a Specific Device
-
-* `target-device` with possible values `handset`, `tablet`, or
- `universal`
-
- * example: `<preference name="target-device" value="universal" />`
-
- * please note that this currently only applies to iOS builds; by
- default all builds are universal
-
--->
-
-<!-- QUERY I: Is webviewbounce OK?
-
- #### WebView Bounce
-
-* `webviewbounce` with values `true` or `false`
-
- <preference name="webviewbounce" value="fubar"/>
-
- * example: `<preference name="webviewbounce" value="false" />`
-
- * controls whether the screen "bounces" when scrolled beyond the top
- or bottom on iOS. By default, the bounce is _on_
-
--->
-
-<!-- QUERY I: Is prerendered-icon OK?
-
- #### Prerendered Icon
-
-* `prerendered-icon` with values `true` or `false`
-
- * example: `<preference name="prerendered-icon" value="true" />`
-
- * if icon is prerendered, iOS will not apply it's gloss to the app's
- icon on the user's home screen
-
- * default is _false_
-
--->
-
-<!-- QUERY I: Is deprecated stay-in-webview still enabled?
-
- #### Open all links in WebView
-
-* __Deprecated__ -- use <a
- href="http://docs.phonegap.com/en/2.9.0/cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>
- with target equal to '_self' (webview), '_blank' (InAppBrowser),
- '_system' (system web browser)
-
-* `stay-in-webview` with values `true` or `false`
-
- * example: `<preference name="stay-in-webview" value="true" />`
-
- * if set to true, all links (even with target set to blank) will
- open in the app's webview
-
- * only use this preference if you want pages from your server to
- take over your entire app
-
- * default is _false_
-
--->
-
-<!-- QUERY I: Is ios-statusbarstyle OK?
-
- #### Status Bar Style
-
-* `ios-statusbarstyle` with values `default`, `black-opaque` or
- `black-translucent`
-
- * example: `<preference name="ios-statusbarstyle" value="black-opaque" />`
-
- * default is a grey status bar, `black-opaque` will appear black
-
- * although `black-translucent` is supported, the PhoneGap webview
- does not extend beneath the status bar, so it will appear
- identical to `black-opaque` once your app is running
-
--->
-
-<!-- QUERY I: Is detect-data-types OK?
-
- #### Detect Data Types
-
-* `detect-data-types` with values `true` or `false`
-
- * example: `<preference name="detect-data-types" value="false" />`
-
- * controls whether certain data types (such as phone numbers and
- dates) are automatically turned into links by the system. Defaults
- to "true" (as does the system web view)
-
- * supported on PhoneGap 2.0.0 and above
-
--->
-
-<!-- QUERY I: Is exit-on-suspend OK?
-
- #### Exit On Suspend
-
-* `exit-on-suspend` with values `true` or `false`
-
- * example: `<preference name="exit-on-suspend" value="true" />`
-
- * if set to true, app will terminate when suspended, for example
- when home button is pressed
-
- * default is _false_
-
--->
-
-<!-- QUERY I: Is show-splash-screen-spinner OK?
-
- #### Show Splash Screen Spinner
-
-* `show-splash-screen-spinner` with values `true` or `false`
-
- * example: `<preference name="show-splash-screen-spinner"
- value="false" />`
-
- * if set to false, the spinner won't appear on the splash screen
- during app loading
-
- * default is _true_
-
--->
-
-<!-- QUERY I: Is auto-hide-splash-screen OK?
-
- #### Auto-Hide Splash Screen
-
-* `auto-hide-splash-screen` with values `true` or `false`
-
- * example: `<preference name="auto-hide-splash-screen" value="false"
- />`
-
- * if set to false, the splash screen must be hidden using a
- JavaScript API
-
- * default is _true_
-
--->
-
-## Custom URL Schemes
-
-On iOS, adding a `<gap:url-scheme>` element allows you to register
-[custom URL schemes](https://developer.apple.com/library/ios/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/AdvancedAppTricks/AdvancedAppTricks.html#//apple_ref/doc/uid/TP40007072-CH7-SW50), as in the following example:
-
- <gap:url-scheme name="com.acme.myscheme" role="None">
- <scheme>pgbr</scheme>
- <scheme>pgbw</scheme>
- </gap:url-scheme>
-The optional `name` attribute defaults to the app's bundle id. It must
-be unique, otherwise the build fails. The optional `role` must be
-either `Editor`, `Viewer`, `Shell`, or `None`. At least one `scheme`
-must be registered.