The Tor Browser / file comparison
comparison: addon-sdk/source/examples/annotator/README.md
addon-sdk/source/examples/annotator/README.md
- branch
- TOR_BUG_9701
- changeset 10
- ac0c01689b40
equal
deleted
inserted
replaced
| -1:000000000000 | 0:9063561d90fe |
|---|---|
| 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/. --> | |
| 4 | |
| 5 This add-on enables users to add notes, or annotations, to Web pages. | |
| 6 | |
| 7 Usage | |
| 8 ----- | |
| 9 | |
| 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. | |
| 14 | |
| 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. | |
| 18 | |
| 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. | |
| 22 | |
| 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. | |
| 26 | |
| 27 To view all annotations in a list, right-click the pencil icon. | |
| 28 | |
| 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. | |
| 32 | |
| 33 Known Issues/Limitations | |
| 34 ------------------------ | |
| 35 | |
| 36 It is not possible to delete annotations, or to edit them after creating them, | |
| 37 but it would be simple to add this. | |
| 38 | |
| 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). | |
| 42 | |
| 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. |
