Repository: cordova-docs Updated Branches: refs/heads/master 69adbc198 -> aa6ac4024
firefox os platform guide and suport entries added Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/542e2088 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/542e2088 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/542e2088 Branch: refs/heads/master Commit: 542e2088fad7041b8c36ce54a9dcd954f7d4a17a Parents: 57d0a32 Author: Chris Mills <[email protected]> Authored: Fri Jan 31 17:52:05 2014 +0000 Committer: Chris Mills <[email protected]> Committed: Fri Jan 31 17:52:05 2014 +0000 ---------------------------------------------------------------------- docs/en/edge/guide/platforms/firefoxos/index.md | 87 ++++++++++++++++++++ docs/en/edge/guide/platforms/index.md | 4 + docs/en/edge/guide/support/index.md | 39 ++++----- 3 files changed, 111 insertions(+), 19 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/542e2088/docs/en/edge/guide/platforms/firefoxos/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/platforms/firefoxos/index.md b/docs/en/edge/guide/platforms/firefoxos/index.md new file mode 100644 index 0000000..84cb148 --- /dev/null +++ b/docs/en/edge/guide/platforms/firefoxos/index.md @@ -0,0 +1,87 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +# Firefox OS Platform Guide + +This guide describes how to set up your development environment to +create Cordova apps for Firefox OS devices, then test and publish those apps. + +## Requirements and Support + +Firefox OS apps are basically just web apps, with the addition of a manifest.webapp file that defines metadata about the app and allows it to be installed on Firefox OS devices. Any platform that Cordova supports can be used.To find out more about building web apps, consult the [App Center](https://developer.mozilla.org/en-US/Apps) on [MDN](https://developer.mozilla.org/en-US/). + +## Installation and Environment Setup + +First install [Node.js](http://nodejs.org/), then install the Cordova package like so: + + $ npm install -g cordova + +Next, create a sample Cordova app then navigate into the newly created directory: + + $ cordova create test-app + $ cd test-app + +Add Firefox OS as a supported platform to the app with the following: + + $ cordova platform add firefoxos + +This creates a Firefox OS app in platforms/firefoxos/www directory, which currently looks the same except that it has a Firefox manifest file (manifest.webapp) inside the www directory. + +##Developing your app + +At this point you are ready to go â change the code inside test-app/www to whatever you want your app to be. You can add [supported plugins]() to the app using "cordova plugin add", for example: + + cordova plugin add org.apache.cordova.device + cordova plugin add org.apache.cordova.vibration + +You also need to add a custom manifest.webapp file into your test-app/www directory, which should include at least the following: + + { + "launch_path":"/index.html", + "installs_allowed_from":["*"], + "version":"0.0.1", + "name":"My app", + "pkgName":"io.cordova.hellocordova", + "icons": { + "128": "/img/logo.png" + } + } + +For more information about Firefox App manifests, read [App manifest](https://developer.mozilla.org/en-US/Apps/Developing/Manifest) on MDN. + +When your app code is written, deploy your changes to the Firefox OS app you've added to your project with + + $ cordova prepare + +Note that a build step (i.e. cordova build) is not required when deploying to the Firefox OS platform, as Firefox OS apps are HTML-based, and therefore not compiled. + +##Testing and Debugging + +The app can be tested using the Firefox OS [App Manager](https://developer.mozilla.org/en-US/Firefox_OS/Using_the_App_Manager). + +When you have connected the App Manager to your test device/simulator, select the "Add Packaged App" option, then make sure you point to the test-app/platforms/firefoxos/www/ directory to include the App in the Manager interface. + +For here you can install the app on your test device/simulator (with the "Update" button). Using the "Debug" button you can then debug the app and edit its code live. + +Note: Before attempting to publish your app you should consider validating it using the [App validator](https://marketplace.firefox.com/developers/validator). + +##Publishing your app on the Firefox Marketplace + +You can submit your app to the Firefox Marketplace, or publish it yourself. Visit the [Firefox Marketplace Zone](https://developer.mozilla.org/en-US/Marketplace) on MDN to find out more about how to do this; [App publishing options](https://developer.mozilla.org/en-US/Marketplace/Publishing/Publish_options) is the best place to start. + http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/542e2088/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 ba60628..3ad781c 100644 --- a/docs/en/edge/guide/platforms/index.md +++ b/docs/en/edge/guide/platforms/index.md @@ -61,6 +61,10 @@ a lower-level alternative to the `cordova` command-line utility. * BlackBerry 10 Command-line Tools * Upgrading BlackBerry 10 +## Firefox OS + +* Firefox OS Platform Guide + ## iOS * iOS Platform Guide http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/542e2088/docs/en/edge/guide/support/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/support/index.md b/docs/en/edge/guide/support/index.md index 5793560..ce03743 100644 --- a/docs/en/edge/guide/support/index.md +++ b/docs/en/edge/guide/support/index.md @@ -34,6 +34,7 @@ CLI's shorthand stubs.) <th><tt>amazon-fireos</tt></th> <th><tt>android</tt></th> <th><tt>blackberry10</tt></th> + <th><tt>Firefox OS</tt></th> <th><tt>ios</tt></th> <th><tt>Ubuntu</tt></th> <th><tt>wp7</tt> (Windows<br/>Phone 7)</th> @@ -51,12 +52,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y">Mac, Windows, Linux</td> <td data-col="android" class="y">Mac, Windows, Linux</td> <td data-col="blackberry10" class="y">Mac, Windows</td> + <td data-col="firefoxos" class="y">Mac, Windows, Linux</td> <td data-col="ios" class="y">Mac</td> <td data-col="ubuntu" class="y">Ubuntu</td> <td data-col="winphone7" class="y">Windows</td> <td data-col="winphone8" class="y">Windows</td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -65,12 +66,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"><a href="guide_platforms_amazonfireos_webview.md.html">(see details)</a></td> <td data-col="android" class="y"><a href="guide_platforms_android_webview.md.html">(see details)</a></td> <td data-col="blackberry10" class="n"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"><a href="guide_platforms_ios_webview.md.html">(see details)</a></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="n"></td> <td data-col="winphone8" class="n"></td> <td data-col="win8" class="n"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -79,12 +80,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"><a href="guide_guide_platforms_amazonfireos_plugin.md.html">(see details)</a></td> <td data-col="android" class="y"><a href="guide_guide_platforms_android_plugin.md.html">(see details)</a></td> <td data-col="blackberry10" class="y"><a href="guide_guide_platforms_blackberry10_plugin.md.html">(see details)</a></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"><a href="guide_guide_platforms_ios_plugin.md.html">(see details)</a></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html">(see details)</a></td> <td data-col="winphone8" class="y"><a href="guide_guide_platforms_wp8_plugin.md.html">(see details)</a></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -98,12 +99,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="y"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -112,12 +113,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="y"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -126,12 +127,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="n"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -140,12 +141,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y">(3GS+)</td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -154,12 +155,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -168,12 +169,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="y"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="n"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -182,12 +183,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="y"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -196,12 +197,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -210,12 +211,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -224,12 +225,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="y"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -238,12 +239,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="n"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="n"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -252,12 +253,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="p">uses iframe</td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -266,12 +267,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -280,12 +281,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr> @@ -294,12 +295,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y"></td> <td data-col="winphone8" class="y"></td> <td data-col="win8" class="y"></td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="n"></td> </tr> @@ -308,12 +309,12 @@ CLI's shorthand stubs.) <td data-col="amazon-fireos" class="y"></td> <td data-col="android" class="y"></td> <td data-col="blackberry10" class="y"></td> + <td data-col="firefoxos" class="n"></td> <td data-col="ios" class="y"></td> <td data-col="ubuntu" class="y"></td> <td data-col="winphone7" class="y">localStorage & indexedDB</td> <td data-col="winphone8" class="y">localStorage & indexedDB</td> <td data-col="win8" class="y">localStorage & indexedDB</td> -<!-- <td data-col="firefoxos" class="n"></td> --> <td data-col="tizen" class="y"></td> </tr>
