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:45 UTC
[01/17] docs commit: bootstrap sample preference code
Updated Branches:
refs/heads/master a81b69f9f -> 0a8fd70b1
bootstrap sample preference code
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/6dbf38ea
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/6dbf38ea
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/6dbf38ea
Branch: refs/heads/master
Commit: 6dbf38ea95a6223a98534acafbe07e2f29d9a630
Parents: 1b7c1d1
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 14:42:36 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:30 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/platforms/android/config.md | 23 +++++++++---
.../edge/guide/platforms/blackberry10/config.md | 19 +++++++---
docs/en/edge/guide/platforms/ios/config.md | 37 +++++++++++++++++---
3 files changed, 64 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6dbf38ea/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 07cae05..0be753f 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -24,43 +24,56 @@ 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.
-## `<preference>`
-
-Various other preferences (as `<preference>` tags) default on not
-breaking existing apps. The available preferences are:
-
* `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"/>
+
* `loadingDialog`: Display a native loading dialog when loading the
app. The value's format is _Title, Message_
+ <preference name="loadingDialog" value="fubar"/>
+
* `loadingPageDialog`: Display a native loading dialog when loading
sub-pages. The value's format is _Title, Message_
+ <preference name="loadingPageDialog" value="fubar"/>
+
* `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="backgroundColor" value="fubar"/>
+
* `loadUrlTimeoutValue`: How much time Cordova should wait before
throwing a timeout error on the application.
+ <preference name="loadUrlTimeoutValue" value="fubar"/>
+
* `keepRunning` (boolean, defaults to `true`): Determines whether
Cordova stays running in the background.
+ <preference name="keepRunning" value="fubar"/>
+
* `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.
+ <preference name="splashscreen" value="fubar"/>
+
* `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"/>
+
## `<plugin>`
Android supports using `<feature>` as analogues to `<plugin>` elements.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6dbf38ea/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 ed73427..f1e28383 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -24,23 +24,24 @@ 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.
-## `<preference>`
-
-Various preferences (as `<preference>` tags) default on not breaking existing apps.
-The available preferences are:
-
* `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"/>
+
* `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"/>
+
* `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.
+ <preference name="childBrowser" 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.
@@ -48,21 +49,29 @@ The available preferences are:
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="hideKeyboardFormAccessoryBar" value="fubar"/>
+
* `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="orientation" 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="fubar"/>
+
* `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="fubar"/>
+
<!--
#### Disable Cursor
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6dbf38ea/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 652a532..73fb218 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -24,67 +24,90 @@ 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.
-## `<preference>`
-
-Various preferences (as `<preference>` tags) default on not breaking
-existing apps. The available preferences are:
-
* `DisallowOverscroll` (boolean, defaults to `false`): set to `true` if
you don't want the WebView to rubber-band.
+ <preference name="DisallowOverscroll" value="fubar"/>
+
* `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"/>
+
* `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="fubar"/>
+
* `EnableViewportScale` (boolean, defaults to `false`): set to `true` to
prevent viewport scaling through a meta tag.
+ <preference name="EnableViewportScale" value="fubar"/>
+
* `AutoHideSplashScreen` (boolean, defaults to `true`): set to `false` to
control when the splashscreen is hidden through a JavaScript API.
+ <preference name="AutoHideSplashScreen" value="fubar"/>
+
* `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"/>
+
* `FadeSplashScreenDuration` (float, defaults to 2): The splash-screen
Fade duration in seconds.
+ <preference name="FadeSplashScreenDuration" value="fubar"/>
+
* `ShowSplashScreenSpinner` (boolean, defaults to `true`): set to `false`
to hide the splash-screen spinner.
+ <preference name="ShowSplashScreenSpinner" value="fubar"/>
+
* `MediaPlaybackRequiresUserAction` (boolean, defaults to `false`): set
to true to not allow autoplayed HTML5 video.
+ <preference name="MediaPlaybackRequiresUserAction" value="fubar"/>
+
* `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"/>
+
* `BackupWebStorage` (string, defaults to `cloud`): valid values are
`none`, `cloud` and `local`. Set to `cloud` to allow the web
storage data to be backed up to iCloud, and set to `local` to only
allow local backups (iTunes sync). Set to `none` to not allow any
backups of web storage.
+ <preference name="BackupWebStorage" value="fubar"/>
+
* `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"/>
+
* `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"/>
+
* `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"/>
+
* `KeyboardShrinksView` (boolean, defaults to `false`): set to `true` to
shrink the WebView when the keyboard comes up. The WebView shrinks
instead of the viewport shrinking and the page scrollable. This
@@ -92,6 +115,8 @@ existing apps. The available preferences are:
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"/>
+
<!--
#### Target a Specific Device
@@ -108,6 +133,8 @@ existing apps. The available preferences are:
* `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
[17/17] docs commit: conolidate new section for non-global,
multiplatform prefs
Posted by mw...@apache.org.
conolidate new section for non-global, multiplatform prefs
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/8ab082c9
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/8ab082c9
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/8ab082c9
Branch: refs/heads/master
Commit: 8ab082c9672521bf728418ab95b52a253d890975
Parents: 2ede92c
Author: Mike Sierra <ms...@adobe.com>
Authored: Fri Sep 13 12:07:50 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:32 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 133 ++++++++++++++++---
docs/en/edge/guide/platforms/android/config.md | 34 ++---
.../edge/guide/platforms/blackberry10/config.md | 43 +-----
docs/en/edge/guide/platforms/ios/config.md | 19 ---
4 files changed, 125 insertions(+), 104 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8ab082c9/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 be92673..c85c065 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -95,39 +95,130 @@ platforms:
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 preferences apply
- globally:
+ unique to specific platforms. 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 fix orientation and prevent changes
+ from rotating the interface. Possible values are `default`,
+ `landscape`, or `portrait`. Example:
+
+ <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
+ default settings (usually portrait-only), leave this tag out of
+ the `config.xml` file.
+
+<!-- QUERY: BB doc specifies its own "orientation" pref; Does it not recognize "default" as a value? Do no other platforms recognize "auto"?
+
+* `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="orientation" value="landscape"/>
+
+-->
+
+- `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" />
<!-- PGB
- - `phonegap-version` specifies the version of PhoneGap to use when
- building the app using the PhoneGap Build interface, or the CLI's
- `remote` feature described in The Command-line Interface. Example:
+- `phonegap-version` specifies the version of PhoneGap to use when
+ building the app using the PhoneGap Build interface, or the CLI's
+ `remote` feature described in The Command-line Interface. Example:
<preference name="phonegap-version" value="2.9.0" />
- Currently supported versions are __2.0.0__, __2.1.0__, __2.2.0__,
- __2.3.0__, __2.5.0__, __2.7.0__, and __2.9.0__ (the default). all
- versions prior to __2.0.0__ are deprecated. Specifying an
- unsupported version number prevents the project from building.
+ Currently supported versions are __2.0.0__, __2.1.0__, __2.2.0__,
+ __2.3.0__, __2.5.0__, __2.7.0__, and __2.9.0__ (the default). all
+ versions prior to __2.0.0__ are deprecated. Specifying an
+ unsupported version number prevents the project from building.
-->
- - `orientation` allows you to fix orientation and prevent changes
- from rotating the interface. Possible values are `default`,
- `landscape`, or `portrait`. Example:
+## Multi-platform Preferences
- <preference name="orientation" value="landscape" />
+The following preferences apply to more than one platform, but not to
+all of them:
- __NOTE:__ The `default` value means _both_ landscape and portrait
- orientations are enabled. If you want to use each platform's
- default settings (usually portrait-only), leave this tag out of
- the `config.xml` file.
+* `DisallowOverscroll` (boolean, defaults to `false`; Android, iOS):
+ set to `true` if you don't want the WebView to rubber-band.
- - `fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ <preference name="DisallowOverscroll" value="true"/>
- <preference name="fullscreen" value="true" />
+<!-- QUERY A: describe the disallowOverscroll glow effect, or provide example
+
+* `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="true"/>
+
+-->
+
+* `BackgroundColor`: Set the app's background color. Supports a
+ four-byte hex value, with the first byte representing and alpha
+ channel, and standard RGB values for the following three bytes. The
+ example below defines black:
+
+ <preference name="backgroundColor" value="0x00000000"/>
+
+<!-- QUERY BB: does backgroundColor take 00000000 or 0x00000000 as Android does? If former, how to spec?
+
+* `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="0x00000000"/>
+
+-->
+
+* `AutoHideSplashScreen` (boolean, defaults to `true`): set to `false` to
+ control when the splashscreen is hidden through a JavaScript API.
+
+ <preference name="AutoHideSplashScreen" value="false"/>
+
+<!-- autoHideSplashScreen vs iOS AutoHideSplashScreen:
+
+* `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="false"/>
+
+-->
+
+* `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="true"/>
+
+<!-- QUERY: for HideKeyboardFormAccessoryBar, does form-helper UI only appear when there's >1 input? -->
+
+<!-- BB version:
+
+* `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="hideKeyboardFormAccessoryBar" value="enable"/>
+
+-->
+
+<!-- @@@ -->
## The `<feature>` Element
@@ -190,7 +281,7 @@ application package.
To define platform-specific icons and splash screens, consult each
platform's configuration options listed at the top of this section.
-<!-- !!!
+<!-- remaining PGB doc for config.xml:
#### Custom Debug Server
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8ab082c9/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 e9d06ec..01ae020 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -45,7 +45,7 @@ The following defines splash screens for each screen type:
<!-- QUERY A: is useBrowserHistory deprecated?
-* `useBrowserHistory` (boolean, defaults to `true`): set to `false` if
+* `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)
@@ -54,26 +54,26 @@ The following defines splash screens for each screen type:
-->
-* `loadingDialog`: Display a native loading dialog when loading the
+* `LoadingDialog`: Display a native loading 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 loading dialog when loading
+* `LoadingPageDialog`: Display a native loading dialog when loading
sub-pages. The value's format is _Title, Message_
<preference name="loadingPageDialog" value="Please wait, the data is loading"/>
<!-- QUERY A: unclear when loadingDialog & loadingPageDialog would appear. Any examples? -->
-* `errorUrl`: Set the error page for your application. Should be
+* `ErrorUrl`: Set the error page for your application. Should be
located in your Android project in `file://android_asset/www/`
<preference name="errorUrl" value="error.html"/>
<!-- QUERY A: under what conditions does the errorUrl page display? -->
-* `loadUrlTimeoutValue`: How much time Cordova should wait before
+* `LoadUrlTimeoutValue`: How much time Cordova should wait before
throwing a timeout error on the application.
<preference name="loadUrlTimeoutValue" value="20000"/>
@@ -92,34 +92,20 @@ The following defines splash screens for each screen type:
-->
-* `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
+* `KeepRunning` (boolean, defaults to `true`): Determines whether
Cordova stays running in the background.
<preference name="keepRunning" value="false"/>
<!-- QUERY A: does keepRunning mean in effect the app continues to execute following pause event? Does event still fire? -->
-* `splashscreen`: The name of the file minus its extension in the
- `res/drawable` directory. Multiple assets must share this common
- name in various subdirectories. For details, see the _Icons_
- section in The config.xml File.
+* `SplashScreen`: The name of the file minus its extension in the
+ `res/drawable` directory. Various assets must share this common
+ name in various subdirectories. For details, see the _Icons and
+ Splash Screens_ section in The config.xml File.
<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="true"/>
-
-<!-- QUERY A: describe the disallowOverscroll glow effect, or provide example -->
-
<!-- QUERY PGB A: do android-minSdkVersion, android-maxSdkVersion apply outside PG Build?
#### Minimum and Maximum SDK Version
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8ab082c9/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 e9855de..f254c88 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -40,23 +40,7 @@ BlackBerry supports a single splash screen image:
## 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.
-
- <preference name="autoHideSplashScreen" value="false"/>
-
-<!-- autoHideSplashScreen vs iOS AutoHideSplashScreen: -->
-
-* `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="0x00000000"/>
-
-<!-- QUERY BB: does backgroundColor take 00000000 or 0x00000000 as Android does? If former, how to spec? -->
-
-* `childBrowser`: Disables child browser windows. By default, when the
+* `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
@@ -65,28 +49,7 @@ BlackBerry supports a single splash screen image:
<preference name="childBrowser" value="disable"/>
-* `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="hideKeyboardFormAccessoryBar" value="enable"/>
-
-<!-- QUERY BB: hideKeyboardFormAccessoryBar vs iOS -->
-
-* `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="orientation" value="landscape"/>
-
-<!-- QUERY: BB doc specifies its own "orientation" pref; Does it not recognize "default" as a value? Do no other platforms recognize "auto"? -->
-
-* `popupBlocker`: Enables the popup blocker. By default, all popups
+* `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
@@ -96,7 +59,7 @@ BlackBerry supports a single splash screen image:
<!-- QUERY BB: for popupBlocker, clarify "popup" -->
-* `webSecurity`: Disables web security. Disabling web security allows
+* `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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8ab082c9/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 980b76a..5a7ac61 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -53,11 +53,6 @@ following defines splash screens for each type of screen:
## iOS Preferences
-* `DisallowOverscroll` (boolean, defaults to `false`): set to `true` if
- you don't want the WebView to rubber-band.
-
- <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`.
@@ -85,11 +80,6 @@ following defines splash screens for each type of screen:
<!-- QUERY: Do viewport meta tags work as expected 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="false"/>
-
* `FadeSplashScreen` (boolean, defaults to `true`): set to `false` to
prevent the splash-screen to fade in and out when showing or hiding
it.
@@ -142,15 +132,6 @@ following defines splash screens for each type of screen:
<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="true"/>
-
-<!-- QUERY: for HideKeyboardFormAccessoryBar, does form-helper UI 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
instead of the viewport shrinking and the page scrollable. This
[15/17] docs commit: rewrite platform-specific icon/splash content
Posted by mw...@apache.org.
rewrite platform-specific icon/splash content
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/5c7fc601
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/5c7fc601
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/5c7fc601
Branch: refs/heads/master
Commit: 5c7fc6015b66ae9db97f2b7a4f9828d0dba43d5f
Parents: 49b93d2
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 18:19:45 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 | 19 ++++-----
.../edge/guide/platforms/blackberry10/config.md | 13 +++---
docs/en/edge/guide/platforms/ios/config.md | 44 ++++++++++----------
3 files changed, 36 insertions(+), 40 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5c7fc601/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 a70bb49..ebf96bf 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -26,20 +26,19 @@ 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.
+Cordova supports images for _ldpi_, _mdpi_, _hdpi_, and _xhdpi_
+displays. The following defines icons for each type of screen:
- <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/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.
+The following defines splash screens for each 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/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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5c7fc601/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 1db8262..5bb4d87 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -26,16 +26,15 @@ 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.
+BlackBerry icons __must be smaller__ than 16K. BlackBerry also defines
+an optional hover state that allows a separate icon to display when
+users roll a trackpad cursor over the icon image. By default, the
+non-hover icon displays for the hover state. Define icons as follows:
- <icon src="icons/bb/icon.png" gap:platform="blackberry" />
+ <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.
+BlackBerry supports a single splash screen image:
<gap:splash src="splash/bb/splash.png" gap:platform="blackberry" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5c7fc601/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 300f544..259447e 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -26,32 +26,30 @@ 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 -->
+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" />
-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 -->
+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" />
+ <gap:splash src="splash/ios/Default-Portrait_at_2x.png" gap:platform="ios" width="1536" height="2008" />
## iOS Preferences
[06/17] docs commit: link to WP icon/splash content
Posted by mw...@apache.org.
link to WP icon/splash content
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/2ede92c2
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/2ede92c2
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/2ede92c2
Branch: refs/heads/master
Commit: 2ede92c2d0572cfc6fb1c7b38ce7a23115fa5d3a
Parents: d439b7f
Author: Mike Sierra <ms...@adobe.com>
Authored: Fri Sep 13 06:59:00 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 7 ++-----
docs/en/edge/guide/platforms/index.md | 6 +-----
2 files changed, 3 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2ede92c2/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 e51984e..be92673 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -40,6 +40,7 @@ sections for platform-specific options:
- iOS Configuration
- Android Configuration
- BlackBerry Configuration
+- Windows Phone Configuration
## Core Configuration Elements
@@ -187,11 +188,7 @@ application package.
<!-- 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:
-
-- iOS Configuration
-- Android Configuration
-- BlackBerry Configuration
+platform's configuration options listed at the top of this section.
<!-- !!!
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2ede92c2/docs/en/edge/guide/platforms/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/index.md b/docs/en/edge/guide/platforms/index.md
index 401a45d..f779358 100644
--- a/docs/en/edge/guide/platforms/index.md
+++ b/docs/en/edge/guide/platforms/index.md
@@ -73,6 +73,7 @@ a lower-level alternative to the `cordova` command-line utility.
* Windows Phone 8 Platform Guide
* Windows Phone 7 Platform Guide
+* Windows Phone Configuration
* Windows Phone Command-line Tools
* Upgrading Windows Phone
@@ -86,8 +87,3 @@ a lower-level alternative to the `cordova` command-line utility.
* Tizen Platform Guide
-<!--
-## FirefoxOS
-
-* FirefoxOS Configuration
--->
[04/17] docs commit: rename section as 'The config.xml File'
Posted by mw...@apache.org.
rename section as 'The config.xml File'
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/6e616481
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/6e616481
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/6e616481
Branch: refs/heads/master
Commit: 6e616481bb0371357621944b83dd00774640cfa8
Parents: c5d081d
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 13:40:42 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:30 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 2 +-
docs/en/edge/guide/overview/index.md | 2 +-
docs/en/edge/index.md | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6e616481/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 4c2abf6..e65bdf6 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -17,7 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-# Configuration Reference
+# The config.xml File
Many aspects of an app's behavior can be controlled with a global
configuration file, `config.xml`, that is placed in the top-level web
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6e616481/docs/en/edge/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/index.md b/docs/en/edge/guide/overview/index.md
index 75a5e25..76422e9 100644
--- a/docs/en/edge/guide/overview/index.md
+++ b/docs/en/edge/guide/overview/index.md
@@ -109,7 +109,7 @@ You may use the command-line utility to initially generate the app, or
iteratively thereafter to feed updated code to SDK tools. You may
also build the app's configuration file yourself.
<!-- XREF
-(See Configuration Reference for details.)
+(See The config.xml File for details.)
XREF -->
<!-- XREF
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6e616481/docs/en/edge/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/index.md b/docs/en/edge/index.md
index 42f5aa4..fa868da 100644
--- a/docs/en/edge/index.md
+++ b/docs/en/edge/index.md
@@ -34,7 +34,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
<span>Set up each SDK and update projects</span>
</li>
<li>
- <h2>Configuration Reference</h2>
+ <h2>The config.xml File</h2>
<span>Customize the features of your app.</span>
</li>
<li>
[05/17] docs commit: rewrite config.xml ref
Posted by mw...@apache.org.
rewrite config.xml ref
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/c5d081d3
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/c5d081d3
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/c5d081d3
Branch: refs/heads/master
Commit: c5d081d30a3dd064f4214ace6ebe0b4046075e3d
Parents: a81b69f
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 13:32:54 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:30 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 151 +++++++++++++++-----
docs/en/edge/guide/platforms/android/config.md | 4 +-
2 files changed, 117 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c5d081d3/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 311a0ec..4c2abf6 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -19,59 +19,138 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Configuration Reference
-Many aspects of an application's behavior can be controlled with a
-platform-agnostic configuration file, `config.xml`, which is formatted
-based on the W3C's
-[Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/)
-specification.
+Many aspects of an app's behavior can be controlled with a global
+configuration file, `config.xml`, that is placed in the top-level web
+asset directory along with the app's home page. This
+platform-agnostic XML file is formatted based on the W3C's [Packaged
+Web Apps (Widgets)](http://www.w3.org/TR/widgets/) specification, and
+extended to specify core Cordova API features, plugins, and
+platform-specific settings.
For projects created with the Cordova CLI (described in The
Command-line Interface), this file can be found in the top-level `www`
-directory. Using the CLI to build projects regenerates versions of
-this file in various subdirectories within `platforms`. For non-CLI
-projects, each platform-specific file serves as a source.
+directory. Using the CLI to build a project regenerates versions of
+this file in various subdirectories within `platforms`. If you use the
+CLI to create a project, but then shift your workflow to an SDK, the
+platform-specific file serves as a source.
-While the location of the `config.xml` file may change depending on
-the platform, its contents generally do not. Some platform-specific
-features are also specified in the same configuration file. Details
-are listed below:
+This section details global configuration options. See the following
+sections for platform-specific options:
- iOS Configuration
- Android Configuration
- BlackBerry Configuration
-## config.xml Elements
+## Core Configuration Elements
-The [Apache Cordova](http://cordova.io) project strives abstract away native platform specifics via web-inspired and web-based
-abstractions that are heavily standards driven and adopted by the web community. Please take a few minutes to familiarize
-yourself with the [config.xml specification](http://www.w3.org/TR/widgets/), to understand the type of application metadata the
-Apache Cordova project aims to abstract and provide simple entry points for.
+This example shows the default `config.xml` generated by the CLI's
+`create` command, described in The Command-line Interface:
-An example:
-
- <widget>
- <preference name="MySetting" value="true" />
- <feature name="MyPlugin" value="MyPluginClass" />
- <access origin="*" />
+ <widget id="com.example.hello" version="0.0.1">
+ <name>HelloWorld</name>
+ <description>
+ A sample Apache Cordova application that responds to the deviceready event.
+ </description>
+ <author email="dev@callback.apache.org" href="http://cordova.io">
+ Apache Cordova Team
+ </author>
<content src="index.html" />
+ <access origin="*" />
+ <preference name="fullscreen" value="true" />
+ <preference name="webviewbounce" value="true" />
</widget>
-A list of supported elements across major platforms which are supported in Apache Cordova follow.
+The following configuration elements appear in the top-level
+`config.xml` file, and are supported across all supported Cordova
+platforms:
+
+- The `<widget>` element's `id` attribute provides the app's
+ reverse-domain identifier, and the `version` its full version number
+ expressed in major/minor/patch notation.
+
+ For Android builds, an optional `versionCode` attribute allows you
+ to express the version number
+ [as an integer](http://developer.android.com/guide/publishing/versioning.html).
+
+- The `<name>` element specifies the app's formal name, as it appears
+ on the device's home screen and within app-store interfaces.
+
+ If you are targeting the BlackBerry platform, use only Latin characters.
+
+- The `<description>` and `<author>` elements specify metadata and
+ contact information that may appear within app-store listings.
+
+ If you are targeting the BlackBerry platform, keep the description short.
+
+- The optional `<content>` element defines your application's starting
+ page in the top-level web assets directory. The default value is
+ `index.html`, which customarily appears in a project's top-level
+ `www` directory.
+
+- `<access>` elements define the set of external domains the app is
+ 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 preferences apply
+ globally:
+
+<!-- PGB
+
+ - `phonegap-version` specifies the version of PhoneGap to use when
+ building the app using the PhoneGap Build interface, or the CLI's
+ `remote` feature described in The Command-line Interface. Example:
+
+ <preference name="phonegap-version" value="2.9.0" />
+
+ Currently supported versions are __2.0.0__, __2.1.0__, __2.2.0__,
+ __2.3.0__, __2.5.0__, __2.7.0__, and __2.9.0__ (the default). all
+ versions prior to __2.0.0__ are deprecated. Specifying an
+ unsupported version number prevents the project from building.
+
+-->
+
+ - `orientation` allows you to fix orientation and prevent changes
+ from rotating the interface. Possible values are `default`,
+ `landscape`, or `portrait`. Example:
+
+ <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
+ default settings (usually portrait-only), leave this tag out of
+ the `config.xml` file.
+
+ - `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" />
+
+## The `<feature>` Element
+
+If you use the CLI to build applications, you use the `plugin` command
+to enable device APIs. This does not modify the top-level `config.xml`
+file, so the `<feature>` element does not apply to your workflow. If
+you are working directly in an SDK and using the platform-specific
+`config.xml` file as source, you use the `<feature>` tag to enable
+device-level APIs and external plugins. They typically appear in this
+form:
-### `<feature>`
+ <feature name="Plugin" value="PluginID" />
-These elements map to native APIs that the application accesses. At
-runtime, the Apache Cordova framework maps `<feature>` elements to
-native code to enable your Cordova application to access device APIs
-otherwise unavailable to typical web-based applications.
+They often appear with custom values in platform-specific `config.xml`
+files. For example, here is how to specify the Device API for Android
+projects:
-### `<access>`
+ <feature name="Device">
+ <param name="android-package" value="org.apache.cordova.device.Device" />
+ </feature>
-These elements define how your whitelist works. Please see the
-Domain Whitelist Guide for more information.
+Here is how the element appears for iOS projects:
-### `<content>`
+ <feature name="Device">
+ <param name="ios-package" value="CDVDevice" />
+ </feature>
-This element defines your application's start page relative to the
-project's standard web assets root directory. This element is optional,
-the default is `index.html`.
+See the API Reference for details on how to access each feature. See
+the Plugin Development Guide for more information about plugins.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c5d081d3/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 6368f83..9b42ee0 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -19,8 +19,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Android Configuration
-The `config.xml` file controls various Cordova settings. These apply
-across the application, and per CordovaWebView instance.
+The `config.xml` file controls various Cordova settings. These
+apply to each application and CordovaWebView instance.
## `<preference>`
[02/17] docs commit: cleanup intros to plat-specific config.xml
Posted by mw...@apache.org.
cleanup intros to plat-specific config.xml
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/1b7c1d14
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/1b7c1d14
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/1b7c1d14
Branch: refs/heads/master
Commit: 1b7c1d1481283f0c41fc5ffc6e27db55117be802
Parents: 0820ebc
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 14:34:43 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:30 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/platforms/android/config.md | 6 +++--
.../edge/guide/platforms/blackberry/config.md | 16 --------------
.../edge/guide/platforms/blackberry10/config.md | 23 ++++++++++++++++++--
docs/en/edge/guide/platforms/ios/config.md | 8 +++----
4 files changed, 29 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1b7c1d14/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 1d67c7c..07cae05 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -19,8 +19,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Android Configuration
-The `config.xml` file controls various Cordova settings. These
-apply to each application and CordovaWebView instance.
+The `config.xml` file controls an app's basic settings that apply
+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.
## `<preference>`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1b7c1d14/docs/en/edge/guide/platforms/blackberry/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry/config.md b/docs/en/edge/guide/platforms/blackberry/config.md
index a07195e..4e212f6 100644
--- a/docs/en/edge/guide/platforms/blackberry/config.md
+++ b/docs/en/edge/guide/platforms/blackberry/config.md
@@ -25,19 +25,3 @@ as well as proprietary RIM extensions. Please see the full
[BlackBerry WebWorks documentation regarding config.xml](https://developer.blackberry.com/html5/documentation/working_with_config_xml_file_1866970_11.html)
for details.
-<!--
-
- #### Disable Cursor
-
-* `disable-cursor` with values `true` or `false`
-
- * example: `<preference name="disable-cursor" value="true" />`
-
- * prevents a mouse-icon/cursor from being displayed on the app -
- desugars to `<rim:navigation />`. See [the BlackBerry
- documentation](https://bdsc.webapps.blackberry.com/html5/documentation/ww_developing/rim_navigation_element_1582456_11.html)
- for more details
-
- * default is _false_
-
--->
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1b7c1d14/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 6e5945b..ed73427 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -19,8 +19,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# BlackBerry 10 Configuration
-The `config.xml` file controls various Cordova settings. These apply across the application.
-The `config.xml` file is is located in `<project folder>/<www>` directory.
+The `config.xml` file controls an app's basic settings that apply
+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.
## `<preference>`
@@ -60,3 +62,20 @@ The available preferences are:
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`.
+
+<!--
+
+ #### Disable Cursor
+
+* `disable-cursor` with values `true` or `false`
+
+ * example: `<preference name="disable-cursor" value="true" />`
+
+ * prevents a mouse-icon/cursor from being displayed on the app -
+ desugars to `<rim:navigation />`. See [the BlackBerry
+ documentation](https://bdsc.webapps.blackberry.com/html5/documentation/ww_developing/rim_navigation_element_1582456_11.html)
+ for more details
+
+ * default is _false_
+
+-->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/1b7c1d14/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 cfc5459..652a532 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -19,10 +19,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# iOS Configuration
-The `config.xml` settings file controls various Cordova settings.
-This is application wide, and not set per CDVViewController instance.
-The `config.xml` file is located within the `<project
-folder>/<appname>` directory.
+The `config.xml` file controls an app's basic settings that apply
+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.
## `<preference>`
[12/17] docs commit: new icon/splash content for WP
Posted by mw...@apache.org.
new icon/splash content for WP
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d439b7f2
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d439b7f2
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d439b7f2
Branch: refs/heads/master
Commit: d439b7f21c7163c8299f49792a8396836420b14c
Parents: 8a360f6
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 21:02:26 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 28 ------------------
docs/en/edge/guide/platforms/ios/config.md | 1 -
docs/en/edge/guide/platforms/wp8/config.md | 38 +++++++++++++++++++++++++
3 files changed, 38 insertions(+), 29 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d439b7f2/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 cc323e8..e51984e 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -195,34 +195,6 @@ platform's configuration options:
<!-- !!!
- # Using config.xml
-
- #### Windows Phone
-
-We support two icons for Windows Phone, a regular icon and a tile
-image.
-
- <icon src="icons/winphone/icon.png" gap:platform="winphone" />
- <icon src="icons/winphone/tileicon.png" gap:platform="winphone" gap:role="background" />
-
- #### WebOS
-
-WebOS supports a default icon and a mini icon which can be used for
-notifications.
-
- <icon src="icons/webos/icon.png" gap:platform="webos" />
- <icon src="icons/webos/miniicon.png" gap:platform="webos" gap:role="mini" />
-
- ### Splash Screens
-
- #### Windows Phone
-
-Windows Phone supports a single splash image and can be defined as
-below. Unlike the other supported platforms, Windows Phone splash
-screen should be in `jpg` format
-
- <gap:splash src="splash/winphone/splash.jpg" gap:platform="winphone" />
-
#### Custom Debug Server
The `debug-server` feature allows you to use a custom Weinre instance
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d439b7f2/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 feeaa6d..980b76a 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -324,4 +324,3 @@ be unique, otherwise the build fails. The optional `role` must be
either `Editor`, `Viewer`, `Shell`, or `None`. At least one `scheme`
must be registered.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d439b7f2/docs/en/edge/guide/platforms/wp8/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/wp8/config.md b/docs/en/edge/guide/platforms/wp8/config.md
new file mode 100644
index 0000000..6b8fe1b
--- /dev/null
+++ b/docs/en/edge/guide/platforms/wp8/config.md
@@ -0,0 +1,38 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Windows Phone Configuration
+
+The `config.xml` file controls an app's basic settings that apply
+across each application and CordovaWebView instance. This section
+lists image-related settings that only apply to Windows Phone builds.
+See The config.xml File for information on global configuration
+options.
+
+Cordova supports two kinds of Windows Phone icons, a regular icon and
+a background tile image:
+
+ <icon src="icons/winphone/icon.png" gap:platform="winphone" />
+ <icon src="icons/winphone/tileicon.png" gap:platform="winphone" gap:role="background" />
+
+Windows Phone supports a single splash screen image as shown below.
+Unlike other platforms, the image should be in _jpg_ format:
+
+ <gap:splash src="splash/winphone/splash.jpg" gap:platform="winphone" />
+
[16/17] docs commit: keep hidden WebOS content in for now to better
track it
Posted by mw...@apache.org.
keep hidden WebOS content in for now to better track it
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/0a8fd70b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/0a8fd70b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/0a8fd70b
Branch: refs/heads/master
Commit: 0a8fd70b11a3544e2b34edb70773aea519889960
Parents: 8ab082c
Author: Mike Sierra <ms...@adobe.com>
Authored: Fri Sep 13 12:23:47 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:32 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 8 ++++++++
1 file changed, 8 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0a8fd70b/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 c85c065..2e89ffa 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -376,4 +376,12 @@ At present, to include a plugin, you will to ensure:
More details, including a list of available plugins, are in our
[plugins documentation](/docs/plugins).
+ #### WebOS
+
+WebOS supports a default icon and a mini icon which can be used for
+notifications.
+
+ <icon src="icons/webos/icon.png" gap:platform="webos" />
+ <icon src="icons/webos/miniicon.png" gap:platform="webos" gap:role="mini" />
+
-->
[13/17] docs commit: global icon/splash content; more queries;
custom URLs in iOS
Posted by mw...@apache.org.
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.
+
+
[11/17] docs commit: move PGB's icon/splash content to
platform-specific config
Posted by mw...@apache.org.
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.
[08/17] docs commit: non-default preference values; light edits
Posted by mw...@apache.org.
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
+-->
+
[14/17] docs commit: gather queries
Posted by mw...@apache.org.
gather queries
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/5e521307
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/5e521307
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/5e521307
Branch: refs/heads/master
Commit: 5e52130719f11f25455e4981a4e1690ed855ecbb
Parents: 71d8936
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 17:18:57 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 6 ++--
docs/en/edge/guide/platforms/android/config.md | 29 +++++++++++-------
.../edge/guide/platforms/blackberry10/config.md | 12 +++++---
docs/en/edge/guide/platforms/ios/config.md | 32 ++++++++++++--------
4 files changed, 50 insertions(+), 29 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5e521307/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 49849e4..3ffeb4d 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -159,7 +159,7 @@ the Plugin Development Guide for more information about plugins.
# Using config.xml
-Apps built using Adobe® PhoneGap™ Build can be set up either through
+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
@@ -252,7 +252,7 @@ image.
#### WebOS
-WebOs supports a default icon and a mini icon which can be used for
+WebOS supports a default icon and a mini icon which can be used for
notifications.
<icon src="icons/webos/icon.png" gap:platform="webos" />
@@ -273,6 +273,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5e521307/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 505e8ee..36fe7d5 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -24,7 +24,7 @@ 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.
-<!-- QUERY: deprecated?
+<!-- QUERY A: is useBrowserHistory deprecated?
* `useBrowserHistory` (boolean, defaults to `true`): set to `false` if
you want to use the history shim that was used to work around the
@@ -38,30 +38,30 @@ config.xml File for information about global configuration options.
* `loadingDialog`: Display a native loading dialog when loading the
app. The value's format is _Title, Message_
- <preference name="loadingDialog" value="Loading, Please wait for application"/>
+ <preference name="loadingDialog" value="Please wait, the app is loading"/>
* `loadingPageDialog`: Display a native loading dialog when loading
sub-pages. The value's format is _Title, Message_
- <preference name="loadingPageDialog" value="Loading, Please wait for data"/>
+ <preference name="loadingPageDialog" value="Please wait, the data is loading"/>
-<!-- QUERY: when do these apply? -->
+<!-- QUERY A: unclear when loadingDialog & loadingPageDialog would appear. Any examples? -->
* `errorUrl`: Set the error page for your application. Should be
located in your Android project in `file://android_asset/www/`
<preference name="errorUrl" value="error.html"/>
-<!-- QUERY: when do these apply? -->
+<!-- QUERY A: under what conditions does the errorUrl page display? -->
* `loadUrlTimeoutValue`: How much time Cordova should wait before
throwing a timeout error on the application.
<preference name="loadUrlTimeoutValue" value="20000"/>
-<!-- QUERY: expressed in milliseconds? 20000 default?-->
+<!-- QUERY A: is loadUrlTimeoutValue expressed in milliseconds? is 20000 the default?-->
-<!-- QUERY
+<!-- QUERY A: confirm loadUrlTimeoutValue replaces PGB's load-url-timeout
#### Load URL timeout
@@ -85,7 +85,7 @@ config.xml File for information about global configuration options.
<preference name="keepRunning" value="false"/>
-<!-- QUERY: does that mean in effect the app continues to execute following pause event? -->
+<!-- QUERY A: does keepRunning mean in effect the app continues to execute following pause event? Does event still fire? -->
* `splashscreen`: The name of the file minus its extension in the
`res/drawable` directory. Multiple assets must share this common
@@ -99,9 +99,9 @@ config.xml File for information about global configuration options.
<preference name="disallowOverscroll" value="true"/>
-<!-- QUERY: glow? -->
+<!-- QUERY A: describe the disallowOverscroll glow effect, or provide example -->
-<!--
+<!-- QUERY PGB A: do android-minSdkVersion, android-maxSdkVersion apply outside PG Build?
#### Minimum and Maximum SDK Version
@@ -119,6 +119,10 @@ config.xml File for information about global configuration options.
* minSdkVersion defaults to 7 (Android 2.1); maxSdkVersion is unset
by default
+-->
+
+<!-- QUERY A: does android-installLocation apply outside PGB?
+
#### Install Location
* `android-installLocation` with values `internalOnly`, `auto` or `preferExternal`
@@ -135,6 +139,10 @@ config.xml File for information about global configuration options.
* more details available in [the Android
documentation](http://developer.android.com/guide/appendix/install-location.html)
+-->
+
+<!-- QUERY A: does splash-screen-duration apply outside PGB?
+
#### Splash Screen Duration
* `splash-screen-duration` with a value in milliseconds
@@ -150,4 +158,3 @@ config.xml File for information about global configuration options.
* supported on PhoneGap 2.1.0 and above
-->
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5e521307/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 ba48622..281db2c 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -30,13 +30,15 @@ config.xml File for information about global configuration options.
<preference name="autoHideSplashScreen" value="false"/>
+<!-- autoHideSplashScreen vs iOS AutoHideSplashScreen: -->
+
* `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="0x00000000"/>
-<!-- QUERY: remove "0x" from above? Varies from Android -->
+<!-- QUERY BB: does backgroundColor take 00000000 or 0x00000000 as Android does? If former, how to spec? -->
* `childBrowser`: Disables child browser windows. By default, when the
content attempts to open a resource in a new window or tab (by using
@@ -58,7 +60,7 @@ config.xml File for information about global configuration options.
<preference name="hideKeyboardFormAccessoryBar" value="enable"/>
-<!-- QUERY: appears for >1 input? -->
+<!-- QUERY BB: hideKeyboardFormAccessoryBar vs iOS -->
* `orientation`: (`auto`, `portrait`, or `landscape`) Specifies the
persistent orientation for screens in your app. By default, if you
@@ -66,7 +68,7 @@ config.xml File for information about global configuration options.
<preference name="orientation" value="landscape"/>
-<!-- QUERY: different from default? -->
+<!-- QUERY: BB doc specifies its own "orientation" pref; Does it not recognize "default" as a value? Do no other platforms recognize "auto"? -->
* `popupBlocker`: Enables the popup blocker. By default, all popups
are displayed by BlackBerry WebWorks apps in a child browser
@@ -76,6 +78,8 @@ config.xml File for information about global configuration options.
<preference name="popupBlocker" value="enable"/>
+<!-- QUERY BB: for popupBlocker, clarify "popup" -->
+
* `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
@@ -86,7 +90,7 @@ config.xml File for information about global configuration options.
<preference name="webSecurity" value="disable"/>
-<!--
+<!-- QUERY BB: does disable-cursor work?
#### Disable Cursor
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5e521307/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 5d8e49d..bfbf52a 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -35,7 +35,7 @@ File for information about global configuration options.
<preference name="TopActivityIndicator" value="white"/>
-<!-- QUERY: ??? -->
+<!-- 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
@@ -45,14 +45,16 @@ File for information about global configuration options.
<preference name="EnableLocation" value="true"/>
-<!-- QUERY: deprecated? -->
+<!-- QUERY I: is deprecated EnableLocation still functional? -->
* `EnableViewportScale` (boolean, defaults to `false`): set to `true` to
prevent viewport scaling through a meta tag.
<preference name="EnableViewportScale" value="true"/>
-<!-- QUERY: Do viewport tags work in other environments? -->
+<!-- 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? -->
* `AutoHideSplashScreen` (boolean, defaults to `true`): set to `false` to
control when the splashscreen is hidden through a JavaScript API.
@@ -75,13 +77,17 @@ File for information about global configuration options.
<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.
+ 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
+ `true` to allow inline HTML5 media playback, also, the video element
in the HTML document must also include the webkit-playsinline
attribute.
@@ -96,25 +102,25 @@ File for information about global configuration options.
<preference name="BackupWebStorage" value="local"/>
* `KeyboardDisplayRequiresUserAction` (boolean, defaults to `true`):
- set to false to open the keyboard when form elements get focus via
+ set to `false` to open the keyboard when form elements get focus via
the JavaScript focus() call.
<preference name="KeyboardDisplayRequiresUserAction" value="false"/>
* `SuppressesIncrementalRendering` (boolean, defaults to `false`): set
- to true to wait until all new view content has been received
+ to `true` to wait until all new view content has been received
before it is rendered.
<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.
+* `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="true"/>
-<!-- QUERY: do form helpers only appear when there's >1 input? -->
+<!-- QUERY: for HideKeyboardFormAccessoryBar, does form-helper UI 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
@@ -125,6 +131,8 @@ File for information about global configuration options.
<preference name="KeyboardShrinksView" value="true"/>
+<!-- QUERY I: ___ -->
+
<!--
#### Target a Specific Device
[03/17] docs commit: stage PGBuild content for platforms' config.xml
Posted by mw...@apache.org.
stage PGBuild content for platforms' config.xml
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/0820ebcf
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/0820ebcf
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/0820ebcf
Branch: refs/heads/master
Commit: 0820ebcff070fa4f97089936463420b5de55082f
Parents: 6e61648
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 14:17:11 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:30 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 298 +++++++++++++++++++
.../file/localfilesystem/localfilesystem.md | 1 -
docs/en/edge/guide/platforms/android/config.md | 59 ++++
.../edge/guide/platforms/blackberry/config.md | 17 ++
docs/en/edge/guide/platforms/ios/config.md | 117 +++++++-
5 files changed, 489 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0820ebcf/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 e65bdf6..49849e4 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -154,3 +154,301 @@ 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).
+
+ ## Other Useful Elements
+
+ ### 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.
+
+ * `src`: (required) specifies the location of the image file,
+ relative to your `www` directory
+
+ * `width`: (optional) but recommended to include, width in pixels
+
+ * `height`: (optional) but recommended to include, height in pixels
+
+ #### Usage and Additional Information:
+
+Unless otherwise specified in a config.xml, each platform will try to
+use the default `icon.png` during compilation. To define platform
+specific icons please use the guide provided below.
+
+Icon files should be the file formats specified in the examples below,
+other file types are not guaranteed to work across platforms.
+
+ #### Default
+
+The default icon must be named `icon.png` and must reside in the root
+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.
+
+ <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" />
+
+ #### BlackBerry
+
+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"/>
+
+ #### Windows Phone
+
+We support two icons for Windows Phone, a regular icon and a tile
+image.
+
+ <icon src="icons/winphone/icon.png" gap:platform="winphone" />
+ <icon src="icons/winphone/tileicon.png" gap:platform="winphone" gap:role="background" />
+
+ #### WebOS
+
+WebOs supports a default icon and a mini icon which can be used for
+notifications.
+
+ <icon src="icons/webos/icon.png" gap:platform="webos" />
+ <icon src="icons/webos/miniicon.png" gap:platform="webos" gap:role="mini" />
+
+ ### 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.
+
+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" />
+
+ #### 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
+below. Unlike the other supported platforms, Windows Phone splash
+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
+for your application. By default PhoneGap Build uses
+`http://debug.build.phonegap.com` however this can be changed by
+adding the following to your `config.xml`.
+
+ <feature name="debug-server" required="true">
+ <param name="domain" value="http://debug.custom.com"/>
+ <param name="key" value="some_unique_key"/>
+ </feature>
+
+Don't forget to change the domain and key to the appropriate values.
+
+ #### API Features
+
+Currently supported through this interface are the following feature names:
+
+* `http://api.phonegap.com/1.0/battery`
+
+ * maps to `android:BROADCAST_STICKY` permission
+
+* `http://api.phonegap.com/1.0/camera`
+
+ * maps to `android:CAMERA`, `winphone:ID_CAP_ISV_CAMERA`, and
+ `winphone:ID_HW_FRONTCAMERA` permissions
+
+* `http://api.phonegap.com/1.0/contacts`
+
+ * maps to `android:READ_CONTACTS`, `android:WRITE_CONTACTS`,
+ `android:GET_ACCOUNTS`, and `winphone:ID_CAP_CONTACTS` permissions
+
+* `http://api.phonegap.com/1.0/file`
+
+ * maps to `WRITE_EXTERNAL_STORAGE` permission
+
+* `http://api.phonegap.com/1.0/geolocation`
+
+ * maps to `android:ACCESS_COARSE_LOCATION`,
+ `android:ACCESS_FINE_LOCATION`,
+ `android:ACCESS_LOCATION_EXTRA_COMMANDS`, and
+ `winphone:ID_CAP_LOCATION` permissions
+
+* `http://api.phonegap.com/1.0/media`
+
+ * maps to `android:RECORD_AUDIO`, `android:RECORD_VIDEO`,
+ `android:MODIFY_AUDIO_SETTINGS`, and `winphone:ID_CAP_MICROPHONE`
+ permissions
+
+* `http://api.phonegap.com/1.0/network`
+
+ * maps to `android:ACCESS_NETWORK_STATE`, and
+ `winphone:ID_CAP_NETWORKING` permissions
+
+* `http://api.phonegap.com/1.0/notification`
+
+ * maps to `VIBRATE` permission
+
+* `http://api.phonegap.com/1.0/device`
+
+ * maps to `winphone:ID_CAP_IDENTITY_DEVICE` permission
+
+ #### Usage
+
+ <!-- If you do not want any permissions to be added to your app, add the
+ following tag to your config.xml; you will still have the INTERNET
+ permission on your app, which PhoneGap requires. -->
+ <preference name="permissions" value="none"/>
+
+ <!-- to enable individual permissions use the following examples -->
+ <feature name="http://api.phonegap.com/1.0/battery"/>
+ <feature name="http://api.phonegap.com/1.0/camera"/>
+ <feature name="http://api.phonegap.com/1.0/contacts"/>
+ <feature name="http://api.phonegap.com/1.0/file"/>
+ <feature name="http://api.phonegap.com/1.0/geolocation"/>
+ <feature name="http://api.phonegap.com/1.0/media"/>
+ <feature name="http://api.phonegap.com/1.0/network"/>
+ <feature name="http://api.phonegap.com/1.0/notification"/>
+
+ ### Plugins
+
+* `<gap:plugin>`: specifies a PhoneGap plugin for PhoneGap Build to
+ include in your generated apps.
+
+At present, to include a plugin, you will to ensure:
+
+* the plugin is supported by PhoneGap Build; and
+
+* any JavaScript script tags are present in your `index.html` file.
+
+More details, including a list of available plugins, are in our
+[plugins documentation](/docs/plugins).
+
+-->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0820ebcf/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
index 438ae03..9de9110 100644
--- a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
@@ -103,7 +103,6 @@ The `LocalFileSystem` object methods are defined on the `window` object.
</body>
</html>
-
# requestFileSystem
> Request a file system in which to store application data.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0820ebcf/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 9b42ee0..1d67c7c 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -63,3 +63,62 @@ breaking existing apps. The available preferences are:
Android supports using `<feature>` as analogues to `<plugin>` elements.
+<!--
+
+ ### Android Specific
+
+ #### Minimum and Maximum SDK Version
+
+* `android-minSdkVersion` and/or `android-maxSdkVersion`, with integer
+ values
+
+ * minSdkVersion example: `<preference name="android-minSdkVersion" value="10" />`
+
+ * maxSdkVersion example: `<preference name="android-maxSdkVersion" value="15" />`
+
+ * corresponds to the `usesSdk` attributes in the
+ `AndroidManifest.xml` file - more details are in [the Android
+ documentation](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html)
+
+ * minSdkVersion defaults to 7 (Android 2.1); maxSdkVersion is unset
+ by default
+
+ #### Install Location
+
+* `android-installLocation` with values `internalOnly`, `auto` or `preferExternal`
+
+ * example: `<preference name="android-installLocation" value="auto"
+ />`
+
+ * where an app can be installed - defaults to `internalOnly` (as the
+ Android SDK)
+
+ * `auto` or `preferExternal` allow the app to be installed on an SD
+ card - this can lead to unexpected behavior
+
+ * more details available in [the Android
+ documentation](http://developer.android.com/guide/appendix/install-location.html)
+
+ #### Splash Screen Duration
+
+ * `splash-screen-duration` with a value in milliseconds
+
+ * defaults to 5000 (5 seconds)
+
+ * example: `<preference name="splash-screen-duration" value="10000"
+ />`
+
+ * for auto-hide behaviour call `navigator.splashscreen.hide();` in
+ the device-ready method
+
+ * 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/0820ebcf/docs/en/edge/guide/platforms/blackberry/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry/config.md b/docs/en/edge/guide/platforms/blackberry/config.md
index 399b553..a07195e 100644
--- a/docs/en/edge/guide/platforms/blackberry/config.md
+++ b/docs/en/edge/guide/platforms/blackberry/config.md
@@ -24,3 +24,20 @@ BlackBerry fully supports the
as well as proprietary RIM extensions. Please see the full
[BlackBerry WebWorks documentation regarding config.xml](https://developer.blackberry.com/html5/documentation/working_with_config_xml_file_1866970_11.html)
for details.
+
+<!--
+
+ #### Disable Cursor
+
+* `disable-cursor` with values `true` or `false`
+
+ * example: `<preference name="disable-cursor" value="true" />`
+
+ * prevents a mouse-icon/cursor from being displayed on the app -
+ desugars to `<rim:navigation />`. See [the BlackBerry
+ documentation](https://bdsc.webapps.blackberry.com/html5/documentation/ww_developing/rim_navigation_element_1582456_11.html)
+ for more details
+
+ * default is _false_
+
+-->
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0820ebcf/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 d3f6e38..cfc5459 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -21,8 +21,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
The `config.xml` settings file controls various Cordova settings.
This is application wide, and not set per CDVViewController instance.
-The `config.xml` file is located in your `<project folder>/<appname>`
-directory.
+The `config.xml` file is located within the `<project
+folder>/<appname>` directory.
## `<preference>`
@@ -91,3 +91,116 @@ existing apps. The available preferences are:
applies to apps that position their elements relative to the bottom
of the WebView. This is the default behaviour on Android, and makes
a lot of sense when building apps as opposed to webpages.
+
+<!--
+
+ #### 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
+
+ #### WebView Bounce
+
+* `webviewbounce` with values `true` or `false`
+
+ * 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_
+
+ #### 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_
+
+ #### 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_
+
+ #### 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
+
+ #### 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
+
+ #### 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_
+
+ #### 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_
+
+ #### 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_
+
+-->
\ No newline at end of file
[07/17] docs commit: rewrite global icon config content
Posted by mw...@apache.org.
rewrite global icon config content
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/ac90b226
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/ac90b226
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/ac90b226
Branch: refs/heads/master
Commit: ac90b22612ca42916b22c3cfecf43b2cf08b0740
Parents: 5c7fc60
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 18:40:24 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
docs/en/edge/config_ref/index.md | 31 +++++++++++++++-----
docs/en/edge/guide/platforms/android/config.md | 2 +-
.../edge/guide/platforms/blackberry10/config.md | 4 +--
docs/en/edge/guide/platforms/ios/config.md | 2 +-
4 files changed, 27 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/ac90b226/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 bba41db..b410467 100644
--- a/docs/en/edge/config_ref/index.md
+++ b/docs/en/edge/config_ref/index.md
@@ -154,11 +154,32 @@ Here is how the element appears for iOS projects:
<param name="ios-package" value="CDVDevice" />
</feature>
-See the API Reference for details on how to access each feature. See
-the Plugin Development Guide for more information about plugins.
+See the API Reference for details on how to specify each feature. See
+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:
+
+ <icon src="app.png" />
+
+To define platform-specific icons, consult each platform's
+configuration options:
+
+- 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
@@ -176,12 +197,6 @@ the Plugin Development Guide for more information about plugins.
#### Usage and Additional Information:
-Unless otherwise specified in a config.xml, each platform will try to
-use the default `icon.png` during compilation. To define platform
-specific icons please use the guide provided below.
-
-Icon files should be the file formats specified in the examples below,
-other file types are not guaranteed to work across platforms.
#### Default
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/ac90b226/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 ebf96bf..e9d06ec 100644
--- a/docs/en/edge/guide/platforms/android/config.md
+++ b/docs/en/edge/guide/platforms/android/config.md
@@ -22,7 +22,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
The `config.xml` file controls an app's basic settings that apply
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.
+config.xml File for information on global configuration options.
## Icons and Splash Screens
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/ac90b226/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 5bb4d87..e9855de 100644
--- a/docs/en/edge/guide/platforms/blackberry10/config.md
+++ b/docs/en/edge/guide/platforms/blackberry10/config.md
@@ -17,12 +17,12 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-# BlackBerry 10 Configuration
+# BlackBerry Configuration
The `config.xml` file controls an app's basic settings that apply
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.
+config.xml File for information on global configuration options.
## Icons and Splash Screens
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/ac90b226/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 259447e..7b4dd49 100644
--- a/docs/en/edge/guide/platforms/ios/config.md
+++ b/docs/en/edge/guide/platforms/ios/config.md
@@ -22,7 +22,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
The `config.xml` file controls an app's basic settings that apply
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.
+File for information on global configuration options.
## Icons and Splash Screens
[09/17] docs commit: unrelated: removed empty stub for firefoxOS
config
Posted by mw...@apache.org.
unrelated: removed empty stub for firefoxOS 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/02fd21e6
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/02fd21e6
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/02fd21e6
Branch: refs/heads/master
Commit: 02fd21e6114bfe296420c2b2da2b6fd9e6c2793b
Parents: abd999e
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 18:43:17 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
.../en/edge/guide/platforms/firefoxos/config.md | 23 --------------------
1 file changed, 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/02fd21e6/docs/en/edge/guide/platforms/firefoxos/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/firefoxos/config.md b/docs/en/edge/guide/platforms/firefoxos/config.md
deleted file mode 100644
index 8d2e96c..0000000
--- a/docs/en/edge/guide/platforms/firefoxos/config.md
+++ /dev/null
@@ -1,23 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
--->
-
-# FirefoxOS Configuration
-
[10/17] docs commit: Using BB10 config page,
vanilla BB config is minimal
Posted by mw...@apache.org.
Using BB10 config page, vanilla BB config is minimal
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/abd999e9
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/abd999e9
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/abd999e9
Branch: refs/heads/master
Commit: abd999e9c9fa5db8936d610b732367d84aff7355
Parents: ac90b22
Author: Mike Sierra <ms...@adobe.com>
Authored: Thu Sep 12 18:41:23 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Fri Sep 13 11:10:31 2013 -0700
----------------------------------------------------------------------
.../edge/guide/platforms/blackberry/config.md | 27 --------------------
1 file changed, 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/abd999e9/docs/en/edge/guide/platforms/blackberry/config.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry/config.md b/docs/en/edge/guide/platforms/blackberry/config.md
deleted file mode 100644
index 4e212f6..0000000
--- a/docs/en/edge/guide/platforms/blackberry/config.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# BlackBerry Configuration
-
-BlackBerry fully supports the
-[W3C Widget Specification](http://www.w3.org/TR/widgets/)
-as well as proprietary RIM extensions. Please see the full
-[BlackBerry WebWorks documentation regarding config.xml](https://developer.blackberry.com/html5/documentation/working_with_config_xml_file_1866970_11.html)
-for details.
-