cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dblotsky <>
Subject [GitHub] cordova-docs pull request: CB-10389: Turning config.xml documentat...
Date Wed, 27 Jan 2016 23:09:21 GMT
Github user dblotsky commented on a diff in the pull request:
    --- Diff: www/docs/en/dev/config_ref/ ---
    @@ -45,207 +45,356 @@ passively copied into various `platforms/` subdirectories, for example:
    -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
    -            </description>
    -            <author email="" href="">
    -                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
    -- 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
    +   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](
    -  for Android
    -- [CFBundleVersion](
    -  for iOS
    -- [packageVersion](
    -  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="">
    +    <!-- 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="">
    +    </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 or file a JIRA ticket
with INFRA.

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message