- Modified docs navigation handling

- Merged in PhoneGap Build docs and images into top-level nav per IA Design doc, added tabs to signing docs - Added push notification docs and images - Link/general fixes, content updates all around - Removed unused metadata and jade files for extra menus
phonegap · May 3, 2016 · 363c542 · 363c542
1 parent dd4fc43
commit 363c542
Show file tree

Hide file tree

Showing 120 changed files with 3,660 additions and 315 deletions.
diff --git a/docpad.js b/docpad.js
@@ -12,6 12,10 @@ module.exports = {
  "layoutsPaths": [
  "layouts"
  ],
  "regenerateDelay": 0,
  "watchOptions": { 
  "catchupDelay": 0
  },
  "plugins": {
  "cleanurls": {
  "trailingSlashes": true,
@@ -73,6 77,26 @@ module.exports = {
  .on('add', function(model) {
  model.setMetaDefaults({ 'layout': 'default' });
  });
  },
  gsDocs: function() {
  return this.getCollection('html')
  .findAllLive({ extension: 'md' }) 
  },
  getStartedDocs: function() {
  return this.getCollection('gsDocs')
  .findAllLive({url: {$startsWith:'getting-started/' }}, [{ relativeBase: 1 }]) 
  }, 
  referenceDocs: function() {
  return this.getCollection('gsDocs')
  .findAllLive({url: {$startsWith:'references/' }}, [{ relativeBase: 1 }]) 
  }, 
  tutorialDocs: function() {
  return this.getCollection('gsDocs')
  .findAllLive({url:{$startsWith:'tutorials/'}}, [{ relativeBase: 1 }])
  }, 
  pgbDocs: function() {
  return this.getCollection('gsDocs')
  .findAllLive({url:{$startsWith:'phonegap-build/'}}, [{ relativeBase: 1 }]) 
  }
  }
 };
diff --git a/docs/1-getting-started/0-index.html.md b/docs/1-getting-started/0-index.html.md
@@ -4,4 4,9 @@ url: getting-started
 layout: subpage
 ---
 
-Getting started content here
 The getting started guides are provided to help new users get up and running as quickly as possible with the least amount of
 setup and time. 
 
 Once you've completed the getting started section, be sure to head over to the [tutorials](/tutorials) 
 and [references](references) sections where you'll be able to dig into more advanced mobile app development related topics 
 and find numerous useful resources. 
diff --git a/docs/1-getting-started/1-install-phonegap/1-desktop.html.md b/docs/1-getting-started/1-install-phonegap/1-desktop.html.md
@@ -24,7 24,7 @@ Select your operating system to continue:
 <a class="anchor" id="mac"></a>
 ### Mac OS X Installation
 
-1. Download the latest [Mac OS X Installer](https://github.com/phonegap/phonegap-app-desktop/releases/download/0.3.0/PhoneGapDesktop.dmg).
 1. Download the latest [Mac OS X Installer](https://github.com/phonegap/phonegap-app-desktop/releases/download/0.3.1/PhoneGapDesktop.dmg).
 
 2. Double-click the downloaded file to run the installer. You will initially be prompted with a license agreement to accept:
 ![](/images/license-agreement.png)
@@ -40,7 40,7 @@ install the __PhoneGap Developer App__ to your mobile device for previewing the
 <a class="anchor" id="win"></a>
 ### Windows Installation
 
-1. Download the latest [Windows Installer](https://github.com/phonegap/phonegap-app-desktop/releases/download/0.3.0/PhoneGapSetup-win32.exe).
 1. Download the latest [Windows Installer](https://github.com/phonegap/phonegap-app-desktop/releases/download/0.3.1/PhoneGapSetup-win32.exe).
 2. Double click the downloaded file to run the installer. You will be prompted with the PhoneGap Desktop Setup Wizard: 
 
  ![](/images/win-desktop1.png)

diff --git a/docs/1-getting-started/1-install-phonegap/2-cli.html.md b/docs/1-getting-started/1-install-phonegap/2-cli.html.md
@@ -19,14 19,14 @@ CLI this option may be best going forward.
 
 <div class="alert--info">**NOTE:** The getting started steps vary based on the initial PhoneGap tool you install here in step 1. For the rest of the steps be sure to choose either the **Desktop** or **CLI** tab at the top accordingly.</div>
 
-###Requirements
 ### Requirements
 There are a few simple requirements you'll need prior to installing the PhoneGap CLI:
 
 - [node.js](http://nodejs.org/) - a JavaScript runtime to build your JavaScript code
 - [git](http://git-scm.com) - used in the background by the CLI to download assets. It comes pre-installed on some operating systems. 
  To see if you already have it installed, type `git` from the command line.
 
-###Install Steps
 ### Install Steps
 
 1. Install the [PhoneGap CLI](https://www.npmjs.com/package/phonegap) via `npm` with the following command from the Terminal app (Mac) or Command Prompt (Win).
  <br>

diff --git a/docs/1-getting-started/3-create-your-app/1-desktop.html.md b/docs/1-getting-started/3-create-your-app/1-desktop.html.md
@@ -17,7 17,7 @@ your first PhoneGap project. This project will be a PhoneGap mobile app with the
 in just a few simple steps.
 
 
-###Create Default PhoneGap Project
 ### Create Default PhoneGap Project
 The PhoneGap desktop tools include a default Hello World project for beginners to start with. It's proven to be the quickest and easiest way to understand the basics of building a mobile PhoneGap app so let's start there:
 
 1. Click the plus sign and select **Create new PhoneGap project** as shown below:

diff --git a/docs/1-getting-started/3-create-your-app/2-cli.html.md b/docs/1-getting-started/3-create-your-app/2-cli.html.md
@@ -16,7 16,7 @@ to your computer and the [PhoneGap Developer App](/getting-started/2-install-mob
 your first PhoneGap project. This project will be a PhoneGap mobile app with the ability to run on multiple devices and across operating systems
 in just a few simple steps.
 
-###Create Default PhoneGap Project
 ### Create Default PhoneGap Project
 The PhoneGap CLI has a default Hello World project for beginners to start with. It's proven to be the quickest and easiest way to understand the
 basics of building a mobile PhoneGap app so let's start by creating the default project with the CLI.
 

diff --git a/docs/1-getting-started/4-preview-your-app/2-cli.html.md b/docs/1-getting-started/4-preview-your-app/2-cli.html.md
@@ -9,6 9,7 @@ tabs:
  - label: CLI
  url: getting-started/4-preview-your-app/cli
 next: 1-getting-started/5-going-further.html.md
 menuHide: true
 ---
 
 The PhoneGap CLI has a `serve` command that starts a small web server to host your project where it can then be consumed by the PhoneGap Developer App 

diff --git a/docs/2-tutorials/0-index.html.md b/docs/2-tutorials/0-index.html.md
@@ -4,4 4,18 @@ url: tutorials
 layout: subpage
 ---
 
-Using Sprite Sheets content here
 #### Mobile App Development Phases 
 
 Creating a mobile app can require several stages which can be categorized in the following phases:
 
 - Configuring
 - Developing 
 - Debugging 
 - Optimizing
 - Distributing 
 
 In this section of our docs, we aim to provide information and resources to help you deal with the most challenging 
 topics in each stage of the app building cycle. This section is a continuous work in progress as the challenges mobile
 developers face are ever changing. Be sure to check back often to learn more. 
 
 
diff --git a/docs/2-tutorials/1-configure/0-index.html.md b/docs/2-tutorials/1-configure/0-index.html.md
@@ -1,8 1,12 @@
 ---
 title: Configure Guides
-url: configure
 url: tutorials/configure
 layout: subpage
-write: false
 ---
 
-Configure landing page here
 The tutorials in this section are aimed at helping you with specific configuration topics or challenges you may face
 once you've dug in and started building your own apps. 
 
 These are the guides you should look to for information on specific platform configuration and more advanced configuration
 topics. 
 
diff --git a/docs/2-tutorials/1-configure/1-icons.html.md → ...torials/1-configure/1-icons/1-ios.html.md b/docs/2-tutorials/1-configure/1-icons.html.md → ...torials/1-configure/1-icons/1-ios.html.md
@@ -1,8 1,14 @@
 ---
-title: Icons
-url: configure/icons
 title: iOS Icons
 url: tutorials/configure/icons/ios
 layout: subpage
-write: false
 tabs:
  - label: iOS
  url: tutorials/configure/icons/ios
  - label: Android
  url: tutorials/configure/icons/android
  - label: Windows
  url: tutorials/configure/icons/win 
 ---
 
 ## Icon Configuration

diff --git a/docs/2-tutorials/1-configure/1-icons/2-android.html.md b/docs/2-tutorials/1-configure/1-icons/2-android.html.md
@@ -0,0 1,102 @@
 ---
 title: Android Icons
 url: tutorials/configure/icons/android
 layout: subpage
 tabs:
  - label: iOS
  url: tutorials/configure/icons/ios
  - label: Android
  url: tutorials/configure/icons/android
  - label: Windows
  url: tutorials/configure/icons/win 
 ---
 
 ## Icon Configuration
 
 This section shows how to configure the icons that represent your mobile application. 
 
 ## Configuring Icons in config.xml
 
 When working in the PhoneGap CLI you can define app icon(s) via the `<icon>` element (`config.xml`).
 
 If you do not specify an icon then the default logo included in the project is used (when available).
 
  <icon src="res/ios/icon.png" platform="ios" width="57" height="57" density="mdpi" />
 
 src: (required) specifies the location of the image file, relative to your project directory
 
 platform: (optional) target platform
 
 width: (optional) icon width in pixels
 
 height: (optional) icon height in pixels 
 
 density: (optional) android specific, specifies icon density
 
 The following configuration can be used to define single default icon
 which will be used for all platforms.
 
   <icon src="res/icon.png" />
 
 For each platform you can also define a pixel-perfect icons set to fit 
 different screen resolutions.
 
 #### Android
 
   <platform name="android">
   <icon src="res/android/ldpi.png" density="ldpi" />
   <icon src="res/android/mdpi.png" density="mdpi" />
   <icon src="res/android/hdpi.png" density="hdpi" />
   <icon src="res/android/xhdpi.png" density="xhdpi" />
   </platform>
 
 <div class="alert-info">**TIP:** See this [Android Developer Iconography Guide](http://developer.android.com/design/style/iconography.html) for more details.</div>
 
 #### iOS
 
   <platform name="ios">
   <!-- iOS 8.0 -->
   <!-- iPhone 6 Plus -->
   <icon src="res/ios/[email protected]" width="180" height="180" />
   <!-- iOS 7.0 -->
   <!-- iPhone / iPod Touch -->
   <icon src="res/ios/icon-60.png" width="60" height="60" />
   <icon src="res/ios/[email protected]" width="120" height="120" />
   <!-- iPad -->
   <icon src="res/ios/icon-76.png" width="76" height="76" />
   <icon src="res/ios/[email protected]" width="152" height="152" />
   <!-- iOS 6.1 -->
   <!-- Spotlight Icon -->
   <icon src="res/ios/icon-40.png" width="40" height="40" />
   <icon src="res/ios/[email protected]" width="80" height="80" />
   <!-- iPhone / iPod Touch -->
   <icon src="res/ios/icon.png" width="57" height="57" />
   <icon src="res/ios/[email protected]" width="114" height="114" />
   <!-- iPad -->
   <icon src="res/ios/icon-72.png" width="72" height="72" />
   <icon src="res/ios/[email protected]" width="144" height="144" />
   <!-- iPhone Spotlight and Settings Icon -->
   <icon src="res/ios/icon-small.png" width="29" height="29" />
   <icon src="res/ios/[email protected]" width="58" height="58" />
   <!-- iPad Spotlight and Settings Icon -->
   <icon src="res/ios/icon-50.png" width="50" height="50" />
   <icon src="res/ios/[email protected]" width="100" height="100" />
   </platform>
 
 #### Windows Phone8
 
   <platform name="wp8">
   <icon src="res/wp/ApplicationIcon.png" width="99" height="99" />
   <!-- tile image -->
   <icon src="res/wp/Background.png" width="159" height="159" />
   </platform>
 
 #### Windows8
 
   <platform name="windows8">
   <icon src="res/windows8/logo.png" width="150" height="150" />
   <icon src="res/windows8/smalllogo.png" width="30" height="30" />
   <icon src="res/windows8/storelogo.png" width="50" height="50" />
   </platform>
 
 
diff --git a/docs/2-tutorials/1-configure/1-icons/3-win.html.md b/docs/2-tutorials/1-configure/1-icons/3-win.html.md
@@ -0,0 1,102 @@
 ---
 title: Windows Icons
 url: tutorials/configure/icons/win
 layout: subpage
 tabs:
  - label: iOS
  url: tutorials/configure/icons/ios
  - label: Android
  url: tutorials/configure/icons/android
  - label: Windows
  url: tutorials/configure/icons/win 
 ---
 
 ## Icon Configuration
 
 This section shows how to configure the icons that represent your mobile application. 
 
 ## Configuring Icons in config.xml
 
 When working in the PhoneGap CLI you can define app icon(s) via the `<icon>` element (`config.xml`).
 
 If you do not specify an icon then the default logo included in the project is used (when available).
 
  <icon src="res/ios/icon.png" platform="ios" width="57" height="57" density="mdpi" />
 
 src: (required) specifies the location of the image file, relative to your project directory
 
 platform: (optional) target platform
 
 width: (optional) icon width in pixels
 
 height: (optional) icon height in pixels 
 
 density: (optional) android specific, specifies icon density
 
 The following configuration can be used to define single default icon
 which will be used for all platforms.
 
   <icon src="res/icon.png" />
 
 For each platform you can also define a pixel-perfect icons set to fit 
 different screen resolutions.
 
 #### Android
 
   <platform name="android">
   <icon src="res/android/ldpi.png" density="ldpi" />
   <icon src="res/android/mdpi.png" density="mdpi" />
   <icon src="res/android/hdpi.png" density="hdpi" />
   <icon src="res/android/xhdpi.png" density="xhdpi" />
   </platform>
 
 <div class="alert-info">**TIP:** See this [Android Developer Iconography Guide](http://developer.android.com/design/style/iconography.html) for more details.</div>
 
 #### iOS
 
   <platform name="ios">
   <!-- iOS 8.0 -->
   <!-- iPhone 6 Plus -->
   <icon src="res/ios/[email protected]" width="180" height="180" />
   <!-- iOS 7.0 -->
   <!-- iPhone / iPod Touch -->
   <icon src="res/ios/icon-60.png" width="60" height="60" />
   <icon src="res/ios/[email protected]" width="120" height="120" />
   <!-- iPad -->
   <icon src="res/ios/icon-76.png" width="76" height="76" />
   <icon src="res/ios/[email protected]" width="152" height="152" />
   <!-- iOS 6.1 -->
   <!-- Spotlight Icon -->
   <icon src="res/ios/icon-40.png" width="40" height="40" />
   <icon src="res/ios/[email protected]" width="80" height="80" />
   <!-- iPhone / iPod Touch -->
   <icon src="res/ios/icon.png" width="57" height="57" />
   <icon src="res/ios/[email protected]" width="114" height="114" />
   <!-- iPad -->
   <icon src="res/ios/icon-72.png" width="72" height="72" />
   <icon src="res/ios/[email protected]" width="144" height="144" />
   <!-- iPhone Spotlight and Settings Icon -->
   <icon src="res/ios/icon-small.png" width="29" height="29" />
   <icon src="res/ios/[email protected]" width="58" height="58" />
   <!-- iPad Spotlight and Settings Icon -->
   <icon src="res/ios/icon-50.png" width="50" height="50" />
   <icon src="res/ios/[email protected]" width="100" height="100" />
   </platform>
 
 #### Windows Phone8
 
   <platform name="wp8">
   <icon src="res/wp/ApplicationIcon.png" width="99" height="99" />
   <!-- tile image -->
   <icon src="res/wp/Background.png" width="159" height="159" />
   </platform>
 
 #### Windows8
 
   <platform name="windows8">
   <icon src="res/windows8/logo.png" width="150" height="150" />
   <icon src="res/windows8/smalllogo.png" width="30" height="30" />
   <icon src="res/windows8/storelogo.png" width="50" height="50" />
   </platform>
 
 
diff --git a/docs/2-tutorials/1-configure/2-splash-screens.html.md b/docs/2-tutorials/1-configure/2-splash-screens.html.md
@@ -1,19 1,16 @@
 ---
 title: Splash Screens
-url: configure/splash-screens
 url: tutorials/configure/splash-screens
 layout: subpage
-write: false
 ---
 
-## Splash Screen Configuration
-
 ## Configuring Splash Screens in config.xml
 
 In the top-level `config.xml` file (not the one in `platforms`), add configuration elements like those specified here.
 
 # Example configuration 
 
-Please notice that the value of the "src" attribute is relative to the project directory and not to the *www* directory.
 The value of the "src" attribute is relative to the project directory and not to the *www* directory.
 You can name the source image whatever you like. The internal names in the app are determined by Cordova.
 
 ### Android