You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2016/08/23 06:04:07 UTC
[5/6] docs commit: copied dev docsinto 6.x for english
copied dev docsinto 6.x for english
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d24004ab
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d24004ab
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d24004ab
Branch: refs/heads/master
Commit: d24004ab3f6119fe0a62add76e4afa47260fd9ac
Parents: 52bf193
Author: Steve Gill <st...@gmail.com>
Authored: Mon Aug 22 22:26:18 2016 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Mon Aug 22 22:26:18 2016 -0700
----------------------------------------------------------------------
www/docs/en/6.x/config_ref/index.md | 5 +-
www/docs/en/6.x/cordova/events/events.md | 39 ++
www/docs/en/6.x/guide/appdev/hooks/index.md | 5 +
www/docs/en/6.x/guide/cli/index.md | 2 +
www/docs/en/6.x/guide/cli/template.md | 72 +++
www/docs/en/6.x/guide/hybrid/plugins/index.md | 48 +-
www/docs/en/6.x/guide/next/index.md | 2 +
www/docs/en/6.x/guide/platforms/ubuntu/index.md | 198 ++++++--
www/docs/en/6.x/guide/support/index.md | 29 +-
.../6.x/platform_plugin_versioning_ref/index.md | 11 +-
www/docs/en/6.x/plugin_ref/spec.md | 106 +++++
www/docs/en/6.x/reference/cordova-cli/index.md | 110 +----
.../cordova-plugin-battery-status/index.md | 3 +-
.../reference/cordova-plugin-camera/index.md | 247 +---------
.../reference/cordova-plugin-console/index.md | 3 +-
.../reference/cordova-plugin-contacts/index.md | 324 ++++++-------
.../cordova-plugin-device-motion/index.md | 5 +-
.../cordova-plugin-device-orientation/index.md | 5 +-
.../reference/cordova-plugin-device/index.md | 3 +-
.../reference/cordova-plugin-dialogs/index.md | 7 +-
.../cordova-plugin-file-transfer/index.md | 460 ++++---------------
.../6.x/reference/cordova-plugin-file/index.md | 330 +------------
.../cordova-plugin-geolocation/index.md | 459 +-----------------
.../cordova-plugin-globalization/index.md | 3 +-
.../cordova-plugin-inappbrowser/index.md | 234 +---------
.../cordova-plugin-legacy-whitelist/index.md | 3 +-
.../cordova-plugin-media-capture/index.md | 43 +-
.../6.x/reference/cordova-plugin-media/index.md | 132 +-----
.../cordova-plugin-network-information/index.md | 123 +----
.../cordova-plugin-splashscreen/index.md | 126 ++---
.../reference/cordova-plugin-statusbar/index.md | 3 +-
.../reference/cordova-plugin-vibration/index.md | 3 +-
.../reference/cordova-plugin-whitelist/index.md | 3 +-
33 files changed, 773 insertions(+), 2373 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/config_ref/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/config_ref/index.md b/www/docs/en/6.x/config_ref/index.md
index 62e0cd0..5cb9cf5 100644
--- a/www/docs/en/6.x/config_ref/index.md
+++ b/www/docs/en/6.x/config_ref/index.md
@@ -63,6 +63,7 @@ Attributes(type) <br/> <span class="sub-header">Only for platform:</span> | Desc
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.
android-versionCode(string) <br/> ==Android== | Alternative version for Android. Sets the [version code](http://developer.android.com/tools/publishing/versioning.html) for the application. See [the Android guide](../guide/platforms/android/index.html#setting-the-version-code) for information on how this attribute may be modified.
+defaultlocale <br /> ==iOS== | Specified the default language of the app, as an IANA language code.
ios-CFBundleVersion(string) <br/> ==iOS== | Alternative version for iOS. For further details, see [iOS versioning](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364).
osx-CFBundleVersion(string) <br/> ==OS X== | Alternative version for OS X. For further details, see [OS X versioning](https://developer.apple.com/library/prerelease/mac/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364).
windows-packageVersion(string) <br/> ==Windows== | Alternative version for Windows. For futher details, see [Windows versioning](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
@@ -160,11 +161,11 @@ Examples:
```xml
<widget ...>
- <access origin="*"></content>
+ <access origin="*"></access>
</widget>
<widget ...>
- <access origin="http://google.com"></content>
+ <access origin="http://google.com"></access>
</widget>
```
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/cordova/events/events.md b/www/docs/en/6.x/cordova/events/events.md
index 0e988bf..586e223 100644
--- a/www/docs/en/6.x/cordova/events/events.md
+++ b/www/docs/en/6.x/cordova/events/events.md
@@ -185,6 +185,15 @@ The following table lists the cordova events and the supported platforms:
<td data-col="winphone8" class="n"></td>
<td data-col="win" class="n"></td>
</tr>
+
+ <tr>
+ <th><a href="#activated">activated</a></th>
+ <td data-col="android" class="n"></td>
+ <td data-col="blackberry10" class="n"></td>
+ <td data-col="ios" class="n"></td>
+ <td data-col="winphone8" class="n"></td>
+ <td data-col="win" class="y"></td>
+ </tr>
</tbody>
</table>
@@ -433,5 +442,35 @@ function onVolumeUpKeyDown() {
}
```
+## activated
+
+The event fires when Windows Runtime activation has occurred. See [MSDN docs][MSDNActivatedEvent] for further details and activation types.
+
+### Quick Example
+
+```javascript
+document.addEventListener("activated", activated, false);
+
+function activated(args) {
+ if (args && args.kind === Windows.ApplicationModel.Activation.ActivationKind.file) {
+ // Using args.raw to get the native StorageFile object
+ Windows.Storage.FileIO.readTextAsync(args.raw.detail[0].files[0]).done(function (text) {
+ console.log(text);
+ }, function (err) {
+ console.error(err);
+ });
+ }
+}
+```
+
+### Windows Quirks
+
+* Original activated event args are available in `args.raw.detail[0]` property and can be used to get a type information or invoke methods of one of the activation arguments,
+
+* Original activated event args are also cloned to `args.detail[0]` and can be used as a fallback in case an inner args property has been lost.
+See https://issues.apache.org/jira/browse/CB-10653 for details.
+
+
[UIApplicationExitsOnSuspend]: http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html
[AndroidLifeCycleGuide]: ../../guide/platforms/android/lifecycle.html
+[MSDNActivatedEvent]: https://msdn.microsoft.com/en-us/library/windows/apps/br212679.aspx
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/appdev/hooks/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/appdev/hooks/index.md b/www/docs/en/6.x/guide/appdev/hooks/index.md
index dbd4c3f..2d52f2c 100644
--- a/www/docs/en/6.x/guide/appdev/hooks/index.md
+++ b/www/docs/en/6.x/guide/appdev/hooks/index.md
@@ -98,6 +98,11 @@ Cordova supports the following hook types:
<th data-col="aftercompile">after_compile</th>
</tr>
<tr>
+ <th data-col="beforedeploy">before_deploy</th>
+ <td data-col="code"><code>cordova emulate</code><br/><code>cordova run</code></td>
+ <td data-col="description">To be executed before deploying your application.</td>
+ </tr>
+ <tr>
<th data-col="beforebuild">before_build</th>
<td data-col="code" rowspan="2"><code>cordova build</code></td>
<td rowspan="2" data-col="description">To be executed before and after building your application.</td>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/cli/index.md b/www/docs/en/6.x/guide/cli/index.md
index c50d3db..0e0f393 100644
--- a/www/docs/en/6.x/guide/cli/index.md
+++ b/www/docs/en/6.x/guide/cli/index.md
@@ -85,6 +85,7 @@ This creates the required directory structure for your cordova app. By default,
###See Also
- [Cordova create command reference documentation][cdv_create]
- [Cordova project directory structure][cdv_dir]
+- [Cordova project templates][cdv_template]
## Add Platforms
@@ -319,6 +320,7 @@ $ cordova platform update ios --save
[DeviceReadyEvent]: ../../cordova/events/events.html#deviceready
[BackButtonEvent]: ../../cordova/events/events.html#backbutton
[Core Plugin APIs]: ../../guide/support/index.html#core-plugin-apis
+[cdv_template]: ../../guide/cli/template.html#
[CLI reference]: ../../reference/cordova-cli/index.html
[cdv_create]: ../../reference/cordova-cli/index.html#cordova-create-command
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/cli/template.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/cli/template.md b/www/docs/en/6.x/guide/cli/template.md
new file mode 100644
index 0000000..b3dd068
--- /dev/null
+++ b/www/docs/en/6.x/guide/cli/template.md
@@ -0,0 +1,72 @@
+---
+license: >
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+title: Cordova App Templates
+description: Learn how to find, use, and create templates in Cordova.
+toc_title: Templates for apps
+
+---
+
+# Cordova App Templates
+
+## Use a Template
+
+Templates allow you to use preexisting code to jumpstart your project.
+
+
+
+Find a template to create your app from by seaching for the keyword `cordova:template` on [npm](https://www.npmjs.com/search?q=cordova%3Atemplate). You can also use local templates on your computer, or a Git repository.
+
+After locating a template you wish to use. Create your project using that template, by specifying the `--template` flag during the `create` command, followed by your template source.
+
+Creating a cordova project from an NPM package, Git repository, or local path:
+```
+$ cordova create hello com.example.hello HelloWorld --template <npm-package-name>
+$ cordova create hello com.example.hello HelloWorld --template <git-remote-url>
+$ cordova create hello com.example.hello HelloWorld --template <path-to-template>
+```
+
+After succesfully using a template to create your project, you'll want to indicate the platforms that you intend to target with your app. Go into your project folder and [add platforms](http://cordova.apache.org/docs/en/latest/guide/cli/index.html#add-platforms).
+
+## Create a Template
+
+Begin by creating a cordova app that will become the basis for your template. Then you'll take the contents of your app and put them into the following structure. When your template is used, all of the contents within `template_src` will be used to create the new project, so be sure to include any necessary files in that folder. Reference [this example](https://github.com/carynbear/cordova-template) for details.
+
+```
+template_package/
+\u251c\u2500\u2500 package.json (optional; needed to publish template on npm)
+\u251c\u2500\u2500 index.js (required)
+\u2514\u2500\u2500 template_src/ (required)
+ \u2514\u2500\u2500 CONTENTS OF APP TEMPLATE
+```
+> __NOTE__: `index.js` should export a reference to `template_src` and `package.json` should reference `index.js`. See [the example](https://github.com/carynbear/cordova-template) for details on how that is done.
+
+To finish off your template, edit `package.json` to contain the keyword `"cordova:template"`.
+```javascript
+{
+ ...
+ "keywords": [
+ "ecosystem:cordova",
+ "cordova:template"
+ ]
+ ...
+}
+```
+
+Congrats! You've made a template for creating a Cordova project. Share your template on npm so that everyone can benefit from your hard work.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/hybrid/plugins/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/hybrid/plugins/index.md b/www/docs/en/6.x/guide/hybrid/plugins/index.md
index 650b7e8..d770265 100644
--- a/www/docs/en/6.x/guide/hybrid/plugins/index.md
+++ b/www/docs/en/6.x/guide/hybrid/plugins/index.md
@@ -87,8 +87,8 @@ are available in the [Plugin Specification](../../../plugin_ref/spec.html). This
```
The top-level `plugin` tag's `id` attribute uses the same
-reverse-domain format to identify the plugin package as the apps to
-they're added. The `js-module` tag specifies the path to the common
+reverse domain format to identify the plugin package as the apps
+they're added to. The `js-module` tag specifies the path to the common
JavaScript interface. The `platform` tag specifies a corresponding
set of native code, for the `ios` platform in this case. The
`config-file` tag encapsulates a `feature` tag that is injected into
@@ -106,8 +106,8 @@ correctly for each platform. Install `plugman` with the following
npm install -g plugman
```
-You need an valid app source directory, such as the top-level `www`
-directory included in a default CLI-generated project as described in
+You need a valid app source directory, such as the top-level `www`
+directory included in a default CLI-generated project, as described in the
[Create your first app](../../cli/index.html) guide.
Then run a command such as the following to test whether iOS
@@ -121,7 +121,7 @@ For details on `plugman` options, see [Using Plugman to Manage Plugins](../../..
## The JavaScript Interface
-The JavaScript provides the front-facing interface, making it perhaps
+The JavaScript interface provides the front-facing interface, making it perhaps
the most important part of the plugin. You can structure your
plugin's JavaScript however you like, but you need to call
`cordova.exec` to communicate with the native platform, using the
@@ -178,14 +178,14 @@ window.echo("echome", function(echoValue) {
});
```
-Look at the last three arguments to the `cordova.exec` function. The
+Look at the last three arguments passed to the `cordova.exec` function. The
first calls the `Echo` _service_, a class name. The second requests
the `echo` _action_, a method within that class. The third is an array
of arguments containing the echo string, which is the `window.echo`
-function's the first parameter.
+function's first parameter.
The success callback passed into `exec` is simply a reference to the
-callback function `window.echo` takes. If the native platform fires
+callback function of `window.echo`. If the native platform fires
the error callback, it simply calls the success callback and passes it
a default string.
@@ -203,9 +203,9 @@ listed below, and each builds on the simple Echo Plugin example above:
## Publishing Plugins
-You can publish your plugin to any `npmjs`-based registry, but the recommended one is the [NPM registry](https://www.npmjs.com). Other developers can install your plugin automatically using either `plugman` or the Cordova CLI.
+You can publish your plugin to any `npmjs`-based registry, but the recommended one is the [npm registry](https://www.npmjs.com). Other developers can install your plugin automatically using either `plugman` or the Cordova CLI.
-To publish a plugin to NPM registry you need to follow steps below:
+To publish a plugin to npm you need to follow these steps:
* install the `plugman` CLI:
@@ -213,7 +213,7 @@ To publish a plugin to NPM registry you need to follow steps below:
$ npm install -g plugman
```
- * create `package.json` file for your plugin:
+ * create a `package.json` file for your plugin:
```bash
$ plugman createpackagejson /path/to/your/plugin
@@ -226,16 +226,16 @@ To publish a plugin to NPM registry you need to follow steps below:
$ npm publish /path/to/your/plugin
```
-For more details on npm usage refer to [publishing a npm package](https://docs.npmjs.com/getting-started/publishing-npm-packages) on the NPM documentation site.
+For more details on npm usage, refer to [Publishing npm Packages](https://docs.npmjs.com/getting-started/publishing-npm-packages) on the npm documentation site.
## Integrating with Plugin Search
To surface the plugin in [Cordova Plugin Search](/plugins/), add the `ecosystem:cordova` keyword to the `package.json` file of your plugin before publishing.
-To indicate support for a particular platform add a keyword with the `<platformName>` as `**cordova-<platformName>**` to the list of keywords in package.json.
+To indicate support for a particular platform, add a keyword in the format `**cordova-<platformName>**` to the list of keywords in package.json.
Plugman's `createpackagejson` command does this for you, but if you did not use it to generate your `package.json`, you should manually edit it as shown below.
-For example, for a plugin that supports android, iOS & Windows, the keywords in package.json should include:
+For example, for a plugin that supports Android, iOS & Windows, the keywords in `package.json` should include:
```json
"keywords": [
@@ -246,13 +246,13 @@ For example, for a plugin that supports android, iOS & Windows, the keywords in
]
```
-For more detailed example of a package.json, review the [package.json file of cordova-plugin-device](https://github.com/apache/cordova-plugin-device/blob/master/package.json).
+For a more detailed example of a package.json, review the [package.json file of cordova-plugin-device](https://github.com/apache/cordova-plugin-device/blob/master/package.json).
## Specifying Cordova Dependencies
**Cordova 6.1.0** added support for specifying the Cordova-related dependencies of a plugin
as part of the plugin's `package.json` file. Plugins may list the dependencies for multiple
-releases so as to provide guidance to the Cordova CLI when it is selecting the version of a
+releases to provide guidance to the Cordova CLI when it is selecting the version of a
plugin to fetch from npm. The CLI will choose the latest release of a plugin that is
compatible with the local project's installed platforms and plugins as well as the
the local Cordova CLI version. If no releases of the plugin are compatible, the CLI will warn
@@ -268,7 +268,7 @@ allows your plugin to respond to breaking changes without fear of confusing devl
are building against old platforms and plugins.
To specify Cordova-related dependencies for a plugin, alter the `engines` element in
-`package.json` to include a `cordovaDependencies` object using the following
+`package.json` to include a `cordovaDependencies` object with the following
structure:
```javascript
@@ -284,18 +284,18 @@ engines: {
}
```
-* `PLUGIN_VERSION` specifies a version of your plugin. It should adhere the syntax for a single version as defined by [npm's semver package][npm-semver] or an upper bound (see [below](#upper-bounds))
+* `PLUGIN_VERSION` specifies the version of your plugin. It should adhere to the syntax for a single version as defined by [npm's semver package][npm-semver] or an upper bound (see [below](#upper-bounds))
* `DEPENDENCY` may be one of the following:
- * The Cordova CLI, `"cordova"`
- * A Cordova platform (e.g. `"cordova-android"`, `"cordova-ios"`, `"cordova-windows"`, etc.)
- * Another Cordova plugin (e.g. `"cordova-plugin-camera"`, etc.)
+ * The Cordova CLI: `"cordova"`
+ * A Cordova platform: `"cordova-android"`, `"cordova-ios"`, `"cordova-windows"`, etc.
+ * Another Cordova plugin: `"cordova-plugin-camera"`, etc.
* `SEMVER_RANGE` should adhere to the syntax for a range as defined by [npm's semver package][npm-semver]
**NOTE:** A Cordova platform `DEPENDENCY` refers to the Cordova platform and not
-the OS (i.e. `cordova-android` rather than the Android OS)
+the OS, i.e. `cordova-android` rather than the Android OS.
Your `cordovaDependencies` may list any number of `PLUGIN_VERSION` requirements
-and any number of `DEPENDENCY` constraints within them. Versions of your plugin
+and any number of `DEPENDENCY` constraints. Versions of your plugin
that do not have their dependencies listed will be assumed to have the same
dependency information as the highest `PLUGIN_VERSION` listed below them. For
example, consider the following entry:
@@ -320,7 +320,7 @@ In addition to a single version, a `PLUGIN_VERSION` in `cordovaDependencies`
may also specify an upper bound to amend entries for older releases
of your plugin. This is useful when a breaking change occurs in a `DEPENDENCY`
and a new constraint must be added for all older versions of a plugin that do
-not support it. These bounds should be written as, a `<` followed by a single
+not support it. These bounds should be written as a `<` followed by a single
[semver][npm-semver] version (**Not an arbitrary range!**). This will apply
whatever `DEPENDENCY` values are given to all versions of the plugin below the
specified version. For example, consider the following entry:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/next/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/next/index.md b/www/docs/en/6.x/guide/next/index.md
index 165f785..6cdc1b7 100644
--- a/www/docs/en/6.x/guide/next/index.md
+++ b/www/docs/en/6.x/guide/next/index.md
@@ -153,6 +153,8 @@ With Safari's web inspector you can debug the webview and js code in your Cordov
## Chrome Remote Debugging
Virtually the same as the Safari version, this works with Android only but can be used from any desktop operating system. It requires a minimum of Android 4.4 (KitKat), minimum API level of 19, and Chrome 30+ (on the desktop). Once connected, you get the same Chrome Dev Tools experience for your mobile applications as you do with your desktop applications. Even better, the Chrome Dev Tools have a mirror option that shows your app running on the mobile device. This is more than just a view - you can scroll and click from dev tools and it updates on the mobile device. More details on Chrome Remote Debugging may be found here: [https://developers.google.com/chrome/mobile/docs/debugging](https://developers.google.com/chrome/mobile/docs/debugging)
+If you can see your device in the inspect devices section, but you can't see the Cordova webview you may need to add `android:debuggable="true"` in the `<application>` node of your `AndroidManifest.xml`.
+
It is possible to use Chrome Dev Tools to inspect iOS apps, through a WebKit proxy: [https://github.com/google/ios-webkit-debug-proxy/](https://github.com/google/ios-webkit-debug-proxy/)
## Ripple
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/platforms/ubuntu/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/platforms/ubuntu/index.md b/www/docs/en/6.x/guide/platforms/ubuntu/index.md
index 8795b3d..9fbe1ff 100644
--- a/www/docs/en/6.x/guide/platforms/ubuntu/index.md
+++ b/www/docs/en/6.x/guide/platforms/ubuntu/index.md
@@ -23,98 +23,210 @@ toc_title: Ubuntu
# Ubuntu Platform Guide
-## Initial Release
+This guide shows how to set up a development environment for creating Cordova applications for Ubuntu.
-Welcome to the initial release of Ubuntu platform support in
-Cordova. With this release, the focus is developing on an Ubuntu
-system and using the cross-platform workflow discussed in the
-[Overview](../../overview/index.html). This includes adding the Ubuntu platform to your project,
-adding standard Cordova plugins, and building and running apps for the
-Ubuntu platform.
+You will need an Ubuntu system for building applications, either running natively or in a virtual machine. You will also need an Ubuntu phone for testing your application, though an emulator can be used for basic verifications.
-### Ubuntu SDK
+## Development Platform Requirements
-You may also want to install the Ubuntu QtCreator development environment. See
-[developer.ubuntu.com](http://developer.ubuntu.com) for more info. (The
-QtCreator SDK is not required to add Ubuntu platform support to your Cordova
-app.)
+### Minimum and Recommended Versions
-### Ubuntu Runtime Platforms
+Developing Cordova apps requires a system running Ubuntu.
-Ubuntu is well known for its Desktop environment (for laptops, PCs and such).
-Ubuntu Touch extends the Ubuntu OS onto phones and tablets. Ubuntu runtime
-platforms have varying CPU architectures (x86, armhf, etc.). App and plugin
-code must be compiled appropriately. Support for this broad area is rapidly
-evolving in Ubuntu.
+The recommended environment is Ubuntu 16.04 LTS, running NodeJS 4.2.x and NPM 2.15.x.
-### Latest Information
+Packages are still available for systems running the previous LTS release (14.04) but some components like NodeJS or phablet-shell may not support all of the latest options.
+
+The target environment is an Ubuntu phone, supporting at least the ubuntu-sdk-api-15.04 framework. All phones on the market, or development images, support that framework by default.
+
+The cordova-ubuntu platform support code requires at least cordova-cli 4.3.1. This is the minimum and recommended version at the time of this writing. cordova-ubuntu 4.3.x releases are all compatible with that tool release.
For the latest information on Cordova app support for Ubuntu runtime platforms,
see [wiki.ubuntu.com/Cordova](http://wiki.ubuntu.com/Cordova).
-## Development Platform Requirements
+## Installing the Development Environment
+
+### Install Ubuntu
+
+Installation images of Ubuntu 16.04 LTS are available at http://www.ubuntu.com/download
-For this initial release, the development platform should be an Ubuntu Desktop.
-Ubuntu 13.10 (codename \u2018saucy\u2019) or later is required to enjoy the full set of
-supported capabilities.
+The simplest option is to download an Ubuntu Desktop image.
-You can install Cordova on non-Ubuntu systems (using npm), but important
-capabilities are only provided through Ubuntu debian packages at this time.
+In any case, the Debian packaging system will ensure that all underlying dependencies for the development environment will be installed. This lets you also install a build environment from an Ubuntu server installation as well.
-## Cordova Installation
+### Ubuntu Virtual Machine (optional)
+
+Ubuntu can also be used in a virtual machine.
+
+You can get an Ubuntu instance on all of the leading public clouds. In fact, Ubuntu is the most popular cloud operating system (http://www.ubuntu.com/cloud/public-cloud). Running in the cloud will let you build your Cordova application. However you will still need to connect a local instance to a phone via USB for testing your app.
+
+You can also install Ubuntu in local VM, with Virtualbox, VMWare or Parallels on either Windows or Mac OS. That configuration lets you re-direct a USB port inside the virtual machine, to let the Ubuntu build system access the Ubuntu phone hardware and install the app for testing.
+
+Refer to the documentation for either your public cloud of choice, or the local virtual machine for the details of the installation procedure.
+
+Once you have a basic Ubuntu VM set up, you can install the rest of the required elements below.
+
+### Node and NPM
+
+Ubuntu 16.04 LTS comes with the required versions of both NodeJS and NPM. To install simlpy do:
+
+```bash
+$ sudo apt-get install nodejs npm
+$ node -v
+v.4.2.6
+$ npm -v
+2.15.6
+```
-Add the Ubuntu Cordova
+### Cordova CLI
+
+The Cordova command line interface can be installed either via npm, or you can use a pre-packaged version available specifically for Ubuntu.
+
+The recommended installation path is to use the pre-packaged version for Ubuntu, as it generally contains Ubuntu specific fixes which may not all have been merged upstream.
+
+Installing the cordova-cli deb package requires to:
+1. Add the Ubuntu Cordova
[Personal Package Archive](https://launchpad.net/~cordova-ubuntu/+archive/ppa)
-to your Ubuntu system:
+to your Ubuntu system
+1. Install the cordova-cli package (and its dependencies)
```bash
-$ sudo add-apt-repository ppa:cordova-ubuntu/ppa
+$ sudo apt-add-repository ppa:cordova-ubuntu/ppa
$ sudo apt-get update
+$ sudo apt-get install cordova-cli
```
-Install cordova-cli package (and its dependencies):
+### Add an Ubuntu "click chroot"
+
+The build environment needs to be separated from the developer's environment, to prevent unwanted side effects and provide a clean, repeatable process.
+
+Ubuntu devices currently use the click packaging system.
+
+To produce click packages, a "click chroot" is required. It is a separate build environment designed to produce binaries, by having a build tools and dependencies contained inside a chroot.
+
+Generally, a click chroot hosts cross-compilation tools which can produce binaries for a different architecture (like armhf) than the one of the developer's system (generally x86).
+
+Last, the click chroot will need to be provisionned with libraries, or more generally "frameworks", corresponding to the target environment.
+
+Ubuntu devices will support the ubuntu-sdk-15.04 framework or later versions.
+
+### Create a click chroot environment
```bash
-$ sudo apt-get install cordova-cli
+$ sudo apt-add-repository ppa:ubuntu-sdk-team/ppa
+$ sudo apt-get update
+# this will create a clean click chroot build environment
+sudo apt-get install click-dev phablet-tools ubuntu-sdk-api-15.04
```
+### Add build dependencies for Cordova
+
+```bash
+# add build dependencies inside the click chroot
+sudo click chroot -a armhf -f ubuntu-sdk-15.04 install cmake libicu-dev:armhf pkg-config qtbase5-dev:armhf qtchooser qtdeclarative5-dev:armhf qtfeedback5-dev:armhf qtlocation5-dev:armhf qtmultimedia5-dev:armhf qtpim5-dev:armhf libqt5sensors5-dev:armhf qtsystems5-dev:armhf
+```
+
+### Ubuntu IDE (optional)
+
+You may also want to install the Ubuntu QtCreator development environment. See
+[developer.ubuntu.com](http://developer.ubuntu.com) for more info. (The
+QtCreator SDK is not required to add Ubuntu platform support to your Cordova
+app.)
+
+
## Project Workflow
+To test your installation, or simply to start developing an application, you can follow the steps below.
+
### Create a project
Creates an app in a `hello` directory whose display name is
`HelloWorld`:
```bash
-$ cordova create hello com.example.hello HelloWorld
+$ cordova create helloworld helloworld.ubuntudeveloper HelloWorld
+$ cd hello
+$ cordova platform add ubuntu
```
-### Move into the Project Directory
+Note that Ubuntu applications use a pair <appname>.<username> as a naming convention.
+
+### Add a Plugin
```bash
-$ cd hello
+$ cordova plugin add cordova-plugin-camera
```
-### Add the Ubuntu Platform
+### Build for Ubuntu devices
```bash
-$ cordova platform add ubuntu
+$ cordova build --device
```
-### Build for Ubuntu
+You can see detailed build logs with the following options:
+```bash
+$ cordova -d build --device -- --verbose
+```
+You can build your app for a different target framework by specifying the option below:
```bash
-$ cordova build ubuntu
+$ cordova -d build --device -- --framework=ubuntu-sdk-16.04
```
-### Run the App
+Note that for the latter to work, you will need to have a corresponding click chroot installed on your build system.
+
+### Run the App on an Ubuntu device
```bash
-$ cordova run ubuntu
+$ cordova run --device
```
-### Add the Camera Plugin
+This will:
+1. build the app for the device target
+1. package it using the click packaging system
+1. transfer the app on the device
+1. stop the app if it was already running
+1. install the app
+1. start the app
+
+
+## Debugging
+
+You can enable chrome devtools support to debug your app, by adding the --debug flag:
```bash
-$ cordova plugin add cordova-plugin-camera
-``
+$ cordova run --device --debug
+```
+
+Then simply connect to the URL mentioned in the logs.
+
+## Publishing your app
+
+Once you have finished developing and testing your app, you can publish it on the Ubuntu App Store.
+
+### Generate and verify the package
+
+Your app is already packaged in a format compatible with the app store. Just find the .click package generate by the cordova-ubuntu build system:
+
+```bash
+$ cordova build --device
+$ find -name "*.click"
+```
+
+You can manually verify that the package passes all verification steps enforced by the Ubuntu App Store system, by using the click-reviewer-tools:
+
+```bash
+$ click review -v <click file>
+```
+
+Note: this step is done automatically by the build system as well.
+
+### Sign up and upload to the app store
+
+You need to first create a free developer account on the Ubuntu App Store.
+
+Then you will be able to upload your package to the store and make it available to all users of Ubuntu devices.
+
+The full process is documented online at https://developer.ubuntu.com/en/publish/
+
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/support/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/support/index.md b/www/docs/en/6.x/guide/support/index.md
index 7e36376..a7a5928 100644
--- a/www/docs/en/6.x/guide/support/index.md
+++ b/www/docs/en/6.x/guide/support/index.md
@@ -43,6 +43,7 @@ CLI's shorthand names.
<th>Ubuntu</th>
<th>wp8<br/>(Windows Phone 8)</th>
<th>windows<br/>(8.1, 10,<br/>Phone 8.1)</th>
+ <th>OS X</th>
</tr>
</thead>
@@ -56,6 +57,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y">Ubuntu</td>
<td data-col="winphone8" class="y">Windows</td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y">Mac</td>
</tr>
<tr>
@@ -66,6 +68,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="n"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -76,6 +79,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"><a href="../platforms/wp8/plugin.html">(see details)</a></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -91,6 +95,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -98,9 +103,10 @@ CLI's shorthand names.
<td data-col="android" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="ubuntu" class="n"></td>
+ <td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y">* Windows Phone 8.1 only</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -111,6 +117,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -121,6 +128,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -131,6 +139,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -141,6 +150,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -148,9 +158,10 @@ CLI's shorthand names.
<td data-col="android" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="ubuntu" class="y"></td>
+ <td data-col="ubuntu" class="p">desktop only</td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="p">partially</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -161,6 +172,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -171,6 +183,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -181,6 +194,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -191,6 +205,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="n"></td>
<td data-col="winphone8" class="y">* Do not support onprogress nor abort</td>
<td data-col="win8" class="y">* Do not support onprogress nor abort</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -201,6 +216,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -211,6 +227,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -221,6 +238,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="p">uses iframe</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -241,6 +259,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -251,6 +270,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -261,6 +281,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="n"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y">Windows Phone 8.1 only</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -271,6 +292,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y">localStorage & indexedDB</td>
<td data-col="win8" class="y">localStorage & indexedDB</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -278,9 +300,10 @@ CLI's shorthand names.
<td data-col="android" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="ubuntu" class="n"></td>
+ <td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y">* Windows Phone 8.1 only</td>
+ <td data-col="osx" class="n"></td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/platform_plugin_versioning_ref/index.md b/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
index 00e3deb..b9eb822 100644
--- a/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
+++ b/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
@@ -144,18 +144,15 @@ $ cordova plugin save
```
-### Updating / Removing plugins
-It is also possible to update/delete from config.xml during the commands 'cordova plugin update' and 'cordova plugin remove' :
+### Removing plugins
+It is also possible to delete from config.xml during the command 'cordova plugin remove' :
```bash
-$ cordova plugin update <plugin[@<version>] | directory | git_url> --save
+
$ cordova plugin remove <plugin> --save
```
-Some examples :
+For example:
- * **'cordova plugin update cordova-plugin-console --save'** => In addition to updating the console plugin to the pinned version, update config.xml entry
- * **'cordova plugin update cordova-plugin-console@0.2.13 --save'** => In addition to updating the android plugin to version 3.8.0, update config.xml entry
- * **'cordova plugin update /path/to/console/plugin --save'** => In addition to updating the console plugin to version in the folder, update config.xml entry
* **'cordova plugin remove cordova-plugin-console --save'** => Removes the console plugin from the project and deletes its entry from config.xml.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/plugin_ref/spec.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/plugin_ref/spec.md b/www/docs/en/6.x/plugin_ref/spec.md
index c70d48f..8412660 100644
--- a/www/docs/en/6.x/plugin_ref/spec.md
+++ b/www/docs/en/6.x/plugin_ref/spec.md
@@ -365,6 +365,112 @@ 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>
+```
+#### Managing edit-config conflicts
+
+Multiple plugins can not 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 the updated plugins.
+
+There is an option for those who are certain that the plugin should be installed despite the conflicts. The `--force` flag can be used with `cordova plugin add`. Force adding the plugin will revert conflicting changes of other plugins so that it can be added without issues. `--force` should be used with caution as reverting changes of other plugins may cause the application to not work as expected.
+
+If the plugins ever get in a weird state, remove all plugins and re-add them.
+
+Example:
+
+Assume plugin-1 from above is already installed. Trying to install plugin-2 below will cause an error because plugin-1 has modified `uses-sdk` element in AndroidManifest.xml already.
+
+```xml
+<!-- plugin-2 -->
+<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
+ <uses-sdk android:minSdkVersion="15" />
+</edit-config>
+```
+
+There are a couple ways plugin-2 can be added:
+
+One possible resolution of the conflict is to remove the `edit-config` tag from plugin-2 and merge it into plugin-1's `edit-config` tag (assuming plugin-1 has no issue with this change). Remove both plugins and re-add them with these changes. plugin-2 should be added cleanly this time.
+
+Removing `edit-config` from plugin-2 and merging it into plugin-1:
+```xml
+<!-- plugin-1 -->
+<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
+ <uses-sdk android:minSdkVersion="15" 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>
+```
+
+The resulting AndroidManifest.xml after removing and re-adding both plugins:
+```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="15" android:targetSdkVersion="23" />
+</manifest>
+```
+
+The second way to add plugin-2 involves adding the plugin with `--force`. The conflicting `edit-config` change from plugin-1 will be reverted and plugin-2's change will be applied. The resulting AndroidManifest.xml will have the `uses-sdk` change from plugin-2 and the `activity` change from plugin-1. Notice only the `uses-sdk` change from plugin-1 is gone since it was the only conflicting change.
+
+The resulting AndroidManifest.xml after force adding plugin-2:
+```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:minSdkVersion="15" android:targetSdkVersion="23" />
+</manifest>
+```
+
+Note: Reverted changes from `--force` are gone for good. They will not reappear after removing the plugin that was force added. If the reverted changes are needed, all associated plugins should be removed and re-added.
+
### plugins-plist
Specifies a key and value to append to the correct `AppInfo.plist` file in an iOS Cordova project. This is _outdated_ as it only applies to cordova-ios 2.2.0 and below. Use the `<config-file>` tag for newer versions of Cordova.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-cli/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-cli/index.md b/www/docs/en/6.x/reference/cordova-cli/index.md
index e118d05..8fe7c38 100644
--- a/www/docs/en/6.x/reference/cordova-cli/index.md
+++ b/www/docs/en/6.x/reference/cordova-cli/index.md
@@ -43,7 +43,6 @@ These commands are available at all times.
|----------|--------------
| create | Create a project
| help <command> | Get help for a command
-| telemetry | Turn telemetry collection on or off
## Project Command List
@@ -71,7 +70,6 @@ These options apply to all cordova-cli commands.
| -v or --version | Print out the version of your `cordova-cli` install.
| --no-update-notifier | Will disable updates check. Alternatively set `"optOut": true` in `~/.config/configstore/update-notifier-cordova.json` or set `NO_UPDATE_NOTIFIER` environment variable with any value (see details in [update-notifier docs](https://www.npmjs.com/package/update-notifier#user-settings)).
|--nohooks | Suppress executing hooks (taking RegExp hook patterns as parameters)
-| --no-telemetry | Disable telemetry collection for the current command.
## Platform-specific options
@@ -85,12 +83,8 @@ Certain commands have options (`platformOpts`) that are specific to a particular
cd myApp
# Add camera plugin to the project and remember that in config.xml
cordova plugin add cordova-plugin-camera --save
- # Add camera plugin to the project and remember that in config.xml. Use npm install to fetch.
- cordova plugin add cordova-plugin-camera --save --fetch
# Add android platform to the project and remember that in config.xml
cordova platform add android --save
- # Add android platform to the project and remember that in config.xml. Use npm install to fetch.
- cordova platform add android --save --fetch
# Check to see if your system is configured for building android platform.
cordova requirements android
# Build the android and emit verbose logs.
@@ -129,7 +123,7 @@ cordova create path [id [name [config]]] [options]
### Directory structure
-Cordova CLI works with the following directory structure:
+A Cordova application created with `cordova-cli` will have the following directory structure:
```
myapp/
@@ -213,12 +207,11 @@ Manage cordova platforms - allowing you to add, remove, update, list and check f
```bash
cordova {platform | platforms} [
- add <platform-spec> [...] {--save | link=<path> | --fetch } |
- {remove | rm} platform [...] {--save | --fetch}|
+ add <platform-spec> [...] {--save | link=<path> } |
+ {remove | rm} platform [...] |
{list | ls} |
check |
- save |
- update ]
+ save ]
```
| Sub-command | Option | Description |
@@ -226,13 +219,10 @@ cordova {platform | platforms} [
| add `<platform-spec>` [...] | | Add specified platforms |
| | --save | Save `<platform-spec>` into `config.xml` after installing them using `<engine>` tag |
| | --link=`<path>` | When `<platform-spec>` is a local path, links the platform library directly instead of making a copy of it (support varies by platform; useful for platform development)
-| | --fetch | Fetches the platform using `npm install` and stores it into the apps `node_modules` directory |
| remove `<platform>` [...] | | Remove specified platforms |
| | --save | Delete specified platforms from `config.xml` after removing them |
-| | --fetch | Removes the platform using `npm uninstall` and removes it from the apps `node_modules` directory |
| update `platform` [...] | | Update specified platforms |
| | --save | Updates the version specified in `config.xml` |
-| | --fetch | Fetches the platform using `npm install` and stores it into the apps `node_modules` directory |
| list | | List all installed and available platforms |
| check | | List platforms which can be updated by `cordova-cli platform update` |
| save | | Save `<platform-spec>` of all platforms added to config.xml |
@@ -275,11 +265,6 @@ There are a number of ways to specify a platform:
cordova platform add android ios --save
-- Add pinned version of the `android` and `ios` platform and save the downloaded version to `config.xml`. Install
-to the project using `npm install` and store it in the apps `node_modules` directory:
-
- cordova platform add android ios --save --fetch
-
- Add `android` platform with [semver](http://semver.org/) version ^5.0.0 and save it to `config.xml`:
cordova platform add android@^5.0.0 --save
@@ -300,11 +285,6 @@ to the project using `npm install` and store it in the apps `node_modules` direc
cordova platform rm android --save
-- Remove `android` platform from the project and from `config.xml`. Run `npm uninstall` to remove it
-from the `node_modules` directory.
-
- cordova platform rm android --save --fetch
-
- List available and installed platforms with version numbers. This is useful to find version numbers when reporting issues:
cordova platform ls
@@ -323,8 +303,8 @@ Manage project plugins
```bash
cordova {plugin | plugins} [
- add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --browserify | --force | --fetch} |
- {remove | rm} {<pluginid> | <name>} --save --fetch |
+ add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --browserify | --force} |
+ {remove | rm} {<pluginid> | <name>} --save |
{list | ls} |
search [<keyword>] |
save |
@@ -334,16 +314,14 @@ cordova {plugin | plugins} [
| Sub-command | Option | Description
|------------------------|-------------|------
| add `<plugin-spec>` [...] | | Add specified plugins
-| |--searchpath `<directory>` | When looking up plugins by ID, look in this directory and each of its subdirectories before hitting the registry. Multiple search paths can be specified. Use ':' as a separator in `*nix` based systems and ';' for Windows.
+| |--searchpath `<directory>` | When looking up plugins by ID, look in this directory and each of its subdirectories before hitting the registry. Multiple search paths can be specified. Use ':' as a separator in *nix based systems and ';' for Windows.
| |--noregistry | Don't search the registry for plugins.
| |--link | When installing from a local path, creates a symbolic link instead of copying files. The extent to which files are linked varies by platform. Useful for plugin development.
| |--save | Save the `<plugin-spec>` as part of the `plugin` element into `config.xml`.
| |--browserify | Compile plugin JS at build time using browserify instead of runtime.
| |--force | _Introduced in version 6.1._ Forces copying source files from the plugin even if the same file already exists in the target directory.
-| |--fetch | Fetches the plugin using `npm install` and stores it into the apps `node_modules` directory |
| remove `<pluginid>|<name>` [...]| | Remove plugins with the given IDs/name.
| |--save | Remove the specified plugin from config.xml
-| |--fetch | Removes the plugin using `npm uninstall` and removes it from the apps `node_modules` directory |
|list | | List currently installed plugins
|search `[<keyword>]` [...] | | Search http://plugins.cordova.io for plugins matching the keywords
|save | | Save `<plugin-spec>` of all plugins currently added to the project
@@ -352,17 +330,16 @@ cordova {plugin | plugins} [
There are a number of ways to specify a plugin:
- <plugin-spec> : [@scope/]pluginID[@version]|directory|url[#commit-ish][:subdir]
+ <plugin-spec> : pluginID[@version]|directory|url[#commit-ish][:subdir]
| Value | Description
|-------------|--------------------
-| scope | Scope of plugin published as a [scoped npm package]
| plugin | Plugin id (id of plugin in npm registry or in --searchPath)
| version | Major.minor.patch version specifier using semver
| directory | Directory containing plugin.xml
| url | Url to a git repository containing a plugin.xml
| commit-ish | Commit/tag/branch reference. If none is specified, 'master' is used
-| subdir | Sub-directory to find plugin.xml for the specified plugin. (Doesn't work with `--fetch` option)
+| subdir | Sub-directory to find plugin.xml for the specified plugin.
### Algorithm for resolving plugins
@@ -384,10 +361,6 @@ based on the following criteria (listed in order of precedence):
cordova plugin add cordova-plugin-camera@^2.0.0 --save
-- Add `cordova-plugin-camera` with [semver](http://semver.org/) version ^2.0.0 and `npm install` it. It will be stored in the `node_modules` directory:
-
- cordova plugin add cordova-plugin-camera@^2.0.0 --fetch
-
- Clone the specified git repo, checkout to tag `2.1.0`, look for plugin.xml in the `plugin` directory, and add it to the project. Save the `plugin-spec` to `config.xml`:
cordova plugin add https://github.com/apache/cordova-plugin-camera.git#2.1.0:plugin --save
@@ -404,10 +377,6 @@ based on the following criteria (listed in order of precedence):
cordova plugin rm camera --save
-- Remove the plugin from the project and `npm uninstall` it. Removes it from the `node_modules` directory:
-
- cordova plugin rm camera --fetch
-
- List all plugins installed in the project:
cordova plugin ls
@@ -423,7 +392,7 @@ copies plugin files for specified platforms so that the project is ready to buil
```
cordova prepare [<platform> [..]]
- [--browserify | --fetch]
+ [--browserify]
```
###Options
@@ -432,8 +401,6 @@ cordova prepare [<platform> [..]]
|------------|------------------
| `<platform> [..]` | Platform name(s) to prepare. If not specified, all platforms are built.
|--browserify | Compile plugin JS at build time using browserify instead of runtime.
-|--fetch | When restoring plugins or platforms, fetch will `npm install` the missing modules.
-
## cordova compile command
@@ -500,31 +467,29 @@ cordova build [<platform> [...]]
### Synopsis
-Prepares, builds, and deploys app on specified platform devices/emulators. If a device is connected it will be used, unless an eligible emulator is already running.
+Prepares, builds (unless `--nobuild` is specified) and deploys app on specified platform devices/emulators. If a device is connected it will be used, unless an eligible emulator is already running.
###Syntax
```bash
cordova run [<platform> [...]]
- [--list | --debug | --release]
- [--noprepare] [--nobuild]
+ [--list | --nobuild ]
[--device|--emulator|--target=<targetName>]
[--buildConfig=<configfile>]
[--browserify]
[-- <platformOpts>]
```
-| Option | Description
-|-------------|------------------
+| Option | Description
+|------------|------------------
| `<platform> [..]` | Platform name(s) to run. If not specified, all platforms are run.
-| --list | Lists available targets. Displays both device and emulator deployment targets unless specified
-| --debug | Deploy a debug build. This is the default behavior unless `--release` is specified.
-| --release | Deploy a release build
-| --noprepare | Skip preparing (available in Cordova v6.2 or later)
-| --nobuild | Skip building
-| --device | Deploy to a device
-| --emulator | Deploy to an emulator
-| --target | Deploy to a specific target emulator/device. Use `--list` to display target options
+|--nobuild | Skip building
+|--debug | Deploy a debug build. This is the default behavior unless `--release` is specified.
+|--release | Deploy a release build
+|--device | Deploy to a device
+|--emulator | Deploy to an emulator
+|--target | Deploy to a specific target emulator/device. Use `--list` to display target options
+| --list | Lists available targets. Displays both device and emulator deployment targets unless specified
| --buildConfig=`<configFile>` | Default: build.json in cordova root directory. <br/> Use the specified build configuration file. `build.json` file is used to specify paramaters to customize the app build process esecially related to signing the package.
| --browserify | Compile plugin JS at build time using browserify instead of runtime
| `<platformOpts>` | To provide platform specific options, you must include them after `--` separator. Review platform guide docs for more details.
@@ -616,38 +581,6 @@ Run a local web server for www/ assets using specified `port` or default of 8000
cordova serve [port]
```
-## cordova telemetry command
-
-### Synopsis
-
-Turns telemetry collection on or off.
-
-### Syntax
-
-```
-cordova telemetry [STATE]
-```
-
-| Option | Description
-|-------------|------------------
-| on | Turn telemetry collection on.
-| off | Turn telemetry collection off.
-
-### Details
- A timed prompt asking the user to opt-in or out is displayed the first time cordova is run.
- It lasts for 30 seconds, after which the user is automatically opted-out if he doesn't provide any answer.
- In CI environments, the `CI` environment variable can be set, which will prevent the prompt from showing up.
- Telemetry collection can also be turned off on a single command by using the `--no-telemetry` flag.
-
-### Examples
-```
-cordova telemetry on
-cordova telemetry off
-cordova build --no-telemetry
-```
-
-For details, see our privacy notice: https://cordova.apache.org/privacy
-
## cordova help command
### Synopsis
@@ -665,4 +598,3 @@ cordova -h [command]
[Hooks guide]: http://cordova.apache.org/docs/en/latest/guide_appdev_hooks_index.md.html
[config.xml ref]: http://cordova.apache.org/docs/en/latest/config_ref/index.html
[Cordova dependencies]: http://cordova.apache.org/docs/en/latest/guide/hybrid/plugins/index.html#specifying-project-requirements
-[scoped npm package]: https://docs.npmjs.com/misc/scope
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md b/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md
index 03471d1..74a9818 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-battery-status/blob/master/README.md'
-title: Battery Status
+title: cordova-plugin-battery-status
plugin_name: cordova-plugin-battery-status
plugin_version: master
-description: Get events for device battery level.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-camera/index.md b/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
index a9181c1..a6c91d7 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-camera/blob/master/README.md'
-title: Camera
+title: cordova-plugin-camera
plugin_name: cordova-plugin-camera
plugin_version: master
-description: Take pictures with the device camera.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -83,20 +82,20 @@ Documentation consists of template and API docs produced from the plugin JS code
* [camera](#module_camera)
- * [.getPicture(successCallback, errorCallback, options)](#module_camera.getPicture)
- * [.cleanup()](#module_camera.cleanup)
- * [.onError](#module_camera.onError) : <code>function</code>
- * [.onSuccess](#module_camera.onSuccess) : <code>function</code>
- * [.CameraOptions](#module_camera.CameraOptions) : <code>Object</code>
+ * [.getPicture(successCallback, errorCallback, options)](#module_camera.getPicture)
+ * [.cleanup()](#module_camera.cleanup)
+ * [.onError](#module_camera.onError) : <code>function</code>
+ * [.onSuccess](#module_camera.onSuccess) : <code>function</code>
+ * [.CameraOptions](#module_camera.CameraOptions) : <code>Object</code>
* [Camera](#module_Camera)
- * [.DestinationType](#module_Camera.DestinationType) : <code>enum</code>
- * [.EncodingType](#module_Camera.EncodingType) : <code>enum</code>
- * [.MediaType](#module_Camera.MediaType) : <code>enum</code>
- * [.PictureSourceType](#module_Camera.PictureSourceType) : <code>enum</code>
- * [.PopoverArrowDirection](#module_Camera.PopoverArrowDirection) : <code>enum</code>
- * [.Direction](#module_Camera.Direction) : <code>enum</code>
+ * [.DestinationType](#module_Camera.DestinationType) : <code>enum</code>
+ * [.EncodingType](#module_Camera.EncodingType) : <code>enum</code>
+ * [.MediaType](#module_Camera.MediaType) : <code>enum</code>
+ * [.PictureSourceType](#module_Camera.PictureSourceType) : <code>enum</code>
+ * [.PopoverArrowDirection](#module_Camera.PopoverArrowDirection) : <code>enum</code>
+ * [.Direction](#module_Camera.Direction) : <code>enum</code>
* [CameraPopoverHandle](#module_CameraPopoverHandle)
* [CameraPopoverOptions](#module_CameraPopoverOptions)
@@ -104,10 +103,8 @@ Documentation consists of template and API docs produced from the plugin JS code
---
<a name="module_camera"></a>
-
## camera
<a name="module_camera.getPicture"></a>
-
### camera.getPicture(successCallback, errorCallback, options)
Takes a photo using the camera, or retrieves a photo from the device's
image gallery. The image is passed to the success callback as a
@@ -175,7 +172,6 @@ More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPict
navigator.camera.getPicture(cameraSuccess, cameraError, cameraOptions);
```
<a name="module_camera.cleanup"></a>
-
### camera.cleanup()
Removes intermediate image files that are kept in temporary storage
after calling [`camera.getPicture`](#module_camera.getPicture). Applies only when the value of
@@ -200,7 +196,6 @@ function onFail(message) {
}
```
<a name="module_camera.onError"></a>
-
### camera.onError : <code>function</code>
Callback function that provides an error message.
@@ -211,7 +206,6 @@ Callback function that provides an error message.
| message | <code>string</code> | The message is provided by the device's native code. |
<a name="module_camera.onSuccess"></a>
-
### camera.onSuccess : <code>function</code>
Callback function that provides the image data.
@@ -231,7 +225,6 @@ function cameraCallback(imageData) {
}
```
<a name="module_camera.CameraOptions"></a>
-
### camera.CameraOptions : <code>Object</code>
Optional parameters to customize the camera settings.
* [Quirks](#CameraOptions-quirks)
@@ -257,10 +250,8 @@ Optional parameters to customize the camera settings.
---
<a name="module_Camera"></a>
-
## Camera
<a name="module_Camera.DestinationType"></a>
-
### Camera.DestinationType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -272,7 +263,6 @@ Optional parameters to customize the camera settings.
| NATIVE_URI | <code>number</code> | <code>2</code> | Return native uri (eg. asset-library://... for iOS) |
<a name="module_Camera.EncodingType"></a>
-
### Camera.EncodingType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -283,7 +273,6 @@ Optional parameters to customize the camera settings.
| PNG | <code>number</code> | <code>1</code> | Return PNG encoded image |
<a name="module_Camera.MediaType"></a>
-
### Camera.MediaType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -295,7 +284,6 @@ Optional parameters to customize the camera settings.
| ALLMEDIA | <code>number</code> | <code>2</code> | Allow selection from all media types |
<a name="module_Camera.PictureSourceType"></a>
-
### Camera.PictureSourceType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -307,7 +295,6 @@ Optional parameters to customize the camera settings.
| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image from picture library (same as PHOTOLIBRARY for Android) |
<a name="module_Camera.PopoverArrowDirection"></a>
-
### Camera.PopoverArrowDirection : <code>enum</code>
Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover.
@@ -323,7 +310,6 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
| ARROW_ANY | <code>number</code> | <code>15</code> |
<a name="module_Camera.Direction"></a>
-
### Camera.Direction : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -336,15 +322,8 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
---
<a name="module_CameraPopoverOptions"></a>
-
## CameraPopoverOptions
-iOS-only parameters that specify the anchor element location and arrow
-direction of the popover when selecting images from an iPad's library
-or album.
-Note that the size of the popover may change to adjust to the
-direction of the arrow and orientation of the screen. Make sure to
-account for orientation changes when specifying the anchor element
-location.
+iOS-only parameters that specify the anchor element location and arrow
direction of the popover when selecting images from an iPad's library
or album.
Note that the size of the popover may change to adjust to the
direction of the arrow and orientation of the screen. Make sure to
account for orientation changes when specifying the anchor element
location.
| Param | Type | Default | Description |
@@ -358,7 +337,6 @@ location.
---
<a name="module_CameraPopoverHandle"></a>
-
## CameraPopoverHandle
A handle to an image picker popover.
@@ -557,202 +535,3 @@ Tizen only supports a `destinationType` of
[web_activities]: https://hacks.mozilla.org/2013/01/introducing-web-activities/
[wp8_bug]: https://issues.apache.org/jira/browse/CB-2083
[msdn_wp8_docs]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh394006.aspx
-
-## Sample: Take Pictures, Select Pictures from the Picture Library, and Get Thumbnails <a name="sample"></a>
-
-The Camera plugin allows you to do things like open the device's Camera app and take a picture, or open the file picker and select one. The code snippets in this section demonstrate different tasks including:
-
-* Open the Camera app and [take a Picture](#takePicture)
-* Take a picture and [return thumbnails](#getThumbnails) (resized picture)
-* Take a picture and [generate a FileEntry object](#convert)
-* [Select a file](#selectFile) from the picture library
-* Select a JPEG image and [return thumbnails](#getFileThumbnails) (resized image)
-* Select an image and [generate a FileEntry object](#convert)
-
-## Take a Picture <a name="takePicture"></a>
-
-Before you can take a picture, you need to set some Camera plugin options to pass into the Camera plugin's `getPicture` function. Here is a common set of recommendations. In this example, you create the object that you will use for the Camera options, and set the `sourceType` dynamically to support both the Camera app and the file picker.
-
-```js
-function setOptions(srcType) {
- var options = {
- // Some common settings are 20, 50, and 100
- quality: 50,
- destinationType: Camera.DestinationType.FILE_URI,
- // In this app, dynamically set the picture source, Camera or photo gallery
- sourceType: srcType,
- encodingType: Camera.EncodingType.JPEG,
- mediaType: Camera.MediaType.PICTURE,
- allowEdit: true,
- correctOrientation: true //Corrects Android orientation quirks
- }
- return options;
-}
-```
-
-Typically, you want to use a FILE_URI instead of a DATA_URL to avoid most memory issues. JPEG is the recommended encoding type for Android.
-
-You take a picture by passing in the options object to `getPicture`, which takes a CameraOptions object as the third argument. When you call `setOptions`, pass `Camera.PictureSourceType.CAMERA` as the picture source.
-
-```js
-function openCamera(selection) {
-
- var srcType = Camera.PictureSourceType.CAMERA;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- displayImage(imageUri);
- // You may choose to copy the picture, save it somewhere, or upload.
- func(imageUri);
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-Once you take the picture, you can display it or do something else. In this example, call the app's `displayImage` function from the preceding code.
-
-```js
-function displayImage(imgUri) {
-
- var elem = document.getElementById('imageFile');
- elem.src = imgUri;
-}
-```
-
-To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example.
-
-```html
-<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">
-```
-
-## Take a Picture and Return Thumbnails (Resize the Picture) <a name="getThumbnails"></a>
-
-To get smaller images, you can return a resized image by passing both `targetHeight` and `targetWidth` values with your CameraOptions object. In this example, you resize the returned image to fit in a 100px by 100px box (the aspect ratio is maintained, so 100px is either the height or width, whichever is greater in the source).
-
-```js
-function openCamera(selection) {
-
- var srcType = Camera.PictureSourceType.CAMERA;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- if (selection == "camera-thmb") {
- options.targetHeight = 100;
- options.targetWidth = 100;
- }
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- // Do something
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-## Select a File from the Picture Library <a name="selectFile"></a>
-
-When selecting a file using the file picker, you also need to set the CameraOptions object. In this example, set the `sourceType` to `Camera.PictureSourceType.SAVEDPHOTOALBUM`. To open the file picker, call `getPicture` just as you did in the previous example, passing in the success and error callbacks along with CameraOptions object.
-
-```js
-function openFilePicker(selection) {
-
- var srcType = Camera.PictureSourceType.SAVEDPHOTOALBUM;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- // Do something
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-## Select an Image and Return Thumbnails (resized images) <a name="getFileThumbnails"></a>
-
-Resizing a file selected with the file picker works just like resizing using the Camera app; set the `targetHeight` and `targetWidth` options.
-
-```js
-function openFilePicker(selection) {
-
- var srcType = Camera.PictureSourceType.SAVEDPHOTOALBUM;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- if (selection == "picker-thmb") {
- // To downscale a selected image,
- // Camera.EncodingType (e.g., JPEG) must match the selected image type.
- options.targetHeight = 100;
- options.targetWidth = 100;
- }
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- // Do something with image
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-## Take a picture and get a FileEntry Object <a name="convert"></a>
-
-If you want to do something like copy the image to another location, or upload it somewhere using the FileTransfer plugin, you need to get a FileEntry object for the returned picture. To do that, call `window.resolveLocalFileSystemURL` on the file URI returned by the Camera app. If you need to use a FileEntry object, set the `destinationType` to `Camera.DestinationType.FILE_URI` in your CameraOptions object (this is also the default value).
-
->*Note* You need the [File plugin](https://www.npmjs.com/package/cordova-plugin-file) to call `window.resolveLocalFileSystemURL`.
-
-Here is the call to `window.resolveLocalFileSystemURL`. The image URI is passed to this function from the success callback of `getPicture`. The success handler of `resolveLocalFileSystemURL` receives the FileEntry object.
-
-```js
-function getFileEntry(imgUri) {
- window.resolveLocalFileSystemURL(imgUri, function success(fileEntry) {
-
- // Do something with the FileEntry object, like write to it, upload it, etc.
- // writeFile(fileEntry, imgUri);
- console.log("got file: " + fileEntry.fullPath);
- // displayFileData(fileEntry.nativeURL, "Native URL");
-
- }, function () {
- // If don't get the FileEntry (which may happen when testing
- // on some emulators), copy to a new FileEntry.
- createNewFileEntry(imgUri);
- });
-}
-```
-
-In the example shown in the preceding code, you call the app's `createNewFileEntry` function if you don't get a valid FileEntry object. The image URI returned from the Camera app should result in a valid FileEntry, but platform behavior on some emulators may be different for files returned from the file picker.
-
->*Note* To see an example of writing to a FileEntry, see the [File plugin README](https://www.npmjs.com/package/cordova-plugin-file).
-
-The code shown here creates a file in your app's cache (in sandboxed storage) named `tempFile.jpeg`. With the new FileEntry object, you can copy the image to the file or do something else like upload it.
-
-```js
-function createNewFileEntry(imgUri) {
- window.resolveLocalFileSystemURL(cordova.file.cacheDirectory, function success(dirEntry) {
-
- // JPEG file
- dirEntry.getFile("tempFile.jpeg", { create: true, exclusive: false }, function (fileEntry) {
-
- // Do something with it, like write to it, upload it, etc.
- // writeFile(fileEntry, imgUri);
- console.log("got file: " + fileEntry.fullPath);
- // displayFileData(fileEntry.fullPath, "File copied to");
-
- }, onErrorCreateFile);
-
- }, onErrorResolveUrl);
-}
-```
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-console/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-console/index.md b/www/docs/en/6.x/reference/cordova-plugin-console/index.md
index 319c250..127a041 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-console/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-console/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-console/blob/master/README.md'
-title: Console
+title: cordova-plugin-console
plugin_name: cordova-plugin-console
plugin_version: master
-description: Get JavaScript logs in your native logs.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org