Updated Branches: refs/heads/master 99fabcce9 -> c8818ec67
Fixes CB-1515 add Project Settings Added Project Settings category in Guides and adding iOS info Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/c8818ec6 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/c8818ec6 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/c8818ec6 Branch: refs/heads/master Commit: c8818ec67e9c1cde85b5519da4741b834a5b6bcf Parents: 99fabcc Author: Becky Gibson <becka...@apache.org> Authored: Tue Oct 9 16:01:50 2012 -0400 Committer: Becky Gibson <becka...@apache.org> Committed: Tue Oct 9 17:37:32 2012 -0400 ---------------------------------------------------------------------- docs/en/edge/guide/project-settings/index.md | 23 +++++++ docs/en/edge/guide/project-settings/ios/index.md | 53 +++++++++++++++++ docs/en/edge/index.md | 4 + 3 files changed, 80 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/c8818ec6/docs/en/edge/guide/project-settings/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/project-settings/index.md b/docs/en/edge/guide/project-settings/index.md new file mode 100644 index 0000000..a6e6a9b --- /dev/null +++ b/docs/en/edge/guide/project-settings/index.md @@ -0,0 +1,23 @@ +--- +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. +--- + +Project Settings +================ + +- Project Settings for iOS http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/c8818ec6/docs/en/edge/guide/project-settings/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/project-settings/ios/index.md b/docs/en/edge/guide/project-settings/ios/index.md new file mode 100644 index 0000000..210fada --- /dev/null +++ b/docs/en/edge/guide/project-settings/ios/index.md @@ -0,0 +1,53 @@ +<!-- +# +# 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. +# +--> + +Project Settings for iOS +======================== + +The **Cordova.plist settings file** controls various settings of Cordova. This is application wide, and not set per CDVViewController instance. + +1. A list of **Plugins** allowed to be used in a CDVViewController (set in the Plugins dictionary - key is the servicename used in JavaScript, and the value is the Objective-C class for the plugin that is a CDVPlugin sub-class) +2. A **white-list** of hosts (with no scheme nor path, hostnames or IP addresses only) that Cordova is allowed to connect to (set in the ExternalHosts array - wildcards allowed) +3. Various **other** settings (defaults err on not breaking existing apps) + + a. **UIWebViewBounce (boolean, defaults to YES)** - set to NO if you don't want the WebView to rubber-band + + b. **TopActivityIndicator (string, defaults to 'gray')** - this is the top spinning throbber in the status/battery bar, valid values are "whiteLarge", "white" and "gray" + + c. **EnableLocation (boolean, defaults to NO)** - set to YES, to initialize the Geolocation plugin at start-up (so the fix on your location can be more accurate) + + d. **EnableViewportScale (boolean, defaults to NO)** - set to YES to prevent viewport scaling through a meta tag + + e. **AutoHideSplashScreen (boolean, defaults to YES)** - set to NO to control when the splashscreen is hidden through a JavaScript API + + f. **ShowSplashScreenSpinner (boolean, defaults to YES)** - set to NO to hide the splash-screen spinner + + g. **MediaPlaybackRequiresUserAction (boolean, defaults to NO)** - set to YES to not allow autoplayed HTML5 video + + h. **AllowInlineMediaPlayback (boolean, defaults to NO)** - set to YES to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute + + i. **OpenAllWhitelistURLsInWebView (boolean, defaults to NO)** - set to YES to open all white-listed URLs in the main WebView + + j. **BackupWebStorage (boolean, defaults to YES)** - set to NO to prevent the backup of localStorage and WebSQL databases to the Documents/Backups folder. This was a fix for this [Apple bug](http://phonegap.com/2012/04/18/ios-5-1-and-the-embedded-uiwebview-with-cordova/) + + k. **KeyboardDisplayRequiresUserAction (boolean, defaults to YES)** - set to NO to open keyboard when form elements get focus via JavaScript focus() call. + + l. **SuppressesIncrementalRendering (boolean, defaults to NO)** - set to YES to wait until all new view content has been received before it is rendered. http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/c8818ec6/docs/en/edge/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/index.md b/docs/en/edge/index.md index 270b0b6..460c211 100644 --- a/docs/en/edge/index.md +++ b/docs/en/edge/index.md @@ -92,6 +92,10 @@ license: Licensed to the Apache Software Foundation (ASF) under one <span>Upgrade an application to the latest Cordova release.</span> </li> <li> + <h2>Project Settings</h2> + <span>Customize the features of your app.</span> + </li> + <li> <h2>Plugin Development Guide</h2> <span>Develop your first Cordova plugin.</span> </li>
