You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by omefire <gi...@git.apache.org> on 2016/01/22 22:56:58 UTC
[GitHub] cordova-docs pull request: CB-10389: Turning the config.xml doc pa...
GitHub user omefire opened a pull request:
https://github.com/apache/cordova-docs/pull/463
CB-10389: Turning the config.xml doc page into a reference XML doc
Work In Progress
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/omefire/cordova-docs CB-10389
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-docs/pull/463.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #463
----
commit bfb50837b9f4e0a7d8bd13ba3d3f5fef53213245
Author: Omar Mefire <om...@gmail.com>
Date: 2016-01-21T21:37:27Z
change the wordings of the intro to config.xml
commit 4df802ab15d4a3931cd157fad2646ac912b989c5
Author: Omar Mefire <om...@gmail.com>
Date: 2016-01-22T21:53:08Z
WIP: Switching to using a table to document config.xml elements and attributes
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-178829332
@omefire I noticed you merged this without squashing - please do that in the future it helps with maintaining a meaningful history on git. https://github.com/apache/cordova-coho/blob/master/docs/committer-workflow.md has more details.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51642289
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ src(string) | *Required* <br/> Defines the app'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.
+
+ Examples:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ Attributes(type) | Description
+ ----------------- | ------------
+ origin(string) | *Required* <br/> Defines 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](../guide/appdev/whitelist/index.html) for details.
-## Global Preferences
+ Examples:
-The following global preferences apply to all platforms:
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ name(string) | *Required* <br/> Name of the platform to be restored
+ spec(string) | *Required* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
--- End diff --
*options
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51643532
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ src(string) | *Required* <br/> Defines the app'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.
+
+ Examples:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ Attributes(type) | Description
+ ----------------- | ------------
+ origin(string) | *Required* <br/> Defines 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](../guide/appdev/whitelist/index.html) for details.
-## Global Preferences
+ Examples:
-The following global preferences apply to all platforms:
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ name(string) | *Required* <br/> Name of the platform to be restored
+ spec(string) | *Required* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ AllowInlineMediaPlayback(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ AndroidLaunchMode(string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ AppendUserAgent(string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ AppendUserAgent(string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ BackgroundColor(string) | **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ BackupWebStorage(string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ ChildBrowser(string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ CordovaWebViewEngine(string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ DefaultVolumeStream(string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ DisallowOverscroll(boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ EnableViewportScale(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ ErrorUrl(URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ErrorUrl(string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ FullScreen(boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ GapBetweenPages(float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ HideKeyboardFormAccessoryBar(boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ KeepRunning(boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ KeyboardDisplayRequiresUserAction(boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ LoadUrlTimeoutValue(number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
+ LoadingDialog(string) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.
+ LogLevel(string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level through which log messages from your application will be filtered.
+ MediaPlaybackAllowsAirPlay(boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.
+ MediaPlaybackRequiresUserAction(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.
+ Min/Max UAP(Regex) | Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> **Platforms supported: Windows** <br/> Sets the min/max UAP versions for Windows. If nothing is specified, Windows.Universal at version 10.0.10240.0 will be used.
+ Orientation(string) | *Default: default* <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> **NOTE:** The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.
+ OverrideUserAgent(string) | **Platforms supported: Android** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ OverrideUserAgent(string) | **Platforms supported: iOS** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
--- End diff --
Repeated.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51300878
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
+ </widget>
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ <widget version="0.0.1">
+ </widget>
-Below is an example that explicitly sets these properties:
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ <widget xmlns="http://www.w3.org/ns/widgets">
+ </widget>
-## Global Preferences
-The following global preferences apply to all platforms:
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ Example:
- <preference name="Fullscreen" value="true" />
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-## Multi-Platform Preferences
+ Example:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-The following preferences apply to more than one platform, but not to
-all of them:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ email (string) | *Required: true <br/>* Email of the author.
+ href (string) | *Required: true <br/>* Website of the author.
-- `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
- if you don't want the interface to display any feedback when users
- scroll past the beginning or end of content.
+ Examples:
- <preference name="DisallowOverscroll" value="true"/>
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- Applies to Android and iOS. On iOS, overscroll gestures cause
- content to bounce back to its original position. On Android, they
- produce a more subtle glowing effect along the top or bottom edge of
- the content.
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ src (string) | *Required: true <br/>* Defines the app'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.
+
+ Example:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-- `BackgroundColor`: Set the app's background color. Supports a
- four-byte hex value, with the first byte representing the alpha
- channel, and standard RGB values for the following three bytes. This
- example specifies blue:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- <preference name="BackgroundColor" value="0xff0000ff"/>
+ Attributes (type) | Description
+ ----------------- | ------------
+ origin (string) | *Required: true <br/>* Defines 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](../guide/appdev/whitelist/index.html) for details.
- Applies to Android and BlackBerry. Overrides CSS otherwise available
- across _all_ platforms, for example: `body{background-color:blue}`.
+ Examples:
-- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
- to `true` to hide the additional toolbar that appears above the
- keyboard, helping users navigate from one form input to another.
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> Name of the platform to be restored
+ spec (string) | *Required: true* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ DisallowOverscroll (boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ FullScreen (boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ BackgroundColor (string) | *Required: false* <br/> **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ HideKeyboardFormAccessoryBar (boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ Orientation (string) | *Default: default* <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> **NOTE:** The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.
+ EnableViewportScale (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ MediaPlaybackAllowsAirPlay (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.
+ MediaPlaybackRequiresUserAction (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.
+ AllowInlineMediaPlayback (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ BackupWebStorage (string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ TopActivityIndicator (string) | *Default: gray* <br/> Allowed values: whiteLarge, white, gray. <br/> **Platforms supported: iOS** <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.
+ KeyboardDisplayRequiresUserAction (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ SuppressesIncrementalRendering (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to wait until all content has been received before it renders to the screen.
+ GapBetweenPages (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ PageLength (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.
+ PaginationBreakingMode (string) | *Default: page* <br/> Allowed values: page, column <br/> **Platforms supported: iOS** <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.
+ PaginationMode (string) | *Default: unpaginated* <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> **Platforms supported: iOS** <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.
+ UIWebViewDecelerationSpeed (string) | *Default: normal* <br/> Allowed values: normal, fast <br/> **Platforms supported: iOS** <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.
+ ErrorUrl (string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ OverrideUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ target-device (string) | *Default: universal* <br/> Allowed values: handset, tablet, universal <br/> **Platforms supported: iOS** <br/> This property maps directly to TARGETED_DEVICE_FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.
+ deployment-target (string) | **Platforms supported: iOS** <br/> This sets the IPHONEOS_DEPLOYMENT_TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings
+ CordovaWebViewEngine (string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ SuppressesLongPressGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.
+ Suppresses3DTouchGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.
+ KeepRunning (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ LoadUrlTimeoutValue (number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
+ SplashScreen (string) | *Default: splash* <br/> **Platforms supported: Android** <br/> The name of the file minus its extension in the res/drawable directory. Various assets must share this common name in various subdirectories.
+ SplashScreenDelay (number in milliseconds) | *Default: 3000, 3 seconds* <br/> **Platforms supported: Android** <br/> The amount of time the splash screen image displays.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ LoadingDialog (string) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.
+ ErrorUrl (URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ShowTitle (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Show the title at the top of the screen.
+ LogLevel (string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level through which log messages from your application will be filtered.
+ SetFullscreen (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.
+ AndroidLaunchMode (string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ DefaultVolumeStream (string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ OverrideUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ ChildBrowser (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ PopupBlocker (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.
+ WebSecurity (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.
+ windows-phone-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows Phone for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to the same version as ```windows-target-version``` (if found).
+ windows-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to '8.1'.
+ Min/Max UAP (Regex) | Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> **Platforms supported: Windows** <br/> Sets the min/max UAP versions for Windows. If nothing is specified, Windows.Universal at version 10.0.10240.0 will be used.
+
+ Examples:
+
+ <preference name="DisallowOverscroll" value="true"/>
+ <preference name="Fullscreen" value="true" />
+ <preference name="BackgroundColor" value="0xff0000ff"/>
+ <preference name="HideKeyboardFormAccessoryBar" value="true"/>
+ <preference name="Orientation" value="landscape" />
+
+ <!-- iOS only preferences -->
+ <preference name="EnableViewportScale" value="true"/>
+ <preference name="MediaPlaybackAllowsAirPlay" value="false"/>
+ <preference name="MediaPlaybackRequiresUserAction" value="true"/>
+ <preference name="AllowInlineMediaPlayback" value="true"/>
+ <preference name="BackupWebStorage" value="local"/>
+ <preference name="TopActivityIndicator" value="white"/>
+ <preference name="SuppressesIncrementalRendering" value="true"/>
+ <preference name="GapBetweenPages" value="0"/>
+ <preference name="PageLength" value="0"/>
+ <preference name="PaginationBreakingMode" value="page"/>
+ <preference name="PaginationMode" value="unpaginated"/>
+ <preference name="UIWebViewDecelerationSpeed" value="fast" />
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+ <preference name="target-device" value="universal" />
+ <preference name="deployment-target" value="7.0" />
+ <preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
+ <preference name="SuppressesLongPressGesture" value="true" />
+ <preference name="Suppresses3DTouchGesture" value="true" />
+
+ <!-- Android only preferences -->
+ <preference name="KeepRunning" value="false"/>
+ <preference name="LoadUrlTimeoutValue" value="10000"/>
+ <preference name="SplashScreen" value="mySplash"/>
+ <preference name="InAppBrowserStorageEnabled" value="true"/>
+ <preference name="LoadingDialog" value="My Title,My Message"/>
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="ShowTitle" value="true"/>
+ <preference name="LogLevel" value="VERBOSE"/>
+ <preference name="AndroidLaunchMode" value="singleTop"/>
+ <preference name="DefaultVolumeStream" value="call" />
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+
+ <!-- Windows only preferences -->
+ <preference name="windows-phone-target-version" value="8.1" />
+ <preference name="windows-target-version" value="8.1" />
+ <preference name="Windows.Universal" value="10.0.10240.0" />
+
+ <!-- BlackBerry only preferences -->
+ <preference name="ChildBrowser" value="disable"/>
+ <preference name="PopupBlocker" value="enable"/>
+ <preference name="WebSecurity" value="disable"/>
+
+## feature
--- End diff --
So this tag is only used by plugin authors, right? They insert it into the platform-level `config.xml` using `plugin.xml`'s `<config-file />` tag. Do Cordova app developers ever have to manually add this to a config.xml file? If not, we should make that very clear; this paragraph is a little confusing.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51298135
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
--- End diff --
'N'amespace.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51065837
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
+ </widget>
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ <widget version="0.0.1">
+ </widget>
-Below is an example that explicitly sets these properties:
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ <widget xmlns="http://www.w3.org/ns/widgets">
+ </widget>
-## Global Preferences
-The following global preferences apply to all platforms:
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ Example:
- <preference name="Fullscreen" value="true" />
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-## Multi-Platform Preferences
+ Example:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-The following preferences apply to more than one platform, but not to
-all of them:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes (type) | Description
--- End diff --
For consistency, and according to the style guide, there's no space between "Attributes" and "(type)".
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51638568
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
--- End diff --
We should probably remove this since we are not specifying these for other optional elements.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-175904149
General comment: should we change this file (and the styleguide) to just use "_Required_" instead of "_Required: true_"? Same for using "**Platforms**" instead of "**Platforms supported**"?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning the config.xml doc pa...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-175868952
llk
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51631675
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
--- End diff --
+1, done !
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51648833
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
--- End diff --
That's not an integer.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51643217
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ src(string) | *Required* <br/> Defines the app'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.
+
+ Examples:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ Attributes(type) | Description
+ ----------------- | ------------
+ origin(string) | *Required* <br/> Defines 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](../guide/appdev/whitelist/index.html) for details.
-## Global Preferences
+ Examples:
-The following global preferences apply to all platforms:
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ name(string) | *Required* <br/> Name of the platform to be restored
+ spec(string) | *Required* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ AllowInlineMediaPlayback(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ AndroidLaunchMode(string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ AppendUserAgent(string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ AppendUserAgent(string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ BackgroundColor(string) | **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ BackupWebStorage(string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ ChildBrowser(string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ CordovaWebViewEngine(string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ DefaultVolumeStream(string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ DisallowOverscroll(boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ EnableViewportScale(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ ErrorUrl(URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ErrorUrl(string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ FullScreen(boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ GapBetweenPages(float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ HideKeyboardFormAccessoryBar(boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ KeepRunning(boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ KeyboardDisplayRequiresUserAction(boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ LoadUrlTimeoutValue(number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
--- End diff --
*When
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51076566
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
--- End diff --
Consider providing 1 example with all the attributes. Since there are a number of required fields - most of these examples are invalid without the correct value.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51298099
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
--- End diff --
'N'amespace.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-178958029
Additional review comments handled and committed.
Thanks !
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51637838
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
--- End diff --
`versionCode` it will be great to link to Android docs here: http://developer.android.com/tools/publishing/versioning.html
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51630990
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
--- End diff --
+1
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-178799405
I'm fine with using "Required" instead of "Required: true", as long as other docs get updated to use this convention.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51637888
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
--- End diff --
Needs to be an integer as far as I understand.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51638042
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
--- End diff --
It will be great to Apple docs here: https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51642241
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ src(string) | *Required* <br/> Defines the app'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.
+
+ Examples:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ Attributes(type) | Description
+ ----------------- | ------------
+ origin(string) | *Required* <br/> Defines 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](../guide/appdev/whitelist/index.html) for details.
-## Global Preferences
+ Examples:
-The following global preferences apply to all platforms:
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
--- End diff --
Add hyperlink to the article?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-175907262
Should the preferences be alphabetized?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51665030
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
+ </widget>
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ <widget version="0.0.1">
+ </widget>
-Below is an example that explicitly sets these properties:
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ <widget xmlns="http://www.w3.org/ns/widgets">
+ </widget>
-## Global Preferences
-The following global preferences apply to all platforms:
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ Example:
- <preference name="Fullscreen" value="true" />
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-## Multi-Platform Preferences
+ Example:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-The following preferences apply to more than one platform, but not to
-all of them:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ email (string) | *Required: true <br/>* Email of the author.
+ href (string) | *Required: true <br/>* Website of the author.
-- `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
- if you don't want the interface to display any feedback when users
- scroll past the beginning or end of content.
+ Examples:
- <preference name="DisallowOverscroll" value="true"/>
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- Applies to Android and iOS. On iOS, overscroll gestures cause
- content to bounce back to its original position. On Android, they
- produce a more subtle glowing effect along the top or bottom edge of
- the content.
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ src (string) | *Required: true <br/>* Defines the app'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.
+
+ Example:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-- `BackgroundColor`: Set the app's background color. Supports a
- four-byte hex value, with the first byte representing the alpha
- channel, and standard RGB values for the following three bytes. This
- example specifies blue:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- <preference name="BackgroundColor" value="0xff0000ff"/>
+ Attributes (type) | Description
+ ----------------- | ------------
+ origin (string) | *Required: true <br/>* Defines 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](../guide/appdev/whitelist/index.html) for details.
- Applies to Android and BlackBerry. Overrides CSS otherwise available
- across _all_ platforms, for example: `body{background-color:blue}`.
+ Examples:
-- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
- to `true` to hide the additional toolbar that appears above the
- keyboard, helping users navigate from one form input to another.
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> Name of the platform to be restored
+ spec (string) | *Required: true* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ DisallowOverscroll (boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ FullScreen (boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ BackgroundColor (string) | *Required: false* <br/> **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ HideKeyboardFormAccessoryBar (boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ Orientation (string) | *Default: default* <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> **NOTE:** The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.
+ EnableViewportScale (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ MediaPlaybackAllowsAirPlay (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.
+ MediaPlaybackRequiresUserAction (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.
+ AllowInlineMediaPlayback (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ BackupWebStorage (string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ TopActivityIndicator (string) | *Default: gray* <br/> Allowed values: whiteLarge, white, gray. <br/> **Platforms supported: iOS** <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.
+ KeyboardDisplayRequiresUserAction (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ SuppressesIncrementalRendering (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to wait until all content has been received before it renders to the screen.
+ GapBetweenPages (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ PageLength (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.
+ PaginationBreakingMode (string) | *Default: page* <br/> Allowed values: page, column <br/> **Platforms supported: iOS** <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.
+ PaginationMode (string) | *Default: unpaginated* <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> **Platforms supported: iOS** <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.
+ UIWebViewDecelerationSpeed (string) | *Default: normal* <br/> Allowed values: normal, fast <br/> **Platforms supported: iOS** <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.
+ ErrorUrl (string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ OverrideUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ target-device (string) | *Default: universal* <br/> Allowed values: handset, tablet, universal <br/> **Platforms supported: iOS** <br/> This property maps directly to TARGETED_DEVICE_FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.
+ deployment-target (string) | **Platforms supported: iOS** <br/> This sets the IPHONEOS_DEPLOYMENT_TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings
+ CordovaWebViewEngine (string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ SuppressesLongPressGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.
+ Suppresses3DTouchGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.
+ KeepRunning (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ LoadUrlTimeoutValue (number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
+ SplashScreen (string) | *Default: splash* <br/> **Platforms supported: Android** <br/> The name of the file minus its extension in the res/drawable directory. Various assets must share this common name in various subdirectories.
+ SplashScreenDelay (number in milliseconds) | *Default: 3000, 3 seconds* <br/> **Platforms supported: Android** <br/> The amount of time the splash screen image displays.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ LoadingDialog (string) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.
+ ErrorUrl (URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ShowTitle (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Show the title at the top of the screen.
+ LogLevel (string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level through which log messages from your application will be filtered.
+ SetFullscreen (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.
+ AndroidLaunchMode (string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ DefaultVolumeStream (string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ OverrideUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ ChildBrowser (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ PopupBlocker (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.
+ WebSecurity (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.
+ windows-phone-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows Phone for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to the same version as ```windows-target-version``` (if found).
+ windows-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to '8.1'.
+ Min/Max UAP (Regex) | Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> **Platforms supported: Windows** <br/> Sets the min/max UAP versions for Windows. If nothing is specified, Windows.Universal at version 10.0.10240.0 will be used.
+
+ Examples:
+
+ <preference name="DisallowOverscroll" value="true"/>
+ <preference name="Fullscreen" value="true" />
+ <preference name="BackgroundColor" value="0xff0000ff"/>
+ <preference name="HideKeyboardFormAccessoryBar" value="true"/>
+ <preference name="Orientation" value="landscape" />
+
+ <!-- iOS only preferences -->
+ <preference name="EnableViewportScale" value="true"/>
+ <preference name="MediaPlaybackAllowsAirPlay" value="false"/>
+ <preference name="MediaPlaybackRequiresUserAction" value="true"/>
+ <preference name="AllowInlineMediaPlayback" value="true"/>
+ <preference name="BackupWebStorage" value="local"/>
+ <preference name="TopActivityIndicator" value="white"/>
+ <preference name="SuppressesIncrementalRendering" value="true"/>
+ <preference name="GapBetweenPages" value="0"/>
+ <preference name="PageLength" value="0"/>
+ <preference name="PaginationBreakingMode" value="page"/>
+ <preference name="PaginationMode" value="unpaginated"/>
+ <preference name="UIWebViewDecelerationSpeed" value="fast" />
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+ <preference name="target-device" value="universal" />
+ <preference name="deployment-target" value="7.0" />
+ <preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
+ <preference name="SuppressesLongPressGesture" value="true" />
+ <preference name="Suppresses3DTouchGesture" value="true" />
+
+ <!-- Android only preferences -->
+ <preference name="KeepRunning" value="false"/>
+ <preference name="LoadUrlTimeoutValue" value="10000"/>
+ <preference name="SplashScreen" value="mySplash"/>
+ <preference name="InAppBrowserStorageEnabled" value="true"/>
+ <preference name="LoadingDialog" value="My Title,My Message"/>
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="ShowTitle" value="true"/>
+ <preference name="LogLevel" value="VERBOSE"/>
+ <preference name="AndroidLaunchMode" value="singleTop"/>
+ <preference name="DefaultVolumeStream" value="call" />
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+
+ <!-- Windows only preferences -->
+ <preference name="windows-phone-target-version" value="8.1" />
+ <preference name="windows-target-version" value="8.1" />
+ <preference name="Windows.Universal" value="10.0.10240.0" />
+
+ <!-- BlackBerry only preferences -->
+ <preference name="ChildBrowser" value="disable"/>
+ <preference name="PopupBlocker" value="enable"/>
+ <preference name="WebSecurity" value="disable"/>
+
+## feature
--- End diff --
Cool, we should still keep the explanation. I don't know if super advanced users actually do this.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-176992408
Yup. +1 to Dmitry's suggestion for using *Required* instead of *Required: true*. Also for platforms we plan of using customized highlight tag provoded by redcarpet. I will update my XML reference PR soon to reflect the changes.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/463#issuecomment-176991484
@rakatyal, do you think it might be better to use _Required_ instead of _Required: true_?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51065460
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
+ </widget>
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ <widget version="0.0.1">
+ </widget>
-Below is an example that explicitly sets these properties:
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ <widget xmlns="http://www.w3.org/ns/widgets">
+ </widget>
-## Global Preferences
-The following global preferences apply to all platforms:
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ Example:
- <preference name="Fullscreen" value="true" />
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-## Multi-Platform Preferences
+ Example:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-The following preferences apply to more than one platform, but not to
-all of them:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ email (string) | *Required: true <br/>* Email of the author.
+ href (string) | *Required: true <br/>* Website of the author.
-- `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
- if you don't want the interface to display any feedback when users
- scroll past the beginning or end of content.
+ Examples:
- <preference name="DisallowOverscroll" value="true"/>
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- Applies to Android and iOS. On iOS, overscroll gestures cause
- content to bounce back to its original position. On Android, they
- produce a more subtle glowing effect along the top or bottom edge of
- the content.
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ src (string) | *Required: true <br/>* Defines the app'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.
+
+ Example:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-- `BackgroundColor`: Set the app's background color. Supports a
- four-byte hex value, with the first byte representing the alpha
- channel, and standard RGB values for the following three bytes. This
- example specifies blue:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- <preference name="BackgroundColor" value="0xff0000ff"/>
+ Attributes (type) | Description
+ ----------------- | ------------
+ origin (string) | *Required: true <br/>* Defines 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](../guide/appdev/whitelist/index.html) for details.
- Applies to Android and BlackBerry. Overrides CSS otherwise available
- across _all_ platforms, for example: `body{background-color:blue}`.
+ Examples:
-- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
- to `true` to hide the additional toolbar that appears above the
- keyboard, helping users navigate from one form input to another.
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> Name of the platform to be restored
+ spec (string) | *Required: true* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ DisallowOverscroll (boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ FullScreen (boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ BackgroundColor (string) | *Required: false* <br/> **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ HideKeyboardFormAccessoryBar (boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ Orientation (string) | *Default: default* <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> **NOTE:** The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.
+ EnableViewportScale (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ MediaPlaybackAllowsAirPlay (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.
+ MediaPlaybackRequiresUserAction (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.
+ AllowInlineMediaPlayback (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ BackupWebStorage (string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ TopActivityIndicator (string) | *Default: gray* <br/> Allowed values: whiteLarge, white, gray. <br/> **Platforms supported: iOS** <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.
+ KeyboardDisplayRequiresUserAction (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ SuppressesIncrementalRendering (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to wait until all content has been received before it renders to the screen.
+ GapBetweenPages (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ PageLength (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.
+ PaginationBreakingMode (string) | *Default: page* <br/> Allowed values: page, column <br/> **Platforms supported: iOS** <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.
+ PaginationMode (string) | *Default: unpaginated* <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> **Platforms supported: iOS** <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.
+ UIWebViewDecelerationSpeed (string) | *Default: normal* <br/> Allowed values: normal, fast <br/> **Platforms supported: iOS** <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.
+ ErrorUrl (string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ OverrideUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ target-device (string) | *Default: universal* <br/> Allowed values: handset, tablet, universal <br/> **Platforms supported: iOS** <br/> This property maps directly to TARGETED_DEVICE_FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.
+ deployment-target (string) | **Platforms supported: iOS** <br/> This sets the IPHONEOS_DEPLOYMENT_TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings
+ CordovaWebViewEngine (string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ SuppressesLongPressGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.
+ Suppresses3DTouchGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.
+ KeepRunning (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ LoadUrlTimeoutValue (number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
+ SplashScreen (string) | *Default: splash* <br/> **Platforms supported: Android** <br/> The name of the file minus its extension in the res/drawable directory. Various assets must share this common name in various subdirectories.
+ SplashScreenDelay (number in milliseconds) | *Default: 3000, 3 seconds* <br/> **Platforms supported: Android** <br/> The amount of time the splash screen image displays.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ LoadingDialog (string) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.
+ ErrorUrl (URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ShowTitle (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Show the title at the top of the screen.
+ LogLevel (string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level through which log messages from your application will be filtered.
+ SetFullscreen (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.
+ AndroidLaunchMode (string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ DefaultVolumeStream (string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ OverrideUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ ChildBrowser (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ PopupBlocker (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.
+ WebSecurity (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.
+ windows-phone-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows Phone for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to the same version as ```windows-target-version``` (if found).
+ windows-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to '8.1'.
+ Min/Max UAP (Regex) | Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> **Platforms supported: Windows** <br/> Sets the min/max UAP versions for Windows. If nothing is specified, Windows.Universal at version 10.0.10240.0 will be used.
+
+ Examples:
+
+ <preference name="DisallowOverscroll" value="true"/>
+ <preference name="Fullscreen" value="true" />
+ <preference name="BackgroundColor" value="0xff0000ff"/>
+ <preference name="HideKeyboardFormAccessoryBar" value="true"/>
+ <preference name="Orientation" value="landscape" />
+
+ <!-- iOS only preferences -->
+ <preference name="EnableViewportScale" value="true"/>
+ <preference name="MediaPlaybackAllowsAirPlay" value="false"/>
+ <preference name="MediaPlaybackRequiresUserAction" value="true"/>
+ <preference name="AllowInlineMediaPlayback" value="true"/>
+ <preference name="BackupWebStorage" value="local"/>
+ <preference name="TopActivityIndicator" value="white"/>
+ <preference name="SuppressesIncrementalRendering" value="true"/>
+ <preference name="GapBetweenPages" value="0"/>
+ <preference name="PageLength" value="0"/>
+ <preference name="PaginationBreakingMode" value="page"/>
+ <preference name="PaginationMode" value="unpaginated"/>
+ <preference name="UIWebViewDecelerationSpeed" value="fast" />
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+ <preference name="target-device" value="universal" />
+ <preference name="deployment-target" value="7.0" />
+ <preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
+ <preference name="SuppressesLongPressGesture" value="true" />
+ <preference name="Suppresses3DTouchGesture" value="true" />
+
+ <!-- Android only preferences -->
+ <preference name="KeepRunning" value="false"/>
+ <preference name="LoadUrlTimeoutValue" value="10000"/>
+ <preference name="SplashScreen" value="mySplash"/>
+ <preference name="InAppBrowserStorageEnabled" value="true"/>
+ <preference name="LoadingDialog" value="My Title,My Message"/>
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="ShowTitle" value="true"/>
+ <preference name="LogLevel" value="VERBOSE"/>
+ <preference name="AndroidLaunchMode" value="singleTop"/>
+ <preference name="DefaultVolumeStream" value="call" />
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+
+ <!-- Windows only preferences -->
+ <preference name="windows-phone-target-version" value="8.1" />
+ <preference name="windows-target-version" value="8.1" />
+ <preference name="Windows.Universal" value="10.0.10240.0" />
+
+ <!-- BlackBerry only preferences -->
+ <preference name="ChildBrowser" value="disable"/>
+ <preference name="PopupBlocker" value="enable"/>
+ <preference name="WebSecurity" value="disable"/>
+
+## feature
+ 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 work 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 often appear with custom values in platform-specific config.xml files. See the API Reference for details on how to specify each feature. See
+ the [Plugin Development Guide](../guide/hybrid/plugins/index.html) for more information on plugins.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true <br/>* The name of the plugin to enable.
+
+
+### param
+ Used to specify what certain plugin parameters such as: what package to retrieve the plugin code from, and whether the plugin code is to be initialized during the Webview's initialization.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> Allowed values: android-package, ios-package, onload. <br/> **Platforms supported: iOS, Android** <br/> 'ios-package' and 'android-package' are used to specify the name of the package (as specified by the 'value' attribute) to be used to initialize the plugin code, while 'onload' is used to specify whether the corresponding plugin (as specified in the 'value' attribute) is to be instantiated when the controller is initialized.
+ value (string or boolean) | *Required: true* <br/> **Platforms supported: iOS, Android** <br/> Specifies the name of the package to be used to initialize the plugin code (when the 'name' attribute is android-package or ios-package), specifies the name of the plugin to be loaded during controller initialization (when 'name' attribute is set to 'onload').
+
+
+ Examples:
+
+ <!-- Here is how to specify the Device API for Android projects -->
+ <feature name="Device">
+ <param name="android-package" value="org.apache.cordova.device.Device" />
+ </feature>
+
+ <!-- Here's how the element appears for iOS projects -->
+ <feature name="Device">
+ <param name="ios-package" value="CDVDevice" />
+ <param name="onload" value="true" />
+ </feature>
- <preference name="HideKeyboardFormAccessoryBar" value="true"/>
- Applies to BlackBerry.
+## platform
+ When using the CLI to build applications, it is sometimes necessary to specify preferences or other elements specific to a particular platform. Use the <platform> element to specify configuration that should only appear in a single platform-specific config.xml file.
-- `Orientation` (string, defaults to `default`): allows you to lock
- orientation and prevent the interface from rotating in response to
- changes in orientation. Possible values are `default`, `landscape`
- or `portrait`. Example:
-
- <preference name="Orientation" value="landscape" />
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> The platform whose preferences are being defined.
+
+ Examples:
+
+ <platform name="android">
+ <preference name="Fullscreen" value="true" />
+ </platform>
+
+## hook
+ Represents your custom script which will be called by Cordova when
+ certain action occurs (for example, after plugin is added or platform
+ prepare logic is invoked). This is useful when you need to extend
+ default Cordova functionality. See [Hooks Guide](../guide/appdev/hooks/index.html) for more information.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ type (string) | *Required: true* <br/> Specifies the action during which the custom script is to be called.
+ src (string) | *Required: true* <br/> Specifies the location of the script to be called when a specific action occurs.
+
+ Examples:
--- End diff --
For consistency's sake, stick with only one of: "Example" or "Examples"
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51630971
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -22,8 +22,8 @@ title: The config.xml File
# The config.xml File
--- End diff --
+1
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51642981
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
+ </widget>
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ <widget version="0.0.1">
+ </widget>
-Below is an example that explicitly sets these properties:
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ <widget xmlns="http://www.w3.org/ns/widgets">
+ </widget>
-## Global Preferences
-The following global preferences apply to all platforms:
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ Example:
- <preference name="Fullscreen" value="true" />
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-## Multi-Platform Preferences
+ Example:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-The following preferences apply to more than one platform, but not to
-all of them:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ email (string) | *Required: true <br/>* Email of the author.
+ href (string) | *Required: true <br/>* Website of the author.
-- `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
- if you don't want the interface to display any feedback when users
- scroll past the beginning or end of content.
+ Examples:
- <preference name="DisallowOverscroll" value="true"/>
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- Applies to Android and iOS. On iOS, overscroll gestures cause
- content to bounce back to its original position. On Android, they
- produce a more subtle glowing effect along the top or bottom edge of
- the content.
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ src (string) | *Required: true <br/>* Defines the app'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.
+
+ Example:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-- `BackgroundColor`: Set the app's background color. Supports a
- four-byte hex value, with the first byte representing the alpha
- channel, and standard RGB values for the following three bytes. This
- example specifies blue:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- <preference name="BackgroundColor" value="0xff0000ff"/>
+ Attributes (type) | Description
+ ----------------- | ------------
+ origin (string) | *Required: true <br/>* Defines 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](../guide/appdev/whitelist/index.html) for details.
- Applies to Android and BlackBerry. Overrides CSS otherwise available
- across _all_ platforms, for example: `body{background-color:blue}`.
+ Examples:
-- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
- to `true` to hide the additional toolbar that appears above the
- keyboard, helping users navigate from one form input to another.
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> Name of the platform to be restored
+ spec (string) | *Required: true* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ DisallowOverscroll (boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ FullScreen (boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ BackgroundColor (string) | *Required: false* <br/> **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ HideKeyboardFormAccessoryBar (boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ Orientation (string) | *Default: default* <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> **NOTE:** The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.
+ EnableViewportScale (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ MediaPlaybackAllowsAirPlay (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.
+ MediaPlaybackRequiresUserAction (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.
+ AllowInlineMediaPlayback (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ BackupWebStorage (string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ TopActivityIndicator (string) | *Default: gray* <br/> Allowed values: whiteLarge, white, gray. <br/> **Platforms supported: iOS** <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.
+ KeyboardDisplayRequiresUserAction (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ SuppressesIncrementalRendering (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to wait until all content has been received before it renders to the screen.
+ GapBetweenPages (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ PageLength (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.
+ PaginationBreakingMode (string) | *Default: page* <br/> Allowed values: page, column <br/> **Platforms supported: iOS** <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.
+ PaginationMode (string) | *Default: unpaginated* <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> **Platforms supported: iOS** <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.
+ UIWebViewDecelerationSpeed (string) | *Default: normal* <br/> Allowed values: normal, fast <br/> **Platforms supported: iOS** <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.
+ ErrorUrl (string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ OverrideUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ target-device (string) | *Default: universal* <br/> Allowed values: handset, tablet, universal <br/> **Platforms supported: iOS** <br/> This property maps directly to TARGETED_DEVICE_FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.
+ deployment-target (string) | **Platforms supported: iOS** <br/> This sets the IPHONEOS_DEPLOYMENT_TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings
+ CordovaWebViewEngine (string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ SuppressesLongPressGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.
+ Suppresses3DTouchGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.
+ KeepRunning (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ LoadUrlTimeoutValue (number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
+ SplashScreen (string) | *Default: splash* <br/> **Platforms supported: Android** <br/> The name of the file minus its extension in the res/drawable directory. Various assets must share this common name in various subdirectories.
+ SplashScreenDelay (number in milliseconds) | *Default: 3000, 3 seconds* <br/> **Platforms supported: Android** <br/> The amount of time the splash screen image displays.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ LoadingDialog (string) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.
+ ErrorUrl (URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ShowTitle (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Show the title at the top of the screen.
+ LogLevel (string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level through which log messages from your application will be filtered.
+ SetFullscreen (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.
+ AndroidLaunchMode (string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ DefaultVolumeStream (string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ OverrideUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ ChildBrowser (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ PopupBlocker (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.
+ WebSecurity (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.
+ windows-phone-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows Phone for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to the same version as ```windows-target-version``` (if found).
+ windows-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to '8.1'.
+ Min/Max UAP (Regex) | Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> **Platforms supported: Windows** <br/> Sets the min/max UAP versions for Windows. If nothing is specified, Windows.Universal at version 10.0.10240.0 will be used.
+
+ Examples:
+
+ <preference name="DisallowOverscroll" value="true"/>
+ <preference name="Fullscreen" value="true" />
+ <preference name="BackgroundColor" value="0xff0000ff"/>
+ <preference name="HideKeyboardFormAccessoryBar" value="true"/>
+ <preference name="Orientation" value="landscape" />
+
+ <!-- iOS only preferences -->
+ <preference name="EnableViewportScale" value="true"/>
+ <preference name="MediaPlaybackAllowsAirPlay" value="false"/>
+ <preference name="MediaPlaybackRequiresUserAction" value="true"/>
+ <preference name="AllowInlineMediaPlayback" value="true"/>
+ <preference name="BackupWebStorage" value="local"/>
+ <preference name="TopActivityIndicator" value="white"/>
+ <preference name="SuppressesIncrementalRendering" value="true"/>
+ <preference name="GapBetweenPages" value="0"/>
+ <preference name="PageLength" value="0"/>
+ <preference name="PaginationBreakingMode" value="page"/>
+ <preference name="PaginationMode" value="unpaginated"/>
+ <preference name="UIWebViewDecelerationSpeed" value="fast" />
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+ <preference name="target-device" value="universal" />
+ <preference name="deployment-target" value="7.0" />
+ <preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
+ <preference name="SuppressesLongPressGesture" value="true" />
+ <preference name="Suppresses3DTouchGesture" value="true" />
+
+ <!-- Android only preferences -->
+ <preference name="KeepRunning" value="false"/>
+ <preference name="LoadUrlTimeoutValue" value="10000"/>
+ <preference name="SplashScreen" value="mySplash"/>
+ <preference name="InAppBrowserStorageEnabled" value="true"/>
+ <preference name="LoadingDialog" value="My Title,My Message"/>
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="ShowTitle" value="true"/>
+ <preference name="LogLevel" value="VERBOSE"/>
+ <preference name="AndroidLaunchMode" value="singleTop"/>
+ <preference name="DefaultVolumeStream" value="call" />
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+
+ <!-- Windows only preferences -->
+ <preference name="windows-phone-target-version" value="8.1" />
+ <preference name="windows-target-version" value="8.1" />
+ <preference name="Windows.Universal" value="10.0.10240.0" />
+
+ <!-- BlackBerry only preferences -->
+ <preference name="ChildBrowser" value="disable"/>
+ <preference name="PopupBlocker" value="enable"/>
+ <preference name="WebSecurity" value="disable"/>
+
+## feature
--- End diff --
But do you ever manually add it? Should we discourage users from doing so?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51664527
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ src(string) | *Required* <br/> Defines the app'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.
+
+ Examples:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ Attributes(type) | Description
+ ----------------- | ------------
+ origin(string) | *Required* <br/> Defines 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](../guide/appdev/whitelist/index.html) for details.
-## Global Preferences
+ Examples:
-The following global preferences apply to all platforms:
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ name(string) | *Required* <br/> Name of the platform to be restored
+ spec(string) | *Required* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ AllowInlineMediaPlayback(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
--- End diff --
+1. thanks for letting me know about ==iOS== ==Android==
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51065593
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
--- End diff --
In above paragraph: "... subdirectories, for example:" should be "... subdirectories. For example:".
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51643080
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ src(string) | *Required* <br/> Defines the app'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.
+
+ Examples:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ Attributes(type) | Description
+ ----------------- | ------------
+ origin(string) | *Required* <br/> Defines 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](../guide/appdev/whitelist/index.html) for details.
-## Global Preferences
+ Examples:
-The following global preferences apply to all platforms:
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ name(string) | *Required* <br/> Name of the platform to be restored
+ spec(string) | *Required* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ AllowInlineMediaPlayback(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ AndroidLaunchMode(string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ AppendUserAgent(string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ AppendUserAgent(string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ BackgroundColor(string) | **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ BackupWebStorage(string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ ChildBrowser(string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ CordovaWebViewEngine(string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ DefaultVolumeStream(string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ DisallowOverscroll(boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ EnableViewportScale(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ ErrorUrl(URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ErrorUrl(string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ FullScreen(boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ GapBetweenPages(float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ HideKeyboardFormAccessoryBar(boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
--- End diff --
'S'et to true..
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51297739
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
--- End diff --
I followed the format of <tag-name> as heading i.e. <widget> here, for plugin.xml. What do you think is better? We should be consistent.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51297388
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -22,8 +22,8 @@ title: The config.xml File
# The config.xml File
--- End diff --
Rename this to 'Config.xml'?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51638474
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app's starting page in the top-level web assets directory. The default value is index.html, which customarily
--- End diff --
In rest of the docs, the directories and file names are put inside inline code blocks. We should do the same here.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51648894
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
--- End diff --
+1
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-docs/pull/463
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51642666
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
--- End diff --
"reverse-domain identifier" should be "npm-style identifier"
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51064971
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -22,8 +22,8 @@ title: The config.xml File
# The config.xml File
-Many aspects of an app's behavior can be controlled with a global
-configuration file, `config.xml`. This
+config.xml is a global configuratino file that controls many aspects
--- End diff --
"configuratino"
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51631119
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
+ </widget>
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ <widget version="0.0.1">
+ </widget>
-Below is an example that explicitly sets these properties:
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ <widget xmlns="http://www.w3.org/ns/widgets">
+ </widget>
-## Global Preferences
-The following global preferences apply to all platforms:
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ Example:
- <preference name="Fullscreen" value="true" />
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-## Multi-Platform Preferences
+ Example:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-The following preferences apply to more than one platform, but not to
-all of them:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ email (string) | *Required: true <br/>* Email of the author.
+ href (string) | *Required: true <br/>* Website of the author.
-- `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
- if you don't want the interface to display any feedback when users
- scroll past the beginning or end of content.
+ Examples:
- <preference name="DisallowOverscroll" value="true"/>
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- Applies to Android and iOS. On iOS, overscroll gestures cause
- content to bounce back to its original position. On Android, they
- produce a more subtle glowing effect along the top or bottom edge of
- the content.
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ src (string) | *Required: true <br/>* Defines the app'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.
+
+ Example:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-- `BackgroundColor`: Set the app's background color. Supports a
- four-byte hex value, with the first byte representing the alpha
- channel, and standard RGB values for the following three bytes. This
- example specifies blue:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- <preference name="BackgroundColor" value="0xff0000ff"/>
+ Attributes (type) | Description
+ ----------------- | ------------
+ origin (string) | *Required: true <br/>* Defines 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](../guide/appdev/whitelist/index.html) for details.
- Applies to Android and BlackBerry. Overrides CSS otherwise available
- across _all_ platforms, for example: `body{background-color:blue}`.
+ Examples:
-- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
- to `true` to hide the additional toolbar that appears above the
- keyboard, helping users navigate from one form input to another.
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> Name of the platform to be restored
+ spec (string) | *Required: true* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ DisallowOverscroll (boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ FullScreen (boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ BackgroundColor (string) | *Required: false* <br/> **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ HideKeyboardFormAccessoryBar (boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ Orientation (string) | *Default: default* <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> **NOTE:** The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.
+ EnableViewportScale (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ MediaPlaybackAllowsAirPlay (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.
+ MediaPlaybackRequiresUserAction (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.
+ AllowInlineMediaPlayback (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ BackupWebStorage (string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ TopActivityIndicator (string) | *Default: gray* <br/> Allowed values: whiteLarge, white, gray. <br/> **Platforms supported: iOS** <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.
+ KeyboardDisplayRequiresUserAction (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ SuppressesIncrementalRendering (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to wait until all content has been received before it renders to the screen.
+ GapBetweenPages (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ PageLength (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.
+ PaginationBreakingMode (string) | *Default: page* <br/> Allowed values: page, column <br/> **Platforms supported: iOS** <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.
+ PaginationMode (string) | *Default: unpaginated* <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> **Platforms supported: iOS** <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.
+ UIWebViewDecelerationSpeed (string) | *Default: normal* <br/> Allowed values: normal, fast <br/> **Platforms supported: iOS** <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.
+ ErrorUrl (string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ OverrideUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ target-device (string) | *Default: universal* <br/> Allowed values: handset, tablet, universal <br/> **Platforms supported: iOS** <br/> This property maps directly to TARGETED_DEVICE_FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.
+ deployment-target (string) | **Platforms supported: iOS** <br/> This sets the IPHONEOS_DEPLOYMENT_TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings
+ CordovaWebViewEngine (string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ SuppressesLongPressGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.
+ Suppresses3DTouchGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.
+ KeepRunning (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ LoadUrlTimeoutValue (number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
+ SplashScreen (string) | *Default: splash* <br/> **Platforms supported: Android** <br/> The name of the file minus its extension in the res/drawable directory. Various assets must share this common name in various subdirectories.
+ SplashScreenDelay (number in milliseconds) | *Default: 3000, 3 seconds* <br/> **Platforms supported: Android** <br/> The amount of time the splash screen image displays.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ LoadingDialog (string) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.
+ ErrorUrl (URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ShowTitle (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Show the title at the top of the screen.
+ LogLevel (string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level through which log messages from your application will be filtered.
+ SetFullscreen (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.
+ AndroidLaunchMode (string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ DefaultVolumeStream (string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ OverrideUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ ChildBrowser (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ PopupBlocker (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.
+ WebSecurity (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.
+ windows-phone-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows Phone for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to the same version as ```windows-target-version``` (if found).
+ windows-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to '8.1'.
+ Min/Max UAP (Regex) | Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> **Platforms supported: Windows** <br/> Sets the min/max UAP versions for Windows. If nothing is specified, Windows.Universal at version 10.0.10240.0 will be used.
+
+ Examples:
+
+ <preference name="DisallowOverscroll" value="true"/>
+ <preference name="Fullscreen" value="true" />
+ <preference name="BackgroundColor" value="0xff0000ff"/>
+ <preference name="HideKeyboardFormAccessoryBar" value="true"/>
+ <preference name="Orientation" value="landscape" />
+
+ <!-- iOS only preferences -->
+ <preference name="EnableViewportScale" value="true"/>
+ <preference name="MediaPlaybackAllowsAirPlay" value="false"/>
+ <preference name="MediaPlaybackRequiresUserAction" value="true"/>
+ <preference name="AllowInlineMediaPlayback" value="true"/>
+ <preference name="BackupWebStorage" value="local"/>
+ <preference name="TopActivityIndicator" value="white"/>
+ <preference name="SuppressesIncrementalRendering" value="true"/>
+ <preference name="GapBetweenPages" value="0"/>
+ <preference name="PageLength" value="0"/>
+ <preference name="PaginationBreakingMode" value="page"/>
+ <preference name="PaginationMode" value="unpaginated"/>
+ <preference name="UIWebViewDecelerationSpeed" value="fast" />
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+ <preference name="target-device" value="universal" />
+ <preference name="deployment-target" value="7.0" />
+ <preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
+ <preference name="SuppressesLongPressGesture" value="true" />
+ <preference name="Suppresses3DTouchGesture" value="true" />
+
+ <!-- Android only preferences -->
+ <preference name="KeepRunning" value="false"/>
+ <preference name="LoadUrlTimeoutValue" value="10000"/>
+ <preference name="SplashScreen" value="mySplash"/>
+ <preference name="InAppBrowserStorageEnabled" value="true"/>
+ <preference name="LoadingDialog" value="My Title,My Message"/>
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="ShowTitle" value="true"/>
+ <preference name="LogLevel" value="VERBOSE"/>
+ <preference name="AndroidLaunchMode" value="singleTop"/>
+ <preference name="DefaultVolumeStream" value="call" />
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+
+ <!-- Windows only preferences -->
+ <preference name="windows-phone-target-version" value="8.1" />
+ <preference name="windows-target-version" value="8.1" />
+ <preference name="Windows.Universal" value="10.0.10240.0" />
+
+ <!-- BlackBerry only preferences -->
+ <preference name="ChildBrowser" value="disable"/>
+ <preference name="PopupBlocker" value="enable"/>
+ <preference name="WebSecurity" value="disable"/>
+
+## feature
--- End diff --
Save/Restore feature also makes use of this tag.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51642563
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -39,222 +39,357 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`,
and that having it here is still supported.
When using the CLI to build a project, versions of this file are
-passively copied into various `platforms/` subdirectories, for example:
+passively copied into various `platforms/` subdirectories.
+For example:
app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode(string) | **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion(string) | **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion(string) | **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName(string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns(string) | *Required* <br/> Namespace for the config.xml document.
+ xmlns:cdv(string) | *Required* <br/> Namespace prefix.
+
+ Examples:
-The following configuration elements appear in the top-level
-`config.xml` file, and are supported across all supported Cordova
-platforms:
+ <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+ </widget>
-- 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.
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-- The optional `<content>` element defines the app'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.
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `<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](../guide/appdev/whitelist/index.html) for details.
+ Examples:
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-### Additional Versioning
+ Examples:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ email(string) | *Required* <br/> Email of the author.
+ href(string) | *Required* <br/> Website of the author.
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ Examples:
-Below is an example that explicitly sets these properties:
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ src(string) | *Required* <br/> Defines the app'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.
+
+ Examples:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ Attributes(type) | Description
+ ----------------- | ------------
+ origin(string) | *Required* <br/> Defines 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](../guide/appdev/whitelist/index.html) for details.
-## Global Preferences
+ Examples:
-The following global preferences apply to all platforms:
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ name(string) | *Required* <br/> Name of the platform to be restored
+ spec(string) | *Required* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes(type) | Description
+ ----------------- | ------------
+ AllowInlineMediaPlayback(boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
--- End diff --
We need to change the formatting for platform supported to ==<platform name>== . This makes it a part of 'mark' element which we apply custom css to on the website. I already updated the XML reference style guide to reflect this. Apologies for not conveying it earlier.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51065054
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -22,8 +22,8 @@ title: The config.xml File
# The config.xml File
-Many aspects of an app's behavior can be controlled with a global
-configuration file, `config.xml`. This
+config.xml is a global configuratino file that controls many aspects
+of a cordova application's behavior. This
platform-agnostic XML file is arranged 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
--- End diff --
In the next paragraph, "The Command-Line Interface" should be a link.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Posted by omefire <gi...@git.apache.org>.
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/463#discussion_r51664771
--- Diff: www/docs/en/dev/config_ref/index.md ---
@@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
-- [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
-
In addition to the various configuration options detailed below, you
can also configure an application's core set of images for each target
platform. See [Icons and Splash Screens](images.html) for more information.
-## Core Configuration Elements
-
-This example shows the default `config.xml` generated by the CLI's
-`create` command, described in [The Command-Line Interface](../guide/cli/index.html):
-
- <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="*" />
- </widget>
-
-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.
-
- The widget tag can also have attributes that specify alternative versions,
- namely `versionCode` for Android, `CFBundleVersion` for iOS, and
- `packageVersion` for Windows. See the Additional Versioning section below
- for details.
-
-- The `<name>` element specifies the app's formal name, as it appears
- on the device's home screen and within app-store interfaces.
-
-- The `<description>` and `<author>` elements specify metadata and
- contact information that may appear within app-store listings.
-
-- The optional `<content>` element defines the app'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](../guide/appdev/whitelist/index.html) for details.
-
-- The `<preference>` tag sets various options as pairs of
- `name`/`value` attributes. Each preference's `name` is
- case-insensitive. Many preferences are unique to specific
- platforms, as listed at the top of this page. The following sections
- detail preferences that apply to more than one platform.
-
-### Additional Versioning
+# widget
+ Root element of the config.xml document.
+
+ Attributes(type) | Description
+ ---------------- | ------------
+ id (string) | *Required: true* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation.
+ version (string) | *Required: true* <br/> Full version number expressed in major/minor/patch notation.
+ versionCode (string) | *Required: false* <br/> **Platforms supported: Android** <br/> Alternative version for Android.
+ CFBundleVersion (string) | *Required: false* <br/> **Platforms supported: iOS** <br/> Alternative version for iOS.
+ packageVersion (string) | *Required: false* <br/> **Platforms supported: Windows** <br/> Alternative version for Windows.
+ packageName (string) | *Default: Cordova.Example* <br/> **Platforms supported: Windows** <br/> Package name for Windows.
+ xmlns (string) | *Required: true* <br/> namespace for the config.xml document.
+ xmlns:cdv (string) | *Required: true* <br/> namespace prefix.
+
+ Examples:
-Android, iOS, and Windows support a second version string (or number) in
-addition to the one visible in app stores:
+ <widget id="io.cordova.hellocordova">
+ </widget>
-- [versionCode](http://developer.android.com/tools/publishing/versioning.html)
- for Android
-- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error)
- for iOS
-- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
- for Windows
+ <widget version="0.0.1">
+ </widget>
-Below is an example that explicitly sets these properties:
+ <!-- Android -->
+ <widget versionCode="0.1.3">
+ </widget>
- <widget id="io.cordova.hellocordova"
- version="0.0.1"
- android-versionCode="7"
- ios-CFBundleVersion="3.3.3"
- windows-packageVersion="1.0.1.2">
+ <!-- iOS -->
+ <widget CFBundleVersion="0.1.3">
+ </widget>
-If alternative version is not specified, the following
-defaults will be used:
+ <!-- Windows -->
+ <widget packageVersion="0.1.3">
+ </widget>
- // assuming version = MAJOR.MINOR.PATCH-whatever
- versionCode = PATCH + MINOR * 100 + MAJOR * 10000
- CFBundleVersion = "MAJOR.MINOR.PATCH"
- packageVersion = "MAJOR.MINOR.PATCH.0"
+ <widget xmlns="http://www.w3.org/ns/widgets">
+ </widget>
-## Global Preferences
-The following global preferences apply to all platforms:
+## name
+ Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.
-- `Fullscreen` allows you to hide the status bar at the top of the
- screen. The default value is `false`. Example:
+ Example:
- <preference name="Fullscreen" value="true" />
+ <widget ...>
+ <name>HelloCordova</name>
+ </widget>
+
+## description
+ Specifies metadata that may appear within app-store listings.
-## Multi-Platform Preferences
+ Example:
+
+ <widget ...>
+ <description>A sample Apache Cordova application</description>
+ </widget>
-The following preferences apply to more than one platform, but not to
-all of them:
+
+## author
+ Specifies contact information that may appear within app-store lisitngs.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ email (string) | *Required: true <br/>* Email of the author.
+ href (string) | *Required: true <br/>* Website of the author.
-- `DisallowOverscroll` (boolean, defaults to `false`): set to `true`
- if you don't want the interface to display any feedback when users
- scroll past the beginning or end of content.
+ Examples:
- <preference name="DisallowOverscroll" value="true"/>
+ <widget ...>
+ <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
+ </widget>
- Applies to Android and iOS. On iOS, overscroll gestures cause
- content to bounce back to its original position. On Android, they
- produce a more subtle glowing effect along the top or bottom edge of
- the content.
+
+## content
+ Optional.
+ Defines the app'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.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ src (string) | *Required: true <br/>* Defines the app'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.
+
+ Example:
+
+ <widget ...>
+ <content src="startPage.html"></content>
+ </widget>
-- `BackgroundColor`: Set the app's background color. Supports a
- four-byte hex value, with the first byte representing the alpha
- channel, and standard RGB values for the following three bytes. This
- example specifies blue:
+
+## access
+ Defines 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](../guide/appdev/whitelist/index.html) for details.
- <preference name="BackgroundColor" value="0xff0000ff"/>
+ Attributes (type) | Description
+ ----------------- | ------------
+ origin (string) | *Required: true <br/>* Defines 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](../guide/appdev/whitelist/index.html) for details.
- Applies to Android and BlackBerry. Overrides CSS otherwise available
- across _all_ platforms, for example: `body{background-color:blue}`.
+ Examples:
-- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set
- to `true` to hide the additional toolbar that appears above the
- keyboard, helping users navigate from one form input to another.
+ <widget ...>
+ <access origin="*"></content>
+ </widget>
+
+ <widget ...>
+ <access origin="http://google.com"></content>
+ </widget>
+
+
+## allow-navigation
+ Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines the set of external domains the WebView is allowed to navigate to.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#navigation-whitelist) for details.
+
+ Examples:
+
+ <!-- Allow links to example.com -->
+ <allow-navigation href="http://example.com/*" />
+
+ <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
+ <allow-navigation href="*://*.example.com/*" />
+
+## allow-intent
+ Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ href (string) | *Required: true* <br/> Defines which URLs the app is allowed to ask the system to open.
+ See the cordova-plugin-whitelist [cordova-plugin-whitelist](https://github.com/apache/cordova-plugin-whitelist#intent-whitelist) for details.
+
+ Examples:
+
+ <allow-intent href="http://*/*" />
+ <allow-intent href="https://*/*" />
+ <allow-intent href="tel:*" />
+ <allow-intent href="sms:*" />
+
+## engine
+ Specifies what platform to restore during a prepare. For more details, see the Platforms & Plugins Version Management.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ name (string) | *Required: true* <br/> Name of the platform to be restored
+ spec (string) | *Required: true* <br/> Version of the platform to be restored
+
+ Examples:
+
+ <engine name="android" spec="^4.0.0" />
+
+## preference
+ Sets various optinos as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms,
+ and will be indicated as such.
+
+ Attributes (type) | Description
+ ----------------- | ------------
+ DisallowOverscroll (boolean) | *Default: false* <br/> **Platforms supported: iOS, Android** <br/> Set to **true** if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/>
+ FullScreen (boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen.
+ BackgroundColor (string) | *Required: false* <br/> **Platforms supported: Android, BlackBerry** <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes.
+ HideKeyboardFormAccessoryBar (boolean) | *Default: false* <br/> **Platforms supported: BlackBerry** <br/> set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.
+ Orientation (string) | *Default: default* <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> **NOTE:** The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.
+ EnableViewportScale (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />```
+ MediaPlaybackAllowsAirPlay (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.
+ MediaPlaybackRequiresUserAction (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.
+ AllowInlineMediaPlayback (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any ```<video>``` elements.
+ BackupWebStorage (string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> **Platforms supported: iOS** <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.
+ TopActivityIndicator (string) | *Default: gray* <br/> Allowed values: whiteLarge, white, gray. <br/> **Platforms supported: iOS** <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.
+ KeyboardDisplayRequiresUserAction (boolean) | *Default: true* <br/> **Platforms supported: iOS** <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.
+ SuppressesIncrementalRendering (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to wait until all content has been received before it renders to the screen.
+ GapBetweenPages (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of the gap, in points, between pages.
+ PageLength (float) | *Default: 0* <br/> **Platforms supported: iOS** <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.
+ PaginationBreakingMode (string) | *Default: page* <br/> Allowed values: page, column <br/> **Platforms supported: iOS** <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.
+ PaginationMode (string) | *Default: unpaginated* <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> **Platforms supported: iOS** <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.
+ UIWebViewDecelerationSpeed (string) | *Default: normal* <br/> Allowed values: normal, fast <br/> **Platforms supported: iOS** <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.
+ ErrorUrl (string) | **Platforms supported: iOS** <br/> If set, will display the referenced local page upon an error in the application.
+ OverrideUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: iOS** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ target-device (string) | *Default: universal* <br/> Allowed values: handset, tablet, universal <br/> **Platforms supported: iOS** <br/> This property maps directly to TARGETED_DEVICE_FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.
+ deployment-target (string) | **Platforms supported: iOS** <br/> This sets the IPHONEOS_DEPLOYMENT_TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings
+ CordovaWebViewEngine (string) | *Default: CDVUIWebViewEngine* <br/> **Platforms supported: iOS** <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.
+ SuppressesLongPressGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.
+ Suppresses3DTouchGesture (boolean) | *Default: false* <br/> **Platforms supported: iOS** <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.
+ KeepRunning (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html) event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html) event, but simply halts execution of code within the cordova webview while the app is in the background.
+ LoadUrlTimeoutValue (number in milliseconds) | *Default: 20000, 20 seconds* <br/> **Platforms supported: Android** <br/> hen loading a page, the amount of time to wait before throwing a timeout error.
+ SplashScreen (string) | *Default: splash* <br/> **Platforms supported: Android** <br/> The name of the file minus its extension in the res/drawable directory. Various assets must share this common name in various subdirectories.
+ SplashScreenDelay (number in milliseconds) | *Default: 3000, 3 seconds* <br/> **Platforms supported: Android** <br/> The amount of time the splash screen image displays.
+ InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.
+ LoadingDialog (string) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.
+ ErrorUrl (URL) | *Default: null* <br/> **Platforms supported: Android** <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".
+ ShowTitle (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Show the title at the top of the screen.
+ LogLevel (string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level through which log messages from your application will be filtered.
+ SetFullscreen (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.
+ AndroidLaunchMode (string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.
+ DefaultVolumeStream (string) | *Default: default* <br/> **Platforms supported: Android**<br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.
+ OverrideUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.
+ AppendUserAgent (string) | **Platforms supported: Android** <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.
+ ChildBrowser (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.
+ PopupBlocker (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.
+ WebSecurity (string) | *Default: enable* <br/> **Platforms supported: BlackBerry** <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.
+ windows-phone-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows Phone for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to the same version as ```windows-target-version``` (if found).
+ windows-target-version (string) | **Platform supported: Windows** <br/> Sets the version of Windows for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to '8.1'.
+ Min/Max UAP (Regex) | Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> **Platforms supported: Windows** <br/> Sets the min/max UAP versions for Windows. If nothing is specified, Windows.Universal at version 10.0.10240.0 will be used.
+
+ Examples:
+
+ <preference name="DisallowOverscroll" value="true"/>
+ <preference name="Fullscreen" value="true" />
+ <preference name="BackgroundColor" value="0xff0000ff"/>
+ <preference name="HideKeyboardFormAccessoryBar" value="true"/>
+ <preference name="Orientation" value="landscape" />
+
+ <!-- iOS only preferences -->
+ <preference name="EnableViewportScale" value="true"/>
+ <preference name="MediaPlaybackAllowsAirPlay" value="false"/>
+ <preference name="MediaPlaybackRequiresUserAction" value="true"/>
+ <preference name="AllowInlineMediaPlayback" value="true"/>
+ <preference name="BackupWebStorage" value="local"/>
+ <preference name="TopActivityIndicator" value="white"/>
+ <preference name="SuppressesIncrementalRendering" value="true"/>
+ <preference name="GapBetweenPages" value="0"/>
+ <preference name="PageLength" value="0"/>
+ <preference name="PaginationBreakingMode" value="page"/>
+ <preference name="PaginationMode" value="unpaginated"/>
+ <preference name="UIWebViewDecelerationSpeed" value="fast" />
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+ <preference name="target-device" value="universal" />
+ <preference name="deployment-target" value="7.0" />
+ <preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
+ <preference name="SuppressesLongPressGesture" value="true" />
+ <preference name="Suppresses3DTouchGesture" value="true" />
+
+ <!-- Android only preferences -->
+ <preference name="KeepRunning" value="false"/>
+ <preference name="LoadUrlTimeoutValue" value="10000"/>
+ <preference name="SplashScreen" value="mySplash"/>
+ <preference name="InAppBrowserStorageEnabled" value="true"/>
+ <preference name="LoadingDialog" value="My Title,My Message"/>
+ <preference name="ErrorUrl" value="myErrorPage.html"/>
+ <preference name="ShowTitle" value="true"/>
+ <preference name="LogLevel" value="VERBOSE"/>
+ <preference name="AndroidLaunchMode" value="singleTop"/>
+ <preference name="DefaultVolumeStream" value="call" />
+ <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+ <preference name="AppendUserAgent" value="My Browser" />
+
+ <!-- Windows only preferences -->
+ <preference name="windows-phone-target-version" value="8.1" />
+ <preference name="windows-target-version" value="8.1" />
+ <preference name="Windows.Universal" value="10.0.10240.0" />
+
+ <!-- BlackBerry only preferences -->
+ <preference name="ChildBrowser" value="disable"/>
+ <preference name="PopupBlocker" value="enable"/>
+ <preference name="WebSecurity" value="disable"/>
+
+## feature
--- End diff --
+1 to discouraging users from playing with this tag directly.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org