Documentation for release 2.1.2

CHANGELOG.md

@@ -27,6 +27,42 @@ docker compose run --rm -it pgbackups /backup.sh
 
 (or `docker-compose` if your version of Docker does not support compose v2).
 
+## [2.1.2] 2024-02-26
+
+### Changed
+- **Breaking change**: When exporting annotations as JSON, the "features" that the annotator entered are no longer nested under `label` ([#347](https://github.com/GateNLP/gate-teamware/issues/347)).  Where previously the export would have been 
+  ```json
+  {
+    "features": {
+      "label": {
+        "field1": "value1"
+      }
+    }
+  }
+  ```
+
+  it is now
+  ```json
+  {
+    "features": {
+      "field1": "value1"
+    }
+  }
+  ```
+- Include details of failed annotations in export formats ([#399](https://github.com/GateNLP/gate-teamware/pull/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](https://github.com/GateNLP/gate-teamware/pull/397))
+- Fixed several issues relating to the export of annotated data ([#377](https://github.com/GateNLP/gate-teamware/pull/377))
+  - "Anonymous" export was not properly anonymous ([#345](https://github.com/GateNLP/gate-teamware/issues/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](https://github.com/GateNLP/gate-teamware/issues/346), [#348](https://github.com/GateNLP/gate-teamware/issues/348))
+
+
 ## [2.1.1] 2023-10-02
 
 ### Added 

CITATION.cff

@@ -1,6 +1,6 @@
 abstract: A web application for collaborative document annotation. GATE teamware provides
   a flexible web app platform for managing classification of documents by human annotators.
-authors: 
+authors:
 - affiliation: The University of Sheffield
   email: [email protected]
   family-names: Karmakharm
@@ -33,13 +33,7 @@ keywords:
 - document annotation
 license: AGPL-3.0
 message: If you use this software, please cite it using the metadata from this file.
-repository-code: https://github.com/GateNLP/gate-teamware
-title: GATE Teamware
-type: software
-url: https://gatenlp.github.io/gate-teamware/
-version: 2.1.1
 preferred-citation:
-  type: conference-paper
   authors:
   - affiliation: The University of Sheffield
     email: [email protected]
@@ -66,14 +60,22 @@ preferred-citation:
     family-names: Bontcheva
     given-names: Kalina
     orcid: https://orcid.org/0000-0001-6152-9600
+  collection-title: 'Proceedings of the 17th Conference of the European Chapter of
+    the Association for Computational Linguistics: System Demonstrations'
   doi: 10.18653/v1/2023.eacl-demo.17
-  title: "GATE Teamware 2: An open-source tool for collaborative document classification annotation"
-  collection-title: "Proceedings of the 17th Conference of the European Chapter of the Association for Computational Linguistics: System Demonstrations"    
+  end: 151
   location:
     name: Dubrovnik, Croatia
-  year: 2023
   month: 5
-  start: 145
-  end: 151
   publisher:
     name: Association for Computational Linguistics
+  start: 145
+  title: 'GATE Teamware 2: An open-source tool for collaborative document classification
+    annotation'
+  type: conference-paper
+  year: 2023
+repository-code: https://github.com/GateNLP/gate-teamware
+title: GATE Teamware
+type: software
+url: https://gatenlp.github.io/gate-teamware/
+version: 2.1.2

VERSION

@@ -1 +1 @@
-2.1.1
+2.1.2

docs/docs/.vuepress/versions.json

@@ -18,6 +18,14 @@
    "text": "2.1.0",
    "value": "/gate-teamware/2.1.0/"
   },
+  {
+   "text": "2.1.1",
+   "value": "/gate-teamware/2.1.1/"
+  },
+  {
+   "text": "2.1.2",
+   "value": "/gate-teamware/2.1.2/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gate-teamware-docs",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Documentation for GATE Teamware.",
   "main": "index.js",
   "scripts": {

docs/versioned/0.3.0/.vuepress/versions.json

@@ -18,6 +18,14 @@
    "text": "2.1.0",
    "value": "/gate-teamware/2.1.0/"
   },
+  {
+   "text": "2.1.1",
+   "value": "/gate-teamware/2.1.1/"
+  },
+  {
+   "text": "2.1.2",
+   "value": "/gate-teamware/2.1.2/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/versioned/0.4.0/.vuepress/versions.json

@@ -18,6 +18,14 @@
    "text": "2.1.0",
    "value": "/gate-teamware/2.1.0/"
   },
+  {
+   "text": "2.1.1",
+   "value": "/gate-teamware/2.1.1/"
+  },
+  {
+   "text": "2.1.2",
+   "value": "/gate-teamware/2.1.2/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/versioned/2.0.0/.vuepress/versions.json

@@ -18,6 +18,14 @@
    "text": "2.1.0",
    "value": "/gate-teamware/2.1.0/"
   },
+  {
+   "text": "2.1.1",
+   "value": "/gate-teamware/2.1.1/"
+  },
+  {
+   "text": "2.1.2",
+   "value": "/gate-teamware/2.1.2/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/versioned/2.1.0/.vuepress/versions.json

@@ -18,6 +18,14 @@
    "text": "2.1.0",
    "value": "/gate-teamware/2.1.0/"
   },
+  {
+   "text": "2.1.1",
+   "value": "/gate-teamware/2.1.1/"
+  },
+  {
+   "text": "2.1.2",
+   "value": "/gate-teamware/2.1.2/"
+  },
   {
    "text": "development",
    "value": "/gate-teamware/development/"

docs/versioned/2.1.1/.vuepress/components/AnnotationRendererPreview.vue

@@ -0,0 +1,107 @@
+<template>
+  <div>
+    <b-tabs>
+      <b-tab title="Code">
+
+      <slot></slot>
+
+      </b-tab>
+      <b-tab title="Preview">
+        <p v-if="documents.length > 1">Document {{documentIndex + 1}} of {{documents.length}}</p>
+        <b-card class="mb-2 mt-2">
+          <AnnotationRenderer ref="annotationRenderer"
+                              :config="config"
+                              :document="currentDocument" :allow_document_reject="true"
+                              v-model="annotationOutput"
+                              :doc_preannotation_field="preAnnotation"
+                              @submit="nextDocument()"
+                              @reject="nextDocument()"
+          ></AnnotationRenderer>
+        </b-card>
+        <b-card class="mb-2 mt-2">
+          <p><strong>Annotation output:</strong></p>
+          {{annotationOutput}}
+        </b-card>
+      </b-tab>
+
+    </b-tabs>
+  </div>
+
+</template>
+
+<script>
+import AnnotationRenderer from '@/components/AnnotationRenderer';
+
+export default {
+  name: "AnnotationRendererPreview",
+  components: {
+    AnnotationRenderer
+  },
+  data(){
+    return {
+      annotationOutput: {},
+      documentIndex: 0
+    }
+
+  },
+  computed: {
+    documents() {
+      if(Array.isArray(this.document)) {
+        return this.document
+      } else {
+        return [this.document]
+      }
+    },
+    currentDocument() {
+      return this.documents[this.documentIndex]
+    }
+  },
+  props: {
+    preAnnotation: {
+      default(){
+        return ""
+      }
+    },
+    document: {
+      default(){
+        return {text: "Sometext with <strong>html</strong>"}
+      }
+    },
+    config: {
+      default() {
+        return [
+            {
+              "name": "htmldisplay",
+              "type": "html",
+              "text": "{{{text}}}"
+            },
+            {
+              "name": "sentiment",
+              "type": "radio",
+              "title": "Sentiment",
+              "description": "Please select a sentiment of the text above.",
+              "options": {
+                "negative": "Negative",
+                "neutral": "Neutral",
+                "positive": "Positive"
+
+              }
+            }
+          ]
+      }
+    },
+  },
+  methods: {
+    nextDocument() {
+      this.documentIndex = (this.documentIndex + 1) % this.documents.length;
+      this.$refs.annotationRenderer.clearForm()
+    }
+  }
+}
+</script>
+
+<style>
+legend {
+font-weight: bold;
+}
+</style>

docs/versioned/2.1.1/.vuepress/components/DisplayVersion.vue

@@ -0,0 +1,21 @@
+<template>
+<span>{{version_name}}</span>
+</template>
+
+<script>
+import versionData from "../versions.json"
+export default {
+  name: "DisplayVersion",
+  computed: {
+    version_name(){
+      return versionData.current
+    }
+  }
+
+
+}
+</script>
+
+<style scoped>
+
+</style>

docs/versioned/2.1.1/.vuepress/config.js

@@ -0,0 +1,42 @@
+const versionData = require("./versions.json")
+const path = require("path");
+module.exports = context => ({
+    title: 'GATE Teamware Documentation',
+    description: 'Documentation for GATE Teamware',
+    base: versionData.base,
+    themeConfig: {
+        nav: [
+            {text: 'Home', link: '/'},
+            {text: 'Annotators', link: '/annotatorguide/'},
+            {text: 'Managers & Admins', link: '/manageradminguide/'},
+            {text: 'Developer', link: '/developerguide/'}
+        ],
+        sidebar: {
+            '/manageradminguide/': [
+                "",
+                "project_management",
+                "project_config",
+                "documents_annotations_management",
+                "annotators_management"
+            ],
+            '/developerguide/': [
+                '',
+                'frontend',
+                'testing',
+                'releases',
+                'documentation',
+                "api_docs",
+
+            ],
+        },
+    },
+    configureWebpack: {
+        resolve: {
+            alias: {
+                '@': path.resolve(__dirname, versionData.frontendSource)
+            }
+        }
+    },
+
+
+})

docs/versioned/2.1.1/.vuepress/enhanceApp.js

@@ -0,0 +1,17 @@
+import Vue from 'vue'
+import {BootstrapVue, BootstrapVueIcons, IconsPlugin} from 'bootstrap-vue'
+
+import 'bootstrap/dist/css/bootstrap.css'
+import 'bootstrap-vue/dist/bootstrap-vue.css'
+
+Vue.use(BootstrapVue)
+Vue.use(BootstrapVueIcons)
+
+export default ({
+  Vue, // the version of Vue being used in the VuePress app
+  options, // the options for the root Vue instance
+  router, // the router instance for the app
+  siteData // site metadata
+}) => {
+
+}