The Tor Browser: addon-sdk/source/examples/annotator/README.md@6474c204b198

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 <!-- This Source Code Form is subject to the terms of the Mozilla Public

     2    - License, v. 2.0. If a copy of the MPL was not distributed with this

     3    - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->

     5 This add-on enables users to add notes, or annotations, to Web pages.

     7 Usage

     8 -----

    10 To switch the annotator on, left-click the pencil icon in the Add-on Bar. The

    11 icon should turn yellow: this indicates that the annotator is active. To switch

    12 it off, click it again. Switching it on/off only stops you from entering

    13 annotations: existing annotations are still displayed.

    15 When the annotator is active and the user moves the mouse over a page element

    16 that can be annotated, the annotator highlights that elements by giving it a

    17 yellow background.

    19 If the user clicks on a highlighted element the add-on opens a dialog for the

    20 user to enter the annotation. When the user hits <return> the annotation is

    21 saved.

    23 Elements which have been annotated are displayed with a yellow border: when the

    24 user moves the mouse over one of these elements, the add-on displays the

    25 annotation associated with that element.

    27 To view all annotations in a list, right-click the pencil icon.

    29 The add-on is deactivated in private browsing mode, meaning that new annotations

    30 can't be created although existing ones are still shown. On exiting private

    31 browsing the add-on returns to its previous activation state.

    33 Known Issues/Limitations

    34 ------------------------

    36 It is not possible to delete annotations, or to edit them after creating them,

    37 but it would be simple to add this.

    39 When right-clicking the annotator icon the add-on bar's context-menu is shown:

    40 this is tracked by

    41 [bug 626326](https://bugzilla.mozilla.org/show_bug.cgi?id=626326).

    43 The list of annotations should be anchored to the widget. The annotation

    44 editor, and the annotation itself, should be anchored to the element which is

    45 annotated. The will be done when the implementation of panel-anchoring is

    46 extended.

The Tor Browser / file revision