Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id AF49F1010B for ; Tue, 9 Apr 2013 22:36:27 +0000 (UTC) Received: (qmail 55379 invoked by uid 500); 9 Apr 2013 22:36:27 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 55313 invoked by uid 500); 9 Apr 2013 22:36:27 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 55198 invoked by uid 99); 9 Apr 2013 22:36:27 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 09 Apr 2013 22:36:27 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 09 Apr 2013 22:36:21 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 911CF2388CA7; Tue, 9 Apr 2013 22:34:43 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r1466271 [37/41] - in /cordova/site: bin/ public/ public/docs/en/2.6.0/ public/docs/en/2.6.0/img/ public/docs/en/2.6.0/img/guide/ public/docs/en/2.6.0/img/guide/getting-started/ public/docs/en/2.6.0/img/guide/getting-started/android/ public... Date: Tue, 09 Apr 2013 22:34:33 -0000 To: commits@cordova.apache.org From: steven@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20130409223443.911CF2388CA7@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_bada_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_bada_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_bada_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_bada_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,145 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for Bada

+ +
+ + + + + + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_blackberry_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_blackberry_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_blackberry_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_blackberry_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,147 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for BlackBerry

+ +
+ + + +
+
+ + +

Project Settings for BlackBerry

+ +

BlackBerry has full support for the W3C Widget Specfication as well as proprietary RIM extensions. Please see the full BlackBerry WebWorks documentation regarding config.xml for details.

+ +
+
+ + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_firefoxos_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_firefoxos_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_firefoxos_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_firefoxos_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,145 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for FirefoxOS

+ +
+ + + + + + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,192 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings

+ +
+ + + +
+
+

Project Settings

+ +

You can set various application configuration parameters using a platform-agnostic configuration file, config.xml. +This file is based on the W3C Packaged Web Apps (Widgets) specification.

+ +

The location of the config.xml file is different depending on the platform. The contents, in general, are not.

+ +

+Platform-Specific Properties +

+ +

As with any abstraction layer, Apache Cordova cannot be a perfect silver bullet. As such, some native and platform-specific +properties, characteristics and behaviours are encapsulated as much as possible as <preference> elements inside the +config.xml file. The following sub-sections linked to are guides which go into more details about these preferences.

+ + +

+config.xml Elements +

+ +

The Apache Cordova 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, to understand the type of application metadata the +Apache Cordova project aims to abstract and provide simple entry points for.

+ +

An example:

+ +
    <widget>
+        <preference name="MySetting" value="true" />
+        <plugins>
+            <plugin name="MyPlugin" value="MyPluginClass" />
+        </plugins>
+        <access origin="*" />
+    </widget>
+
+ +

A list of supported elements across major platforms which are supported in Apache Cordova follow.

+ +

<plugin>

+ +

These elements map to native APIs that the application will be able to access. At runtime, the Apache Cordova framework checks +the <plugin> elements and maps them to native code to enable your Cordova application to access device APIs otherwise +unavailable to typical web-based applications.

+ +

<access>

+ +

These elements define how your whitelist works. Please see the Domain Whitelist Guide for more information.

+ +

<content>

+ +

This element defines the start page of your application, relative to the project's standard web assets root folder. The default is "index.html".

+ +
+
+ + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_ios_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_ios_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_ios_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_ios_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,172 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for iOS

+ +
+ + + +
+
+ + +

Project Settings for iOS

+ +

The config.xml settings file controls various settings of Cordova. This is application wide, and not set per CDVViewController instance. +The config.xml file is located in your <project folder>/<appname> directory.

+ +

+<preference> +

+ +

Various preferences (as <preference> tags) default on not breaking existing apps. The available preferences are:

+ +
    +

  1. DisallowOverscroll (boolean, defaults to false) - set to true if you don't want the WebView to rubber-band

    2. +

  2. TopActivityIndicator (string, defaults to 'gray') - this is the top spinning throbber in the status/battery bar, valid values are "whiteLarge", "white" and "gray"

    3. +

  3. 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.

    4. +

  4. EnableViewportScale (boolean, defaults to false) - set to true to prevent viewport scaling through a meta tag

    5. +

  5. AutoHideSplashScreen (boolean, defaults to true) - set to false to control when the splashscreen is hidden through a JavaScript API

    6. +

  6. FadeSplashScreen (boolean, defaults to true) - set to false to prevent the splash-screen to fade in and out when showing/hiding it.

    7. +

  7. FadeSplashScreenDuration (float, defaults to 2) - The splash-screen Fade duration in seconds.

    8. +

  8. ShowSplashScreenSpinner (boolean, defaults to true) - set to false to hide the splash-screen spinner

    9. +

  9. MediaPlaybackRequiresUserAction (boolean, defaults to false) - set to true to not allow autoplayed HTML5 video

    10. +

  10. 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

    11. +

  11. 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.

    12. +

  12. KeyboardDisplayRequiresUserAction (boolean, defaults to true) - set to false to open the keyboard when form elements get focus via the JavaScript focus() call.

    13. +

  13. SuppressesIncrementalRendering (boolean, defaults to false) - set to true to wait until all new view content has been received before it is rendered.

    14. +

  14. HideKeyboardFormAccessoryBar (boolean, defaults to false) - set to true to hide the additional toolbar that is on top of the keyboard (this is the toolbar that has the Prev, Next and Done buttons)

    15. +

  15. 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 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.

    16. +
+
+
+ + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_webos_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_webos_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_webos_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_webos_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,147 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for webOS

+ +
+ + + +
+
+ + +

Project Settings for webOS

+ +

WebOS does not currently have any additional configurable features.

+ +
+
+ + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_windows8_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_windows8_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_windows8_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_windows8_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,147 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for Windows 8

+ +
+ + + +
+
+ + +

Project Settings for Windows 8

+ +

Windows 8 does not currently support this feature.

+ +
+
+ + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp7_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp7_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp7_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp7_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,147 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for Windows Phone 7

+ +
+ + + +
+
+ + +

Project Settings for Windows Phone 7

+ +

Windows Phone 7 does not currently have any additional configurable features.

+ +
+
+ + + + + Added: cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp8_index.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp8_index.md.html?rev=1466271&view=auto ============================================================================== --- cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp8_index.md.html (added) +++ cordova/site/public/docs/en/2.6.0rc1/guide_project-settings_wp8_index.md.html Tue Apr 9 22:34:28 2013 @@ -0,0 +1,147 @@ + + + + + + +Apache Cordova API Documentation + + + + + + +
+

Project Settings for Windows Phone 8

+ +
+ + + +
+
+ + +

Project Settings for Windows Phone 8

+ +

Windows Phone 8 does not currently have any additional configurable features.

+ +
+
+ + + + +