Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4E52B10D44 for ; Mon, 31 Mar 2014 20:26:39 +0000 (UTC) Received: (qmail 37040 invoked by uid 500); 31 Mar 2014 20:26:38 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 36856 invoked by uid 500); 31 Mar 2014 20:26:35 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 36561 invoked by uid 99); 31 Mar 2014 20:26:29 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 31 Mar 2014 20:26:29 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id B9FAA91A0C3; Mon, 31 Mar 2014 20:26:28 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: agrieve@apache.org To: commits@cordova.apache.org Date: Mon, 31 Mar 2014 20:26:34 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [07/31] docs commit: [CB-5122] rename shell 'tools' guides to 'Development' guides [CB-5122] rename shell 'tools' guides to 'Development' guides Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/9ddf3c83 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/9ddf3c83 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/9ddf3c83 Branch: refs/heads/master Commit: 9ddf3c8399c3dc2b365ff26ea9fef312ee0fed40 Parents: d22eaad Author: Mike Sierra Authored: Tue Nov 5 08:50:32 2013 -0500 Committer: Mike Sierra Committed: Tue Nov 5 08:50:32 2013 -0500 ---------------------------------------------------------------------- docs/en/edge/guide/platforms/android/devel.md | 85 +++++++++ docs/en/edge/guide/platforms/android/tools.md | 85 --------- .../en/edge/guide/platforms/blackberry/devel.md | 88 +++++++++ .../en/edge/guide/platforms/blackberry/tools.md | 88 --------- .../edge/guide/platforms/blackberry10/devel.md | 183 +++++++++++++++++++ .../edge/guide/platforms/blackberry10/tools.md | 183 ------------------- docs/en/edge/guide/platforms/ios/devel.md | 63 +++++++ docs/en/edge/guide/platforms/ios/tools.md | 63 ------- docs/en/edge/guide/platforms/win8/devel.md | 50 +++++ docs/en/edge/guide/platforms/win8/tools.md | 50 ----- docs/en/edge/guide/platforms/wp8/devel.md | 107 +++++++++++ docs/en/edge/guide/platforms/wp8/tools.md | 107 ----------- 12 files changed, 576 insertions(+), 576 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/android/devel.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/android/devel.md b/docs/en/edge/guide/platforms/android/devel.md new file mode 100644 index 0000000..efc6ead --- /dev/null +++ b/docs/en/edge/guide/platforms/android/devel.md @@ -0,0 +1,85 @@ +--- +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 Development Guide + +The `cordova` command-line utility is a high-level tool that allows +you to build applications across several platforms at once. An older +version of the Cordova framework provides sets of command-line tools +specific to each platform. To use them as an alternative to the CLI, +you need to download this version of Cordova from +[cordova.apache.org](http://cordova.apache.org). The download contains +separate archives for each platform. Expand the platform you wish to +target. The tools described here are typically available in the +top-level `bin` directory, otherwise consult the __README__ file for +more detailed directions. + +For information on the low-level command-line interface that enables +plugins, see Using Plugman to Manage Plugins. See Application Plugins +for an overview. + +## Create a project + +Run the `create` command, specifying the existing path to the project, +the reverse-domain-style package identifier, and the app's display +name. Here is the syntax for both Mac and Windows: + + $ /path/to/cordova-android/bin/create /path/to/project com.example.project_name ProjectName + $ C:\path\to\cordova-android\bin\create.bat C:\path\to\project com.example.project_name ProjectName + +## Build + +This cleans then builds a project. + +Debug, on Mac or Windows: + + $ /path/to/project/cordova/build --debug + $ C:\path\to\project\cordova\build.bat --debug + +Release, on Mac or Windows: + + $ /path/to/project/cordova/build --release + $ C:\path\to\project\cordova\build.bat --release + +## Run the App + +The `run` command accepts the following _optional_ parameters: + +* Target specification. This includes `--emulator`, `--device`, or `--target=`. + +* Build specification. This includes `--debug`, `--release`, or `--nobuild`. + + $ /path/to/project/cordova/run [Target] [Build] + $ C:\path\to\project\cordova\run.bat [Target] [Build] + +Make sure you create at least one Android Virtual Device, otherwise +you're prompted to do so with the `android` command. If more than one +AVD is available as a target, you're prompted to select one. By +default the `run` command detects a connected device, or a currently +running emulator if no device is found. + +## Logging + + $ /path/to/project/cordova/log + $ C:\path\to\project\cordova\log.bat + +### Cleaning + + $ /path/to/project/cordova/clean + $ C:\path\to\project\cordova\clean.bat http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/android/tools.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/android/tools.md b/docs/en/edge/guide/platforms/android/tools.md deleted file mode 100644 index efc6ead..0000000 --- a/docs/en/edge/guide/platforms/android/tools.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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 Development Guide - -The `cordova` command-line utility is a high-level tool that allows -you to build applications across several platforms at once. An older -version of the Cordova framework provides sets of command-line tools -specific to each platform. To use them as an alternative to the CLI, -you need to download this version of Cordova from -[cordova.apache.org](http://cordova.apache.org). The download contains -separate archives for each platform. Expand the platform you wish to -target. The tools described here are typically available in the -top-level `bin` directory, otherwise consult the __README__ file for -more detailed directions. - -For information on the low-level command-line interface that enables -plugins, see Using Plugman to Manage Plugins. See Application Plugins -for an overview. - -## Create a project - -Run the `create` command, specifying the existing path to the project, -the reverse-domain-style package identifier, and the app's display -name. Here is the syntax for both Mac and Windows: - - $ /path/to/cordova-android/bin/create /path/to/project com.example.project_name ProjectName - $ C:\path\to\cordova-android\bin\create.bat C:\path\to\project com.example.project_name ProjectName - -## Build - -This cleans then builds a project. - -Debug, on Mac or Windows: - - $ /path/to/project/cordova/build --debug - $ C:\path\to\project\cordova\build.bat --debug - -Release, on Mac or Windows: - - $ /path/to/project/cordova/build --release - $ C:\path\to\project\cordova\build.bat --release - -## Run the App - -The `run` command accepts the following _optional_ parameters: - -* Target specification. This includes `--emulator`, `--device`, or `--target=`. - -* Build specification. This includes `--debug`, `--release`, or `--nobuild`. - - $ /path/to/project/cordova/run [Target] [Build] - $ C:\path\to\project\cordova\run.bat [Target] [Build] - -Make sure you create at least one Android Virtual Device, otherwise -you're prompted to do so with the `android` command. If more than one -AVD is available as a target, you're prompted to select one. By -default the `run` command detects a connected device, or a currently -running emulator if no device is found. - -## Logging - - $ /path/to/project/cordova/log - $ C:\path\to\project\cordova\log.bat - -### Cleaning - - $ /path/to/project/cordova/clean - $ C:\path\to\project\cordova\clean.bat http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/blackberry/devel.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry/devel.md b/docs/en/edge/guide/platforms/blackberry/devel.md new file mode 100644 index 0000000..51f8341 --- /dev/null +++ b/docs/en/edge/guide/platforms/blackberry/devel.md @@ -0,0 +1,88 @@ +--- +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. +--- + +# BlackBerry Development Guide + +The `cordova` command-line utility is a high-level tool that allows +you to build applications across several platforms at once. An older +version of the Cordova framework provides sets of command-line tools +specific to each platform. To use them as an alternative to the CLI, +you need to download this version of Cordova from +[cordova.apache.org](http://cordova.apache.org). The download contains +separate archives for each platform. Expand the platform you wish to +target. The tools described here are typically available in the +top-level `bin` directory, otherwise consult the __README__ file for +more detailed directions. + +For information on the low-level command-line interface that enables +plugins, see Using Plugman to Manage Plugins. See Application Plugins +for an overview. + +## Create a project + +Run the `create` command, specifying the existing path to the project, +the reverse-domain-style package identifier, and the app's display +name. Here is the syntax for both Mac and Windows: + + $ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_project com.example.project_name ProjectName + $ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_project com.example.project_name ProjectName + +__NOTE:__ The BlackBerry platform ignores the package name placeholder +(`com.example.project_name`), but it's still required for use by +cross-platform tools. + +## Build a project + +For BlackBerry projects, please make sure you customize the +`project.properties` file in your Cordova project's root directory. +You need to do so to supply your BlackBerry signing key password, and +specify locations for the BlackBerry WebWorks SDK and BlackBerry +emulator executables. + + $ /path/to/my_new_project/cordova/build + $ /path/to/my_new_project/cordova/build.bat + +## Launch emulator + +For BlackBerry projects, please make sure you customize the +`project.properties` file in the root of your Cordova project directory. +You need to do so to supply your BlackBerry signing key password, and +specify locations for the BlackBerry WebWorks SDK and BlackBerry +emulator executables. + + $ /path/to/my_new_project/cordova/run + +and then choose 'no' when prompted with: + + Do you have a BlackBerry device connected to your computer? (y/n) + $ /path/to/my_new_project/cordova/run + +and then choose 'no' when prompted with: + + Do you have a BlackBerry device connected to your computer? (y/n) + +## Logging + +Unfortunately, streaming logs directly from the device is currently +unsupported. However, BlackBerry offers built-in Web Inspector support +for Playbook and BlackBerry smartphone devices running BlackBerry OS +7.0 and above. You can also access your application's logs (including +any calls to `console.log`) on your device by holding down the ''ALT'' +key from the home screen and typing ''lglg'' keys. + http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/blackberry/tools.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry/tools.md b/docs/en/edge/guide/platforms/blackberry/tools.md deleted file mode 100644 index 51f8341..0000000 --- a/docs/en/edge/guide/platforms/blackberry/tools.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. ---- - -# BlackBerry Development Guide - -The `cordova` command-line utility is a high-level tool that allows -you to build applications across several platforms at once. An older -version of the Cordova framework provides sets of command-line tools -specific to each platform. To use them as an alternative to the CLI, -you need to download this version of Cordova from -[cordova.apache.org](http://cordova.apache.org). The download contains -separate archives for each platform. Expand the platform you wish to -target. The tools described here are typically available in the -top-level `bin` directory, otherwise consult the __README__ file for -more detailed directions. - -For information on the low-level command-line interface that enables -plugins, see Using Plugman to Manage Plugins. See Application Plugins -for an overview. - -## Create a project - -Run the `create` command, specifying the existing path to the project, -the reverse-domain-style package identifier, and the app's display -name. Here is the syntax for both Mac and Windows: - - $ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_project com.example.project_name ProjectName - $ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_project com.example.project_name ProjectName - -__NOTE:__ The BlackBerry platform ignores the package name placeholder -(`com.example.project_name`), but it's still required for use by -cross-platform tools. - -## Build a project - -For BlackBerry projects, please make sure you customize the -`project.properties` file in your Cordova project's root directory. -You need to do so to supply your BlackBerry signing key password, and -specify locations for the BlackBerry WebWorks SDK and BlackBerry -emulator executables. - - $ /path/to/my_new_project/cordova/build - $ /path/to/my_new_project/cordova/build.bat - -## Launch emulator - -For BlackBerry projects, please make sure you customize the -`project.properties` file in the root of your Cordova project directory. -You need to do so to supply your BlackBerry signing key password, and -specify locations for the BlackBerry WebWorks SDK and BlackBerry -emulator executables. - - $ /path/to/my_new_project/cordova/run - -and then choose 'no' when prompted with: - - Do you have a BlackBerry device connected to your computer? (y/n) - $ /path/to/my_new_project/cordova/run - -and then choose 'no' when prompted with: - - Do you have a BlackBerry device connected to your computer? (y/n) - -## Logging - -Unfortunately, streaming logs directly from the device is currently -unsupported. However, BlackBerry offers built-in Web Inspector support -for Playbook and BlackBerry smartphone devices running BlackBerry OS -7.0 and above. You can also access your application's logs (including -any calls to `console.log`) on your device by holding down the ''ALT'' -key from the home screen and typing ''lglg'' keys. - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/blackberry10/devel.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry10/devel.md b/docs/en/edge/guide/platforms/blackberry10/devel.md new file mode 100644 index 0000000..dace921 --- /dev/null +++ b/docs/en/edge/guide/platforms/blackberry10/devel.md @@ -0,0 +1,183 @@ +--- +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. +--- + +# BlackBerry 10 Development Guide + +The `cordova` command-line utility is a high-level tool that allows +you to build applications across several platforms at once. An older +version of the Cordova framework provides sets of command-line tools +specific to each platform. To use them as an alternative to the CLI, +you need to download this version of Cordova from +[cordova.apache.org](http://cordova.apache.org). The download contains +separate archives for each platform. Expand the platform you wish to +target. The tools described here are typically available in the +top-level `bin` directory, otherwise consult the __README__ file for +more detailed directions. + +For information on the low-level command-line interface that enables +plugins, see Using Plugman to Manage Plugins. See Application Plugins +for an overview. + +If you need help with any command listed below, type the command along +with the `-h` or `-help` arguments, which are supported by all +commands and which provide descriptions for each of the available +arguments. + +## create + +The `create` command creates a new project: + + bin/create + +where + +- `` specifies the directory you want the project created in + +- `` specifies a reverse domain style identifier + +- `` specifies the apps display name + +__NOTE:__ the `create` command bootstraps dependency installation +through the `npm install` command. Depending on the installation +directory and system permissions, this may require administrator +privileges. If there's problem on OSX/Linux, run `sudo npm install` +before using the `create` command. On Windows, run `npm install` in a +command-line utility opened with administrator privileges. + +## target + +The `target` command allows you to manage the emulator or BlackBerry +devices that you use to test the app. You can add or remove a target, +or set a target as the default target. + +### Add a target + + /cordova/target add [-t | --type ] [-p | --password ] [--pin ] + +where + +- `` specifies a unique name for the target. + +- `` specifies the ip address of the BlackBerry device or + simulator. + +- `-p | --password ` specifies the password for the device or + emulator. This is required only if the device or emulator is + password protected. + +- `--pin ` specifies the PIN of the BlackBerry device, + which identifies that device as a valid host for the debug + token. This argument is required only if you are creating a debug + token. + +### Remove a target + + /cordova/target remove + +### Set a target as the default + + /cordova/target default + +## build + +The `build` command builds the project as a .bar file. You can build +the app in either release mode (which produces a signed .bar file) or +in debug mode (which produces an unsigned .bar file). + +### Build your project in release mode + + /cordova/build release [-k | --keystorepass ] [-b | --buildId ] [-p | --params ] + +where + +- `-k | --keystorepass ` specifies the password you defined when you configured your computer to sign applications. + +- `-b | --buildId ` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional. + +- `-p | --params ` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional. + +### Build your project in debug mode + + /cordova/build debug [] [-k | --keystorepass ] [-p | --params ] [-ll | --loglevel ] + +where + +- `` specifies the name of a previously added target. If + `` is not specified, the default target is used, if one has + been created. This argument is only required if you want the script + to deploy the app to a BlackBerry device or emulator and you have + not created a default target. Additionally, if `` is a + device, then that device must be connected to your computer by USB + connection or be connected to the same Wi-Fi network as your + computer. + +- `-k | --keystorepass ` specifies the password you defined + when you configured your computer to sign applications. This + password is also used to create your debug token. This argument is + only required if you want the script to create and install the debug + token for you. + +- `-p | --params ` specifies a JSON file containing + additional parameters to pass to downstream tools. + +- `-ll | --loglevel ` specifies the log level. The log level may + be one of `error`, `warn`, or `verbose`. + +If you have previously defined a default target (and previously +installed a debug token, if that target is a BlackBerry device), you +can run the script with no arguments, and the script will package your +app and deploy it to the default target. For example: + + /cordova/build debug + +## run + +The `run` command deploys the app on the specified BlackBerry device +or an emulator. Before deploying the app, you must first create a +target for the device or emulator you want to deploy the app to using +the target script. The deploy script will deploy the most recent build of the app. + + /cordova/run + +where + +- ` `specifies the name of a previously added target. If + ` `is a device, then that device must be connected to your + computer by USB connection or be connected to the same Wi-Fi network + as your computer. + +## plugin + +The `target` command allows you to add and remove plugins + +### Fetch a locally hosted plugin + + /cordova/plugin fetch + +### View a list of installed plugins + + /cordova/plugin ls + +### Add a plugin + + /cordova/plugin add + +### Remove a plugin + + /cordova/plugin rm http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/blackberry10/tools.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry10/tools.md b/docs/en/edge/guide/platforms/blackberry10/tools.md deleted file mode 100644 index dace921..0000000 --- a/docs/en/edge/guide/platforms/blackberry10/tools.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -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. ---- - -# BlackBerry 10 Development Guide - -The `cordova` command-line utility is a high-level tool that allows -you to build applications across several platforms at once. An older -version of the Cordova framework provides sets of command-line tools -specific to each platform. To use them as an alternative to the CLI, -you need to download this version of Cordova from -[cordova.apache.org](http://cordova.apache.org). The download contains -separate archives for each platform. Expand the platform you wish to -target. The tools described here are typically available in the -top-level `bin` directory, otherwise consult the __README__ file for -more detailed directions. - -For information on the low-level command-line interface that enables -plugins, see Using Plugman to Manage Plugins. See Application Plugins -for an overview. - -If you need help with any command listed below, type the command along -with the `-h` or `-help` arguments, which are supported by all -commands and which provide descriptions for each of the available -arguments. - -## create - -The `create` command creates a new project: - - bin/create - -where - -- `` specifies the directory you want the project created in - -- `` specifies a reverse domain style identifier - -- `` specifies the apps display name - -__NOTE:__ the `create` command bootstraps dependency installation -through the `npm install` command. Depending on the installation -directory and system permissions, this may require administrator -privileges. If there's problem on OSX/Linux, run `sudo npm install` -before using the `create` command. On Windows, run `npm install` in a -command-line utility opened with administrator privileges. - -## target - -The `target` command allows you to manage the emulator or BlackBerry -devices that you use to test the app. You can add or remove a target, -or set a target as the default target. - -### Add a target - - /cordova/target add [-t | --type ] [-p | --password ] [--pin ] - -where - -- `` specifies a unique name for the target. - -- `` specifies the ip address of the BlackBerry device or - simulator. - -- `-p | --password ` specifies the password for the device or - emulator. This is required only if the device or emulator is - password protected. - -- `--pin ` specifies the PIN of the BlackBerry device, - which identifies that device as a valid host for the debug - token. This argument is required only if you are creating a debug - token. - -### Remove a target - - /cordova/target remove - -### Set a target as the default - - /cordova/target default - -## build - -The `build` command builds the project as a .bar file. You can build -the app in either release mode (which produces a signed .bar file) or -in debug mode (which produces an unsigned .bar file). - -### Build your project in release mode - - /cordova/build release [-k | --keystorepass ] [-b | --buildId ] [-p | --params ] - -where - -- `-k | --keystorepass ` specifies the password you defined when you configured your computer to sign applications. - -- `-b | --buildId ` specifies the build version number of your application. Typically, this number should be incremented from the previous signed version. This argument is optional. - -- `-p | --params ` specifies a JSON file containing additional parameters to pass to downstream tools. This argument is optional. - -### Build your project in debug mode - - /cordova/build debug [] [-k | --keystorepass ] [-p | --params ] [-ll | --loglevel ] - -where - -- `` specifies the name of a previously added target. If - `` is not specified, the default target is used, if one has - been created. This argument is only required if you want the script - to deploy the app to a BlackBerry device or emulator and you have - not created a default target. Additionally, if `` is a - device, then that device must be connected to your computer by USB - connection or be connected to the same Wi-Fi network as your - computer. - -- `-k | --keystorepass ` specifies the password you defined - when you configured your computer to sign applications. This - password is also used to create your debug token. This argument is - only required if you want the script to create and install the debug - token for you. - -- `-p | --params ` specifies a JSON file containing - additional parameters to pass to downstream tools. - -- `-ll | --loglevel ` specifies the log level. The log level may - be one of `error`, `warn`, or `verbose`. - -If you have previously defined a default target (and previously -installed a debug token, if that target is a BlackBerry device), you -can run the script with no arguments, and the script will package your -app and deploy it to the default target. For example: - - /cordova/build debug - -## run - -The `run` command deploys the app on the specified BlackBerry device -or an emulator. Before deploying the app, you must first create a -target for the device or emulator you want to deploy the app to using -the target script. The deploy script will deploy the most recent build of the app. - - /cordova/run - -where - -- ` `specifies the name of a previously added target. If - ` `is a device, then that device must be connected to your - computer by USB connection or be connected to the same Wi-Fi network - as your computer. - -## plugin - -The `target` command allows you to add and remove plugins - -### Fetch a locally hosted plugin - - /cordova/plugin fetch - -### View a list of installed plugins - - /cordova/plugin ls - -### Add a plugin - - /cordova/plugin add - -### Remove a plugin - - /cordova/plugin rm http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/ios/devel.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/ios/devel.md b/docs/en/edge/guide/platforms/ios/devel.md new file mode 100644 index 0000000..53f0213 --- /dev/null +++ b/docs/en/edge/guide/platforms/ios/devel.md @@ -0,0 +1,63 @@ +--- +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. +--- + +# iOS Development Guide + +The `cordova` command-line utility is a high-level tool that allows +you to build applications across several platforms at once. An older +version of the Cordova framework provides sets of command-line tools +specific to each platform. To use them as an alternative to the CLI, +you need to download this version of Cordova from +[cordova.apache.org](http://cordova.apache.org). The download contains +separate archives for each platform. Expand the platform you wish to +target. The tools described here are typically available in the +top-level `bin` directory, otherwise consult the __README__ file for +more detailed directions. + +The iOS command-line tools are built upon shell scripts and rely on +Xcode command-line tools such as `xcode-select` and `xcodebuild`. + +For information on the low-level command-line interface that enables +plugins, see Using Plugman to Manage Plugins. See Application Plugins +for an overview. + +## Create a project + +Run the `create` command, specifying the existing path to the project, +the reverse-domain-style package identifier, and the app's display +name. + + $ ./path/to/cordova-ios/bin/create /path/to/my_new_project com.example.project_name ProjectName + +## Build a project + + $ /path/to/my_new_project/cordova/build + +## Run app on emulator + + $ /path/to/my_new_project/cordova/run + +## Releasing + + $ /path/to/my_new_project/cordova/release + +## Logging + + $ /path/to/my_new_project/cordova/log + http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/ios/tools.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/ios/tools.md b/docs/en/edge/guide/platforms/ios/tools.md deleted file mode 100644 index 53f0213..0000000 --- a/docs/en/edge/guide/platforms/ios/tools.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. ---- - -# iOS Development Guide - -The `cordova` command-line utility is a high-level tool that allows -you to build applications across several platforms at once. An older -version of the Cordova framework provides sets of command-line tools -specific to each platform. To use them as an alternative to the CLI, -you need to download this version of Cordova from -[cordova.apache.org](http://cordova.apache.org). The download contains -separate archives for each platform. Expand the platform you wish to -target. The tools described here are typically available in the -top-level `bin` directory, otherwise consult the __README__ file for -more detailed directions. - -The iOS command-line tools are built upon shell scripts and rely on -Xcode command-line tools such as `xcode-select` and `xcodebuild`. - -For information on the low-level command-line interface that enables -plugins, see Using Plugman to Manage Plugins. See Application Plugins -for an overview. - -## Create a project - -Run the `create` command, specifying the existing path to the project, -the reverse-domain-style package identifier, and the app's display -name. - - $ ./path/to/cordova-ios/bin/create /path/to/my_new_project com.example.project_name ProjectName - -## Build a project - - $ /path/to/my_new_project/cordova/build - -## Run app on emulator - - $ /path/to/my_new_project/cordova/run - -## Releasing - - $ /path/to/my_new_project/cordova/release - -## Logging - - $ /path/to/my_new_project/cordova/log - http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/win8/devel.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/win8/devel.md b/docs/en/edge/guide/platforms/win8/devel.md new file mode 100644 index 0000000..90c92dc --- /dev/null +++ b/docs/en/edge/guide/platforms/win8/devel.md @@ -0,0 +1,50 @@ +--- +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. +--- + +# Windows 8 Development Guide + +The `cordova` command-line utility is a high-level tool that allows +you to build applications across several platforms at once. An older +version of the Cordova framework provides sets of command-line tools +specific to each platform. To use them as an alternative to the CLI, +you need to download this version of Cordova from +[cordova.apache.org](http://cordova.apache.org). The download contains +separate archives for each platform. Expand the platform you wish to +target. The tools described here are typically available in the +top-level `bin` directory, otherwise consult the __README__ file for +more detailed directions. + +For information on the low-level command-line interface that enables +plugins, see Using Plugman to Manage Plugins. See Application Plugins +for an overview. + +## Windows 8 + +The Windows 8 command-line tools only support creating new projects. +Commands must be run from a cmd or powershell prompt. + +## Create a project + +Run the `create` command with the following parameters: + +* Path to your new Cordova Windows 8 project + +* Package Name, following reverse-domain style convention. This becomes the default Namespace. + +* Project name http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/win8/tools.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/win8/tools.md b/docs/en/edge/guide/platforms/win8/tools.md deleted file mode 100644 index 90c92dc..0000000 --- a/docs/en/edge/guide/platforms/win8/tools.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -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. ---- - -# Windows 8 Development Guide - -The `cordova` command-line utility is a high-level tool that allows -you to build applications across several platforms at once. An older -version of the Cordova framework provides sets of command-line tools -specific to each platform. To use them as an alternative to the CLI, -you need to download this version of Cordova from -[cordova.apache.org](http://cordova.apache.org). The download contains -separate archives for each platform. Expand the platform you wish to -target. The tools described here are typically available in the -top-level `bin` directory, otherwise consult the __README__ file for -more detailed directions. - -For information on the low-level command-line interface that enables -plugins, see Using Plugman to Manage Plugins. See Application Plugins -for an overview. - -## Windows 8 - -The Windows 8 command-line tools only support creating new projects. -Commands must be run from a cmd or powershell prompt. - -## Create a project - -Run the `create` command with the following parameters: - -* Path to your new Cordova Windows 8 project - -* Package Name, following reverse-domain style convention. This becomes the default Namespace. - -* Project name http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/wp8/devel.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/wp8/devel.md b/docs/en/edge/guide/platforms/wp8/devel.md new file mode 100644 index 0000000..3d6888b --- /dev/null +++ b/docs/en/edge/guide/platforms/wp8/devel.md @@ -0,0 +1,107 @@ +--- +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. +--- + +# Windows Phone Development Guide + +The `cordova` command-line utility is a high-level tool that allows +you to build applications across several platforms at once. An older +version of the Cordova framework provides sets of command-line tools +specific to each platform. To use them as an alternative to the CLI, +you need to download this version of Cordova from +[cordova.apache.org](http://cordova.apache.org). The download contains +separate archives for each platform. Expand the platform you wish to +target. The tools described here are typically available in the +top-level `bin` directory, otherwise consult the __README__ file for +more detailed directions. + +For information on the low-level command-line interface that enables +plugins, see Using Plugman to Manage Plugins. See Application Plugins +for an overview. + +## Windows Phone + +The Windows Phone command-line tools support creating, building, and +running new projects. Commands must be run from a cmd or powershell +prompt. + +The WP8 repo now includes code for building both WP7 + WP8 apps. The +repo has subdirectories for each: `wp7/` and `wp8/`. + +## Create a project + +There are 2 ways to go about creating a new Apache Cordova WP7 or WP8 application. + +### Run the batch file to create and install the templates. + +- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where x.x.x is the current version number) To easily use these files in Visual Studio, copy them to +"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu. + +- If you run the batch file from the command line, you can also call with a parameter to install automatically + +Run the script : + + >createTemplates.bat -install + +### Use the create scripts on the command line + +Run the `create` command, specifying the existing path to the project, +the reverse-domain-style package identifier, and the app's display +name. Here is the syntax for both Windows Phone 7 and 8: + + >.\wp7\bin\create PathToNewProject [ PackageName ] [ AppName ] + >.\wp8\bin\create PathToNewProject [ PackageName ] [ AppName ] + + >PathToNewProject : The path to where you wish to create the project + >PackageName : The namespace for the project (default is Cordova.Example) + >AppName : The name of the application (default is CordovaWP8AppProj or CordovaWP7AppProj) + + >examples: + >.\wp7\bin\create C:\path\to\my_new_project + >.\wp8\bin\create C:\path\to\my_new_project io.cordova.example CordovaWP8App + +Launch Visual Studio and open Solution file (.sln) in (C:\path\to\my_new_project) + +Build and Run it + +## Building your project (cleans then builds) + +* Debug + + $ C:\path\to\my_new_project\cordova\build --debug + +* Release + + $ C:\path\to\my_new_project\cordova\build --release + +## Running your application + +Run the 'run' command with the following *optional* parameters + +* Target specification. This includes `--emulator`, `--device`, or `--target=`. + +* Build specification. This includes `--debug`, `--release`, or `--nobuild`. + + $ C:\path\to\my_new_project\cordova\run [Target] [Build] + +By default the `run` command will be called with `--emulator --debug` if flags are not provided. + +## Cleaning + + $ C:\path\to\my_new_project\cordova\clean + http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/9ddf3c83/docs/en/edge/guide/platforms/wp8/tools.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/wp8/tools.md b/docs/en/edge/guide/platforms/wp8/tools.md deleted file mode 100644 index 3d6888b..0000000 --- a/docs/en/edge/guide/platforms/wp8/tools.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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. ---- - -# Windows Phone Development Guide - -The `cordova` command-line utility is a high-level tool that allows -you to build applications across several platforms at once. An older -version of the Cordova framework provides sets of command-line tools -specific to each platform. To use them as an alternative to the CLI, -you need to download this version of Cordova from -[cordova.apache.org](http://cordova.apache.org). The download contains -separate archives for each platform. Expand the platform you wish to -target. The tools described here are typically available in the -top-level `bin` directory, otherwise consult the __README__ file for -more detailed directions. - -For information on the low-level command-line interface that enables -plugins, see Using Plugman to Manage Plugins. See Application Plugins -for an overview. - -## Windows Phone - -The Windows Phone command-line tools support creating, building, and -running new projects. Commands must be run from a cmd or powershell -prompt. - -The WP8 repo now includes code for building both WP7 + WP8 apps. The -repo has subdirectories for each: `wp7/` and `wp8/`. - -## Create a project - -There are 2 ways to go about creating a new Apache Cordova WP7 or WP8 application. - -### Run the batch file to create and install the templates. - -- The root of the repo contains a file createTemplates.bat. Double clicking this file will generate 2 .zip files. (CordovaWP7_x_x_x.zip + CordovaWP8_x_x_x.zip where x.x.x is the current version number) To easily use these files in Visual Studio, copy them to -"My Documents\Visual Studio 2012\Templates\ProjectTemplates\" You will then be able to create new Apache Cordova Windows Phone apps from the Visual Studio File->New Project menu. - -- If you run the batch file from the command line, you can also call with a parameter to install automatically - -Run the script : - - >createTemplates.bat -install - -### Use the create scripts on the command line - -Run the `create` command, specifying the existing path to the project, -the reverse-domain-style package identifier, and the app's display -name. Here is the syntax for both Windows Phone 7 and 8: - - >.\wp7\bin\create PathToNewProject [ PackageName ] [ AppName ] - >.\wp8\bin\create PathToNewProject [ PackageName ] [ AppName ] - - >PathToNewProject : The path to where you wish to create the project - >PackageName : The namespace for the project (default is Cordova.Example) - >AppName : The name of the application (default is CordovaWP8AppProj or CordovaWP7AppProj) - - >examples: - >.\wp7\bin\create C:\path\to\my_new_project - >.\wp8\bin\create C:\path\to\my_new_project io.cordova.example CordovaWP8App - -Launch Visual Studio and open Solution file (.sln) in (C:\path\to\my_new_project) - -Build and Run it - -## Building your project (cleans then builds) - -* Debug - - $ C:\path\to\my_new_project\cordova\build --debug - -* Release - - $ C:\path\to\my_new_project\cordova\build --release - -## Running your application - -Run the 'run' command with the following *optional* parameters - -* Target specification. This includes `--emulator`, `--device`, or `--target=`. - -* Build specification. This includes `--debug`, `--release`, or `--nobuild`. - - $ C:\path\to\my_new_project\cordova\run [Target] [Build] - -By default the `run` command will be called with `--emulator --debug` if flags are not provided. - -## Cleaning - - $ C:\path\to\my_new_project\cordova\clean -