Places:Fx3FeaturePlan: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
DRAFT **** DRAFT **** DRAFT **** DRAFT ****
= Status =
 
* History and Bookmarks are currently running on the Places back-end
* The annotation service is currently enabled
* Livemarks and Microsummaries are both using the Places back-end services


= Status =
Ongoing work:
;Feature tracking bug
* The tracking bug for Places in Firefox 3: {{bug|374945}}
* {{bug|355737}} - meta bug: re-implement all the existing bookmarks UI on top of the Places backend
* {{bug|370099}} - places-based bookmarks blockers


= Overview =
= Overview =
''Describe the goals and objectives of the feature here.''
 
The primary objectives of this project are to:
 
    * Improve access to History and Bookmarks
    * Make it easier for people to Bookmark pages
 
Secondary objectives include:
 
    * Consolidating user data formats
    * Providing a platform for using interesting per-URL metadata
    * Improving the capabilities of Live Bookmarks
    * Providing a solid architecture for bookmark sync and remote storage


== Motivation ==
== Motivation ==
Line 13: Line 26:


== Use Cases ==
== Use Cases ==
''Describe the primary use cases for the feature here.''
 
* sync
* tagging
* ease bookmark and history extension development


== Requirements ==
== Requirements ==
''List functional and non-functional requirements for the feature here, with links back to any relevant product PRD. These requirements should be prioritized.''


