# D3-Annotator
D3-Annotator is a Tor (and Firefox) add-on that enables its users to annotate, categorise, and save excerpts from
.onion web pages. Users can add their own categories to be synchronised with the server (running D3-Centraliser). 

# Installation Guide
This add-on should, currently, be run as temporary add-on by typing about:debugging into the URL field
in the Tor Browser and then click "This Tor Browser". Then it should be possible to select a local file (see screenshot below). Choose the manifest.json file and click OK.  


<img src="screenshots/about_debugging.png" heigh="500" width="500">

Once the add-on is loaded successfully it is time to exempt the API server IP address from the Tor socket.
To do this you need to type about:config into the URL field in the Tor Browser. Once loaded, search for the
setting "proxy.ip" type the IP address of your API (i.e. D3-Centraliser) server here. 

<img src="screenshots/about_config.png" heigh="500" width="500">

# User Guide
Once the add-on is loaded and has established a connection to the D3-Centraliser server, you should be able to 
start annotating and categorising web pages.

Whenever you want to categorise a web page, simply right click it and go to D3-Annotator in the drop down menu. 

<img src="screenshots/menu.png" heigh="500" width="500">

Select "Annotate and Categorise Page" and then simply check the box for which category/categories you would like
to add the page to. If you want to add an annotation you can do that in the annotation field as well (see screenshot below).

<img src="screenshots/annotation.png" heigh="500" width="500">


# Troubleshooting
You do not need to enable Javascript on any .onion site to run the add-on. 

You might need to click "Remember History" under the Tor Browser settings in order for the local storage to work. 

# Nota Bene
This is a work in progress with a lot of ugly code in it. 

# Licence 
GPL-3 (see LICENCE file)