michael@0: <!-- This Source Code Form is subject to the terms of the Mozilla Public
michael@0:    - License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:    - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
michael@0: 
michael@0: This add-on enables users to add notes, or annotations, to Web pages.
michael@0: 
michael@0: Usage
michael@0: -----
michael@0: 
michael@0: To switch the annotator on, left-click the pencil icon in the Add-on Bar. The
michael@0: icon should turn yellow: this indicates that the annotator is active. To switch
michael@0: it off, click it again. Switching it on/off only stops you from entering
michael@0: annotations: existing annotations are still displayed.
michael@0: 
michael@0: When the annotator is active and the user moves the mouse over a page element
michael@0: that can be annotated, the annotator highlights that elements by giving it a
michael@0: yellow background.
michael@0: 
michael@0: If the user clicks on a highlighted element the add-on opens a dialog for the
michael@0: user to enter the annotation. When the user hits <return> the annotation is
michael@0: saved.
michael@0: 
michael@0: Elements which have been annotated are displayed with a yellow border: when the
michael@0: user moves the mouse over one of these elements, the add-on displays the
michael@0: annotation associated with that element.
michael@0: 
michael@0: To view all annotations in a list, right-click the pencil icon.
michael@0: 
michael@0: The add-on is deactivated in private browsing mode, meaning that new annotations
michael@0: can't be created although existing ones are still shown. On exiting private
michael@0: browsing the add-on returns to its previous activation state.
michael@0: 
michael@0: Known Issues/Limitations
michael@0: ------------------------
michael@0: 
michael@0: It is not possible to delete annotations, or to edit them after creating them,
michael@0: but it would be simple to add this.
michael@0: 
michael@0: When right-clicking the annotator icon the add-on bar's context-menu is shown:
michael@0: this is tracked by
michael@0: [bug 626326](https://bugzilla.mozilla.org/show_bug.cgi?id=626326).
michael@0: 
michael@0: The list of annotations should be anchored to the widget. The annotation
michael@0: editor, and the annotation itself, should be anchored to the element which is
michael@0: annotated. The will be done when the implementation of panel-anchoring is
michael@0: extended.