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 2017/05/04 15:02:13 UTC
[32/52] [abbrv] [partial] docs commit: CB-12747: added 7.x docs
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5ad93d20/www/docs/en/7.x/reference/cordova-cli/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/7.x/reference/cordova-cli/index.md b/www/docs/en/7.x/reference/cordova-cli/index.md
new file mode 100644
index 0000000..f248980
--- /dev/null
+++ b/www/docs/en/7.x/reference/cordova-cli/index.md
@@ -0,0 +1,675 @@
+---
+edit_link: 'https://github.com/apache/cordova-cli/blob/master/doc/readme.md'
+title: CLI Reference
+description: Learn how to use Cordova CLI commands and their options.
+---
+
+<!-- WARNING: This file is generated. See fetch_docs.js. -->
+
+<!--
+#
+# 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.
+#
+-->
+
+# Cordova Command-line-interface (CLI) Reference
+
+## Syntax
+
+```bash
+cordova <command> [options] -- [platformOpts]
+```
+
+## Global Command List
+
+These commands are available at all times.
+
+| Command | Description
+|----------|--------------
+| create | Create a project
+| help <command> | Get help for a command
+| telemetry | Turn telemetry collection on or off
+
+## Project Command List
+
+These commands are supported when the current working directory is a valid Cordova project.
+
+| Command | Description
+|--------------|--------------
+| info | Generate project information
+| requirements | Checks and print out all the installation requirements for platforms specified
+| platform | Manage project platforms
+| plugin | Manage project plugins
+| prepare | Copy files into platform(s) for building
+| compile | Build platform(s)
+| clean | Cleanup project from build artifacts
+| run | Run project (including prepare && compile)
+| serve | Run project with a local webserver (including prepare)
+
+## Common options
+
+These options apply to all cordova-cli commands.
+
+| Option | Description
+|----------------------|------------------------
+| -d or --verbose | Pipe out more verbose output to your shell. You can also subscribe to `log` and `warn` events if you are consuming `cordova-cli` as a node module by calling `cordova.on('log', function() {})` or `cordova.on('warn', function() {})`.
+| -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
+
+Certain commands have options (`platformOpts`) that are specific to a particular platform. They can be provided to the cordova-cli with a '--' separator that stops the command parsing within the cordova-lib module and passes through rest of the options for platforms to parse.
+
+## Examples
+- This example demonstrates how cordova-cli can be used to create a project with the `camera` plugin and run it for `android` platform. In particular, platform specific options like `--keystore` can be provided:
+
+ # Create a cordova project
+ cordova create myApp com.myCompany.myApp myApp
+ 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.
+ cordova build android --verbose
+ # Run the project on the android platform.
+ cordova run android
+ # Build for android platform in release mode with specified signing parameters.
+ cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
+
+## cordova create command
+
+### Synopsis
+
+Create the directory structure for the Cordova project in the specified path.
+
+### Syntax
+
+```
+cordova create path [id [name [config]]] [options]
+```
+
+| Value | Description |
+|-------|---------------|
+| path | Directory which should not already exist. Cordova will create this directory. For more details on the directory structure, see below. |
+| id | _Default_: `io.cordova.hellocordova` <br/> Reverse domain-style identifier that maps to `id` attribute of `widget` element in `config.xml`. This can be changed but there may be code generated using this value, such as Java package names. It is recommended that you select an appropriate value. |
+| name | _Default_: `HelloCordova` <br/> Application's display title that maps `name` element in `config.xml` file. This can be changed but there may be code generated using this value, such as Java class names. The default value is `HelloCordova`, but it is recommended that you select an appropriate value. |
+| config | JSON string whose key/values will be included in `<path>`/.cordova/config.json |
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| --template | Use a custom template located locally, in NPM, or GitHub. |
+| --copy-from\|--src | _Deprecated_ <br/> Use --template instead. Specifies a directory from which to copy the current Cordova project. |
+|--link-to | Symlink to specified `www` directory without creating a copy. |
+
+### Directory structure
+
+Cordova CLI works with the following directory structure:
+
+```
+myapp/
+|-- config.xml
+|-- hooks/
+|-- merges/
+| | |-- android/
+| | |-- windows/
+| | |-- ios/
+|-- www/
+|-- platforms/
+| |-- android/
+| |-- windows/
+| |-- ios/
+|-- plugins/
+ |--cordova-plugin-camera/
+```
+
+#### config.xml
+
+Configures your application and allows you to customize the behavior of your project. See also [config.xml reference documentation][config.xml ref]
+
+#### www/
+
+Contains the project's web artifacts, such as .html, .css and .js files. As a cordova application developer, most of your code and assets will go here. They will be copied on a `cordova prepare` to each platform's www directory. The www source directory is reproduced within each platform's subdirectory, appearing for example in `platforms/ios/www` or `platforms/android/assets/www`. Because the CLI constantly copies over files from the source www folder, you should only edit these files and not the ones located under the platforms subdirectories. If you use version control software, you should add this source www folder, along with the merges folder, to your version control system.
+
+#### platforms/
+
+Contains all the source code and build scripts for the platforms that you add to your project.
+
+> **WARNING:** When using the CLI to build your application, you should not edit any files in the /platforms/ directory unless you know what you are doing, or if documentation specifies otherwise. The files in this directory are routinely overwritten when preparing applications for building, or when plugins are re-installed.
+
+#### plugins/
+
+Any added plugins will be extracted or copied into this directory.
+
+#### hooks/
+
+This directory may contains scripts used to customize cordova-cli commands. Any scripts you add to these directories will be executed before and after the commands corresponding to the directory name. Useful for integrating your own build systems or integrating with version control systems.
+
+Refer to [Hooks Guide] for more information.
+
+#### merges/
+
+Platform-specific web assets (HTML, CSS and JavaScript files) are contained within appropriate subfolders in this directory. These are deployed during a `prepare` to the appropriate native directory. Files placed under `merges/` will override matching files in the `www/` folder for the relevant platform. A quick example, assuming a project structure of:
+
+```
+merges/
+|-- ios/
+| -- app.js
+|-- android/
+| -- android.js
+www/
+-- app.js
+```
+
+After building the Android and iOS projects, the Android application will contain both `app.js` and `android.js`. However, the iOS application will only contain an `app.js`, and it will be the one from `merges/ios/app.js`, overriding the "common" `app.js` located inside `www/`.
+
+#### Version control
+
+It is recommended not to check in `platforms/` and `plugins/` directories into version control as they are considered a build artifact. Instead, you should save the platform/plugin spec in the `config.xml` and they will be downloaded when on the machine when `cordova prepare` is invoked.
+
+### Examples
+
+- Create a Cordova project in `myapp` directory using the specified ID and display name:
+
+ cordova create myapp com.mycompany.myteam.myapp MyApp
+
+- Create a Cordova project with a symlink to an existing `www` directory. This can be useful if you have a custom build process or existing web assets that you want to use in your Cordova app:
+
+ cordova create myapp --link-to=../www
+
+
+## cordova platform command
+
+### Synopsis
+
+Manage cordova platforms - allowing you to add, remove, update, list and check for updates. Running commands to add or remove platforms affects the contents of the project's platforms directory.
+
+### Syntax
+
+```bash
+cordova {platform | platforms} [
+ add <platform-spec> [...] {--save | link=<path> | --fetch } |
+ {remove | rm} platform [...] {--save | --fetch}|
+ {list | ls} |
+ check |
+ save |
+ update ]
+```
+
+| Sub-command | Option | Description |
+------------------------|-------------|------|
+| 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 |
+
+### Platform-spec
+
+There are a number of ways to specify a platform:
+
+```
+<platform-spec> : platform[@version] | path | url[#commit-ish]
+```
+
+| Value | Description |
+|-----------|-------------|
+| platform | Platform name e.g. android, ios, windows etc. to be added to the project. Every release of cordova CLI pins a version for each platform. When no version is specified this version is used to add the platform. |
+| version | Major.minor.patch version specifier using semver |
+| path | Path to a directory or tarball containing a platform |
+| url | URL to a git repository or tarball containing a platform |
+| commit-ish | Commit/tag/branch reference. If none is specified, 'master' is used |
+
+### Supported Platforms
+
+- Android
+- iOS
+- Windows (8.1, Phone 8.1, UWP - Windows 10)
+- Blackberry10
+- Ubuntu
+- Browser
+
+### Deprecated Platforms
+
+- Amazon-fireos (use Android platform instead)
+- WP8 (use Windows platform instead)
+- Windows 8.0 (use older versions of cordova)
+- Firefox OS (use older versions of cordova)
+
+### Examples
+
+- Add pinned version of the `android` and `ios` platform and save the downloaded version to `config.xml`:
+
+ 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
+
+- Add platform by cloning the specified git repo and checkout to the `4.0.0` tag:
+
+ cordova platform add https://github.com/myfork/cordova-android.git#4.0.0
+
+- Add platform using a local directory named `android`:
+
+ cordova platform add ../android
+
+- Add platform using the specified tarball:
+
+ cordova platform add ../cordova-android.tgz
+
+- Remove `android` platform from the project and from `config.xml`:
+
+ 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
+
+- Save versions of all platforms currently added to the project to `config.xml`.
+
+ cordova platform save
+
+## cordova plugin command
+
+### Synopsis
+
+Manage project plugins
+
+### Syntax
+
+```bash
+cordova {plugin | plugins} [
+ add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --browserify | --force | --fetch} |
+ {remove | rm} {<pluginid> | <name>} --save --fetch |
+ {list | ls} |
+ search [<keyword>] |
+ save |
+]
+```
+
+| 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.
+| |--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
+
+### Plugin-spec
+
+There are a number of ways to specify a plugin:
+
+ <plugin-spec> : [@scope/]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)
+
+### Algorithm for resolving plugins
+
+When adding a plugin to a project, the CLI will resolve the plugin
+based on the following criteria (listed in order of precedence):
+
+1. The `plugin-spec` given in the command (e.g. `cordova plugin add pluginID@version`)
+2. The `plugin-spec` saved in `config.xml` (i.e. if the plugin was previously added with `--save`)
+3. As of Cordova version 6.1, the latest plugin version published to npm that the current project can support (only applies to plugins that list their [Cordova dependencies] in their `package.json`)
+4. The latest plugin version published to npm
+
+### Examples
+
+- Add `cordova-plugin-camera` and `cordova-plugin-file` to the project and save it to `config.xml`. Use `../plugins` directory to search for the plugins.
+
+ cordova plugin add cordova-plugin-camera cordova-plugin-file --save --searchpath ../plugins
+
+- Add `cordova-plugin-camera` with [semver](http://semver.org/) version ^2.0.0 and save it to `config.xml`:
+
+ 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
+
+- Add the plugin from the specified local directory:
+
+ cordova plugin add ../cordova-plugin-camera
+
+- Add the plugin from the specified tarball file:
+
+ cordova plugin add ../cordova-plugin-camera.tgz --save
+
+- Remove the plugin from the project and the `config.xml`:
+
+ 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
+
+### Conflicting plugins
+Conflicting plugins may occur when adding plugins that use `edit-config` tags in their plugin.xml file. `edit-config` allows plugins to add or replace attributes of XML elements.
+
+This feature can cause issues with the application if more than one plugin tries to modify the same XML element. Conflict detection has been implemented to prevent plugins from being added so one plugin doesn't try to overwrite another plugin's `edit-config` changes. An error will be thrown when a conflict in `edit-config` has been found and the plugin won't be added. The error message will mention that all conflicts must be resolved before the plugin can be added. One option to resolving the `edit-config` conflict is to make changes to the affected plugins' plugin.xml so that they do not modify the same XML element. The other option is to use the `--force` flag to force add the plugin. This option should be used with caution as it ignores the conflict detection and will overwrite all conflicts it has with other plugins, thus may leave the other plugins in a bad state.
+
+Refer to the [plugin.xml guide](https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#edit-config) for managing `edit-config`, resolving conflicts, and examples.
+
+## cordova prepare command
+
+### Synopsis
+
+Transforms config.xml metadata to platform-specific manifest files, copies icons & splashscreens,
+copies plugin files for specified platforms so that the project is ready to build with each native SDK.
+
+### Syntax
+
+```
+cordova prepare [<platform> [..]]
+ [--browserify | --fetch]
+```
+
+###Options
+
+| Option | Description
+|------------|------------------
+| `<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
+
+### Synopsis
+
+`cordova compile` is a subset of the [cordova build command](#cordova-build-command).
+It only performs the compilation step without doing prepare. It's common to invoke `cordova build` instead of this command - however, this stage is useful to allow extending using [hooks][Hooks guide].
+
+###Syntax
+
+```bash
+cordova build [<platform> [...]]
+ [--debug|--release]
+ [--device|--emulator|--target=<targetName>]
+ [--buildConfig=<configfile>]
+ [--browserify]
+ [-- <platformOpts>]
+```
+For detailed documentation see [cordova build command](#cordova-build-command) docs below.
+
+## cordova build command
+
+### Synopsis
+
+Shortcut for `cordova prepare` + `cordova compile` for all/the specified platforms. Allows you to build the app for the specified platform.
+
+### Syntax
+
+```bash
+cordova build [<platform> [...]]
+ [--debug|--release]
+ [--device|--emulator]
+ [--buildConfig=<configfile>]
+ [--browserify]
+ [-- <platformOpts>]
+```
+
+| Option | Description
+|------------|------------------
+| `<platform> [..]` | Platform name(s) to build. If not specified, all platforms are built.
+| --debug | Perform a debug build. This typically translates to debug mode for the underlying platform being built.
+| --release | Perform a release build. This typically translates to release mode for the underlying platform being built.
+| --device | Build it for a device
+| --emulator | Build it for an emulator. In particular, the platform architecture might be different for a device Vs emulator.
+| --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.
+
+### Examples
+
+- Build for `android` and `windows` platform in `debug` mode for deployment to device:
+
+ cordova build android windows --debug --device
+
+- Build for `android` platform in `release` mode and use the specified build configuration:
+
+ cordova build android --release --buildConfig=..\myBuildConfig.json
+
+- Build for `android` platform in release mode and pass custom platform options to android build process:
+
+ cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
+
+## cordova run command
+
+### 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.
+
+###Syntax
+
+```bash
+cordova run [<platform> [...]]
+ [--list | --debug | --release]
+ [--noprepare] [--nobuild]
+ [--device|--emulator|--target=<targetName>]
+ [--buildConfig=<configfile>]
+ [--browserify]
+ [-- <platformOpts>]
+```
+
+| 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
+| --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.
+
+###Examples
+
+- Run a release build of current cordova project on `android` platform emulator named `Nexus_5_API_23_x86`. Use the spcified build configuration when running:
+
+ cordova run android --release --buildConfig=..\myBuildConfig.json --target=Nexus_5_API_23_x86
+
+- Run a debug build of current cordova project on `android` platform using a device or emulator (if no device is connected). Skip doing the build:
+
+ cordova run android --nobuild
+
+- Run a debug build of current cordova project on an `ios` device:
+
+ cordova run ios --device
+
+- Enumerate names of all the connected devices and available emulators that can be used to run this app:
+
+ cordova run ios --list
+
+
+## cordova emulate command
+
+### Synopsis
+
+Alias for `cordova run --emulator`. Launches the emulator instead of device.
+See [cordova run command docs](#cordova-run-command) for more details.
+
+## cordova clean command
+
+### Synopsis
+
+Cleans the build artifacts for the specified platform, or all platforms by running platform-specific build cleanup.
+
+### Syntax
+
+```
+cordova clean [<platform> [...]]
+```
+
+### Example
+
+- Clean `android` platform build artifiacts:
+
+ cordova clean android
+
+
+## cordova requirements command
+
+### Synopsis
+
+Checks and print out all the requirements for platforms specified (or all platforms added
+to project if none specified). If all requirements for each platform are met, exits with code 0
+otherwise exits with non-zero code.
+
+This can be useful when setting up a machine for building a particular platform.
+
+### Syntax
+
+```
+cordova requirements android
+```
+
+## cordova info command
+
+### Synopsis
+
+Print out useful information helpful for submitting bug
+reports and getting help. Creates an info.txt file at the
+base of your project.
+
+### Syntax
+
+```
+cordova info
+```
+
+## cordova serve command
+
+### Synopsis
+
+Run a local web server for www/ assets using specified `port` or default of 8000. Access projects at: `http://HOST_IP:PORT/PLATFORM/www`
+
+### Syntax
+
+```
+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
+
+Show syntax summary, or the help for a specific command.
+
+### Syntax
+
+```
+cordova help [command]
+cordova [command] -h
+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/5ad93d20/www/docs/en/7.x/reference/cordova-plugin-battery-status/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/7.x/reference/cordova-plugin-battery-status/index.md b/www/docs/en/7.x/reference/cordova-plugin-battery-status/index.md
new file mode 100644
index 0000000..97e0176
--- /dev/null
+++ b/www/docs/en/7.x/reference/cordova-plugin-battery-status/index.md
@@ -0,0 +1,143 @@
+---
+edit_link: 'https://github.com/apache/cordova-plugin-battery-status/blob/master/README.md'
+title: 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. -->
+
+<!--
+# 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.
+-->
+
+|Android 4.4|Android 5.1|iOS|Windows 10 Store|Travis CI|
+|:-:|:-:|:-:|:-:|:-:|
+|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android-4.4,PLUGIN=cordova-plugin-battery-status/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android-5.1,PLUGIN=cordova-plugin-battery-status/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-battery-status/)|[](http://cor
dova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-battery-status/)|[](https://travis-ci.org/apache/cordova-plugin-battery-status)|
+
+# cordova-plugin-battery-status
+
+This plugin provides an implementation of an old version of the [Battery Status Events API][w3c_spec]. It adds the following three events to the `window` object:
+
+* batterystatus
+* batterycritical
+* batterylow
+
+Applications may use `window.addEventListener` to attach an event listener for any of the above events after the `deviceready` event fires.
+
+## Installation
+
+ cordova plugin add cordova-plugin-battery-status
+
+## Status object
+
+All events in this plugin return an object with the following properties:
+
+- __level__: The battery charge percentage (0-100). _(Number)_
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+## batterystatus event
+
+Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an [object][status_object] containing battery status.
+
+### Example
+
+ window.addEventListener("batterystatus", onBatteryStatus, false);
+
+ function onBatteryStatus(status) {
+ console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
+ }
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Windows Phone 7 and 8
+- Windows (Windows Phone 8.1 and Windows 10)
+- Firefox OS
+- Browser (Chrome, Firefox, Opera)
+
+### Quirks: Android & Amazon Fire OS
+
+**Warning**: the Android and Fire OS implementations are greedy and prolonged use will drain the device's battery.
+
+### Quirks: Windows Phone 7 & Windows Phone 8
+
+The `level` property is _not_ supported on Windows Phone 7 because the OS does not provide native APIs to determine battery level. The `isPlugged` parameter _is_ supported.
+
+### Quirks: Windows Phone 8.1
+
+The `isPlugged` parameter is _not_ supported on Windows Phone 8.1. The `level` parameter _is_ supported.
+
+## batterylow event
+
+Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
+
+### Example
+
+ window.addEventListener("batterylow", onBatteryLow, false);
+
+ function onBatteryLow(status) {
+ alert("Battery Level Low " + status.level + "%");
+ }
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Firefox OS
+- Windows (Windows Phone 8.1 and Windows 10)
+- Browser (Chrome, Firefox, Opera)
+
+### Quirks: Windows Phone 8.1
+
+The `batterylow` event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.
+
+## batterycritical event
+
+Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
+
+### Example
+
+ window.addEventListener("batterycritical", onBatteryCritical, false);
+
+ function onBatteryCritical(status) {
+ alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
+ }
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Firefox OS
+- Windows (Windows Phone 8.1 and Windows 10)
+- Browser (Chrome, Firefox, Opera)
+
+### Quirks: Windows Phone 8.1
+
+The `batterycritical` event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.
+
+[w3c_spec]: http://www.w3.org/TR/2011/WD-battery-status-20110915/
+[status_object]: #status-object
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5ad93d20/www/docs/en/7.x/reference/cordova-plugin-camera/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/7.x/reference/cordova-plugin-camera/index.md b/www/docs/en/7.x/reference/cordova-plugin-camera/index.md
new file mode 100644
index 0000000..bb9e0df
--- /dev/null
+++ b/www/docs/en/7.x/reference/cordova-plugin-camera/index.md
@@ -0,0 +1,799 @@
+---
+edit_link: 'https://github.com/apache/cordova-plugin-camera/blob/master/README.md'
+title: 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. -->
+
+<!---
+# 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.
+-->
+
+|Android 4.4|Android 5.1|iOS|Windows 10 Store|Travis CI|
+|:-:|:-:|:-:|:-:|:-:|
+|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android-4.4,PLUGIN=cordova-plugin-camera/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android-5.1,PLUGIN=cordova-plugin-camera/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-camera/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLA
TFORM=windows-10-store,PLUGIN=cordova-plugin-camera/)|[](https://travis-ci.org/apache/cordova-plugin-camera)
+
+# cordova-plugin-camera
+
+This plugin defines a global `navigator.camera` object, which provides an API for taking pictures and for choosing images from
+the system's image library.
+
+Although the object is attached to the global scoped `navigator`, it is not available until after the `deviceready` event.
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ console.log(navigator.camera);
+ }
+
+
+## Installation
+
+This requires cordova 5.0+
+
+ cordova plugin add cordova-plugin-camera
+Older versions of cordova can still install via the __deprecated__ id
+
+ cordova plugin add org.apache.cordova.camera
+It is also possible to install via repo url directly ( unstable )
+
+ cordova plugin add https://github.com/apache/cordova-plugin-camera.git
+
+
+## How to Contribute
+
+Contributors are welcome! And we need your contributions to keep the project moving forward. You can [report bugs](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Reopened)%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Camera%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC), improve the documentation, or [contribute code](https://github.com/apache/cordova-plugin-camera/pulls).
+
+There is a specific [contributor workflow](http://wiki.apache.org/cordova/ContributorWorkflow) we recommend. Start reading there. More information is available on [our wiki](http://wiki.apache.org/cordova).
+
+:warning: **Found an issue?** File it on [JIRA issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Reopened)%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Camera%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC).
+
+**Have a solution?** Send a [Pull Request](https://github.com/apache/cordova-plugin-camera/pulls).
+
+In order for your changes to be accepted, you need to sign and submit an Apache [ICLA](http://www.apache.org/licenses/#clas) (Individual Contributor License Agreement). Then your name will appear on the list of CLAs signed by [non-committers](https://people.apache.org/committer-index.html#unlistedclas) or [Cordova committers](http://people.apache.org/committers-by-project.html#cordova).
+
+**And don't forget to test and document your code.**
+
+
+## This documentation is generated by a tool
+
+:warning: Run `npm install` in the plugin repo to enable automatic docs generation if you plan to send a PR.
+[jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) is used to generate the docs.
+Documentation consists of template and API docs produced from the plugin JS code and should be regenerated before each commit (done automatically via [husky](https://github.com/typicode/husky), running `npm run gen-docs` script as a `precommit` hook - see `package.json` for details).
+
+
+
+### iOS Quirks
+
+Since iOS 10 it's mandatory to add a `NSCameraUsageDescription` and `NSPhotoLibraryUsageDescription` in the info.plist.
+
+- `NSCameraUsageDescription` describes the reason that the app accesses the user’s camera.
+- `NSPhotoLibraryUsageDescription` describes the reason the app accesses the user's photo library.
+
+When the system prompts the user to allow access, this string is displayed as part of the dialog box.
+
+To add this entry you can pass the following variables on plugin install.
+
+- `CAMERA_USAGE_DESCRIPTION` for `NSCameraUsageDescription`
+- `PHOTOLIBRARY_USAGE_DESCRIPTION` for `NSPhotoLibraryUsageDescription`
+
+Example:
+
+ cordova plugin add cordova-plugin-camera --variable CAMERA_USAGE_DESCRIPTION="your usage message" --variable PHOTOLIBRARY_USAGE_DESCRIPTION="your usage message"
+
+If you don't pass the variable, the plugin will add an empty string as value.
+
+---
+
+# API Reference <a name="reference"></a>
+
+
+* [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>
+
+
+* [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>
+
+* [CameraPopoverHandle](#module_CameraPopoverHandle)
+* [CameraPopoverOptions](#module_CameraPopoverOptions)
+
+---
+
+<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
+Base64-encoded `String`, or as the URI for the image file.
+
+The `camera.getPicture` function opens the device's default camera
+application that allows users to snap pictures by default - this behavior occurs,
+when `Camera.sourceType` equals [`Camera.PictureSourceType.CAMERA`](#module_Camera.PictureSourceType).
+Once the user snaps the photo, the camera application closes and the application is restored.
+
+If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
+`Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a dialog displays
+that allows users to select an existing image.
+
+The return value is sent to the [`cameraSuccess`](#module_camera.onSuccess) callback function, in
+one of the following formats, depending on the specified
+`cameraOptions`:
+
+- A `String` containing the Base64-encoded photo image.
+- A `String` representing the image file location on local storage (default).
+
+You can do whatever you want with the encoded image or URI, for
+example:
+
+- Render the image in an `<img>` tag, as in the example below
+- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc.)
+- Post the data to a remote server
+
+__NOTE__: Photo resolution on newer devices is quite good. Photos
+selected from the device's gallery are not downscaled to a lower
+quality, even if a `quality` parameter is specified. To avoid common
+memory problems, set `Camera.destinationType` to `FILE_URI` rather
+than `DATA_URL`.
+
+__Supported Platforms__
+
+- Android
+- BlackBerry
+- Browser
+- Firefox
+- FireOS
+- iOS
+- Windows
+- WP8
+- Ubuntu
+
+More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPicture-quirks).
+
+**Kind**: static method of <code>[camera](#module_camera)</code>
+
+| Param | Type | Description |
+| --- | --- | --- |
+| successCallback | <code>[onSuccess](#module_camera.onSuccess)</code> | |
+| errorCallback | <code>[onError](#module_camera.onError)</code> | |
+| options | <code>[CameraOptions](#module_camera.CameraOptions)</code> | CameraOptions |
+
+**Example**
+```js
+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
+`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
+`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
+
+__Supported Platforms__
+
+- iOS
+
+**Kind**: static method of <code>[camera](#module_camera)</code>
+**Example**
+```js
+navigator.camera.cleanup(onSuccess, onFail);
+
+function onSuccess() {
+ console.log("Camera cleanup success.")
+}
+
+function onFail(message) {
+ alert('Failed because: ' + message);
+}
+```
+<a name="module_camera.onError"></a>
+
+### camera.onError : <code>function</code>
+Callback function that provides an error message.
+
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
+
+| Param | Type | Description |
+| --- | --- | --- |
+| 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.
+
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
+
+| Param | Type | Description |
+| --- | --- | --- |
+| imageData | <code>string</code> | Base64 encoding of the image data, _or_ the image file URI, depending on [`cameraOptions`](#module_camera.CameraOptions) in effect. |
+
+**Example**
+```js
+// Show image
+//
+function cameraCallback(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+}
+```
+<a name="module_camera.CameraOptions"></a>
+
+### camera.CameraOptions : <code>Object</code>
+Optional parameters to customize the camera settings.
+* [Quirks](#CameraOptions-quirks)
+
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| quality | <code>number</code> | <code>50</code> | Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. (Note that information about the camera's resolution is unavailable.) |
+| destinationType | <code>[DestinationType](#module_Camera.DestinationType)</code> | <code>FILE_URI</code> | Choose the format of the return value. |
+| sourceType | <code>[PictureSourceType](#module_Camera.PictureSourceType)</code> | <code>CAMERA</code> | Set the source of the picture. |
+| allowEdit | <code>Boolean</code> | <code>true</code> | Allow simple editing of image before selection. |
+| encodingType | <code>[EncodingType](#module_Camera.EncodingType)</code> | <code>JPEG</code> | Choose the returned image file's encoding. |
+| targetWidth | <code>number</code> | | Width in pixels to scale image. Must be used with `targetHeight`. Aspect ratio remains constant. |
+| targetHeight | <code>number</code> | | Height in pixels to scale image. Must be used with `targetWidth`. Aspect ratio remains constant. |
+| mediaType | <code>[MediaType](#module_Camera.MediaType)</code> | <code>PICTURE</code> | Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. |
+| correctOrientation | <code>Boolean</code> | | Rotate the image to correct for the orientation of the device during capture. |
+| saveToPhotoAlbum | <code>Boolean</code> | | Save the image to the photo album on the device after capture. |
+| popoverOptions | <code>[CameraPopoverOptions](#module_CameraPopoverOptions)</code> | | iOS-only options that specify popover location in iPad. |
+| cameraDirection | <code>[Direction](#module_Camera.Direction)</code> | <code>BACK</code> | Choose the camera to use (front- or back-facing). |
+
+---
+
+<a name="module_Camera"></a>
+
+## Camera
+<a name="module_Camera.DestinationType"></a>
+
+### Camera.DestinationType : <code>enum</code>
+Defines the output format of `Camera.getPicture` call.
+_Note:_ On iOS passing `DestinationType.NATIVE_URI` along with
+`PictureSourceType.PHOTOLIBRARY` or `PictureSourceType.SAVEDPHOTOALBUM` will
+disable any image modifications (resize, quality change, cropping, etc.) due
+to implementation specific.
+
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| DATA_URL | <code>number</code> | <code>0</code> | Return base64 encoded string. DATA_URL can be very memory intensive and cause app crashes or out of memory errors. Use FILE_URI or NATIVE_URI if possible |
+| FILE_URI | <code>number</code> | <code>1</code> | Return file uri (content://media/external/images/media/2 for Android) |
+| 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**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| JPEG | <code>number</code> | <code>0</code> | Return JPEG encoded image |
+| 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**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| PICTURE | <code>number</code> | <code>0</code> | Allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType |
+| VIDEO | <code>number</code> | <code>1</code> | Allow selection of video only, ONLY RETURNS URL |
+| ALLMEDIA | <code>number</code> | <code>2</code> | Allow selection from all media types |
+
+<a name="module_Camera.PictureSourceType"></a>
+
+### Camera.PictureSourceType : <code>enum</code>
+Defines the output format of `Camera.getPicture` call.
+_Note:_ On iOS passing `PictureSourceType.PHOTOLIBRARY` or `PictureSourceType.SAVEDPHOTOALBUM`
+along with `DestinationType.NATIVE_URI` will disable any image modifications (resize, quality
+change, cropping, etc.) due to implementation specific.
+
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from the device's photo library (same as SAVEDPHOTOALBUM for Android) |
+| CAMERA | <code>number</code> | <code>1</code> | Take picture from camera |
+| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image only from the device's Camera Roll album (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.
+
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default |
+| --- | --- | --- |
+| ARROW_UP | <code>number</code> | <code>1</code> |
+| ARROW_DOWN | <code>number</code> | <code>2</code> |
+| ARROW_LEFT | <code>number</code> | <code>4</code> |
+| ARROW_RIGHT | <code>number</code> | <code>8</code> |
+| 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**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| BACK | <code>number</code> | <code>0</code> | Use the back-facing camera |
+| FRONT | <code>number</code> | <code>1</code> | Use the front-facing camera |
+
+---
+
+<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.
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [x] | <code>Number</code> | <code>0</code> | x pixel coordinate of screen element onto which to anchor the popover. |
+| [y] | <code>Number</code> | <code>32</code> | y pixel coordinate of screen element onto which to anchor the popover. |
+| [width] | <code>Number</code> | <code>320</code> | width, in pixels, of the screen element onto which to anchor the popover. |
+| [height] | <code>Number</code> | <code>480</code> | height, in pixels, of the screen element onto which to anchor the popover. |
+| [arrowDir] | <code>[PopoverArrowDirection](#module_Camera.PopoverArrowDirection)</code> | <code>ARROW_ANY</code> | Direction the arrow on the popover should point. |
+
+---
+
+<a name="module_CameraPopoverHandle"></a>
+
+## CameraPopoverHandle
+A handle to an image picker popover.
+
+__Supported Platforms__
+
+- iOS
+
+**Example**
+```js
+navigator.camera.getPicture(onSuccess, onFail,
+{
+ destinationType: Camera.DestinationType.FILE_URI,
+ sourceType: Camera.PictureSourceType.PHOTOLIBRARY,
+ popoverOptions: new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY)
+});
+
+// Reposition the popover if the orientation changes.
+window.onorientationchange = function() {
+ var cameraPopoverHandle = new CameraPopoverHandle();
+ var cameraPopoverOptions = new CameraPopoverOptions(0, 0, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
+ cameraPopoverHandle.setPosition(cameraPopoverOptions);
+}
+```
+---
+
+
+## `camera.getPicture` Errata
+
+#### Example <a name="camera-getPicture-examples"></a>
+
+Take a photo and retrieve the image's file location:
+
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.FILE_URI });
+
+ function onSuccess(imageURI) {
+ var image = document.getElementById('myImage');
+ image.src = imageURI;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+Take a photo and retrieve it as a Base64-encoded image:
+
+ /**
+ * Warning: Using DATA_URL is not recommended! The DATA_URL destination
+ * type is very memory intensive, even with a low quality setting. Using it
+ * can result in out of memory errors and application crashes. Use FILE_URI
+ * or NATIVE_URI instead.
+ */
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 25,
+ destinationType: Camera.DestinationType.DATA_URL
+ });
+
+ function onSuccess(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+#### Preferences (iOS)
+
+- __CameraUsesGeolocation__ (boolean, defaults to false). For capturing JPEGs, set to true to get geolocation data in the EXIF header. This will trigger a request for geolocation permissions if set to true.
+
+ <preference name="CameraUsesGeolocation" value="false" />
+
+#### Amazon Fire OS Quirks <a name="camera-getPicture-quirks"></a>
+
+Amazon Fire OS uses intents to launch the camera activity on the device to capture
+images, and on phones with low memory, the Cordova activity may be killed. In this
+scenario, the image may not appear when the Cordova activity is restored.
+
+#### Android Quirks
+
+Android uses intents to launch the camera activity on the device to capture
+images, and on phones with low memory, the Cordova activity may be killed. In this
+scenario, the result from the plugin call will be delivered via the resume event.
+See [the Android Lifecycle guide][android_lifecycle]
+for more information. The `pendingResult.result` value will contain the value that
+would be passed to the callbacks (either the URI/URL or an error message). Check
+the `pendingResult.pluginStatus` to determine whether or not the call was
+successful.
+
+#### Browser Quirks
+
+Can only return photos as Base64-encoded image.
+
+#### Firefox OS Quirks
+
+Camera plugin is currently implemented using [Web Activities][web_activities].
+
+#### iOS Quirks
+
+Including a JavaScript `alert()` in either of the callback functions
+can cause problems. Wrap the alert within a `setTimeout()` to allow
+the iOS image picker or popover to fully close before the alert
+displays:
+
+ setTimeout(function() {
+ // do your thing here!
+ }, 0);
+
+#### Windows Phone 7 Quirks
+
+Invoking the native camera application while the device is connected
+via Zune does not work, and triggers an error callback.
+
+#### Windows quirks
+
+On Windows Phone 8.1 using `SAVEDPHOTOALBUM` or `PHOTOLIBRARY` as a source type causes application to suspend until file picker returns the selected image and
+then restore with start page as defined in app's `config.xml`. In case when `camera.getPicture` was called from different page, this will lead to reloading
+start page from scratch and success and error callbacks will never be called.
+
+To avoid this we suggest using SPA pattern or call `camera.getPicture` only from your app's start page.
+
+More information about Windows Phone 8.1 picker APIs is here: [How to continue your Windows Phone app after calling a file picker](https://msdn.microsoft.com/en-us/library/windows/apps/dn720490.aspx)
+
+#### Tizen Quirks
+
+Tizen only supports a `destinationType` of
+`Camera.DestinationType.FILE_URI` and a `sourceType` of
+`Camera.PictureSourceType.PHOTOLIBRARY`.
+
+
+## `CameraOptions` Errata <a name="CameraOptions-quirks"></a>
+
+#### Amazon Fire OS Quirks
+
+- Any `cameraDirection` value results in a back-facing photo.
+
+- Ignores the `allowEdit` parameter.
+
+- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
+
+#### Android Quirks
+
+- Any `cameraDirection` value results in a back-facing photo.
+
+- **`allowEdit` is unpredictable on Android and it should not be used!** The Android implementation of this plugin tries to find and use an application on the user's device to do image cropping. The plugin has no control over what application the user selects to perform the image cropping and it is very possible that the user could choose an incompatible option and cause the plugin to fail. This sometimes works because most devices come with an application that handles cropping in a way that is compatible with this plugin (Google Plus Photos), but it is unwise to rely on that being the case. If image editing is essential to your application, consider seeking a third party library or plugin that provides its own image editing utility for a more robust solution.
+
+- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
+
+- Ignores the `encodingType` parameter if the image is unedited (i.e. `quality` is 100, `correctOrientation` is false, and no `targetHeight` or `targetWidth` are specified). The `CAMERA` source will always return the JPEG file given by the native camera and the `PHOTOLIBRARY` and `SAVEDPHOTOALBUM` sources will return the selected file in its existing encoding.
+
+#### BlackBerry 10 Quirks
+
+- Ignores the `quality` parameter.
+
+- Ignores the `allowEdit` parameter.
+
+- `Camera.MediaType` is not supported.
+
+- Ignores the `correctOrientation` parameter.
+
+- Ignores the `cameraDirection` parameter.
+
+#### Firefox OS Quirks
+
+- Ignores the `quality` parameter.
+
+- `Camera.DestinationType` is ignored and equals `1` (image file URI)
+
+- Ignores the `allowEdit` parameter.
+
+- Ignores the `PictureSourceType` parameter (user chooses it in a dialog window)
+
+- Ignores the `encodingType`
+
+- Ignores the `targetWidth` and `targetHeight`
+
+- `Camera.MediaType` is not supported.
+
+- Ignores the `correctOrientation` parameter.
+
+- Ignores the `cameraDirection` parameter.
+
+#### iOS Quirks
+
+- When using `destinationType.FILE_URI`, photos are saved in the application's temporary directory. The contents of the application's temporary directory is deleted when the application ends.
+
+- When using `destinationType.NATIVE_URI` and `sourceType.CAMERA`, photos are saved in the saved photo album regardless on the value of `saveToPhotoAlbum` parameter.
+
+- When using `destinationType.NATIVE_URI` and `sourceType.PHOTOLIBRARY` or `sourceType.SAVEDPHOTOALBUM`, all editing options are ignored and link is returned to original picture.
+
+#### Tizen Quirks
+
+- options not supported
+
+- always returns a FILE URI
+
+#### Windows Phone 7 and 8 Quirks
+
+- Ignores the `allowEdit` parameter.
+
+- Ignores the `correctOrientation` parameter.
+
+- Ignores the `cameraDirection` parameter.
+
+- Ignores the `saveToPhotoAlbum` parameter. IMPORTANT: All images taken with the WP8/8 Cordova camera API are always copied to the phone's camera roll. Depending on the user's settings, this could also mean the image is auto-uploaded to their OneDrive. This could potentially mean the image is available to a wider audience than your app intended. If this is a blocker for your application, you will need to implement the CameraCaptureTask as [documented on MSDN][msdn_wp8_docs]. You may also comment or up-vote the related issue in the [issue tracker][wp8_bug].
+
+- Ignores the `mediaType` property of `cameraOptions` as the Windows Phone SDK does not provide a way to choose videos from PHOTOLIBRARY.
+
+[android_lifecycle]: http://cordova.apache.org/docs/en/dev/guide/platforms/android/lifecycle.html
+[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/5ad93d20/www/docs/en/7.x/reference/cordova-plugin-console/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/7.x/reference/cordova-plugin-console/index.md b/www/docs/en/7.x/reference/cordova-plugin-console/index.md
new file mode 100644
index 0000000..73a9452
--- /dev/null
+++ b/www/docs/en/7.x/reference/cordova-plugin-console/index.md
@@ -0,0 +1,115 @@
+---
+edit_link: 'https://github.com/apache/cordova-plugin-console/blob/master/README.md'
+title: 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. -->
+
+<!---
+# 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.
+-->
+
+|Android 4.4|Android 5.1|iOS|Windows 10 Store|Travis CI|
+|:-:|:-:|:-:|:-:|:-:|
+|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android-4.4,PLUGIN=cordova-plugin-console/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android-5.1,PLUGIN=cordova-plugin-console/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-console/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-bu
ild/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-console/)|[](https://travis-ci.org/apache/cordova-plugin-console)|
+
+# cordova-plugin-console
+
+This plugin is meant to ensure that console.log() is as useful as it can be.
+It adds additional function for iOS, Ubuntu, Windows Phone 8, and Windows. If
+you are happy with how console.log() works for you, then you probably
+don't need this plugin.
+
+This plugin defines a global `console` object.
+
+Although the object is in the global scope, features provided by this plugin
+are not available until after the `deviceready` event.
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ console.log("console.log works well");
+ }
+
+:warning: Report issues on the [Apache Cordova issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Console%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC)
+
+
+## Installation
+
+ cordova plugin add cordova-plugin-console
+
+### Android Quirks
+
+On some platforms other than Android, console.log() will act on multiple
+arguments, such as console.log("1", "2", "3"). However, Android will act only
+on the first argument. Subsequent arguments to console.log() will be ignored.
+This plugin is not the cause of that, it is a limitation of Android itself.
+
+## Supported Methods
+
+The plugin support following methods of the `console` object:
+
+- `console.log`
+- `console.error`
+- `console.exception`
+- `console.warn`
+- `console.info`
+- `console.debug`
+- `console.assert`
+- `console.dir`
+- `console.dirxml`
+- `console.time`
+- `console.timeEnd`
+- `console.table`
+
+## Partially supported Methods
+
+Methods of the `console` object which implemented, but behave different from browser implementation:
+
+- `console.group`
+- `console.groupCollapsed`
+
+The grouping methods are just log name of the group and don't actually indicate grouping for later
+calls to `console` object methods.
+
+## Not supported Methods
+
+Methods of the `console` object which are implemented, but do nothing:
+
+- `console.clear`
+- `console.trace`
+- `console.groupEnd`
+- `console.timeStamp`
+- `console.profile`
+- `console.profileEnd`
+- `console.count`
+
+## Supported formatting
+
+The following formatting options available:
+
+Format chars:
+
+* `%j` - format arg as JSON
+* `%o` - format arg as JSON
+* `%c` - format arg as `''`. No color formatting could be done.
+* `%%` - replace with `'%'`
+
+Any other char following `%` will format its arg via `toString()`.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org