Giter VIP home page Giter VIP logo

tippanee_web_annotator's Introduction

Tippanee Web Annotator        License: MIT

The Tippanee web annotator allows it's users to weave textual web contents and applications by hooking up to existing web pages - independent of ownership!

The platform allows its user to hook up notes to web components. Tippanee has a minimalistic design and doesn’t hamper user experience. It’s sidebar design neatly embeds into any webpage and can be easily hidden if required. Save multiple notes on different webpages and switch between them with a few clicks.

Download from Google Web Store.

social-preview


Getting Started Guide

Introduction

The following guide is meant to enable users to install and start creating annotations with Tippanee. The primary features and user-interface components of the annotation tool are demonstrated through screenshots captured on a Windows machine.

Installing Tippanee

To begin, we will need to first install Tippanee's browser extension on the Google Chrome browser.

  1. Start by opening the Google Chrome browser on your system, and then go to the Chrome Web Store. To get to the Chrome Web Store, type the URL (https://chrome.google.com/webstore/category/extensions) in the address bar of the browser, and hit the Enter key.

  2. Once on the Chrome Web Store, type the word "Tippanee" on the search bar on the left, and hit the Enter key.

Screenshot_1

  1. The Tippanee browser extension should now be visible at the center of screen. Click on the extension description, to get to the extension's page.

Screenshot_2

  1. The extension's page should have an Add to Chrome button on the right side of the page. Click on the button to install the extension on to your browser.

Screenshot_3

  1. You will be prompted with the permissions required by the extension. Click the Add extension button to go ahead with the installation.

Screenshot_4

  1. You will be prompted, once the extension is installed. Now, to view the extension shortcut on your browser, click on the puzzle-like logo at the top-right corner of the browser window. This Extension button allows users to pin extensions to the browser UI.

  2. Click on the pin, to the right of the extension "Tippanee - Weave your own Web".

Screenshot_5

The Tippanee extension should now be ready for use, and the extension's shortcut should be visible in the top-right area of the browser window.

Screenshot_5

To enable or disable the extension on any web page, click on the extension shortcut once. If Tippanee's extension logo turns to gray-scale, this means the extension is disabled. While if the extension logo is colored (i.e., black, blue and white), this implies the extension is active. Please note, that if the extension takes to long to load on a page, or doesn't seem to work, you should disable and re-enable the extension.

Creating Annotations

To create an annotation on Tippanee, simply visit the web you would like to annotate, verify whether the extension is enabled on the web page, and then follow these steps:\

Please note that we demonstrate these steps by creating annotations on the Wikipedia home page (https://en.wikipedia.org/wiki/Main_Page).

  1. Select the text you would like to annotate, by clicking and dragging the mouse over the text. Once the text is selected you should see Tippanee's logo to the bottom-right of the selected text.

  2. Click on the Tippanee logo to annotate the selected text.

Screenshot_7

Once the text is annotated, you should see a light-blue box around the previously selected text. The box indicates the HTML DOM element that the annotated text belongs to. The Tippanee shortcut in the top-right area of the browser indicates the number of annotations of the current web page.

Screenshot_8 \clearpage

Viewing Annotations and Adding Comments

To view the annotations previously created on a web page, click the left/right-facing arrow on the right side of the browser. By default the dashboard of the extension is hidden. However clicking on the left-facing arrow, should make the dashboard visible on the right side of the browser window.

To add comments to an annotation, click on the text box with the message "Add a note...". Then type in comment you would like to add, and hit the Enter key.

Screenshot_9

To view an annotation on the web page, click on the annotation within the dashboard. Doing so, should highlight the exact annotated text in yellow, and the annotated element in pink.

Screenshot_10

To view all annotations you have created so far, click on the Browse all annotations button, indicated by two overlapping squares, inside the annotation tool's dashboard.

Screenshot_15

User Interface and System Features

If a user visits a previously annotated web page, the Tippanee extension uses its novel anchoring anchoring algorithm and attempts to reattach the annotations to their correct locations. In doing so, the extension generates a similarity index for each of the page's annotations. The similarity index of the reattached annotation can be found on the bottom-left of the corresponding annotation, inside the annotation tool's dashboard. To the right of the similarity index indicator, are the buttons: Reconstruct annotation, Link annotations, Transclude annotation, Describe annotation, and Delete annotation.

To create links between annotations, first click on the Link annotations button. A list of all annotations created by the user should appear under the annotation. By clicking on Add link button, indicated by the link logo, a user can create a uni-direction link between the original annotation and the annotation being linked. By clicking on the same logo again user can unlink the annotations (i.e., Remove link).

Screenshot_11

\clearpage To add semantic descriptions to annotated contents, users can use the Describe annotation button. On clicking the button, users should be able to see the Describe Annotation window, under the original annotation. The new window contains a drop-down menu titled "What is the annotation about?". Users can choose between a few pre-defined semantic classes and properties, that they can then use to describe the context of the annotation. Once the users have added information into the (semantic metadata) text boxes, they are required to click on the Add button to store the added metadata. For now, this information is used to retrieve annotations, when users are searching for a specific annotation, using the Search annotations feature.

Screenshot_12

Screenshot_13

Using Tippanee's Reconstruct annotation feature, users can view created annotations in their original forms. The feature works by showing users how the annotation looked like when it was first created. Also, it allows users to see both the annotated content and its surrounding context, given the annotation is part of a larger DOM element. The annotated text is made visible with a green highlight, while its surrounding text has no highlight.

Screenshot_14

Users can view linked annotations by using the Visualize annotations feature. Activated by using the tree-like logo in the top-right area of the annotation tool dashboard, the feature allows users to visualize the annotations and their links. Through the feature, annotations are visualized as a node, while their links are visualized as edges. It should be noted that the size of each node indicates the number of comments the annotation has. By hovering the mouse over a node, users can view the node's corresponding annotation text, while double-clicking on the node redirects users to the corresponding annotation's web page.

Screenshot_16


Licence

This project is licensed under the MIT License - see the LICENSE.md file for details.

Citation

  • Vishwajeet Pattanaik, Shweta Suran, and Dirk Draheim. 2019. Enabling Social Information Exchange via Dynamically Robust Annotations. In The 21st International Conference on Information Integration and Web-based Applications & Services (iiWAS2019), December 2–4, 2019, Munich, Germany. ACM, New York, NY, USA, 9 pages. https://doi.org/10.1145/3366030.3366060
Copyright (c) 2020 Vishwajeet Pattanaik

tippanee_web_annotator's People

Contributors

vpattanaik avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.