Annotations: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
== Introduction ==
== Introduction ==


Annotations is a service that can associate arbitrary information about URLs.
Annotations is a service that can associate arbitrary information about URLs. The goal is to use it for both history and bookmarks.
 
The goal is to use it for both history and bookmarks.


Possible uses:
Possible uses:
Line 14: Line 12:


(*) May be stored in history instead (TBD)
(*) May be stored in history instead (TBD)
Note that IE has persistency for web pages called 'userData' which we should understand: http://216.239.63.104/search?q=cache:msdn.microsoft.com/workshop/author/behaviors/reference/behaviors/userdata.asp&hl=en&lr=&sa=G&strip=1


== Internal design ==
== Internal design ==

Revision as of 00:57, 20 August 2005

Introduction

Annotations is a service that can associate arbitrary information about URLs. The goal is to use it for both history and bookmarks.

Possible uses:

  • Visit count (*)
  • Last visit date (*)
  • Fav icon
  • Page thumbnail
  • Notes
  • Persistent storage for Javascript on the page

(*) May be stored in history instead (TBD)

Note that IE has persistency for web pages called 'userData' which we should understand: http://216.239.63.104/search?q=cache:msdn.microsoft.com/workshop/author/behaviors/reference/behaviors/userdata.asp&hl=en&lr=&sa=G&strip=1

Internal design

The design consists of two tables. The first maps URLs to internal IDs.

The second stores all annotations:

  • URL ID
  • Annotation name
  • Value
  • Expiration information

Expiration

Because some annotations can be large, and the number of pages can also become very large, some sort of annotation expiration scheme is required. Annotations beyond the expiration date will be deleted. The time frame must be variable because some annotations may be large and should expire faster, while others may be small and have minimal overhead for keeping them around. The option of never expiring will also be provided.

This time frame may be measured from annotation creation, but it could potentially be more valuable to measure from from last page access time: "this annotation expires after one month of page disuse".

External interface

Required operations:

  • Get/set annotation "x" on this page
  • Give me all the annotations on this page
  • Give me all pages with annotation "x"="y" or "x" > "y", etc.

Issues: Namespacing of annotation names