Apps documentation status

This page aims to track all ongoing Open Web Apps documentation work; each section covers a different topic/task area. For more information about specific API documentation, you should cross reference this page with the API documentation status page.

Summary

Pages No tags Needs* tags Editorial reviews Technical reviews Outdated pages Dev-doc-needed bugs Documentation requests
192 35 (19%) 18 (10%) 4 (3%) 29 (16%) 42 (22%) 17 (9%) 6 (4%)

See also localization status of this section.

No tags

Found 35 pages:

Needs* tags

Found 18 pages:

Editorial reviews

Found 4 pages:

Technical reviews

Found 29 pages:

Outdated pages

Found 42 pages:

Dev-doc-needed bugs

Found 17 bugs:

Bug Summary Release
824697 Installing a Hosted App that Preloads the Appcache, updating the appcache, manual syncing the app - no updates found B2G C4 (2jan on)
820206 Validate "Webapps:*" message parameters in the parent process B2G C4 (2jan on)
831246 Enforce the mime type check for webapp manifests same and cross origin, not just cross-origin ---
772358 Enumerate elevated privileges in manifest ---
790558 Add install/update API ---
768931 Each permission in the manifest should support a corresponding "intended usage" ---
757226 Implement mozApps app.replaceReceipt() mozilla29
849335 Make the FMRadio API privileged mozilla22
821288 Strange behavior when installing multiple hosted apps from the same origin mozilla21
826555 Ensure that updates can't rename an app mozilla21
806624 (dev mode only) Support using hosted apps with certified permissions mozilla19
779982 Change behaviour of getSelf and add amInstalled function mozilla18
786710 The launch_path of a manifest allows for absolute URLs to launch an app at - this should not be allowed mozilla18
789527 Change the way we install packaged apps mozilla18
790870 Implement install/update API during installation of hosted apps mozilla18
781379 getNotInstalled should be under mgmt and return apps from all origins mozilla17
772363 Implement installation API for packaged apps mozilla16

Documentation requests

Found 6 bugs:

Bug Summary
724105 Apps MDN Page Docs: Add checklist to Submitting an app article
900502 B2GOnlyHeader2 macro uses confusing/out-of-date terminology
901039 Document FxOS changes for user agents
912852 Update App Manifest Documentation on MDN for Third Party Keyboard Support
926500 What to do about Firefox OS open web app components
973562 Price point table script should identify countries in a proper way and extend the supported countries

Localizations

Please help us to localize this documentation into different languages.

bn-BD

Pages Translated Translations up to date
190 14 (8%) 6 (43%)

de

Pages Translated Translations up to date
192 18 (10%) 4 (23%)

es

Pages Translated Translations up to date
190 38 (20%) 9 (24%)

fa

Pages Translated Translations up to date
191 0 (0%) 0 (0%)

fr

Pages Translated Translations up to date
190 28 (15%) 2 (8%)

ja

Pages Translated Translations up to date
190 52 (28%) 21 (41%)

pl

Pages Translated Translations up to date
190 1 (1%) 1 (100%)

pt-BR

Pages Translated Translations up to date
190 32 (17%) 9 (29%)

zh-CN

Pages Translated Translations up to date
190 13 (7%) 7 (54%)

ko

Pages Translated Translations up to date
190 11 (6%) 3 (28%)

Content outline

  • Green: complete
  • Yellow: in progress
  • Red: not started
  • Number of stars against article name indicates priority: *** is high, ** is medium, * is low

General app topics

Articles in the General app topics section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
Porting Chrome apps to open web apps Chris has written the starter article, with input from David Clarke. Mark Giffin also interested. David has written a hello world port of the Chrome hello world, but we need more.        

App layout

Articles in the app layout section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
**Using the full screen            
*Dealing with portait and landscape-speific layouts            
*Serving a separate view for specific devices            

Installable apps

Articles in the Installable apps section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
**Creating an application update system There is already some minimal info at updating apps, but this could easily be improved upon. Julien Wajsberg has written a nice little template that allows you to do this, and has agreed to write some notes and a finished demo for us to publish on the subject. His early work on this is at self-updating-packaged-app Install API, done    

Basic data flow

Articles in the Basic data flow section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
HTTP basics Karl Dubost wrote some really good HTTP articles for dev.opera.com. Perhaps we could erpublish those?  

 

     
Ajax basics (architecture, technique)            
Data storage systems and Ajax            
Handling offline Ajax and timeouts            
Handling data within the browser Notes: persistant or temporary; technique with cookies vs. storage vs. IndexedDB vs. data attributes). For offline stuff, defer to the Offline section          
Advanced Ajax topics, such as UI interaction and perceived performance            
Links to other useful demos and resources            

Gather and modify data

Articles in the Gather and modify data section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
***Reading and writing files on your device   Reference documentation is okay

FileHandle API, currently in draft

Device Storage API, done

,    
***Plotting yourself on the map   Chris has written a simple geolocation demo that would be ok here, but we probably also want to present another article containing something a bit more applied too. Geolocation API, done (see Using geolocation)    
***Keep it level: responding to device orientation changes     Detecting device orientation, done    
**Updating phone contacts from the web   Demo being written by baron0 (on IRC) Contacts API, completed Should be ready very soon (19th Sep 2013)  
**Retrieving Battery status information   Chris has written a simple Firefox OS app that shows battery level and charged status in two different ways. Battery Status API, completed    
**Optimizing for high and low network speeds     Network Information API, done    
**Near, or far? responding to proximity     Proximity API, done    
*Responding to light conditions     Using Ambient Light Events, completed    
Web activities can probably fit in here as well.            

