v2.2.0

Changed

• Breaking change: When exporting annotations as JSON, the "features" that the annotator entered are no longer nested under label (#347). Where previously the export would have been

  {
    "features": {
      "label": {
        "field1": "value1"
      }
    }
  }

  it is now

  {
    "features": {
      "field1": "value1"
    }
  }

• Include details of failed annotations in export formats (#399)

  • When exporting annotation data from projects (both via the web UI and using the command line tool),
    each document includes details of which users rejected, timed out or aborted annotation of
    that document, as well as the annotation data from the users who completed the document successfully.
    This can be useful for the project manager to identify documents that are particularly difficult
    to annotate, perhaps suggesting that the annotation guidelines need to be extended or clarified.

Fixed

• Upgraded a number of third-party dependencies to close various vulnerabilities (#397)
• Fixed several issues relating to the export of annotated data (#377)
  • "Anonymous" export was not properly anonymous (#345)
  • Teamware now does a better job of preserving the GATE BDOC JSON structure when exporting documents that were originally uploaded in that format (#346, #348)
• Added an explicit setting for "no email security", as an alternative to the implicit setting when the relevant environment variable is omitted. This is because the implicit setting was lost on upgrades, whereas an explicit "none" will be preserved (#402)

v2.1.1

Fixed

In versions from 0.2.0 to 2.1.0 inclusive the default docker-compose.yml file fails to back up the database, due to a mismatch between the version of the database server and the version of the backup client. This is now fixed, but in order to create a proper database backup before attempting to upgrade you will need to manually edit your docker-compose.yml file and change

  pgbackups:
    image: prodrigestivill/postgres-backup-local:12

to

  pgbackups:
    image: prodrigestivill/postgres-backup-local:14

(change the "12" to "14"), then run docker compose up -d (or docker-compose up -d) again to upgrade just the backup tool. Once the correct backup tool is running you can start an immediate backup using

docker compose run --rm -it pgbackups /backup.sh

(or docker-compose if your version of Docker does not support compose v2).

Added

• Script for extracting annotations without web UI

v2.1.0

Added

• Radio buttons and checkbox widgets can optionally have a per-choice helptext tooltip (#329)

Changed

• Frontend build chain now uses Vite (#342)
• Navbar and footer are now more responsive (#339)
• Node version upgraded to 18 (#357)
• Python and Node base images upgraded to used Bullseye Debian (#357)

Fixed

• Footer no longer covers over content (#339)
• Maximum annotations per document limit is no longer erroneously enforced on training and test documents (#355)
• Release workflow fixed (#341)

Version 2.0.0

This is GATE Teamware version 2.0.0, which is the first stable release of the GATE Teamware tool, a web application for collaborative document annotation.

• Free and open source software.
• Configure annotation options using a highly flexible JSON config.
• Set limits on proportions of a task that annotators can annotate.
• Import existing annotations as CSV or JSON.
• Export annotations as CSV or JSON.
• Annotation instructions and document rendering supports markdown and HTML.

Getting started

A quickstart guide for annotators is available here.

To use an existing instance of GATE Teamware as a project manager or admin, find instructions in the Managers and Admins guide.

Documentation on deploying your own instance can be found in the Developer Guide.

The simplest way to deploy your own copy of GATE Teamware is to use Docker Compose on Linux or Mac. Installation on Windows is possible but not officially supported - you need to be able to run bash shell scripts for the quick-start installer.

• Install Docker - Docker Engine for Linux servers or Docker Desktop for Mac.
• Install Docker Compose, if your Docker does not already include it (Compose is included by default with Docker Desktop)
• Download the installation script (get-teamware.sh in the list below) into an empty directory, run it and follow the instructions.

For a summary of key changes since version 0.1.0 see https://github.com/GateNLP/gate-teamware/blob/master/CHANGELOG.md