[CB-3827] Superficial markdown convention to make it easier to grep heading structure
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/5f2f4726 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/5f2f4726 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/5f2f4726 Branch: refs/heads/master Commit: 5f2f472625a309b4c2a0f5c953f42853698f39bb Parents: ff249f1 Author: Mike Sierra <[email protected]> Authored: Thu Jul 18 11:26:14 2013 -0400 Committer: Michael Brooks <[email protected]> Committed: Thu Jul 18 12:19:14 2013 -0700 ---------------------------------------------------------------------- docs/en/edge/guide/platforms/android/config.md | 3 +- docs/en/edge/guide/platforms/android/index.md | 3 +- .../edge/guide/platforms/android/upgrading.md | 3 +- docs/en/edge/guide/platforms/android/webview.md | 9 ++---- .../edge/guide/platforms/blackberry/config.md | 3 +- .../en/edge/guide/platforms/blackberry/index.md | 13 ++++----- .../edge/guide/platforms/blackberry/plugin.md | 3 +- .../guide/platforms/blackberry/upgrading.md | 4 +-- .../edge/guide/platforms/blackberry10/index.md | 28 ++++++------------ .../en/edge/guide/platforms/firefoxos/config.md | 3 +- docs/en/edge/guide/platforms/index.md | 3 +- docs/en/edge/guide/platforms/ios/config.md | 3 +- docs/en/edge/guide/platforms/ios/index.md | 3 +- docs/en/edge/guide/platforms/ios/upgrading.md | 4 +-- docs/en/edge/guide/platforms/ios/webview.md | 15 ++++------ docs/en/edge/guide/platforms/tizen/index.md | 3 +- docs/en/edge/guide/platforms/win8/index.md | 18 ++++-------- docs/en/edge/guide/platforms/win8/upgrading.md | 3 +- docs/en/edge/guide/platforms/wp7/index.md | 24 ++++++---------- docs/en/edge/guide/platforms/wp8/index.md | 30 +++++++------------- docs/en/edge/guide/platforms/wp8/plugin.md | 21 +++++--------- docs/en/edge/guide/platforms/wp8/upgrading.md | 3 +- docs/en/edge/guide/privacy/index.md | 3 +- docs/en/edge/guide/project-settings/index.md | 3 +- docs/en/edge/guide/upgrading/index.md | 3 +- docs/en/edge/guide/webviews/index.md | 3 +- docs/en/edge/guide/whitelist/index.md | 24 ++++++---------- 27 files changed, 78 insertions(+), 160 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/android/config.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/android/config.md b/docs/en/edge/guide/platforms/android/config.md index 4e8dd74..d4bbe3f 100644 --- a/docs/en/edge/guide/platforms/android/config.md +++ b/docs/en/edge/guide/platforms/android/config.md @@ -19,8 +19,7 @@ # --> -Android Configuration -=================================== +# Android Configuration The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CordovaWebView Instance. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/android/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/android/index.md b/docs/en/edge/guide/platforms/android/index.md index 7b544c5..439bb6f 100644 --- a/docs/en/edge/guide/platforms/android/index.md +++ b/docs/en/edge/guide/platforms/android/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Android Platform Guide -============================ +# Android Platform Guide This guide describes how to set up your SDK development environment to deploy Cordova apps for Android devices. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/android/upgrading.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/android/upgrading.md b/docs/en/edge/guide/platforms/android/upgrading.md index 1cd8367..392b8d8 100644 --- a/docs/en/edge/guide/platforms/android/upgrading.md +++ b/docs/en/edge/guide/platforms/android/upgrading.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Upgrading Android -========================= +# Upgrading Android This guide shows how to modify Android projects to upgrade from older versions of Cordova. Most of these instructions apply to projects created with an older set http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/android/webview.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/android/webview.md b/docs/en/edge/guide/platforms/android/webview.md index c3c96b3..ece0458 100644 --- a/docs/en/edge/guide/platforms/android/webview.md +++ b/docs/en/edge/guide/platforms/android/webview.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Android WebViews -==================================== +# Android WebViews Beginning in Cordova 1.9, with the assistance of the `CordovaActivity`, you can use Cordova as a component in a larger @@ -33,14 +32,12 @@ attempting to include a WebView. It's not the main way to author Android Cordova applications. These instructions are currently manual, but may be eventually be automated. -Prerequisites -------------- +## Prerequisites 1. **Cordova 1.9** or greater 2. Android SDK updated with 15 -Guide to using CordovaWebView in an Android Project ---------------------------------------------------- +## Guide to using CordovaWebView in an Android Project 1. Use `bin/create` to fetch the `commons-codec-1.6.jar` file. 2. `cd` into `/framework` and run `ant jar` to build the cordova jar. It creates the .jar file formed as `cordova-x.x.x.jar` in the `/framework` folder. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/blackberry/config.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry/config.md b/docs/en/edge/guide/platforms/blackberry/config.md index ab266ad..f7fc631 100644 --- a/docs/en/edge/guide/platforms/blackberry/config.md +++ b/docs/en/edge/guide/platforms/blackberry/config.md @@ -19,8 +19,7 @@ # --> -BlackBerry Configuration -=================================== +# BlackBerry Configuration BlackBerry fully supports the [W3C Widget Specification](http://www.w3.org/TR/widgets/) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/blackberry/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry/index.md b/docs/en/edge/guide/platforms/blackberry/index.md index b0a5352..dfd2d10 100644 --- a/docs/en/edge/guide/platforms/blackberry/index.md +++ b/docs/en/edge/guide/platforms/blackberry/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -BlackBerry Platform Guide -============================ +# BlackBerry Platform Guide This guide shows you how to set up an SDK environment to target applications for the BlackBerry platform prior to version 10. If you @@ -61,21 +60,19 @@ SDKs can be downloaded from the following locations. - [BlackBerry PlayBook SDK] (https://developer.blackberry.com/html5/download/#playbook) and [Adobe Air SDK](http://www.adobe.com/devnet/air/air-sdk-download.html) - [BlackBerry Smartphones SDK] (https://developer.blackberry.com/html5/download/#smartphones) -3. Register for Signing Keys -------------------------- +## 3. Register for Signing Keys + If you wish to publish your application on BlackBerry App World, or deploy on an actual device youâll need to register for a set of free Code Signing Keys. To register for Signing Keys visit, and complete the [BlackBerry Keys Order Form](https://www.blackberry.com/SignedKeys). Once you receive your Signing Keys, they'll need to be setup. To learn how to setup your Signing Keys visit the [BlackBerry HTML5/WebWorks website](https://developer.blackberry.com/html5/documentation/signing_setup_bb10_apps_2008396_11.html). -4. Install Cordova -------------------------- +## 4. Install Cordova Download and extract the latest copy of [Cordova](http://cordova.apache.org/#download). -5. Set up New Project --------------------- +## 5. Set up New Project - Open up a command-line terminal and navigate to where you extracted Cordova. - There is a directory for each platform that Cordova supports. CD into the `blackberry` directory. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/blackberry/plugin.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry/plugin.md b/docs/en/edge/guide/platforms/blackberry/plugin.md index aca4b83..56ba5ac 100644 --- a/docs/en/edge/guide/platforms/blackberry/plugin.md +++ b/docs/en/edge/guide/platforms/blackberry/plugin.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -BlackBerry Plugins -================================= +# BlackBerry Plugins This guide shows how to develop an Echo plugin on BlackBerry. The Plugin Development Guide provides a broad overview with which you http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/blackberry/upgrading.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry/upgrading.md b/docs/en/edge/guide/platforms/blackberry/upgrading.md index 9a1fc0a..8c17b29 100644 --- a/docs/en/edge/guide/platforms/blackberry/upgrading.md +++ b/docs/en/edge/guide/platforms/blackberry/upgrading.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Upgrading BlackBerry -============================ +# Upgrading BlackBerry This guide shows how to modify BlackBerry projects to upgrade from older versions of Cordova. Most of these instructions apply to projects created with an older set @@ -26,7 +25,6 @@ of command-line tools that precede the `cordova` CLI utility. See The Cordova Command-line Interface for information how to update the version of the CLI. - ## Upgrading 2.8.0 projects to 2.9.0 ## BlackBerry 10: http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/blackberry10/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/blackberry10/index.md b/docs/en/edge/guide/platforms/blackberry10/index.md index 9cf0f33..cd1e09d 100644 --- a/docs/en/edge/guide/platforms/blackberry10/index.md +++ b/docs/en/edge/guide/platforms/blackberry10/index.md @@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -BlackBerry 10 Platform Guide -================================== +# BlackBerry 10 Platform Guide Apache Cordova is an application development platform that allows you to use common web technologies, primarily HTML5, JavaScript, and CSS, to create applications for mobile devices. Cordova uses a standard set of APIs to access common device features. Additional plugins allow you to access BlackBerry specific APIs, so that you can extend your application to tightly integrate with the BlackBerry 10 OS. -Requirements ------------- +## Requirements Cordova for BlackBerry has the following software requirements: @@ -31,12 +29,7 @@ Cordova for BlackBerry has the following software requirements: - node.js (> 0.9.9) [Download node.js now](http://nodejs.org/) - BlackBerry 10 Native SDK. [Download the BlackBerry 10 Native SDK now.](http://developer.blackberry.com/native/download/) - After installing the native SDK, its tools must be added to your system path. Either manually add the bin directory to your path or run the following scripts: - - [Linux/Mac] source [BBNDK directory]/bbndk-env.sh - - [Windows] [BBNDK directory]\bbndk-env.bat - -Setting up your signing keys ----------------------------- +## Setting up your signing keys Before starting development, you'll need to register for your code signing key and debug token. The signing key allows you to sign your completed app so that you can distribute it through BlackBerry World. The debug token allows you to test an unsigned app on a BlackBerry 10 device. You do not need to create and install the debug token yourself; if you supply the keystore password, the build script will create and install the debug token for you. @@ -44,8 +37,7 @@ Before starting development, you'll need to register for your code signing key a - [Set your computer up for code signing. ](http://developer.blackberry.com/html5/documentation/set_up_for_signing.html) - [Learn more about debug tokens.](http://developer.blackberry.com/html5/documentation/running_your_bb10_app_2008471_11.html) -Creating your project -------------------------- +## Creating your project To create a new project, you use the `create` command to set up the folder structure for your app. @@ -56,8 +48,7 @@ To create a new project, you use the `create` command to set up the folder struc This command creates the folder structure for your project at the specified location. All of your project resource files should be stored in the *<path-to-project>*/www folder, or in a subfolder within it. -Adding and managing targets ---------------------------- +## Adding and managing targets A target refers to a BlackBerry device or emulator that you will use to test your app. Targets are added directly to your project; you can add multiple targets to your project, each with a unique name. Then, when you want to deploy your app to a particular target, you can simply refer to that target by name when you run your script. @@ -87,8 +78,7 @@ To specify a specific target as the default, on the command line, type the follo <path-to-project>/cordova/target default <name> -Building your app ------------------ +## Building your app To build your app, run the build script. You can build the app in either release mode or in debug mode. @@ -126,8 +116,7 @@ Note that all of these parameters are optional. If you have previously defined a <path-to-project>/cordova/build debug -Deploying an app -------------------------- +## Deploying an app You can test your app using either a BlackBerry device or an emulator. Before deploying your app, you must first create a target for the device or emulator you want to deploy your app to. @@ -142,8 +131,7 @@ where - `-no--build` will use the most recently built version of the application rather than re-building. This is useful to test an application in release mode. -Adding and managing plugins ---------------------------- +## Adding and managing plugins To add additional functionality that is outside of the core features of Cordova, you'll need to add plugins. A plugin represents a set of APIs that provide access to additional features of the platform. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/firefoxos/config.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/firefoxos/config.md b/docs/en/edge/guide/platforms/firefoxos/config.md index 2806083..8d2e96c 100644 --- a/docs/en/edge/guide/platforms/firefoxos/config.md +++ b/docs/en/edge/guide/platforms/firefoxos/config.md @@ -19,6 +19,5 @@ # --> -FirefoxOS Configuration -=================================== +# FirefoxOS Configuration http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/index.md b/docs/en/edge/guide/platforms/index.md index 6c65f1d..45ea7e1 100644 --- a/docs/en/edge/guide/platforms/index.md +++ b/docs/en/edge/guide/platforms/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Platform Guides -====================== +# Platform Guides Before developing for any of the platforms listed below, install cordova's command-line interface (CLI). http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/ios/config.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/ios/config.md b/docs/en/edge/guide/platforms/ios/config.md index 38fd333..e1dced4 100644 --- a/docs/en/edge/guide/platforms/ios/config.md +++ b/docs/en/edge/guide/platforms/ios/config.md @@ -19,8 +19,7 @@ # --> -iOS Configuration -======================== +# iOS Configuration The `config.xml` settings file controls various settings of Cordova. This is application wide, and not set per CDVViewController instance. The `config.xml` file is located in your `<project folder>/<appname>` directory. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/ios/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/ios/index.md b/docs/en/edge/guide/platforms/ios/index.md index 9107443..0ff286d 100644 --- a/docs/en/edge/guide/platforms/ios/index.md +++ b/docs/en/edge/guide/platforms/ios/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -iOS Platform Guide -======================== +# iOS Platform Guide This guide describes how to set up your SDK development environment to deploy Cordova apps for iOS devices such as iPhone and iPad. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/ios/upgrading.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/ios/upgrading.md b/docs/en/edge/guide/platforms/ios/upgrading.md index 3b48536..0a8330f 100644 --- a/docs/en/edge/guide/platforms/ios/upgrading.md +++ b/docs/en/edge/guide/platforms/ios/upgrading.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Upgrading iOS -===================== +# Upgrading iOS This guide shows how to modify iOS projects to upgrade from older versions of Cordova. Most of these instructions apply to projects created with an older set @@ -59,7 +58,6 @@ Please note that **Xcode 4.5 is required**. To submit to the Apple App Store, yo NOTE: Starting with Cordova 3.0.0, projects do not come with any plugins, you will have to install the ones you require for your project using the `plugman` CLI utility - see the "Using Plugman to Manage Plugins". - ## Upgrading 2.8.0 projects to 2.9.0 ## 1. **Download and extract the Cordova 2.9.0 source** to a **permanent folder location** on your hard drive (say to ~/Documents/Cordova-2.9.0) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/ios/webview.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/ios/webview.md b/docs/en/edge/guide/platforms/ios/webview.md index 445016a..18caa27 100644 --- a/docs/en/edge/guide/platforms/ios/webview.md +++ b/docs/en/edge/guide/platforms/ios/webview.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -iOS WebViews -================================ +# iOS WebViews Beginning with Cordova 1.4, you can use Cordova as a component in your iOS applications. This component is code-named 'Cleaver'. @@ -30,15 +29,13 @@ Cleaver's reference implementation.) Cordova 2.0.0 and subsequent versions only support the sub-project based Cleaver implementation. -Prerequisites -------------- +## Prerequisites 1. **Cordova 2.3.0** or greater 2. **Xcode 4.5** or greater 3. `config.xml` file (from a newly created iOS project) -Adding Cleaver to your Xcode project (CordovaLib sub-project) -------------------------------------------------------------- +## Adding Cleaver to your Xcode project (CordovaLib sub-project) 1. **Download and extract the Cordova source** to a **permanent folder location** on your hard drive (say to `~/Documents/Cordova`) 2. **Quit Xcode** if it is running. @@ -82,8 +79,7 @@ Adding Cleaver to your Xcode project (CordovaLib sub-project) With **Cordova 2.1.0**, CordovaLib has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit → Refactor → Convert to Objective-C ARC...**, **de-select libCordova.a**, then run the wizard to completion. -Using CDVViewController in your code ------------------------------------- +## Using CDVViewController in your code 1. Add this **header**: @@ -117,8 +113,7 @@ Using CDVViewController in your code [myView addSubview:viewController.view]; -Adding your HTML, CSS and JavaScript assets -------------------------------------------- +## Adding your HTML, CSS and JavaScript assets 1. Create a **new folder** in your project **on disk**, `www` for example. 2. Put your **HTML, CSS and JavaScript** assets into this folder. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/tizen/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/tizen/index.md b/docs/en/edge/guide/platforms/tizen/index.md index 9ec823f..47130f0 100644 --- a/docs/en/edge/guide/platforms/tizen/index.md +++ b/docs/en/edge/guide/platforms/tizen/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Tizen Platform Guide -========================= +# Tizen Platform Guide This guide describes how to set up your SDK development environment to deploy Cordova apps for devices running the Tizen operating system. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/win8/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/win8/index.md b/docs/en/edge/guide/platforms/win8/index.md index 658ca32..896523b 100644 --- a/docs/en/edge/guide/platforms/win8/index.md +++ b/docs/en/edge/guide/platforms/win8/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Windows 8 Platform Guide -================================== +# Windows 8 Platform Guide This guide describes how to set up your Cordova development environment and run a sample application. Note that Cordova used to @@ -30,8 +29,7 @@ Windows RT. MSDN now refers to this type of app as a _Windows Store_ app, and this guide follows that convention. Also, in this guide _Windows 8_ signifies both Windows 8 and Windows RT. -1. Requirements ---------------- +## 1. Requirements - Windows 8 @@ -39,14 +37,12 @@ _Windows 8_ signifies both Windows 8 and Windows RT. Follow the instructions [here](http://www.windowsstore.com/) to submit your apps Windows Store. -2. Install SDK + Cordova ----------------------------- +## 2. Install SDK + Cordova - Set up your preferred variant of Visual Studio 2012. All of the product's paid versions (Professional, etc.) let you build Windows Store apps. You need **Express for Windows 8** to build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products). - Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-8` subfolder. -3. Set up New Project --------------------- +## 3. Set up New Project You can already build Windows 8 apps using the _HTML/JavaScript track_ available in Windows Store apps. Use Cordova in Windows Store apps to @@ -97,15 +93,13 @@ expose the same APIs as on other Cordova-supported platforms. </body> -5. Test the Project -------------------------------- +## 5. Test the Project - Run the project from Visual Studio. You'll see the message box appear:  -Done! ------ +## Done! That's it! You're now ready to build Windows Store apps with Cordova. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/platforms/win8/upgrading.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/win8/upgrading.md b/docs/en/edge/guide/platforms/win8/upgrading.md index b786faa..102ad4a 100644 --- a/docs/en/edge/guide/platforms/win8/upgrading.md +++ b/docs/en/edge/guide/platforms/win8/upgrading.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Upgrading Windows 8 -=============================== +# Upgrading Windows 8 This guide shows how to modify Windows 8 projects to upgrade from older versions of Cordova. Most of these instructions apply to projects created with an older set http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/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 4676878..81f7e24 100644 --- a/docs/en/edge/guide/platforms/wp7/index.md +++ b/docs/en/edge/guide/platforms/wp7/index.md @@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Windows Phone 7 Platform Guide -================================== +# Windows Phone 7 Platform Guide This guide describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name. -1. System Requirements ---------------- +## 1. System Requirements - Operating System: - Windows 7 or Windows 8 (Pro) or Windows Vista with SP2 @@ -34,15 +32,13 @@ This guide describes how to set up your development environment for Cordova and __NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac). -2. Install SDK + Cordova ----------------------------- +## 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 ------------------------------ +## 2.1. Building the template __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. @@ -58,15 +54,13 @@ Run the script : >createTemplates.bat -install -3. Set up New Project --------------------- +## 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 -------------------------------- +## 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. @@ -74,8 +68,7 @@ Run the script :  -6. Build your project for the device ------------------------------------- +## 6. Build your project for the device 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. @@ -85,8 +78,7 @@ In order to test your application on a device, the device must be registered. Cl  -Done! ------ +## Done! [register-url]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff402565(v=vs.105).aspx http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/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 f526afa..e1d8f40 100644 --- a/docs/en/edge/guide/platforms/wp8/index.md +++ b/docs/en/edge/guide/platforms/wp8/index.md @@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Windows Phone 8 Platform Guide -================================== +# Windows Phone 8 Platform Guide This guide describes how to set up your development environment for Cordova and run a sample application. Note that Cordova used to be called PhoneGap, so some of the sites still use the old PhoneGap name. __NOTE:__ Applications built with Apache Cordova for Windows Phone 8 (wp8) run only on Windows Phone 8 devices. If you want to target both 7.5 'and' 8 devices, then use Apache Cordova for Windows Phone 7 (wp7), which does not have all the advanced features included in IE10, but implements the same APIs. -1. System Requirements ---------------- +## 1. System Requirements - Operating System: - Windows 8 or Windows 8 Pro @@ -51,15 +49,13 @@ __NOTE:__ Applications built with Apache Cordova for Windows Phone 8 (wp8) run o __NOTE:__ Running the SDK in Virtual Machine might present some challenges. You can read this blog post that gives insight on the solutions to develop for [Windows Phone on a Mac](http://aka.ms/BuildaWP8apponaMac). -2. Install SDK + Cordova ----------------------------- +## 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 ------------------------------ +## 2.1. Building the template __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. @@ -75,8 +71,7 @@ Run the script : >createTemplates.bat -install -3. Set up New Project --------------------- +## 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.) @@ -84,8 +79,7 @@ Run the script :  -4. Review the project structure -------------------------------- +## 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. @@ -93,16 +87,14 @@ Run the script :  -5. Build and Deploy to Emulator -------------------------------- +## 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__.  -6. Build your project for the device ------------------------------------- +## 6. Build your project for the device 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. @@ -112,11 +104,9 @@ In order to test your application on a device, the device must be registered. Cl  -Done! ------ +## Done! -Further Reading -------- +## Further Reading For more details on the specific differences between IE10 and WebKit browsers, and how to support both MS has a helpful [guide here](http://blogs.windows.com/windows_phone/b/wpdev/archive/2012/11/15/adapting-your-webkit-optimized-site-for-internet-explorer-10.aspx) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/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 81040c6..3bf34b4 100644 --- a/docs/en/edge/guide/platforms/wp8/plugin.md +++ b/docs/en/edge/guide/platforms/wp8/plugin.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Windows Phone Plugins -==================================== +# Windows Phone Plugins Writing a plugin for Cordova on Windows Phone requires a basic understanding of the architecture of Cordova. Cordova-WP7 consists of a WebBrowser which hosts the @@ -54,8 +53,7 @@ and it comes with the majority of the 'plumbing' built for you already. } } -Namespaces ----------- +## Namespaces The default namespace for unqualified commands is: @@ -80,8 +78,7 @@ Then, in JS you need to call `exec` like this: cordova.exec(win, fail, "com.mydomain.cordovaExtensions.Echo", ...); -Interpreting your arguments in C# ----------------------------------- +## Interpreting your arguments in C# 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. @@ -102,8 +99,7 @@ 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 JS The base class BaseCommand provides methods for passing data to your JS callback handlers. To simply signal that the command has succeeded, when no additional result info is needed, @@ -123,8 +119,7 @@ If you need to signal that an error has occurred, you can call `DispatchCommandR DispatchCommandResult(new PluginResult(PluginResult.Status.ERROR, "Echo signaled an error")); -Handling serialization errors in your plugin's C# method --------------------------------------------------------- +## Handling serialization errors in your plugin's C# method When interpreting your arguments, it is a good idea to use a try/catch block in case we have bad input. This is a pattern used throughout the Cordova C# code: @@ -149,8 +144,7 @@ in case we have bad input. This is a pattern used throughout the Cordova C# code // ... continue on to do our work } -Advanced Plugin Functionality ------------------------------ +## Advanced Plugin Functionality See other methods that you can override in: @@ -167,8 +161,7 @@ JavaScript is a little more difficult to debug on Windows Phone. You need to use `console.log` to output the state of your plugin, or inform yourself of errors. -Common Pitfalls ---------------- +## Common Pitfalls - Be careful when deciding on the arguments you pass to native in your JavaScript implementation. Most device platforms expect the args passed to cordova.exec http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/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 a210f7b..bc58ba6 100644 --- a/docs/en/edge/guide/platforms/wp8/upgrading.md +++ b/docs/en/edge/guide/platforms/wp8/upgrading.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Upgrading Windows Phone -=============================== +# Upgrading Windows Phone This guide shows how to modify Windows Phone projects, both versions 7 and 8, to upgrade from older versions of Cordova. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/privacy/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/privacy/index.md b/docs/en/edge/guide/privacy/index.md index 2cbf047..7603e08 100644 --- a/docs/en/edge/guide/privacy/index.md +++ b/docs/en/edge/guide/privacy/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Privacy Guide -============= +# Privacy Guide Mobile privacy is a critical issue that every app developer must address. Your users expect that their private information will be collected and treated appropriately by your app. Also, there are an increasing number of jurisdictions that now have legal requirements regarding mobile privacy practices. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/project-settings/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/project-settings/index.md b/docs/en/edge/guide/project-settings/index.md index 0bf20d2..b042e57 100644 --- a/docs/en/edge/guide/project-settings/index.md +++ b/docs/en/edge/guide/project-settings/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Project Settings -================ +# Project Settings You can set various application configuration parameters using a platform-agnostic configuration file, `config.xml`. This file is based on the W3C [Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/) specification. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/upgrading/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/upgrading/index.md b/docs/en/edge/guide/upgrading/index.md index ac4b96f..e365fec 100644 --- a/docs/en/edge/guide/upgrading/index.md +++ b/docs/en/edge/guide/upgrading/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Upgrading Guides -================ +# Upgrading Guides > Learn how to upgrade an application to the latest Apache Cordova release. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/webviews/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/webviews/index.md b/docs/en/edge/guide/webviews/index.md index 649a5e8..937db59 100644 --- a/docs/en/edge/guide/webviews/index.md +++ b/docs/en/edge/guide/webviews/index.md @@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Embedding WebViews -================= +# Embedding WebViews > Implement the Cordova WebView in your own project. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f2f4726/docs/en/edge/guide/whitelist/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/whitelist/index.md b/docs/en/edge/guide/whitelist/index.md index 9e5b075..6307b3f 100644 --- a/docs/en/edge/guide/whitelist/index.md +++ b/docs/en/edge/guide/whitelist/index.md @@ -17,11 +17,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one under the License. --- -Domain Whitelist Guide -====================== +# Domain Whitelist Guide -Overview --------- +## Overview Domain whitelisting is a security model that controls access to outside domains, such as `http://google.com`. Apache Cordova's @@ -29,13 +27,11 @@ default security policy allows access to any site. Before moving your application to production, you should review its whitelist and declare access to specific network domains and subdomains. -Specification -------------- +## Specification Domain whitelisting lays the groundwork for the [W3C Widget Access][1] specification. In the Widget Access specification, the `<access>` element is used to declare access to specific network domains. In the future, Apache Cordova will abstract the platform whitelisting implementations to the W3C Widget Access specification. However, for now each platform must implement its own domain whitelisting. -Syntax ------- +## Syntax Access to [google.com][2]: @@ -57,8 +53,7 @@ Access to all domains (e.g. [google.com][2] and [developer.mozilla.org][7]): * -Android -------- +## Android ### Details @@ -73,8 +68,7 @@ Access to [google.com][2]: <access origin="http://google.com"; /> -BlackBerry ----------- +## BlackBerry ### Details @@ -121,8 +115,7 @@ Access to all subdomains and TLDs (`.com`, `.net`, etc): *.google.* -Windows Phone (7 & 8) ---------------------- +## Windows Phone (7 & 8) The whitelisting rules are found in `config.xml` and declared with the element `<access origin="..." />`. @@ -134,8 +127,7 @@ Access to [google.com][2]: <access origin="http://google.com"; /> -Tizen ----------- +## Tizen ### Details