Control the display

Articles in the Control the display section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
***Notifying users, via system notifications and alarms Three articles written by Chris, covering the general area of detecting when to notify users, how to detect when a deadline is up, and using the notification and vibration apis. We still to write an article about the Alarm API.  

Time/Clock API (Time and Clock), done

Notification API (Using Web Notifications), needs update, see bug

Alarm API (Alarm), done

, ,   bug 899574
***Fullscreen applications     Fullscreen API, draft    
**Locking the screen orientation     Screen orientation API (see Managing screen orientation)    
**Wake me up! starting apps in response to events     Simple Push API (Simple Push API), draft    
**Providing user feedback via vibrations     Vibration API, done    
*Locking the pointer to simulate 3D or locational movement     Pointer Lock API (was Mouse Lock API), draft ?    

Note: this should probably be retitled to something like "Controlling display and feedback"

Working offline

Note: there is a discussion of offline app strategies on Mozilla's Google Drive account, for those wth access. Apoligies for those who don't have access; Chris is trying to open this up asap.

Articles in the Working offline section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
***Detecting whether your device is offline     XHR, online and offline events, done    
***Offline resources: AppCache versus installable apps. Detecting which one you need    

AppCache, done

Installable apps, done

,    
**Storing simple data with localstorage     basic DOM storage written — a number of options to explore here.  
**Stored complex structured data with IndexedDB  

Chris has written a simple to do list app that stores data using IndexedDB (hasn't everyone?)

Shuhao Wu is also writing an account of Offline SUMO for MDN

basic /IndexedDB done, will need an update once the  WebIDL switch has occurred Shuhao started writing on about September 10th, check in with him soon.  
*Persisting data from on-device storage to a server-side database   Not sure how possible this is, but it sounds like a great idea to work it out.

 

 

     

Manipulating video, audio and images

Articles in the Manipulating video, audio and images section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
***Taking pictures with your webcam   Chris has mostly written a gUM demo. Needs picture storage built into it. Also would be nice to release it after FxOS starts to support gUM!

Camera API (see navigator.mozCameras), done, certified only

gUM, done, currently doesn't work in FxOS

Web Activities, done

, ,    
**More audio stuff, including Web Audio API. A simple radio, dictaphone, and child's robot voice changer type app all sound like good ideas    

Web Audio API, done, cross browser code available.

Some <audio> material available, but could be better

,    
**More video stuff. A custom video player would be good, as well as strategies for serving video to low powered devices    

Some <video> material available, but could be better

   
*Canvas/WebGL stuff. An instagram API using canvas would be cool to show.    

Canvas material

WebGL material

,    
*Let's talk! Creating real time phone and video conferences     Beginner's material added, reference not done.    

Play games

See https://wiki.mozilla.org/MDN/Development/Game_dev_zone for a wider discussion around games dev docs.

Articles in the Play games section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
     

 

     

App payments

Articles in the app payments section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
TBD etc.  

 

     

Firefox Marketplace

Articles in the marketplace section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
TBD etc.  

 

     

Firefox OS partners

Articles in the partners section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
TBD etc.  

 

     

User services

Articles in the User services section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
Logging users in with Persona    

There is some Persona information on MDN already (see Identity integration).

   

Implement user input and control mechanisms

Articles in the user input and control section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
**Drag and drop            
**Touch events            
*contentEditable            

Advanced network communications

Articles in the Advanced network communications section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
*Running tasks in the background with web workers, etc - hard on mobile, battery eating            
*Web sockets / TCP sockets. When to use either            
CORS            
System Ajax            
Web RTC relevant here too?            

UP/Cloud apps/personalisation

Mark Mayo did an interesting talk at the Toronto Mozilla summit about the Mozilla cloud technologies — Sync, Persona, push messages, etc.

Note: these articles probably need arranging in a different way, as they could potentially apply to any kind of app, and aren't really a category in their own right. The Mozilla cloud stuff could possibly have its own landing page eventually, although bear in mind that persona already has it's own landing page.

Articles in the cloud apps section
Article Content status Demo/code status Relevant API doc status Tag Schedule Relevant bugs
Using/Updating sync    

 

     
Getting updates (Simple Push, push server, etc.) Push API messages don't contain data, they just tell the process to wake up            
Using Persona in an app            
User personalization (UP)            
geolocation/stumbling/war driving - crowd sourced geodata.            

Topics for coverage in near future

Weekly Apps docs meetings

We have a recurring weekly meeting to discuss apps documentation, and everyone is welcome to join:

Most Thursdays at 9am West Coast US / Midday East Coast US / 5pm UK / 6pm Europe

  • Location: Chris Mills' Vidyo room. Ping chrismills about it in the #devmo IRC channcel
  • For external meeting access: click on the link below to attend: https://v.mozilla.com/flex.html?roomdirect.html&key=jk4t3cgzH5P3. If you do not have a user account, please enter your name in the "Guest Name" field and then click "Join".
  • To join from a telephone, dial the following number: +1 650 903 0800, x92 99905 or +1 800 707 2533, pin 369 - conf 99905

Agendas/notes:

Document Tags and Contributors

Contributors to this page: Jeremie, fscholz, MarkGiffin, chrisdavidmills
Last updated by: fscholz,