Skip to content

thomasmckinstry/Web-Page-Annotator-for-Firefox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Web Page Annotator

Web Page Annotater is a browser extension for firefox that allows the users to take notes on any HTML web page by highlighting text and making annotations. Any notes are displayed in the sidebar on the page they were made in.

Features

  • Highlight text.
  • Annotate text.
  • Edit existing annotations.
  • Display notes in the sidebar.
  • Display notes on subsequent visits to the same page.
  • Scroll to annotated text in page from sidebar.
  • Remove notes.

Installation

addons.mozilla.org (AMO)

  1. Click Here

Building from source

  1. Clone repository
  2. Download web-ext here
  3. Run web-ext build in the cloned Web Page Annotater repository
  4. Go to about:addons in your browser
  5. Click the setting icon, and then "Install add-on from file"
  6. Select the zip file generated in the web-ext-artifacts folder

Usage

Making Notes


The user should select the desired text and then can highlight text with the shortcut Ctrl + Alt + h or annotate text with the shortcut Ctrl + Alt + n. Alternatively, when text is selected, the user can right-click and there will be a sub-menu corresponding to the extension that will have buttons for each note type. If the user chooses to annotate text, a pop-up will appear to input the note.

The note made on annotated text can be viewed by hovering over the text, causing a pop-up to appear. Annotated text will have a text-shadow to indicate that it was annotated.

Notes are stored in the "Local Storage" for the web page it was made on. See Here for details.


Sidebar


The sidebar automatically displays all notes on the current page, it can be opened using the regular firefox sidebar button located to the left of the address bar.

The sidebar has two color selectors at the top, which will change the color of highlighted text, and the color of annotated text. Icons indicate which selector controls the color of each note type.

Each note has a button to delete the note. Deleting the note will not immediately remove it from the web page, but it will not display after a refresh. Another button exists to scroll to the note on the web page. Annotations have a button to edit the note, a pop-up will appear when this button is clicked to create a new annotation.


Technologies Used

  • Javascript
  • HTML
  • CSS
  • web-ext

Issues and Requests

Feel free to notify me of any feature requests or problems via the Issues tab in this repository.

About

GPLv3 License

Free and Open-source. No data about the user is collected.

About

No description, website, or topics provided.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors