1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/addon-sdk/source/examples/annotator/README.md Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,46 @@
1.4 +<!-- This Source Code Form is subject to the terms of the Mozilla Public
1.5 + - License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
1.7 +
1.8 +This add-on enables users to add notes, or annotations, to Web pages.
1.9 +
1.10 +Usage
1.11 +-----
1.12 +
1.13 +To switch the annotator on, left-click the pencil icon in the Add-on Bar. The
1.14 +icon should turn yellow: this indicates that the annotator is active. To switch
1.15 +it off, click it again. Switching it on/off only stops you from entering
1.16 +annotations: existing annotations are still displayed.
1.17 +
1.18 +When the annotator is active and the user moves the mouse over a page element
1.19 +that can be annotated, the annotator highlights that elements by giving it a
1.20 +yellow background.
1.21 +
1.22 +If the user clicks on a highlighted element the add-on opens a dialog for the
1.23 +user to enter the annotation. When the user hits <return> the annotation is
1.24 +saved.
1.25 +
1.26 +Elements which have been annotated are displayed with a yellow border: when the
1.27 +user moves the mouse over one of these elements, the add-on displays the
1.28 +annotation associated with that element.
1.29 +
1.30 +To view all annotations in a list, right-click the pencil icon.
1.31 +
1.32 +The add-on is deactivated in private browsing mode, meaning that new annotations
1.33 +can't be created although existing ones are still shown. On exiting private
1.34 +browsing the add-on returns to its previous activation state.
1.35 +
1.36 +Known Issues/Limitations
1.37 +------------------------
1.38 +
1.39 +It is not possible to delete annotations, or to edit them after creating them,
1.40 +but it would be simple to add this.
1.41 +
1.42 +When right-clicking the annotator icon the add-on bar's context-menu is shown:
1.43 +this is tracked by
1.44 +[bug 626326](https://bugzilla.mozilla.org/show_bug.cgi?id=626326).
1.45 +
1.46 +The list of annotations should be anchored to the widget. The annotation
1.47 +editor, and the annotation itself, should be anchored to the element which is
1.48 +annotated. The will be done when the implementation of panel-anchoring is
1.49 +extended.
