addon-sdk/source/examples/annotator/README.md@6474c204b198 (annotated)
addon-sdk/source/examples/annotator/README.md
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | <!-- This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 2 | - License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 3 | - file, You can obtain one at http://mozilla.org/MPL/2.0/. --> |
| michael@0 | 4 | |
| michael@0 | 5 | This add-on enables users to add notes, or annotations, to Web pages. |
| michael@0 | 6 | |
| michael@0 | 7 | Usage |
| michael@0 | 8 | ----- |
| michael@0 | 9 | |
| michael@0 | 10 | To switch the annotator on, left-click the pencil icon in the Add-on Bar. The |
| michael@0 | 11 | icon should turn yellow: this indicates that the annotator is active. To switch |
| michael@0 | 12 | it off, click it again. Switching it on/off only stops you from entering |
| michael@0 | 13 | annotations: existing annotations are still displayed. |
| michael@0 | 14 | |
| michael@0 | 15 | When the annotator is active and the user moves the mouse over a page element |
| michael@0 | 16 | that can be annotated, the annotator highlights that elements by giving it a |
| michael@0 | 17 | yellow background. |
| michael@0 | 18 | |
| michael@0 | 19 | If the user clicks on a highlighted element the add-on opens a dialog for the |
| michael@0 | 20 | user to enter the annotation. When the user hits <return> the annotation is |
| michael@0 | 21 | saved. |
| michael@0 | 22 | |
| michael@0 | 23 | Elements which have been annotated are displayed with a yellow border: when the |
| michael@0 | 24 | user moves the mouse over one of these elements, the add-on displays the |
| michael@0 | 25 | annotation associated with that element. |
| michael@0 | 26 | |
| michael@0 | 27 | To view all annotations in a list, right-click the pencil icon. |
| michael@0 | 28 | |
| michael@0 | 29 | The add-on is deactivated in private browsing mode, meaning that new annotations |
| michael@0 | 30 | can't be created although existing ones are still shown. On exiting private |
| michael@0 | 31 | browsing the add-on returns to its previous activation state. |
| michael@0 | 32 | |
| michael@0 | 33 | Known Issues/Limitations |
| michael@0 | 34 | ------------------------ |
| michael@0 | 35 | |
| michael@0 | 36 | It is not possible to delete annotations, or to edit them after creating them, |
| michael@0 | 37 | but it would be simple to add this. |
| michael@0 | 38 | |
| michael@0 | 39 | When right-clicking the annotator icon the add-on bar's context-menu is shown: |
| michael@0 | 40 | this is tracked by |
| michael@0 | 41 | [bug 626326](https://bugzilla.mozilla.org/show_bug.cgi?id=626326). |
| michael@0 | 42 | |
| michael@0 | 43 | The list of annotations should be anchored to the widget. The annotation |
| michael@0 | 44 | editor, and the annotation itself, should be anchored to the element which is |
| michael@0 | 45 | annotated. The will be done when the implementation of panel-anchoring is |
| michael@0 | 46 | extended. |
