You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/07/18 21:21:35 UTC
[05/14] docs commit: [CB-3816] modify plugman doc to remove & xref
CLI plugin doc; basic cleanup
[CB-3816] modify plugman doc to remove & xref CLI plugin doc; basic cleanup
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/a9705bd1
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/a9705bd1
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/a9705bd1
Branch: refs/heads/master
Commit: a9705bd1c34796db533b13536ce175a768bf540d
Parents: 572579b
Author: Mike Sierra <le...@gmail.com>
Authored: Wed Jul 17 16:45:25 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Thu Jul 18 12:15:21 2013 -0700
----------------------------------------------------------------------
docs/en/edge/guide/plugins/corePluginInstall.md | 85 ++++++++++----------
1 file changed, 42 insertions(+), 43 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/a9705bd1/docs/en/edge/guide/plugins/corePluginInstall.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/plugins/corePluginInstall.md b/docs/en/edge/guide/plugins/corePluginInstall.md
index 0867bab..7b8f01e 100644
--- a/docs/en/edge/guide/plugins/corePluginInstall.md
+++ b/docs/en/edge/guide/plugins/corePluginInstall.md
@@ -17,95 +17,94 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-# Core Plugin Installion Guide
+# Using Plugman to Manage Plugins
-Their are two approaches to installing plugins in 3.0+ world. For this guide, the examples are using [plugman](https://github.com/apache/cordova-plugman/). Below, we explain how to use both methods.
+From version 3.0 onward, Cordova implements all device APIs as
+plugins, and leaves them disabled by default. It also supports two
+different ways to add and remove plugins. The first is by using the
+`cordova` CLI described in The Command-line Interface. The second is
+by using a lower-level
+[plugman](https://github.com/apache/cordova-plugman/)
+command-line interface. This guide concentrates on the second
+approach, which may be useful for developers who want to upgrade their
+version of Cordova, but who haven't yet adopted the Cordova CLI in
+their workflow.
-##Plugman
+For more information on plugman, see
+[the README file in its repository](https://github.com/apache/cordova-plugman/blob/master/README.md).
-Plugman is a command line tool to install and uninstall plugins for use with Apache Cordova projects. Learn more about how to install and use plugman at [https://github.com/apache/cordova-plugman/blob/master/README.md](https://github.com/apache/cordova-plugman/blob/master/README.md).
+## Basic Commands
-Install plugman (must have node installed on development machine):
+To install plugman, you must have [node](http://nodejs.org/) installed
+on your machine:
npm install -g plugman
-Installing plugins with plugman
+Here is the syntax to add a plugin for each platform:
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]
-Uninstalling plugins with plugman
+To uninstall a plugin:
- plugman --uninstall --platform <ios|android|blackberr10|wp7|wp8> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]
+ plugman --uninstall --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]
-##Cordova CLI
-Cordova CLI is a command line tool to build, deploy and manage Cordova-based applications. Cordova CLI uses plugman under the hood to manage all aspects of plugins. Cordova CLI is the preferred method for working with Cordova 3.0. It is highly recommended that users read The Command-line Interface guide. Users can also checkout the readme at [https://github.com/apache/cordova-cli/blob/master/README.md](https://github.com/apache/cordova-cli/blob/master/README.md).
+## Installing Core Plugins
-Install Cordova CLI (must have node installed on development machine):
+The examples below show how to add plugins as needed so that any
+Cordova APIs you use in your project still work after you upgrade to
+version 3.0. For each command, you need to select the target
+platform, and reference the platform's project directory.
- npm install -g cordova
-
-Installing plugins with CLI
-
- plugin add <path-to-plugin> [<path-to-plugin> ...]
-
-Uninstalling plugins with CLI
-
- plugin [rm | remove] <plugin-name> [<plugin-name> ...]
-
-
-##Core Plugins
-Below are examples of installing all of the core plugins using plugman. Make sure to select which platform to install for and point to the directory of your project.
-
-###cordova-plugin-battery-status
+* cordova-plugin-battery-status
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git
-###cordova-plugin-camera
+* cordova-plugin-camera
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git
-###cordova-plugin-console
+* cordova-plugin-console
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-console.git
-###cordova-plugin-contacts
+* cordova-plugin-contacts
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git
-###cordova-plugin-device
+* cordova-plugin-device
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git
-###cordova-plugin-device-motion (accelerometer)
+* cordova-plugin-device-motion (accelerometer)
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git
-###cordova-plugin-device-orientation (compass)
+* cordova-plugin-device-orientation (compass)
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git
-###cordova-plugin-dialogs
+* cordova-plugin-dialogs
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git
-###cordova-plugin-file
+* cordova-plugin-file
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
-###cordova-plugin-file-transfer
+* cordova-plugin-file-transfer
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
-###cordova-plugin-geolocation
+* cordova-plugin-geolocation
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git
-###cordova-plugin-globalization
+* cordova-plugin-globalization
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
-###cordova-plugin-inappbrowser
+* cordova-plugin-inappbrowser
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
-###cordova-plugin-media
+* cordova-plugin-media
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
-###cordova-plugin-media-capture
+* cordova-plugin-media-capture
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git
-###cordova-plugin-network-information
+* cordova-plugin-network-information
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git
-###cordova-plugin-splashscreen
+* cordova-plugin-splashscreen
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git
-###cordova-plugin-vibration
+* cordova-plugin-vibration
plugman --platform <ios|android|blackberry10|wp7|wp8> --project <directory> --plugin https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git