Skip to content

Commit

Permalink
Versioned documentation for 2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ianroberts committed May 8, 2024
1 parent 96f2886 commit 64d7e12
Show file tree
Hide file tree
Showing 29 changed files with 3,856 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/docs/.vuepress/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"text": "2.1.1",
"value": "/gate-teamware/2.1.1/"
},
{
"text": "2.2.0",
"value": "/gate-teamware/2.2.0/"
},
{
"text": "development",
"value": "/gate-teamware/development/"
Expand Down
4 changes: 4 additions & 0 deletions docs/versioned/0.3.0/.vuepress/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"text": "2.1.1",
"value": "/gate-teamware/2.1.1/"
},
{
"text": "2.2.0",
"value": "/gate-teamware/2.2.0/"
},
{
"text": "development",
"value": "/gate-teamware/development/"
Expand Down
4 changes: 4 additions & 0 deletions docs/versioned/0.4.0/.vuepress/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"text": "2.1.1",
"value": "/gate-teamware/2.1.1/"
},
{
"text": "2.2.0",
"value": "/gate-teamware/2.2.0/"
},
{
"text": "development",
"value": "/gate-teamware/development/"
Expand Down
4 changes: 4 additions & 0 deletions docs/versioned/2.0.0/.vuepress/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"text": "2.1.1",
"value": "/gate-teamware/2.1.1/"
},
{
"text": "2.2.0",
"value": "/gate-teamware/2.2.0/"
},
{
"text": "development",
"value": "/gate-teamware/development/"
Expand Down
4 changes: 4 additions & 0 deletions docs/versioned/2.1.0/.vuepress/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"text": "2.1.1",
"value": "/gate-teamware/2.1.1/"
},
{
"text": "2.2.0",
"value": "/gate-teamware/2.2.0/"
},
{
"text": "development",
"value": "/gate-teamware/development/"
Expand Down
4 changes: 4 additions & 0 deletions docs/versioned/2.1.1/.vuepress/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"text": "2.1.1",
"value": "/gate-teamware/2.1.1/"
},
{
"text": "2.2.0",
"value": "/gate-teamware/2.2.0/"
},
{
"text": "development",
"value": "/gate-teamware/development/"
Expand Down
Original file line number Diff line number Diff line change
@@ -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>
21 changes: 21 additions & 0 deletions docs/versioned/2.2.0/.vuepress/components/DisplayVersion.vue
Original file line number Diff line number Diff line change
@@ -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>
42 changes: 42 additions & 0 deletions docs/versioned/2.2.0/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -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)
}
}
},


})
17 changes: 17 additions & 0 deletions docs/versioned/2.2.0/.vuepress/enhanceApp.js
Original file line number Diff line number Diff line change
@@ -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
}) => {

}
Loading

0 comments on commit 64d7e12

Please sign in to comment.