Github user riknoll commented on a diff in the pull request: https://github.com/apache/cordova-docs/pull/614#discussion_r70540748 --- Diff: www/docs/en/dev/plugin_ref/spec.md --- @@ -365,6 +365,111 @@ For windows-specific attributes: ``` The above example will set pre-8.1 platforms (Windows 8, specifically) to require the `webcam` device capability and the `picturesLibrary` general capability, and apply the `webcam` device capability only to Windows 8.1 projects that build for Windows Phone. Windows desktop 8.1 systems are unmodified. +### edit-config +Similar to `config-file`, `edit-config` identifies an XML-based configuration file to be modified, where in that document the modification should take place, and what should be modified. Instead of appending new children to an XML document tree, `edit-config` makes modifications to attributes of XML elements. There are two modes which will determine what type of attribute modification will be made, `merge` or `overwrite`. `edit-config` has one child and that child will contain the attributes to be added. + +Attributes(type) <br/> <span class="sub-header">Only for platform:</span> | Description +---------------- | ------------ +file(string) | The file to be modified, and the path relative to the root of the Cordova project. If the specified file does not exist, the tool ignores the configuration change and continues installation. <br/> The target can include wildcard (`*`) elements. In this case, the CLI recursively searches through the project directory structure and uses the first match. <br/> On iOS, the location of configuration files relative to the project directory root is not known, so specifying a target of `config.xml` resolves to `cordova-ios-project/MyAppName/config.xml`. +target(string) | An XPath selector referencing the target element to make attribute modifications to. If you use absolute selectors, you can use a wildcard (`*`) to specify the root element, e.g., `/*/plugins`. If the selector does not resolve to a child of the specified document, the tool stops and reverses the installation process, issues a warning, and exits with a non-zero code. +mode(string) | The mode that determines what type of attribute modifications will be made. <br/> `merge` - Adds the specified attributes to the target element. Will replace the attribute values if the specified attributes already exist in the target element. <br/> `overwrite` - Replaces all attributes in the target element with the attributes specified. + +Example: + +```xml +<!-- plugin-1 --> +<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge"> + <uses-sdk android:minSdkVersion="16" android:maxSdkVersion="23" /> +</edit-config> +<edit-config file="AndroidManifest.xml" target="/manifest/application/activity[@android:name='MainActivity']" mode="overwrite"> + <activity android:name="MainActivity" android:label="NewLabel" android:configChanges="orientation|keyboardHidden" /> +</edit-config> +``` + +AndroidManifest.xml before adding plugin-1: +```xml +<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android"> + ... + <activity android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale" android:label="@string/activity_name" android:launchMode="singleTop" android:name="MainActivity" android:theme="@android:style/Theme.DeviceDefault.NoActionBar" android:windowSoftInputMode="adjustResize"> + ... + </activity> + ... + <uses-sdk android:minSdkVersion="14" android:targetSdkVersion="23" /> +</manifest> +``` + +AndroidManifest.xml after adding plugin-1: +```xml +<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android"> + ... + <activity android:configChanges="orientation|keyboardHidden" android:label="NewLabel" android:name="MainActivity"> + ... + </activity> + ... + <uses-sdk android:maxSdkVersion="23" android:minSdkVersion="16" android:targetSdkVersion="23" /> +</manifest> +``` + +Multiple plugins will not be able to to modify the same attributes because it may cause problems with the application. An error will be thrown and plugin install will fail. The conflicting `edit-config` tags must be resolved before the plugin can be added. Make modifications to conflicting tags to resolve the conflict, then remove and re-add those updated plugins. --- End diff -- "Multiple plugins will not be able to to modify " => "Multiple plugins can not modify" "then remove and re-add those updated plugins" => "then remove and re-add the updated plugins"
--- 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 infrastruct...@apache.org or file a JIRA ticket with INFRA. --- --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org For additional commands, e-mail: dev-h...@cordova.apache.org