Updated Branches: refs/heads/master dc55db0c0 -> 551147fa3
Updated docs to reflect tooling/cli changes Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/551147fa Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/551147fa Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/551147fa Branch: refs/heads/master Commit: 551147fa36ea57437ac919ec4cf544a19d01b126 Parents: dc55db0 Author: Benn Mapes <[email protected]> Authored: Mon Apr 22 14:09:14 2013 -0700 Committer: Michael Brooks <[email protected]> Committed: Wed Apr 24 14:02:15 2013 -0700 ---------------------------------------------------------------------- docs/en/2.7.0rc1/guide/command-line/index.md | 101 +++++++++++---- .../guide/getting-started/windows-phone-7/index.md | 6 +- .../guide/getting-started/windows-phone-8/index.md | 15 +-- docs/en/edge/guide/command-line/index.md | 101 +++++++++++---- .../guide/getting-started/windows-phone-7/index.md | 6 +- .../guide/getting-started/windows-phone-8/index.md | 15 +-- 6 files changed, 166 insertions(+), 78 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/551147fa/docs/en/2.7.0rc1/guide/command-line/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.7.0rc1/guide/command-line/index.md b/docs/en/2.7.0rc1/guide/command-line/index.md index b235cf2..e16a0ac 100644 --- a/docs/en/2.7.0rc1/guide/command-line/index.md +++ b/docs/en/2.7.0rc1/guide/command-line/index.md @@ -35,21 +35,54 @@ Cordova projects. * [BlackBerry](#Command-Line%20Usage_blackberry) * [Windows Phone 8](#Command-Line%20Usage_wp8) -## Windows Phone 8 +## Windows Phone -The Windows Phone 8 command line tools support creating new projects. +The Windows Phone command line tools support creating, building and +running new projects. ### Create a project Run the `create` command with the following parameters: -* Path to your new Cordova WP8 project +* Path to your new Cordova Windows Phone project * Package Name, following reverse-domain style convention ( this becomes the default Namespace ) * Project name <!-- --> - $ ./path/to/cordova-wp8/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName + $ C:\path\to\cordova-wp8\bin\create C:\path\to\my_new_cordova_project com.example.cordova_project_name CordovaProjectName + +### Building your project (cleans then builds) + +* Debug + +<!-- --> + + $ C:\path\to\my_new_cordova_project\cordova\build --debug + +* Release + +<!-- --> + + $ C:\path\to\my_new_cordova_project\cordova\build --release + +### Running your application + +Run the 'run' command with the following *optional* parameters + +* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`. +* Build specification. This includes `--debug`, `--release`, or `--nobuild`. + +<!-- --> + + $ C:\path\to\my_new_cordova_project\cordova\run [Target] [Build] + +By default the `run` command will look for a connected device, if no device is found it will look for any started emulators. If you have multiple emulators, you can specify a target ID. + +### Cleaning + + $ C:\path\to\my_new_cordova_project\cordova\clean + ## iOS @@ -103,52 +136,66 @@ Run the `create` command with the following parameters: $ /path/to/cordova-android/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName -or, on **Windows** +or, on *Windows* - $ /path/to/cordova-android/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName + $ C:\path\to\cordova-android\bin\create.bat C:\path\to\my_new_cordova_project com.example.cordova_project_name CordovaProjectName -### Build a project +### Building your project (cleans then builds) - $ /path/to/my_new_cordova_project/cordova/build +* **Debug** -or, on **Windows** +<!-- --> - $ /path/to/my_new_cordova_project/cordova/build.bat + $ /path/to/my_new_cordova_project/cordova/build --debug -### Run app on emulator/device + or, on *Windows* - $ /path/to/my_new_cordova_project/cordova/run + $ C:\path\to\my_new_cordova_project\cordova\build.bat --debug -or, on **Windows** +* **Release** + +<!-- --> + + $ /path/to/my_new_cordova_project/cordova/build --release + + or, on *Windows* + + $ C:\path\to\my_new_cordova_project\cordova\build.bat --release + + +### Running your application + +Run the 'run' command with the following *optional* parameters + +* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`. +* Build specification. This includes `--debug`, `--release`, or `--nobuild`. + +<!-- --> + $ /path/to/my_new_cordova_project/cordova/run [Target] [Build] + + or, on *Windows* + + $ C:\path\to\my_new_cordova_project\cordova\run.bat [Target] [Build] - $ /path/to/my_new_cordova_project/cordova/run.bat Make sure you have created at least one Android Virtual Device. If you did not it will ask you to create one with the `android` command. -If you have multiple AVDs, it will prompt you to select an AVD. +By default the `run` command will look for a connected device, if no device is found it will look for any started emulators. If you have multiple AVDs, you can specify a target ID. ### Logging $ /path/to/my_new_cordova_project/cordova/log -or, on **Windows** +or, on *Windows* - $ /path/to/my_new_cordova_project/cordova/log.bat + $ C:\path\to\my_new_cordova_project\cordova\log.bat ### Cleaning $ /path/to/my_new_cordova_project/cordova/clean -or, on **Windows** - - $ /path/to/my_new_cordova_project/cordova/clean.bat - -### Releasing - - $ /path/to/my_new_cordova_project/cordova/release - -or, on **Windows** +or, on *Windows* - $ /path/to/my_new_cordova_project/cordova/release.bat + $ C:\path\to\my_new_cordova_project\cordova\clean.bat ## BlackBerry http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/551147fa/docs/en/2.7.0rc1/guide/getting-started/windows-phone-7/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.7.0rc1/guide/getting-started/windows-phone-7/index.md b/docs/en/2.7.0rc1/guide/getting-started/windows-phone-7/index.md index 3de69c5..7d91253 100644 --- a/docs/en/2.7.0rc1/guide/getting-started/windows-phone-7/index.md +++ b/docs/en/2.7.0rc1/guide/getting-started/windows-phone-7/index.md @@ -32,7 +32,7 @@ Video Tutorials: 1. Requirements --------------- -- Windows 7 or Windows Vista with SP2 +- Windows 7, Windows 8 or Windows Vista with SP2 Note: Running in VM has issues, if you are on a Mac, you will need to setup a bootcamp partition with Windows 7 or Vista @@ -46,7 +46,7 @@ Necessary for Installing on Device and Submitting to Market Place: - Download and install [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/) - Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder: lib\windows-phone\ -- copy the file CordovaStarter-2.7.0.zip to the folder : \My Documents\Visual Studio 2010\Templates\ProjectTemplates\ +- copy the file CordovaWP7_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates ( if the template file does not exist, you will need to build it. See 2.1 below ) if you have just installed VisualStudio, you should launch it once to create this folder if you prefer, you may add the project instead to the "Silverlight for Windows Phone" subfolder of "Visual C#". This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder. @@ -54,7 +54,7 @@ if you prefer, you may add the project instead to the "Silverlight for Windows P 2.1. Building the template ----------------------------- -( note, this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-2.7.0.zip then you may skip this step ) +( note, this step may not be required. If the lib\windows-phone directory already contains a file CordovaWP7_x_x_x.zip then you may skip this step ) - Open the file lib\windows-phone\templates\standalone\CordovaSolution.sln in Visual Studio Express for Windows Phone - From the file menu, select 'Export Template...' - Choose template type 'Project template' http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/551147fa/docs/en/2.7.0rc1/guide/getting-started/windows-phone-8/index.md ---------------------------------------------------------------------- diff --git a/docs/en/2.7.0rc1/guide/getting-started/windows-phone-8/index.md b/docs/en/2.7.0rc1/guide/getting-started/windows-phone-8/index.md index 4e62d9c..bd0c9b1 100644 --- a/docs/en/2.7.0rc1/guide/getting-started/windows-phone-8/index.md +++ b/docs/en/2.7.0rc1/guide/getting-started/windows-phone-8/index.md @@ -57,12 +57,12 @@ Note: Running the SDK in Virtual Machine might present some challenges. You can - Download and install [Windows Phone SDK](http://www.microsoft.com/en-us/download/details.aspx?id=35471) - Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder: lib\windows-phone-8\ -- copy the file CordovaWP8AppFull-2.7.0.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\ +- copy the file CordovaWP8_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\ 2.1. Building the template ----------------------------- -Note: this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-2.7.0.zip then you may skip this step. +Note: this step may not be required. If the lib\windows-phone directory already contains a file CordovaWP8_x_x_x.zip then you may skip this step. In order to simplify the development process, Cordova comes with a Visual Studio template that allows creating a Cordova application rapidly. This template can be modified if needed and the below steps indicate how to proceed if you want to modify and re-generate the template. @@ -75,23 +75,20 @@ In order to simplify the development process, Cordova comes with a Visual Studio - Press 'Finish' -2.2 About the different templates +2.2 About the template -------------------- -Apache Cordova for Windows Phone 8 supports 2 different types of templates. +Apache Cordova for Windows Phone 8 has moved to only supporting the standalone template. -The 'Full' template includes a pre-built dll containing all the framework code for Apache Cordova. This template will create a project that is easy to update, as you can simply replace the JavaScript and .dll in your project and rebuild when a new version comes out. The downside of this approach is that because the dll contains ALL of the Cordova API, it requires all available permissions even if the APIs are not called. When you submit an app to the App store, Microsoft will run a static analyzer against your application, and detect that you require all available permissions, and place a disclaimer on you app that is presented to the user when they choose to install your app. Users may be discouraged if they see a required permission that does not make sense ( ie, why does this drawing program need access to my media library and contacts ). - -The 'Stand-Alone' template includes ALL the source code for Apache Cordova. This project is easier to fine-tune to use just the features you need, thereby working around the permissions issues of the 'Full' template, however this type of project will be more difficult to update, as you will need to update individual files within your project and manage any dependancies yourself. In order to exclude an API you are not using, you can simply right-click-select the Command class file in Visual Studio and choose 'do not include in project'. +The 'Stand-Alone' template includes ALL the source code for Apache Cordova. This project is easier to fine-tune to use just the features you need, thereby working around the permissions issues of using the dll. In order to exclude an API (Plugin) you are not using, you can simply right-click-select the Command class file in Visual Studio and choose 'do not include in project'. 3. Setup New Project -------------------- - Open Visual Studio Express for Windows Phone and choose **New Project**. -- Select **CordovaWP8AppFull** or **CordovaWP8AppStandalone**. ( the version number will be displayed in the template description ) +- Select **CordovaWP8**. ( the version number will be displayed in the template description ) - Give your project a name, and select OK. -  http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/551147fa/docs/en/edge/guide/command-line/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/command-line/index.md b/docs/en/edge/guide/command-line/index.md index b235cf2..e16a0ac 100644 --- a/docs/en/edge/guide/command-line/index.md +++ b/docs/en/edge/guide/command-line/index.md @@ -35,21 +35,54 @@ Cordova projects. * [BlackBerry](#Command-Line%20Usage_blackberry) * [Windows Phone 8](#Command-Line%20Usage_wp8) -## Windows Phone 8 +## Windows Phone -The Windows Phone 8 command line tools support creating new projects. +The Windows Phone command line tools support creating, building and +running new projects. ### Create a project Run the `create` command with the following parameters: -* Path to your new Cordova WP8 project +* Path to your new Cordova Windows Phone project * Package Name, following reverse-domain style convention ( this becomes the default Namespace ) * Project name <!-- --> - $ ./path/to/cordova-wp8/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName + $ C:\path\to\cordova-wp8\bin\create C:\path\to\my_new_cordova_project com.example.cordova_project_name CordovaProjectName + +### Building your project (cleans then builds) + +* Debug + +<!-- --> + + $ C:\path\to\my_new_cordova_project\cordova\build --debug + +* Release + +<!-- --> + + $ C:\path\to\my_new_cordova_project\cordova\build --release + +### Running your application + +Run the 'run' command with the following *optional* parameters + +* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`. +* Build specification. This includes `--debug`, `--release`, or `--nobuild`. + +<!-- --> + + $ C:\path\to\my_new_cordova_project\cordova\run [Target] [Build] + +By default the `run` command will look for a connected device, if no device is found it will look for any started emulators. If you have multiple emulators, you can specify a target ID. + +### Cleaning + + $ C:\path\to\my_new_cordova_project\cordova\clean + ## iOS @@ -103,52 +136,66 @@ Run the `create` command with the following parameters: $ /path/to/cordova-android/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName -or, on **Windows** +or, on *Windows* - $ /path/to/cordova-android/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName + $ C:\path\to\cordova-android\bin\create.bat C:\path\to\my_new_cordova_project com.example.cordova_project_name CordovaProjectName -### Build a project +### Building your project (cleans then builds) - $ /path/to/my_new_cordova_project/cordova/build +* **Debug** -or, on **Windows** +<!-- --> - $ /path/to/my_new_cordova_project/cordova/build.bat + $ /path/to/my_new_cordova_project/cordova/build --debug -### Run app on emulator/device + or, on *Windows* - $ /path/to/my_new_cordova_project/cordova/run + $ C:\path\to\my_new_cordova_project\cordova\build.bat --debug -or, on **Windows** +* **Release** + +<!-- --> + + $ /path/to/my_new_cordova_project/cordova/build --release + + or, on *Windows* + + $ C:\path\to\my_new_cordova_project\cordova\build.bat --release + + +### Running your application + +Run the 'run' command with the following *optional* parameters + +* Target specification. This includes `--emulator`, `--device`, or `--target=<targetID>`. +* Build specification. This includes `--debug`, `--release`, or `--nobuild`. + +<!-- --> + $ /path/to/my_new_cordova_project/cordova/run [Target] [Build] + + or, on *Windows* + + $ C:\path\to\my_new_cordova_project\cordova\run.bat [Target] [Build] - $ /path/to/my_new_cordova_project/cordova/run.bat Make sure you have created at least one Android Virtual Device. If you did not it will ask you to create one with the `android` command. -If you have multiple AVDs, it will prompt you to select an AVD. +By default the `run` command will look for a connected device, if no device is found it will look for any started emulators. If you have multiple AVDs, you can specify a target ID. ### Logging $ /path/to/my_new_cordova_project/cordova/log -or, on **Windows** +or, on *Windows* - $ /path/to/my_new_cordova_project/cordova/log.bat + $ C:\path\to\my_new_cordova_project\cordova\log.bat ### Cleaning $ /path/to/my_new_cordova_project/cordova/clean -or, on **Windows** - - $ /path/to/my_new_cordova_project/cordova/clean.bat - -### Releasing - - $ /path/to/my_new_cordova_project/cordova/release - -or, on **Windows** +or, on *Windows* - $ /path/to/my_new_cordova_project/cordova/release.bat + $ C:\path\to\my_new_cordova_project\cordova\clean.bat ## BlackBerry http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/551147fa/docs/en/edge/guide/getting-started/windows-phone-7/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/getting-started/windows-phone-7/index.md b/docs/en/edge/guide/getting-started/windows-phone-7/index.md index 7cf023a..7d91253 100644 --- a/docs/en/edge/guide/getting-started/windows-phone-7/index.md +++ b/docs/en/edge/guide/getting-started/windows-phone-7/index.md @@ -32,7 +32,7 @@ Video Tutorials: 1. Requirements --------------- -- Windows 7 or Windows Vista with SP2 +- Windows 7, Windows 8 or Windows Vista with SP2 Note: Running in VM has issues, if you are on a Mac, you will need to setup a bootcamp partition with Windows 7 or Vista @@ -46,7 +46,7 @@ Necessary for Installing on Device and Submitting to Market Place: - Download and install [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/) - Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder: lib\windows-phone\ -- copy the file CordovaStarter-x.x.x.zip to the folder : \My Documents\Visual Studio 2010\Templates\ProjectTemplates\ +- copy the file CordovaWP7_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates ( if the template file does not exist, you will need to build it. See 2.1 below ) if you have just installed VisualStudio, you should launch it once to create this folder if you prefer, you may add the project instead to the "Silverlight for Windows Phone" subfolder of "Visual C#". This is up to you, and only affects where the project template is shown when creating a new project. Also, You may need to create this folder. @@ -54,7 +54,7 @@ if you prefer, you may add the project instead to the "Silverlight for Windows P 2.1. Building the template ----------------------------- -( note, this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-x.x.x.zip then you may skip this step ) +( note, this step may not be required. If the lib\windows-phone directory already contains a file CordovaWP7_x_x_x.zip then you may skip this step ) - Open the file lib\windows-phone\templates\standalone\CordovaSolution.sln in Visual Studio Express for Windows Phone - From the file menu, select 'Export Template...' - Choose template type 'Project template' http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/551147fa/docs/en/edge/guide/getting-started/windows-phone-8/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/getting-started/windows-phone-8/index.md b/docs/en/edge/guide/getting-started/windows-phone-8/index.md index 4f6aa5d..bd0c9b1 100644 --- a/docs/en/edge/guide/getting-started/windows-phone-8/index.md +++ b/docs/en/edge/guide/getting-started/windows-phone-8/index.md @@ -57,12 +57,12 @@ Note: Running the SDK in Virtual Machine might present some challenges. You can - Download and install [Windows Phone SDK](http://www.microsoft.com/en-us/download/details.aspx?id=35471) - Download the latest copy of [Cordova](http://phonegap.com/download) and extract its contents. We will be working with the subfolder: lib\windows-phone-8\ -- copy the file CordovaWP8AppFull-x.x.x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\ +- copy the file CordovaWP8_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\ 2.1. Building the template ----------------------------- -Note: this step may not be required. If the lib\windows-phone directory already contains a file CordovaStarter-x.x.x.zip then you may skip this step. +Note: this step may not be required. If the lib\windows-phone directory already contains a file CordovaWP8_x_x_x.zip then you may skip this step. In order to simplify the development process, Cordova comes with a Visual Studio template that allows creating a Cordova application rapidly. This template can be modified if needed and the below steps indicate how to proceed if you want to modify and re-generate the template. @@ -75,23 +75,20 @@ In order to simplify the development process, Cordova comes with a Visual Studio - Press 'Finish' -2.2 About the different templates +2.2 About the template -------------------- -Apache Cordova for Windows Phone 8 supports 2 different types of templates. +Apache Cordova for Windows Phone 8 has moved to only supporting the standalone template. -The 'Full' template includes a pre-built dll containing all the framework code for Apache Cordova. This template will create a project that is easy to update, as you can simply replace the JavaScript and .dll in your project and rebuild when a new version comes out. The downside of this approach is that because the dll contains ALL of the Cordova API, it requires all available permissions even if the APIs are not called. When you submit an app to the App store, Microsoft will run a static analyzer against your application, and detect that you require all available permissions, and place a disclaimer on you app that is presented to the user when they choose to install your app. Users may be discouraged if they see a required permission that does not make sense ( ie, why does this drawing program need access to my media library and contacts ). - -The 'Stand-Alone' template includes ALL the source code for Apache Cordova. This project is easier to fine-tune to use just the features you need, thereby working around the permissions issues of the 'Full' template, however this type of project will be more difficult to update, as you will need to update individual files within your project and manage any dependancies yourself. In order to exclude an API you are not using, you can simply right-click-select the Command class file in Visual Studio and choose 'do not include in project'. +The 'Stand-Alone' template includes ALL the source code for Apache Cordova. This project is easier to fine-tune to use just the features you need, thereby working around the permissions issues of using the dll. In order to exclude an API (Plugin) you are not using, you can simply right-click-select the Command class file in Visual Studio and choose 'do not include in project'. 3. Setup New Project -------------------- - Open Visual Studio Express for Windows Phone and choose **New Project**. -- Select **CordovaWP8AppFull** or **CordovaWP8AppStandalone**. ( the version number will be displayed in the template description ) +- Select **CordovaWP8**. ( the version number will be displayed in the template description ) - Give your project a name, and select OK. - 
