Places is a system for storing bookmarks, history, and other user information about the Web, intended to improve developer access to this data and make it easier for people to Bookmark pages. It Places is currently enabled in trunk buildsfor Firefox 3 and greater, powering History and Bookmarks, as well as providing plumbing for Livemarks, Annotations and Microsummaries and debuted in Firefox 3. This document covers the design and user-interface of PlacesAwesomebar.
= Quick links:Links =
Documentation
* Toolkit backend code: [http://mxr.mozilla.org/mozilla-central/source/toolkit/components/places/ mozilla/toolkit/components/places/]
Current work:* See the [https://wiki.mozilla.org/Places:Plan plan] for current work. Active core contributorsmodule peers:* [http://autonome.wordpress.com/ Dietrich Ayala](MO)
* [http://shawnwilsher.com/ Shawn Wilsher]
* [http://twitter.com/mak77 Marco Bonardo]
= Timeline and History Design =
* Initial Places implementation slated for Firefox 2. Landed for early alphas and then backed out and eventually cut from Contemporary design information is on the release. [TODOhttp: proper links and dates needed//developer.mozilla.org/en/docs/Places Places developer wiki].* Project re-initialized in fall 2007, slated for [[Places:Design Overview]] contains much of the original design documentation from Firefox 2 and 3work on Places.* History-on-[[Places was enabled on the trunk in January 2007, first released in Gran Paradiso Alpha 2.:Performance]]* Bookmarks-on-[[Places:SecurityReview|Places was enabled in May 2007, first released in Gran Paradiso Alpha 5.Security Review]]
= Goals & Objectives Compatibility =
The primary objectivesAs of Firefox 3, the APIs for accessing Bookmarks and History have been replaced. Some history APIs remain the same. See the [http: //developer.mozilla.org/en/docs/Places Places developer wiki] for more information.
* Improve access to History and Bookmarks* Make it easier for people to Bookmark pages= Extensions =
Secondary objectives:The APIs for accessing and manipulating Bookmarks and History have been replaced entirely in Firefox 3, and are incompatible. Almost all Bookmarks and History user interface components have been replaced or updated significantly. Any extension that does anything with History or Bookmarks will almost certainly have to be rewritten, at the very least to use the new APIs.
* 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 = Timeline and remote storageHistory =
= Overview =* Initial Places implementation slated for Firefox 2. Landed for early alphas and then backed out and eventually cut from the release. [TODO: proper links and dates needed]* Project re-initialized in fall 2007, slated for Firefox 3.* History-on-Places was enabled on the trunk in January 2007, first released in Gran Paradiso Alpha 2.* Bookmarks-on-Places was enabled in May 2007, first released in Gran Paradiso Alpha 5.
Implemented new back-end for Bookmarks, History and related components using the mozStorage wrapper for SQLite. Developed newer, more usable front-end components to display results, emphasizing simple search and categorization.= Credits =
== Background == Studies from the late 1990s show that while revisitations of pages previously seen counted for roughly 39% of all page navigations (see [httpPast core contributors://scholar.google.com/ Google Scholar]), Bookmarks and History usage was low (1-3%), despite the fact that roughly 20% of those revisitations were to pages seen > 10 URLs ago (and thus outside the usefulness range of the Back button or menu).
Autocomplete in the URL bar is a useful tool but fails to address some common desires when looking up visited pages. There is a gulf between the capabilities of that tool, the capabilities of the Bookmarks and History systems today, and the desired capabilities of those systems.
== Use Cases ==
* [[Places:History Use Cases]]
* [[Bookmarks Use Cases]] (not specific to places)
== Functional Requirements ==
The original requirements for Places in Firefox 3 are detailed in the [[Firefox3/Product_Requirements_Document#Places|Firefox 3 PRD]]
= Design =
* [[Places:User Interface]]
* [[Places:Design Overview]]
* [[Places:URL Store]]
* [[Places:Bookmarks]]
* [[Places:place URIs]]
* [[Places:Results]]
* [[Places:Controller]]
* [[Browser History]]
* [[Places:AutoComplete]]
* [[Places:Transactions]]
* [[Places:Drag & Drop]]
* [[Places:Manager]]
* [[Places:Bookmarks Containers]]
* [[Places:Live Bookmarks]]
More design information is on the [http://developer.mozilla.org/en/docs/Places Places developer wiki].
= Implementation =
Places is currently enabled for Firefox 3 and greater, powering History and Bookmarks, as well as providing plumbing for Livemarks, Annotations and Microsummaries and the Awesomebar.
== Team ==
Active core contributors:
* [http://autonome.wordpress.com/ Dietrich Ayala]
* [http://shawnwilsher.com/ Shawn Wilsher]
* [http://twitter.com/mak77 Marco Bonardo]
Past core contributors:
* Asaf Romano
* [http://www.xulplanet.com/ndeakin/ Neil Deakin]
* [http://blog.mozilla.com/sspitzer/ Seth Spitzer]
With help Help and guidance from:
* [http://maxradi.us/ Brett Wilson] (former back-end contributor)
* [http://blog.mozilla.com/faaborg Alex Faaborg]
See the [https://wiki.mozilla.org/Places:Plan plan] for current work.= Discussion & Research =
== API Changes == The APIs for accessing Bookmarks have been replaced. Some history APIs remain the same. See In-depth discussion is in the [http://developer.mozilla.org/en/docs/Places Places developer wiki] for more information. * [http://developer.mozilla.org/en/docs/Places:History_Service Places: History Service]* [http://developer.mozilla.org/en/docs/Places:Bookmarks_Service Places: Bookmarks Service]* [http://developer.mozilla.org/en/docs/Places:Annotation_Service Places: Annotation Service]* [http://developer.mozilla.org/en/docs/Places:Livemark_Service Places: Livemark Service]* [http://developer.mozilla.org/en/docs/Places:Favicon_Service Places: Favicon Service]* [http://developer.mozilla.org/en/docs/Places:Tagging_Service Places: Tagging Service] == Special Containers == XXXdietrich - move to developer wiki, replace with an original design page for extensibility = Impact = == Extensions == The APIs for accessing and manipulating Bookmarks and History have been replaced entirely in Firefox 3, and are incompatible. Almost all Bookmarks and History user interface components have been replaced or updated significantly. Any extension that does anything with History or Bookmarks will almost certainly have to be rewrittendocuments, at the very least to use the new APIs. == Performance == See linked from [[Places:PerformanceDesign Overview]] for more information. = Discussion & Implications = * [[Places:SecurityReview|Places Security Review]] == Discussion Elsewhere ==
* [http://robert.accettura.com/archives/2005/08/01/intelligent-bookmarking-draft/ Intelligent Bookmarking (Draft) - Robert Accettura]
* [http://pubnotes.wordpress.com/2007/10/14/evolution-of-bookmarking/ The Evolution of Bookmarking -- Bookmarks, Firefox, del.icio.us, Tagging, and Information Management]
* [http://www.ra.ethz.ch/CDstore/www5/www185/overview.htm Automatically Organizing Bookmarks per Contents], Fifth International World Wide Web Conference, May 6-10, 1996, Paris, France. ([http://scholar.google.com/scholar?cluster=5092164817324641042 Google Scholar search for the article] if it moves)
* [[User:Dria/On Tagging|Deb Richardson's "On Tagging"]]
