Gaia/System/Microformats: Difference between revisions

From MozillaWiki
< Gaia‎ | System
Jump to navigation Jump to search
No edit summary
(Development Components drafted)
Line 1: Line 1:
== Status & Team ==
== Status & Team ==
* Advocate: Jayn Sullivan
* Product&Project Management: [[User:Joshcarpenter|Josh Carpenter]], [[User:Tantek|Tantek Çelik]]
* Design/UX: ___
* Development: ___


See: [https://docs.google.com/spreadsheet/ccc?key=0AiBigu584YY7dGlNSlY0QzhJb3M5anRBa1gxalV0Y3c#gid=0 Project tracking spreadsheet]
See also: [https://docs.google.com/spreadsheet/ccc?key=0AiBigu584YY7dGlNSlY0QzhJb3M5anRBa1gxalV0Y3c#gid=0 Project tracking spreadsheet]
 


== Background ==
== Background ==
 
=== Prior Art ===
==== Prior Art ====
 
 
* Operator
* Operator
** [https://addons.mozilla.org/en-us/firefox/addon/operator/ Operator] (Firefox Add-on)
** [https://addons.mozilla.org/en-us/firefox/addon/operator/ Operator] (Firefox Add-on)
Line 16: Line 16:
* [https://chrome.google.com/webstore/detail/oalbifknmclbnmjlljdemhjjlkmppjjl Microformats for Google Chrome]  
* [https://chrome.google.com/webstore/detail/oalbifknmclbnmjlljdemhjjlkmppjjl Microformats for Google Chrome]  
* [https://mozillalabs.com/en-US/contacts/ Mozilla Contacts]
* [https://mozillalabs.com/en-US/contacts/ Mozilla Contacts]


== Design Specs==  
== Design Specs==  
=== Interaction ===
* ...


==== Interaction ====
=== Visual Design ===
* ...
* ...


==== Visual Design ====
== Development Components ==
* ...
=== Update Platform microformats support ===
Existing Gecko [[microformats]] support includes decent (but a bit out of date) [[hCard]] and [[hCalendar]] parsing support among others.
 
These are tasks to bring Gecko's microformats parsing (microformats.js) up to date.
 
Each of these should be fixed by creating a bug (if there isn't one already) for the desired improvement, and then attaching a patch for microformats.js to the bug. Ideally we should get help reviewing and landing these patches in (in priority order) :
* [[B2G]]
* [[Fennec]]
* [[Firefox]]
 
==== bug fixes ====
* triage [[https://bugzilla.mozilla.org/buglist.cgi?product=Mozilla%20Labs;component=Operator;resolution=---;list_id=3316047 existing bugs]], then list / direct link to "must fix" bugs here
==== parser improvements ====
* complete [http://microformats.org/wiki/vcp Value Class Pattern] support
** e.g. file/fix bugs for test cases like http://microformats.org/wiki/value-dt-test-YYYY-MM-DD--H-MM
* [[HTML5]] <code>time</code> and <code>data</code> element support (per http://microformats.org/wiki/hcard-parsing.
* http://microformats.org/wiki/uf2 support for h-card, h-event, h-adr, h-geo
 
=== Implement User Interactions ===
The following front end development tasks need to be completed to implement the user-facing microformats features/functionality.
 
==== Discovery ====
See design spec for how the browser should visually indicate the presence of microformats for interaction (e.g. "highlight the text contained by the microformat").
 
==== Activation ====
See design spec for what user action should activate a microformat on a page (e.g. make it tappable and/or long press activatable).
 
==== Execution ====
Each microformat has at least a primary action and possible additional actions depending on what's in the microformat.
* '''hCard''': Add to Contacts App
** if there's a tel: Call (tel#) (primary - it's a phone!)
** if there's an impp: IM (im address)
** if there's an email: Email (email address)
** any presence of nested geo/adr handled by below
* '''hCalendar''': Add to Calendar App
* '''adr''': View in Map App (use name of hCard or hCalendar event if contained therein)
* '''geo''': View in Map App (use name of hCard or hCalendar event if contained therein)

Revision as of 02:44, 22 August 2012

Status & Team

See also: Project tracking spreadsheet

Background

Prior Art

Design Specs

Interaction

  • ...

Visual Design

  • ...

Development Components

Update Platform microformats support

Existing Gecko microformats support includes decent (but a bit out of date) hCard and hCalendar parsing support among others.

These are tasks to bring Gecko's microformats parsing (microformats.js) up to date.

Each of these should be fixed by creating a bug (if there isn't one already) for the desired improvement, and then attaching a patch for microformats.js to the bug. Ideally we should get help reviewing and landing these patches in (in priority order) :

bug fixes

  • triage [existing bugs], then list / direct link to "must fix" bugs here

parser improvements

Implement User Interactions

The following front end development tasks need to be completed to implement the user-facing microformats features/functionality.

Discovery

See design spec for how the browser should visually indicate the presence of microformats for interaction (e.g. "highlight the text contained by the microformat").

Activation

See design spec for what user action should activate a microformat on a page (e.g. make it tappable and/or long press activatable).

Execution

Each microformat has at least a primary action and possible additional actions depending on what's in the microformat.

  • hCard: Add to Contacts App
    • if there's a tel: Call (tel#) (primary - it's a phone!)
    • if there's an impp: IM (im address)
    • if there's an email: Email (email address)
    • any presence of nested geo/adr handled by below
  • hCalendar: Add to Calendar App
  • adr: View in Map App (use name of hCard or hCalendar event if contained therein)
  • geo: View in Map App (use name of hCard or hCalendar event if contained therein)