cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Michael Sierra <>
Subject config.xml doc queries
Date Fri, 13 Sep 2013 15:23:01 GMT
I'm doing a bunch of cleanup work on the doc about config.xml
preferences, and have accumulated a faceful of queries I could use
some help with. I'm also folding in some parallel PhoneGap Build doc
where appropriate, but suspect some of it may be out of date. At least
one preference applies only to remote PhoneGap builds, and not to
Cordova.  You could save me a lot of time testing & untangling all
this. I separated them out for those with special expertise with
iOS/Android/BB platforms. Any other undoc'ed prefs, please let me
know. Thanks in advance.


* Some of the doc is unclear. Please confirm that placing an icon.png
  in the app dir, but without referencing it via <icon> tag, enables
  it & overrides the default cordova icon.

* Does the splash.png file behave the same way: apply by default, even
  when not referenced via <gap:splash> tag?


* For HideKeyboardFormAccessoryBar, does the default form-helper UI
  only appear when there's more than one input within a form?

* Please confirm the phonegap-version preference applies only to
  PhoneGap Build.

* AFAYK, do any platforms _not_ support the viewport metatag?  Do any
  not allow user scaling by default?


* Please confirm EnableViewportScale allows a viewport metatag to
  control the range of user scaling. That is, with
  EnableViewportScale=true, a viewport metatag may actually
  _disable_ user scaling.

* Based on the above, is it safe to assert the default behavior for a
  cordova web view in iOS allows user scaling absent a metatag that
  disables it?

* Is the deprecated EnableLocation pref still functional?

* As an alternative to the deprecated EnableLocation pref, current doc
  suggests calling the Geolocation plugin with the "onload" attribute.
  Is this method of passing options only possible via config.xml's
  <feature> tag, as opposed to using the CLI's "plugin add"?

* Unfamiliar with the KeyboardShrinksView effect. Are there any
  obvious examples of an app whose webview shrinks as described when
  the keyboard appears?

* Also not sure what "spinner" UI effect ShowSplashScreenSpinner
  produces.  Any obvious examples?

* The PhoneGap Build doc references "show-splash-screen-spinner" and
  "auto-hide-splash-screen" preferences. Please confirm they're
  superseded by ShowSplashScreenSpinner and AutoHideSplashScreen.

* Does MediaPlaybackRequiresUserAction also apply to audio, or just
  video? Either way, please confirm the scope is media's autoplay attribute,
  and that JS can initiate playback with no user input.

* The following preferences are listed in PhoneGap Build doc
  (, but not in Cordova doc
  for iOS config options. Please confirm if these work, and/or have
  been renamed as CamelCase:

  - target-device (handset|tablet|universal)
  - webviewbounce
  - prerendered-icon
  - ios-statusbarstyle (default|black-opaque|black-translucent)
  - detect-data-types
  - exit-on-suspend

* Is the deprecated stay-in-webview (or StayInWebview) still enabled?


* PhoneGap Build doc lists a splash-screen-duration preference. Does
  it apply to Cordova, and is it renamed SplashScreenDuration?

* is the useBrowserHistory preference deprecated, as promised would
  happen in 4/13? The doc explaining what it does is opaque, and I'm
  inclined to remove it. Otherwise clarify, thanks.

* Unclear when loadingDialog & loadingPageDialog would appear in an
  app. Any obvious examples? I'm adding an example that reads: "Please
  wait, the app is loading" (or "data is loading")

* Does the errorUrl page display in response to standard HTTP errors
  in the 400-500 range?

* Please confirm the load-url-timeout pref listed in PhoneGap Build
  doc is superseded by loadUrlTimeoutValue. Also confirm the latter is
  also expressed in milliseconds and defaults to 20000.

* does keepRunning mean in effect the app continues to execute
  e.g. following the pause event? Does the pause event still fire?

* Am unfamiliar with the disallowOverscroll "glow" effect. Are there
  any obvious examples?

* Do android-minSdkVersion & android-maxSdkVersion apply to Cordova
  rather than just PhoneGap Build? Does it work? Is it ReNamed?

* Same for android-installLocation.


* BlackBerry config doc lists its own "orientation" preferance that
  varies from the global preference. Does BB not recognize "default"
  as a value? Do no other platforms recognize "auto" as BB appears to?

* Doc for Android's backgroundColor uses black as a sample value:
  "0x00000000". Does BB adhere to the same ARGB format, or it is

* PG Build doc lists a disable-cursor preference. Does it work in
  Cordova, and it renamed DisableCursor?

* For popupBlocker, I assume it would disable calls to &
  the onunload event in an inAppBrowser context. Correct?

* I notice BB's "hideKeyboardFormAccessoryBar" pref starts lowercase
  while iOS's is InitCapped. Please confirm they're case-insensitive.
  If so, will InitCap all to remain consistent.

* Note the HideKeyboardFormAccessoryBar pref is supported by both iOS
  & BB. Likewise for BackgroundColor.  When reading the doc, would you
  prefer sections for platform-specific config options list only
  preferences that are unique to each platform? If so, I'll
  consolidate "multi-platform" prefs in the main config.xml doc along
  with existing "global" prefs. I'm already inclined to consolidate to
  better maintain the doc, but could use feedback. Thanks.

--Mike Sierra
View raw message