Updated Branches: refs/heads/master 1904513f8 -> 34f9eb6e9
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/guide/platforms/wp7/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/wp7/index.md b/docs/en/edge/guide/platforms/wp7/index.md index b5a1fe4..c458fb5 100644 --- a/docs/en/edge/guide/platforms/wp7/index.md +++ b/docs/en/edge/guide/platforms/wp7/index.md @@ -50,7 +50,9 @@ __NOTE:__ Running the SDK in Virtual Machine might present some challenges. You ## 2. Install SDK + Cordova - Download and install the [Windows Phone SDK](http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=27570/) + - Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8\wp7` subfolder, `lib\windows-phone-8\wp8` contains the Windwos Phone 8 version of Cordova. + - Copy the file CordovaWP7_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\ ## 2.1. Building the template @@ -63,6 +65,7 @@ In order to simplify the development process, Cordova comes with a script to bui - 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 : @@ -72,13 +75,17 @@ Run the script : ## 3. Set up New Project - Open Visual Studio Express for Windows Phone and choose **New Project**. + - Select **CordovaWP7**. (The version number is displayed in the template description.) + - Give the project a name, and select __OK__. ## 4. Review the project structure - The `www` folder contains your Cordova `html/js/css` and any other resources included in your app. + - Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content. + - Note: This screen capture was from the wp8 cordova-2.3.0 download, your listing will vary based on the actual version installed.  @@ -88,7 +95,9 @@ Run the script : In order to test your application on a device, the device must be registered. Click [here][register-url] to read documentation on deploying and testing on your Windows Phone 7. - Make sure your phone is connected, and the screen is unlocked. + - In Visual Studio, select 'Device' from the top drop-down menu. + - Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.  http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/guide/platforms/wp8/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/wp8/index.md b/docs/en/edge/guide/platforms/wp8/index.md index 7656de9..fd97c69 100644 --- a/docs/en/edge/guide/platforms/wp8/index.md +++ b/docs/en/edge/guide/platforms/wp8/index.md @@ -67,7 +67,9 @@ __NOTE:__ Running the SDK in Virtual Machine might present some challenges. You ## 2. Install SDK + Cordova - Download and install [Windows Phone SDK](http://www.microsoft.com/en-us/download/details.aspx?id=35471) + - Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-phone-8\wp8` subfolder, `lib\windows-phone-8\wp7` contains the Windwos Phone 7 version of Cordova. + - Copy the file CordovaWP8_x_x_x.zip to the folder : \My Documents\Visual Studio 2012\Templates\ProjectTemplates\ ## 2.1. Building the template @@ -80,6 +82,7 @@ In order to simplify the development process, Cordova comes with a script to bui - 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 : @@ -89,7 +92,9 @@ Run the script : ## 3. Set up New Project - Open Visual Studio Express for Windows Phone and choose **New Project**. + - Select **CordovaWP8**. (The version number is displayed in the template description.) + - Give the project a name, and select __OK__.  @@ -97,7 +102,9 @@ Run the script : ## 4. Review the project structure - The `www` folder contains your Cordova `html/js/css` and any other resources included in your app. + - Any content that you add here needs to be a part of the Visual Studio project, and it must be set as content. + - Note: This screen capture was from the cordova-2.3.0 download, your listing will vary based on the actual version installed.  @@ -105,6 +112,7 @@ Run the script : ## 5. Build and Deploy to Emulator - Make sure **Windows Phone Emulator** is selected in the main drop-down menu. + - Press the green **play** button next to the drop-down menu to start debugging, or type __F5__.  @@ -114,7 +122,9 @@ Run the script : In order to test your application on a device, the device must be registered. Click [here][register-url] to read documentation on deploying and testing on your Windows Phone 8. - Make sure your phone is connected, and the screen is unlocked. + - In Visual Studio, select 'Device' from the top drop-down menu. + - Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.  http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/guide/platforms/wp8/plugin.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/wp8/plugin.md b/docs/en/edge/guide/platforms/wp8/plugin.md index 3bf34b4..1c09791 100644 --- a/docs/en/edge/guide/platforms/wp8/plugin.md +++ b/docs/en/edge/guide/platforms/wp8/plugin.md @@ -27,8 +27,10 @@ and it comes with the majority of the 'plumbing' built for you already. 1. Select your project, and right-click to choose __Add → New Item...__ - Preferably add it to the 'Plugins' folder, but it is up to you + 2. Select 'Class' and name it `Echo.cs` - The name of this class must _exactly_ match what you call into `cordova.exec(win, fail, "Echo", ...)` + 3. Include the base classes implementation using WPCordovaClassLib.Cordova; @@ -42,7 +44,7 @@ and it comes with the majority of the 'plumbing' built for you already. // ... } -5. Add a method that is callable from JS +5. Add a method that is callable from JavaScript public class Echo : BaseCommand { @@ -74,7 +76,7 @@ your C# class like this: } } -Then, in JS you need to call `exec` like this: +Then, in JavaScript you need to call `exec` like this: cordova.exec(win, fail, "com.mydomain.cordovaExtensions.Echo", ...); @@ -82,7 +84,7 @@ Then, in JS you need to call `exec` like this: The data received by your plugin method is a string value, but in actuality looking at our JavaScript code, we see our intention was to pass an array of strings. -Looking back at our JS call to `cordova.exec`, we see we passed `[str]`: +Looking back at our JavaScript call to `cordova.exec`, we see we passed `[str]`: cordova.exec(win, fail, "Echo", "echo", ["input string"]); @@ -91,7 +93,7 @@ we see that the value is actually: "[\"input string\"]" -All JavaScript exec arguments are JSON encoded before being passed into C#. +All JavaScript `exec` arguments are JSON encoded before being passed into C#. If we want to treat this as the string we were expecting, we need to decode it. We can use simple JSON deserialization. @@ -99,9 +101,9 @@ We can use simple JSON deserialization. string optVal = JsonHelper.Deserialize<string[]>(options)[0]; // optVal now has the value of "input string" -## Passing results from C# to JS +## Passing results from C# to JavaScript -The base class BaseCommand provides methods for passing data to your JS callback handlers. +The base class BaseCommand provides methods for passing data to your JavaScript callback handlers. To simply signal that the command has succeeded, when no additional result info is needed, you can simply call: @@ -111,7 +113,7 @@ To pass data back, you need to call a different version of `DispatchCommandResul DispatchCommandResult(new PluginResult(PluginResult.Status.OK, "Everything went as planned, this is a result that is passed to the success handler.")); -To pass structured object data back to JS, it should be encoded as a JSON string: +To pass structured object data back to JavaScript, it should be encoded as a JSON string: DispatchCommandResult(new PluginResult(PluginResult.Status.OK, "{result:\"super awesome!\"}")); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/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 index 2d96064..e04b34d 100644 --- a/docs/en/edge/guide/platforms/wp8/tools.md +++ b/docs/en/edge/guide/platforms/wp8/tools.md @@ -47,6 +47,7 @@ There are 2 ways to go about creating a new Apache Cordova WP7 or WP8 applicatio - 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 : @@ -89,6 +90,7 @@ name. Here is the syntax for both Windows Phone 7 and 8: 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_project\cordova\run [Target] [Build] http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/guide/platforms/wp8/upgrading.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/wp8/upgrading.md b/docs/en/edge/guide/platforms/wp8/upgrading.md index 76e27eb..5a208dd 100644 --- a/docs/en/edge/guide/platforms/wp8/upgrading.md +++ b/docs/en/edge/guide/platforms/wp8/upgrading.md @@ -20,37 +20,47 @@ license: Licensed to the Apache Software Foundation (ASF) under one # Upgrading Windows Phone This guide shows how to modify Windows Phone projects, both versions 7 -and 8, to upgrade from older versions of Cordova. -Most of these instructions apply to projects created with an older set -of command-line tools that precede the `cordova` CLI utility. See The Command-line Interface for information how to update the -version of the CLI. -The following section shows how to upgrade from non-CLI projects. +and 8, to upgrade from older versions of Cordova. Most of these +instructions apply to projects created with an older set of +command-line tools that precede the `cordova` CLI utility. See The +Command-line Interface for information how to update the version of +the CLI. The following section shows how to upgrade from non-CLI +projects. ## Upgrade to the CLI (3.0.0) from 2.9.0 ## 1. Create a new Apache Cordova 3.0.0 project using the cordova CLI, as described in The Command-line Interface. + 2. Add your platforms the the cordova project, for example: `cordova platform add wp7 wp8`. -3. Copy the contents of the project's `www` folder to the `www` folder + +3. Copy the contents of the project's `www` directory to the `www` directory at the root of the cordova project you just created. + 4. Copy or overwrite any native assets from your original project (`SplashScreen`, `ApplicationIcon`, etc.), making sure to add any new files to the `.csproj` file. The windows phone project builds inside the `platforms\wp7` or `platforms\wp8` directory. + 5. Use the cordova CLI tool to install any plugins you need. Note that the CLI handles all core APIs as plugins, so they may need to be added. Only 3.0.0 plugins are compatible with the CLI. + 6. Build and test. ## Upgrade to 3.0.0 (non-CLI) from 2.9.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 or WP8 3.0.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. +1. Create a new Apache Cordova WP7 or WP8 3.0.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Copy and overwrite any splash screen, or icon images. -4. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +4. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 5. Build and test. __NOTE:__ all core APIs are removed from Cordova version 3.0, and must @@ -62,92 +72,144 @@ Manage Plugins. In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 or WP8 2.9.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. -3. Update the name of cordova.js in the HTML tag if it's still using cordova-VERSION.js (should be just cordova.js). +1. Create a new Apache Cordova WP7 or WP8 2.9.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + +3. Update the name of `cordova.js` in the HTML tag if it's still using cordova-VERSION.js (should be just `cordova.js`). + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the .csproj file. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the .csproj file. + 6. Build and test. ## Upgrade to 2.8.0 from 2.7.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 or WP8 2.8.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. -3. Update your HTML to use the new cordova.js file. ( note that there is no longer a version number in the name ) +1. Create a new Apache Cordova WP7 or WP8 2.8.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + +3. Update your HTML to use the new `cordova.js` file. ( note that there is no longer a version number in the name ). + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.7.0 from 2.6.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 or WP8 2.7.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 or WP8 2.7.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.7.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.6.0 from 2.5.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 or WP8 2.6.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 or WP8 2.6.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.6.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.5.0 from 2.4.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 or WP8 2.5.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 or WP8 2.5.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.5.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.4.0 from 2.3.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 or WP8 2.4.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 or WP8 2.4.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.4.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.3.0 from 2.2.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 2.3.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 2.3.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.3.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.2.0 from 2.1.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 2.2.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 2.2.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.2.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.1.0 from 2.0.0 ## In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 2.1.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 2.1.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.1.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 2.0.0 from 1.9.0 ## @@ -155,119 +217,185 @@ In Visual Studio's Solution Explorer window: There have been considerable changes to the WP7 project structure in Apache Cordova 2.0.0 which make this upgrade a little more involved that the others. Essentially this is not an upgrade but creation of a new project and copy over of existing source files. In Visual Studio's Solution Explorer window: -1. Create a new Apache Cordova WP7 2.0 Project -2. Copy the contents of your `www` folder to the new project, and be sure these items are added to the VS project. + +1. Create a new Apache Cordova WP7 2.0 Project. + +2. Copy the contents of your `www` directory to the new project, and be sure these items are added to the VS project. + 3. Update your HTML to use the new `cordova-2.0.0.js` file. + 4. Copy and overwrite any splash screen, or icon images. -5. Copy over any plugins from the `plugins` folder to the new project and ensure that they are also added to the VS project. + +5. Copy over any plugins from the `plugins` directory to the new project and ensure that they are also added to the VS project. + 6. Build and test. ## Upgrade to 1.9.0 from 1.8.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.9.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.9.0.js` file. ## Upgrade to 1.8.0 from 1.7.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.8.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.8.0.js` file. ## Upgrade to 1.7.0 from 1.6.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.7.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.7.0.js` file. ## Upgrade to 1.6.1 from 1.6.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.6.1.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.6.1.js` file. ## Upgrade to 1.6.0 from 1.5.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.6.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.6.0.js` file. ## Upgrade to 1.5.0 from 1.4.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.5.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.5.0.js` file. ## Upgrade to 1.4.0 from 1.3.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.4.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.4.0.js` file. ## Upgrade to 1.3.0 from 1.2.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.3.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.3.0.js` file. ## Upgrade to 1.2.0 from 1.1.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ You can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.2.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.2.0.js` file. ## Upgrade to 1.1.0 from 1.0.0 ## In Visual Studio's Solution Explorer window: + 1. Delete `GapLib/WP7CordovaClassLib.dll` from your project. + 2. Remove the reference to `WP7CordovaClassLib` in the __References__ folder. -3. Right-click on __References__ and select __Add Reference__ -4. Navigate to the new distribution and add the file 'WP7CordovaClassLib.dll' + +3. Right-click on __References__ and select __Add Reference__. + +4. Navigate to the new distribution and add the file `WP7CordovaClassLib.dll`. - __NOTE:__ you can view the version of the DLL by right-clicking on the reference, and selecting __Properties__. + 5. Copy the new `cordova-1.1.0.js` into your project. (Be sure it is marked as Content.) + 6. Update your HTML to use the new `cordova-1.1.0.js` file. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/7e5cc869/docs/en/edge/plugin_ref/spec.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/plugin_ref/spec.md b/docs/en/edge/plugin_ref/spec.md index 63b9b0c..ca36f6e 100644 --- a/docs/en/edge/plugin_ref/spec.md +++ b/docs/en/edge/plugin_ref/spec.md @@ -32,7 +32,7 @@ A sample plugin element: id="com.alunny.foo" version="1.0.2"> -## <plugin> element +## `<plugin>` element The `plugin` element is the plugin manifest's top-level element. It features the following attributes: @@ -53,7 +53,7 @@ features the following attributes: ^\d+[.]\d+[.]\d+$ -## <engines> and <engine> elements +## `<engines>` and `<engine>` elements The child elements of the `<engines>` element specify versions of Apache Cordova-based frameworks that this plugin supports. An example: @@ -86,7 +86,7 @@ project does not meet the engine's constraints. If no `<engine>` tags are specified, plugman attempts to install into the specified cordova project directory blindly. -## <name> element +## `<name>` element A human-readable name for the plugin, whose text content contains the name of the plugin. For example: @@ -95,7 +95,7 @@ name of the plugin. For example: This element does not (yet) handle localization. -## <asset> element +## `<asset>` element One or more elements listing the files or directories to be copied into a Cordova app's `www` directory. Examples: @@ -132,7 +132,7 @@ platform-specific web assets, as described below. Attributes include: issues a notification about the conflict, and exits with a non-zero code. -## <js-module> element +## `<js-module>` element Most plugins include one or more JavaScript files. Each `<js-module>` tag corresponds to a JavaScript file, and prevents the plugin's users @@ -198,7 +198,7 @@ exits with a non-zero code. Nesting `<js-module>` elements within `<platform>` declares platform-specific JavaScript module bindings. -## <dependency> +## `<dependency>` The `<dependency>` tag allows you specify other plugins on which the current plugin depends. While future versions will access them from @@ -240,7 +240,7 @@ installed the plugin with a local path directly to it. Plugman finds the root of the git repository and then finds the other plugin from there. -## <platform> +## `<platform>` The `<platform>` tag identifies platforms that have associated native code or require modifications to their configuration files. Tools @@ -271,7 +271,7 @@ chosen, are listed: * wp7 * wp8 -## <source-file> +## `<source-file>` The `<source-file>` element identifies executable source code that should be installed into a project. Examples: @@ -312,7 +312,7 @@ It supports the following attributes: If set, assigns the specified compiler flags for the particular source file. -## <config-file> +## `<config-file>` Identifies an XML-based configuration file to be modified, where in that document the modification should take place, and what should be @@ -375,7 +375,7 @@ It supports the following attributes: document, the tool stops and reverses the installation process, issues a warning, and exits with a non-zero code. -## <plugins-plist> +## `<plugins-plist>` This is _outdated_ as it only applies to cordova-ios 2.2.0 and below. Use the `<config-file>` tag for newer versions of Cordova. @@ -391,7 +391,7 @@ file in an iOS Cordova project. For example: <plugins-plist key="Foo" string="CDVFoo" /> -## <resource-file> and <header-file> +## `<resource-file>` and `<header-file>` Like source files, but specifically for platforms such as iOS that distinguish between source files, headers, and resources. Examples: @@ -400,7 +400,7 @@ distinguish between source files, headers, and resources. Examples: <resource-file src="CDVFooViewController.xib" /> <header-file src="CDVFoo.h" /> -## <lib-file> +## `<lib-file>` Like source, resource, and header files, but specifically for platforms such as BlackBerry 10 that use user-generated libraries. @@ -420,7 +420,7 @@ Supported attributes: * `arch`: The architecture for which the `.so` file has been built, either `device` or `simulator`. -## <framework> +## `<framework>` Identifies a framework (usually part of the OS/platform) on which the plugin depends. @@ -429,9 +429,6 @@ Examples: <framework src="libsqlite3.dylib" /> <framework src="social.framework" weak="true" /> - - - The `src` attribute identifies the framework, which plugman attempts to add to the Cordova project, in the correct fashion for a given platform. @@ -439,7 +436,7 @@ platform. The optional `weak` attribute is a boolean indicating whether the framework should be weakly linked. The default is `false`. -## <info> +## `<info>` Additional information provided to users. This is useful when you require extra steps that can't be easily automated or are beyond
