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:57 UTC
[13/17] docs commit: global icon/splash content; more queries;
custom URLs in iOS
global icon/splash content; more queries; custom URLs in iOS
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/8a360f6e
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/8a360f6e
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/8a360f6e
Branch: refs/heads/master
Commit: 8a360f6eec6e2851fd7d441c122a7a19f74de302
Parents: 02fd21e
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 20:50:46 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 141 +++++-------------------
docs/en/edge/guide/platforms/ios/config.md | 52 ++++++++-
2 files changed, 75 insertions(+), 118 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8a360f6e/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 b410467..cc323e8 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -160,76 +160,43 @@ the Plugin Development Guide for more information on plugins.
## Icons and Splash Screens
By default, Cordova generates icons based on the root application
-directory's `icon.png` file. Otherwise, adding the `<icon>` tag to the
-`config.xml` file allows you to specify a different filename:
+directory's `icon.png` file. Otherwise, adding `<icon>` elements to
+the `config.xml` file allows you to specify a different default
+filename, or platform-specific icons. The `width` and `height`
+attributes are optional:
- <icon src="app.png" />
+ <icon src="app.png" width="128" height="128"/>
-To define platform-specific icons, consult each platform's
-configuration options:
+Likewise, the default splash screen must be named `splash.png` and
+must reside in the root of your application folder in _png_
+format. Otherwise, use the `gap:splash` tag to specify a different
+filename:
-- iOS Configuration
-- Android Configuration
-- BlackBerry Configuration
-
-
-Icon files should be the file formats specified in the examples below,
-other file types are not guaranteed to work across platforms.
-
-<!-- QUERY: fishes for icon.png by default? Or is cordova icon the default? -->
-
-Add the `<icon> element`
-
-<!-- !!!
-
- ### Icon Support
-
-* `<icon>`: You can have zero or more of these elements present in
- your `config.xml`. If you do not specify a icon then the PhoneGap
- logo will be used as your application's icon.
+ <gap:splash src="app_splash.png" />
- * `src`: (required) specifies the location of the image file,
- relative to your `www` directory
+The `gap:platform` attribute specifies custom splash screens for
+target platforms. For example:
- * `width`: (optional) but recommended to include, width in pixels
+ <gap:splash src="splash/ios/Default-568h@2x~iphone.png"
+ gap:platform="ios" width="320" height="480" />
- * `height`: (optional) but recommended to include, height in pixels
+If the `gap:platform` attribute is not specified, the referenced file
+is copied to _all_ platforms, unnecessarily increasing the size of the
+application package.
- #### Usage and Additional Information:
+<!-- QUERY: confirm default icon.png, splash.png; or is cordova icon the default? -->
+To define platform-specific icons and splash screens, consult each
+platform's configuration options:
- #### Default
-
-The default icon must be named `icon.png` and must reside in the root
-of your application folder.
-
- <icon src="icon.png" />
-
+- iOS Configuration
+- Android Configuration
+- BlackBerry Configuration
+<!-- !!!
# 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).
-
- ## Other Useful Elements
-
#### Windows Phone
We support two icons for Windows Phone, a regular icon and a tile
@@ -248,37 +215,6 @@ notifications.
### Splash Screens
-You can have zero or more of these elements present in your
-`config.xml`. This element can have `src`, `gap:platform`, `width` and
-`height` attributes, just like the `<icon>` element above. Like icon
-files, your splash screens should be saved as `png` files.
-
- <gap:splash src="splash/ios/Default-568h@2x~iphone.png" gap:platform="ios" width="320" height="480" />
-
- #### Usage and Additional Information:
-
-Unless otherwise specified in a config.xml, each platform will try to
-use the default `splash.png` during compilation. To define platform
-specific splash screens please use the guide provided below.
-
-<!-- QUERY: is there a default splash.png, like icon.png? -->
-
-Splash files should be the file formats specified in the examples
-below. Any other file type is not guaranteed to work across platforms.
-
- ##### Warning:
-
-If you do not supply the `gap:platform` attribute, the referenced
-image will be copied to ALL platforms, increasing the size of their
-application packages.
-
- #### Default
-
-The default splash must be named `splash.png` and must reside in the
-root of your application folder.
-
- <gap:splash src="splash.png" />
-
#### Windows Phone
Windows Phone supports a single splash image and can be defined as
@@ -287,33 +223,6 @@ screen should be in `jpg` format
<gap:splash src="splash/winphone/splash.jpg" gap:platform="winphone" />
- ### Custom URL Schemes
-
-iOS Only. Allows registration of [custom URL
-schemes](https://developer.apple.com/library/ios/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/AdvancedAppTricks/AdvancedAppTricks.html#//apple_ref/doc/uid/TP40007072-CH7-SW50).
-
- <gap:url-scheme name="com.acme.myscheme" role="None">
- <scheme>pgbr</scheme>
- <scheme>pgbw</scheme>
- </gap:url-scheme>
-
-* multiple `gap:url-scheme` elements can be present.
-
-* `name`, optional, defaults to the application bundle id. This has to
- be unique. If a duplicate is found the build will fail.
-
-* `role` must be `Editor`, `Viewer`, `Shell` or `None`, optional,
- defaults to `None`.
-
-* at least one `scheme` must be present.
-
- ### Features
-
-* `<feature>`: the feature element can be used to specify which
-features your application is using. If you specify features of the
-PhoneGap API, those will be expanded to the appropriate permissions
-for you application.
-
#### Custom Debug Server
The `debug-server` feature allows you to use a custom Weinre instance
@@ -322,7 +231,7 @@ for your application. By default PhoneGap Build uses
adding the following to your `config.xml`.
<feature name="debug-server" required="true">
- <param name="domain" value="http://debug.custom.com"/>
+ <param name="domain" value="http://debug.example.com"/>
<param name="key" value="some_unique_key"/>
</feature>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8a360f6e/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 7b4dd49..feeaa6d 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -160,9 +160,9 @@ following defines splash screens for each type of screen:
<preference name="KeyboardShrinksView" value="true"/>
-<!-- QUERY I: ___ -->
+<!-- QUERY I: describe KeyboardShrinksView; shrink webview when keyboard appears -->
-<!--
+<!-- QUERY I: is target-device OK?
#### Target a Specific Device
@@ -174,6 +174,10 @@ following defines splash screens for each type of screen:
* 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`
@@ -185,6 +189,10 @@ following defines splash screens for each type of screen:
* 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`
@@ -196,6 +204,10 @@ following defines splash screens for each type of screen:
* default is _false_
+-->
+
+<!-- QUERY I: Is deprecated stay-in-webview still enabled?
+
#### Open all links in WebView
* __Deprecated__ -- use <a
@@ -215,6 +227,10 @@ following defines splash screens for each type of screen:
* default is _false_
+-->
+
+<!-- QUERY I: Is ios-statusbarstyle OK?
+
#### Status Bar Style
* `ios-statusbarstyle` with values `default`, `black-opaque` or
@@ -228,6 +244,10 @@ following defines splash screens for each type of screen:
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`
@@ -240,6 +260,10 @@ following defines splash screens for each type of screen:
* 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`
@@ -251,6 +275,10 @@ following defines splash screens for each type of screen:
* default is _false_
+-->
+
+<!-- QUERY I: Is show-splash-screen-spinner OK?
+
#### Show Splash Screen Spinner
* `show-splash-screen-spinner` with values `true` or `false`
@@ -263,6 +291,10 @@ following defines splash screens for each type of screen:
* default is _true_
+-->
+
+<!-- QUERY I: Is auto-hide-splash-screen OK?
+
#### Auto-Hide Splash Screen
* `auto-hide-splash-screen` with values `true` or `false`
@@ -277,3 +309,19 @@ following defines splash screens for each type of screen:
-->
+## 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.
+
+