{| border="1"
{| border="1"
Line 25: Line 40:
| PLCS-001b||Build a sync client on this new infrastructure||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374519 374519]||
| PLCS-001b||Build a sync client on this new infrastructure||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374519 374519]||
|-
|-
| PLCS-001c||Provide platform support to support generic annotations||P1||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374518 374518]||||New area for extension authors to explore. We aren't going to be able to implement everything for Places ourselves.
| PLCS-001c||Provide platform support to support generic annotations||P1||FR||{{bug|374943}}||||New area for extension authors to explore. We aren't going to be able to implement everything for Places ourselves.
|-
|-
| PLCS-001d||Ensure that Places includes a usable and robust API for extensibility||P1||NFR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374520 374520]||
| PLCS-001d||Ensure that Places includes a usable and robust API for extensibility||P1||NFR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374520 374520]||
Line 31: Line 46:
| PLCS-002a||Unified user interface that improves the usability and discoverability of features||P1||NFR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374521 374521]||||[http://wiki.mozilla.org/Places:Manager details]
| PLCS-002a||Unified user interface that improves the usability and discoverability of features||P1||NFR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374521 374521]||||[http://wiki.mozilla.org/Places:Manager details]
|-
|-
| PLCS-002b||Parity with Firefox 2 Bookmarks/History UI||P1||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374518 374518]||
| PLCS-002b||Parity with Firefox 2 Bookmarks/History UI||P1||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=355737 355737]||
|-
|-
| PLCS-002c||Provide some UI that allows users to mark a URI as "interesting"||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374522 374522]||
| PLCS-002c||Provide some UI that allows users to mark a URI as "interesting"||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374522 374522]||
Line 47: Line 62:
| PLCS-003d||Make it easy for users to export their bookmarks for use in another application||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374529 374529]||
| PLCS-003d||Make it easy for users to export their bookmarks for use in another application||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374529 374529]||
|-
|-
| PLCS-004a||Index web page content into a DB that can be queried||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374518 374518]||||See Bug 342913
| PLCS-004a||Index web page content into a DB that can be queried||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=342913 342913]||||
|-
|-
| PLCS-004b||Allows users to search on all available URI metadata||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374530 374530]||
| PLCS-004b||Allows users to search on all available URI metadata||P2||FR||[https://bugzilla.mozilla.org/show_bug.cgi?id=374530 374530]||
Line 66: Line 81:
|Notes
|Notes
|-
|-
|?
|A1
|Platform support for annotations
|Platform support for annotations
|
|Done
|-
|-
|A4
|A5
|Places Bookmarks on by default
|Places Bookmarks on by default
|Needs to be on by 3/31 - 4/6 in order to get a reasonable number of weeks of nightly testing before A4 code freeze.
|Bookmarks turned on 5/18/07
|-
|-
|?
|A5
|Platform support for sync
|UI Parity with Fx2
|
|Done (with a few minor exceptions
|-
|-
|?
|A5
|Platform API for extensibility
|Protection and safeguarding against data loss
|
|Done
|-
|-
|?
|A5
|Unified Places Organizer
|Bookmark data is never lost
|
|Done
|-
|-
|?
|A5
|UI Parity with Fx2
|Backup and restore for all Places data
|
|Done
|-
|-
|?
|B1
|Protection and safeguarding against data loss
|Platform support for sync
|
|
|-
|-
|?
|B1
|Bookmark date is never lost
|Unified Places Organizer
|
|
|-
|-
|?
|B1
|Backup and restore for all Places data
|Improve performance
|
|
|-
|-
|?
|Ongoing
|Improve performance
|Platform API for extensibility
|
|
|}
|}
Line 109: Line 124:
= Design & Implementation =
= Design & Implementation =
;Documentation
;Documentation
* [[/User Interface|User Interface]]
* [http://wiki.mozilla.org/Places:User_Interface User Interface]
* [[/Architecture|Architecture]]
* [http://wiki.mozilla.org/Places Architecture]
* [[/Test Plan|Test Plan]]
* [http://wiki.mozilla.org/MozillaQualityAssurance:Home_Page:Firefox_3.0_TestPlan:Places Test Plan]


;Repository
;Repository
:''Indicate where the code for the feature lives (in branch or as extension).''
 
<pre>mozilla/browser/components/places/</pre> for the front-end, <pre>mozilla/toolkit/components/places/</pre> for the back-end.


== API Changes ==
== API Changes ==
''list any API changes made by this feature.''
 
[http://developer.mozilla.org/en/docs/Places Developer documentation]


== Extensibility ==
== Extensibility ==
Line 138: Line 155:


== Global Audience ==
== Global Audience ==
''list l10n requirements and a11y efforts''


== Web Compatibility ==
l10n
''list any known effects on compatibility with websites''
* [http://wiki.mozilla.org/Places:L10n_impact_meeting/2007-03-19 Places l10n meeting]


== Other ==
a11y
''any other implementation or design related documentation''
* list a11y bugs here


= Discussion & Implications =
= Discussion & Implications =

Latest revision as of 21:16, 26 July 2007

Status

  • History and Bookmarks are currently running on the Places back-end
  • The annotation service is currently enabled
  • Livemarks and Microsummaries are both using the Places back-end services

Ongoing work:

  • The tracking bug for Places in Firefox 3: bug 374945

Overview

The primary objectives of this project are to:

   * Improve access to History and Bookmarks
   * Make it easier for people to Bookmark pages 

Secondary objectives include:

   * Consolidating user data formats
   * Providing a platform for using interesting per-URL metadata
   * Improving the capabilities of Live Bookmarks
   * Providing a solid architecture for bookmark sync and remote storage 

Motivation

Describe the motivation behind the feature here.

Use Cases

  • sync
  • tagging
  • ease bookmark and history extension development

Requirements

PRD # Title Priority Type Bug # Owner Notes
PLCS-001a Provide platform support to enable syncing of Places datamodel objects to a remote server P1 FR 374518 This is just an event model and not the network infrastructure/sync layer, just the platform hooks.
PLCS-001b Build a sync client on this new infrastructure P2 FR 374519
PLCS-001c Provide platform support to support generic annotations P1 FR bug 374943 New area for extension authors to explore. We aren't going to be able to implement everything for Places ourselves.
PLCS-001d Ensure that Places includes a usable and robust API for extensibility P1 NFR 374520
PLCS-002a Unified user interface that improves the usability and discoverability of features P1 NFR 374521 details
PLCS-002b Parity with Firefox 2 Bookmarks/History UI P1 FR 355737
PLCS-002c Provide some UI that allows users to mark a URI as "interesting" P2 FR 374522
PLCS-002d Provide some UI that allows users to annotate a URI with tags P2 FR 374524
PLCS-002e Provide some UI that allows users to annotate a URI with free-form notes P3 FR 374525
PLCS-003a Protection and safeguarding against data loss P1 FR 374526
PLCS-003b Bookmark data is never lost between browsing sessions P1 NFR 374527
PLCS-003c Provide backup and restore functionality for bookmarks P1 FR 374528
PLCS-003d Make it easy for users to export their bookmarks for use in another application P2 FR 374529
PLCS-004a Index web page content into a DB that can be queried P2 FR 342913
PLCS-004b Allows users to search on all available URI metadata P2 FR 374530
PLCS-004c Support SQL queries of the bookmarks database in the Error Console P3 FR 374531
PLCS-005a Improve performance (as measured by memory use, transactional speed and Ts) of bookmark and history storage and retrieval operations P1 NFR 374532

Schedule

Only P1s are currently listed here.

Target Milestone Feature Notes
A1 Platform support for annotations Done
A5 Places Bookmarks on by default Bookmarks turned on 5/18/07
A5 UI Parity with Fx2 Done (with a few minor exceptions
A5 Protection and safeguarding against data loss Done
A5 Bookmark data is never lost Done
A5 Backup and restore for all Places data Done
B1 Platform support for sync
B1 Unified Places Organizer
B1 Improve performance
Ongoing Platform API for extensibility

Design & Implementation

Documentation
Repository
mozilla/browser/components/places/

for the front-end,

mozilla/toolkit/components/places/

for the back-end.

API Changes

Developer documentation

Extensibility

list work done to make feature extensible by add-ons & any impact to extensibility of Firefox

Customization

list changes to preferences and customization controls for the feature

Performance

list effects on performance, tests used, metrics targeted

Reliability/Stability

list effects on reliability/stability, tests used, metrics targeted

Security

list security impact and link to results of security reviews

Privacy

list privacy impacts and any tie-ins to user privacy features

Global Audience

l10n

a11y

  • list a11y bugs here

Discussion & Implications

Caveats / What We've Tried Before

links to previous design documents, discussions, etc.

References

links to external documents that could inform the design of the feature