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:58 UTC
[14/17] docs commit: gather queries
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