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:55 UTC
[11/17] docs commit: move PGB's icon/splash content to
platform-specific config
move PGB's icon/splash content to platform-specific config
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/49b93d27
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/49b93d27
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/49b93d27
Branch: refs/heads/master
Commit: 49b93d2750eeb52966c868b57add3ec927d7bcee
Parents: 5e52130
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 17:33:06 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 107 ++++---------------
docs/en/edge/guide/platforms/android/config.md | 20 ++++
.../edge/guide/platforms/blackberry10/config.md | 17 +++
docs/en/edge/guide/platforms/ios/config.md | 31 ++++++
4 files changed, 91 insertions(+), 84 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49b93d27/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 3ffeb4d..bba41db 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -44,7 +44,8 @@ sections for platform-specific options:
## Core Configuration Elements
This example shows the default `config.xml` generated by the CLI's
-`create` command, described in The Command-line Interface:
+`create` command, described in The Command-line Interface, along with
+a custom icon file:
<widget id="com.example.hello" version="0.0.1">
<name>HelloWorld</name>
@@ -58,6 +59,7 @@ This example shows the default `config.xml` generated by the CLI's
<access origin="*" />
<preference name="fullscreen" value="true" />
<preference name="webviewbounce" value="true" />
+ <icon src="app_icon.png" />
</widget>
The following configuration elements appear in the top-level
@@ -155,30 +157,9 @@ Here is how the element appears for iOS projects:
See the API Reference for details on how to access each feature. See
the Plugin Development Guide for more information about plugins.
-<!-- !!!
-
- # Using config.xml
-
-Apps built using Adobe PhoneGap Build can be set up either through
-our web interface, or by using a `config.xml`. The `config.xml` file,
-as specified in the [W3C widget
-specification](http://www.w3.org/TR/widgets/), allows developers to
-easily specify metadata about their applications. You can see a sample
-`config.xml` with our [PhoneGap
-Start](https://github.com/phonegap/phonegap-start/blob/master/www/config.xml)
-application.
-
-One thing to note: please ensure that your `config.xml` file is at the
-top level of your application (the same level as your `index.html`
-file). Otherwise it will not be loaded correctly.
-
-We're continually adding features to cour `config.xml` support, to
-give PhoneGap Build developers more power to customize their apps. If
-there are any specific features you'd like to see support for, [please
-let us
-know](http://getsatisfaction.com/nitobi/products/nitobi_phonegap_build).
+## Icons and Splash Screens
- ## Other Useful Elements
+<!-- !!!
### Icon Support
@@ -209,38 +190,30 @@ of your application folder.
<icon src="icon.png" />
- #### iOS
-
-We support classic, retina, iPad displays (and retina iPad displays in
-PhoneGap 2.5.0+). The following will define icons for each specific
-screen type.
- <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 support: PhoneGap 2.5.0+ only -->
- <icon src="icons/ios/icon-72_at_2x.png" gap:platform="ios" width="144" height="144" />
-
- #### Android
-
-We support ldpi, mdpi, hdpi, and xhdpi displays; the following will
-define icons for each specific screen type.
+ # Using config.xml
- <icon src="icons/android/ldpi.png" gap:platform="android" gap:density="ldpi" />
- <icon src="icons/android/mdpi.png" gap:platform="android" gap:density="mdpi" />
- <icon src="icons/android/hdpi.png" gap:platform="android" gap:density="hdpi" />
- <icon src="icons/android/xhdpi.png" gap:platform="android" gap:density="xhdpi" />
+Apps built using Adobe PhoneGap Build can be set up either through
+our web interface, or by using a `config.xml`. The `config.xml` file,
+as specified in the [W3C widget
+specification](http://www.w3.org/TR/widgets/), allows developers to
+easily specify metadata about their applications. You can see a sample
+`config.xml` with our [PhoneGap
+Start](https://github.com/phonegap/phonegap-start/blob/master/www/config.xml)
+application.
- #### BlackBerry
+One thing to note: please ensure that your `config.xml` file is at the
+top level of your application (the same level as your `index.html`
+file). Otherwise it will not be loaded correctly.
-BlackBerry icons __must be smaller__ then 16kb. BlackBerry also
-defines an optional hover state; this state allows for a separate icon
-to be displayed when a user uses the trackpad to roll over your icon
-image. By default the non-hover icon will be used as the hover state.
+We're continually adding features to cour `config.xml` support, to
+give PhoneGap Build developers more power to customize their apps. If
+there are any specific features you'd like to see support for, [please
+let us
+know](http://getsatisfaction.com/nitobi/products/nitobi_phonegap_build).
- <icon src="icons/bb/icon.png" gap:platform="blackberry" />
- <icon src="icons/bb/icon_hover.png" gap:platform="blackberry" gap:state="hover"/>
+ ## Other Useful Elements
#### Windows Phone
@@ -291,40 +264,6 @@ root of your application folder.
<gap:splash src="splash.png" />
- #### iOS
-
-We support classic, retina, iPhone 5 and iPad displays; the following
-will define splash screens for each of those. Standard iPads have two
-different splash screens, portrait, landscape. Retina iPads have two
-additional splash screens, retina portrait and retina landscape
-(PhoneGap 2.5.0+ only).
-
- <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 support: PhoneGap 2.5.0+ only -->
- <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" />
-
- #### Android
-
-We support ldpi, mdpi, hdpi and xhdpi displays; the following will
-define splash screens for each specific screen type.
-
- <gap:splash src="splash/android/ldpi.png" gap:platform="android" gap:density="ldpi" />
- <gap:splash src="splash/android/mdpi.png" gap:platform="android" gap:density="mdpi" />
- <gap:splash src="splash/android/hdpi.png" gap:platform="android" gap:density="hdpi" />
- <gap:splash src="splash/android/xhdpi.png" gap:platform="android" gap:density="xhdpi" />
-
- #### BlackBerry
-
-BlackBerry supports a single splash image and can be defined as below.
-
- <gap:splash src="splash/bb/splash.png" gap:platform="blackberry" />
-
#### Windows Phone
Windows Phone supports a single splash image and can be defined as
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49b93d27/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 36fe7d5..a70bb49 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -24,6 +24,26 @@ 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.
+## Icons and Splash Screens
+
+We support ldpi, mdpi, hdpi, and xhdpi displays; the following will
+define icons for each specific screen type.
+
+ <icon src="icons/android/ldpi.png" gap:platform="android" gap:density="ldpi" />
+ <icon src="icons/android/mdpi.png" gap:platform="android" gap:density="mdpi" />
+ <icon src="icons/android/hdpi.png" gap:platform="android" gap:density="hdpi" />
+ <icon src="icons/android/xhdpi.png" gap:platform="android" gap:density="xhdpi" />
+
+We support ldpi, mdpi, hdpi and xhdpi displays; the following will
+define splash screens for each specific screen type.
+
+ <gap:splash src="splash/android/ldpi.png" gap:platform="android" gap:density="ldpi" />
+ <gap:splash src="splash/android/mdpi.png" gap:platform="android" gap:density="mdpi" />
+ <gap:splash src="splash/android/hdpi.png" gap:platform="android" gap:density="hdpi" />
+ <gap:splash src="splash/android/xhdpi.png" gap:platform="android" gap:density="xhdpi" />
+
+## Android Preferences
+
<!-- QUERY A: is useBrowserHistory deprecated?
* `useBrowserHistory` (boolean, defaults to `true`): set to `false` if
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49b93d27/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 281db2c..1db8262 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -24,6 +24,23 @@ 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.
+## Icons and Splash Screens
+
+BlackBerry icons __must be smaller__ then 16kb. BlackBerry also
+defines an optional hover state; this state allows for a separate icon
+to be displayed when a user uses the trackpad to roll over your icon
+image. By default the non-hover icon will be used as the hover state.
+
+ <icon src="icons/bb/icon.png" gap:platform="blackberry" />
+ <icon src="icons/bb/icon_hover.png" gap:platform="blackberry" gap:state="hover"/>
+
+
+BlackBerry supports a single splash image and can be defined as below.
+
+ <gap:splash src="splash/bb/splash.png" gap:platform="blackberry" />
+
+## BlackBerry 10 Preferences
+
* `autoHideSplashScreen`: (`true` or `false`): Set to `false` to
control when the splashscreen is hidden through a JavaScript
API. This preference defaults to true.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/49b93d27/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 bfbf52a..300f544 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -24,6 +24,37 @@ across each application and CordovaWebView instance. This section
details preferences that only apply to iOS builds. See The config.xml
File for information about global configuration options.
+## Icons and Splash Screens
+
+We support classic, retina, iPad displays (and retina iPad displays in
+PhoneGap 2.5.0+). The following will define icons for each specific
+screen type.
+
+ <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 support: PhoneGap 2.5.0+ only -->
+ <icon src="icons/ios/icon-72_at_2x.png" gap:platform="ios" width="144" height="144" />
+
+We support classic, retina, iPhone 5 and iPad displays; the following
+will define splash screens for each of those. Standard iPads have two
+different splash screens, portrait, landscape. Retina iPads have two
+additional splash screens, retina portrait and retina landscape
+(PhoneGap 2.5.0+ only).
+
+ <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 support: PhoneGap 2.5.0+ only -->
+ <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
+
* `DisallowOverscroll` (boolean, defaults to `false`): set to `true` if
you don't want the WebView to rubber-band.