Difference between revisions of "UD annotatrix/UD annotatrix at GSoC 2017"

From Apertium
Jump to navigation Jump to search
Line 5: Line 5:
 
== The idea ==
 
== The idea ==
   
The aim of this project was to create a ...
+
The aim of this project was to create a ...
   
== Project description ==
+
== Main work on the project ==
   
=== Main work on the project ===
+
=== Visualisation ===
 
==== Visualisation ====
 
   
 
Primarily, the tool was using brat's JavaScript library for visualisation. As a part of this project, I have rewritten the visualisation part using the Cytoscape library. Cytoscape is a JS graph library primarily developed for biologists, but avaliable to use for different purposes. This was made to add functionality which brat's visualisation library could not provide, namely, easier implementation of editing functionality and alignment (RTL, top to bottom) settings.
 
Primarily, the tool was using brat's JavaScript library for visualisation. As a part of this project, I have rewritten the visualisation part using the Cytoscape library. Cytoscape is a JS graph library primarily developed for biologists, but avaliable to use for different purposes. This was made to add functionality which brat's visualisation library could not provide, namely, easier implementation of editing functionality and alignment (RTL, top to bottom) settings.
Line 17: Line 15:
 
The source code for visualisation support is mostly located in ./standalone/lib/visualiser.js.
 
The source code for visualisation support is mostly located in ./standalone/lib/visualiser.js.
   
==== Editing functionality ====
+
=== Editing functionality ===
   
 
Currently, the interface allows to:
 
Currently, the interface allows to:
Line 26: Line 24:
 
The source code for visualisation support is mostly located in ./standalone/lib/gui.js.
 
The source code for visualisation support is mostly located in ./standalone/lib/gui.js.
   
==== Server version ====
+
=== Server version ===
   
 
There is also a ...
 
There is also a ...
   
=== The product ===
+
== The product ==
   
 
The web-interface is currently available on GitHub pages: [https://maryszmary.github.io/ud-annotatrix/standalone/annotator.html]. The basic manual to the interface is provided on the [https://maryszmary.github.io/ud-annotatrix/standalone/help.html help page].
 
The web-interface is currently available on GitHub pages: [https://maryszmary.github.io/ud-annotatrix/standalone/annotator.html]. The basic manual to the interface is provided on the [https://maryszmary.github.io/ud-annotatrix/standalone/help.html help page].
Line 39: Line 37:
 
*
 
*
   
=== The project's components ===
+
== The project's architecture and components ==
   
==== Dependencies ====
+
=== Dependencies ===
   
 
All the JS dependencies needed for the standalone version are included in the package. These are:
 
All the JS dependencies needed for the standalone version are included in the package. These are:
Line 53: Line 51:
 
The project's package consists of sever and standalone sub-directories.
 
The project's package consists of sever and standalone sub-directories.
   
==== Standalone ====
+
=== Standalone ===
   
 
The server directory contains only additional support ...
 
The server directory contains only additional support ...

Revision as of 17:22, 28 August 2017

Commitment

The contributions were made to [1] ...

The idea

The aim of this project was to create a ...

Main work on the project

Visualisation

Primarily, the tool was using brat's JavaScript library for visualisation. As a part of this project, I have rewritten the visualisation part using the Cytoscape library. Cytoscape is a JS graph library primarily developed for biologists, but avaliable to use for different purposes. This was made to add functionality which brat's visualisation library could not provide, namely, easier implementation of editing functionality and alignment (RTL, top to bottom) settings.

The source code for visualisation support is mostly located in ./standalone/lib/visualiser.js.

Editing functionality

Currently, the interface allows to:

  • Draw depencencies
  • Label dependencies

The source code for visualisation support is mostly located in ./standalone/lib/gui.js.

Server version

There is also a ...

The product

The web-interface is currently available on GitHub pages: [2]. The basic manual to the interface is provided on the help page.

The product has some functionality not present in other tools:

  • It supports multiword tokens visualisation
  • It supports RTL sentences

The project's architecture and components

Dependencies

All the JS dependencies needed for the standalone version are included in the package. These are:

  • jQuery
  • Cytoscape
  • head.js

The server version is written on Python 3, Flask.

The project's package consists of sever and standalone sub-directories.

Standalone

The server directory contains only additional support ...


Usability testing

To evaluate the usability of the interface, ...

Future work

All the existing bugs and plans are listed on the issue page of the main repository.