https://github.com/lukasbach/textannotation

Eclipse plugin for annotating text files.
https://github.com/lukasbach/textannotation

annotation eclipse labeling plugin tool

Last synced: 6 months ago
JSON representation

Eclipse plugin for annotating text files.

• Host: GitHub
• URL: https://github.com/lukasbach/textannotation
• Owner: lukasbach
• License: mit
• Created: 2020-02-01T14:02:57.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-15T13:15:00.000Z (over 5 years ago)
• Last Synced: 2025-02-15T08:28:01.668Z (8 months ago)
• Topics: annotation, eclipse, labeling, plugin, tool
• Language: Java
• Homepage:
• Size: 2.41 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Eclipse Text Annotation Plugin

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/dashboard?id=lukasbach_textannotation)

[![Build Status](https://travis-ci.com/lukasbach/textannotation.svg?branch=master)](https://travis-ci.com/lukasbach/textannotation)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=lukasbach_textannotation&metric=coverage)](https://sonarcloud.io/dashboard?id=lukasbach_textannotation)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=lukasbach_textannotation&metric=ncloc)](https://sonarcloud.io/dashboard?id=lukasbach_textannotation)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=lukasbach_textannotation&metric=bugs)](https://sonarcloud.io/dashboard?id=lukasbach_textannotation)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=lukasbach_textannotation&metric=code_smells)](https://sonarcloud.io/dashboard?id=lukasbach_textannotation)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=lukasbach_textannotation&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=lukasbach_textannotation)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=lukasbach_textannotation&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=lukasbach_textannotation)

![Plugin Screenshot](screenshot.png)

## Quick Setup

For now the plugin has to be installed manually. Download the latest ``edu.kit.textannotation.annotationplugin-1.0.0-SNAPSHOT.jar`` file from the most recent [release](https://github.com/lukasbach/textannotation/releases) and place it in ``%eclipse-install-dir%/dropins/plugins``. The ``plugins`` subdirectory might not exist yet and has to be created in this case.

Then start eclipse with the ``-clean`` option for it to load the plugin.

## Examples

The repository comes with an example Eclipse workspace to explore the functions of the plugin. Clone the repository with ``git clone https://github.com/lukasbach/textannotation && cd textannotation/example`` and open an Eclipse workspace at that location. You can then open the file ``annotation-example-project/travelManagement.taf`` in Eclipse with the plugin installed.

## Using the Annotation Perspective

The plugin adds a custom perspective that provides all necessary views for using the plugin. Click the perspective shortcut on the top right or navigate through the menu bar via ``Window > Perspective > Open Perspective`` and open the *Text Annotation Perspective*. This automatically opens the relevant views and adds shortcuts for creating new files.

## Documentation

The user documentation as well as a documentation on the development of this plugin is located [here](./docs/documentation.md).

## Logs

The plugin uses the default logging service of Eclipse. By default, all logs are saved at

``workspace/.metadata/.log`` or ``eclipse/configuration/*.log``. You can also open the logs from within eclipse via ``Window > Show View > PDE Runtime > Error Log``.

Logging granularity can be changed via the ``config.ini`` file of eclipse by adapting the ``eclipse.log.level`` to one of the following: ``INFO``, ``WARNING``, ``ERROR``.

## About

This plugin was developed during a practical project at the Karlsruher Institut of Technology.

The project is documented [here](./docs/documentation.md).

The icon used in the plugin is part of the Silk Iconset by [famfamfam.com](famfamfam.com), and licensec under the [CC Attribution 2.5](http://creativecommons.org/licenses/by/2.5/) license.