Documentation

config.toml

@@ -1,6 +1,6 @@
 baseURL = "/"
 enableRobotsTXT = true
-title = "The Ellogon Annotation Framework"
+title = "The Ellogon Annotation Platform"
 
 # Hugo allows theme composition (and inheritance). The precedence is from left to right.
 theme = ["docsy"]
@@ -69,13 +69,13 @@ id = "UA-00000000-0"
 
 [languages]
 [languages.en]
-title = "The Ellogon Annotation Framework"
-description = "An <b>open-source</b>, <b>free</b> to use, <b>customisable</b>, <b>collaborative</b> Data Annotation Frameworktool - in the cloud!"
+title = "The Ellogon Annotation Platform"
+description = "An <b>open-source</b>, <b>free</b> to use, <b>customisable</b>, <b>collaborative</b> Data Annotation Platformtool - in the cloud!"
 languageName ="English"
 # Weight used for sorting.
 weight = 1
 #[languages.no]
-#title = "The Ellogon Annotation Framework"
+#title = "The Ellogon Annotation Platform"
 #description = "Docsy er operativsystem for skyen"
 #languageName ="Norsk"
 #contentDir = "content/no"
@@ -99,7 +99,7 @@ weight = 1
 section = ["HTML", "print", "RSS"]
 
 [params]
-copyright = "The Ellogon Annotation Framework Authors |"
+copyright = "The Ellogon Annotation Platform Authors |"
 privacy_policy = ""
 
 # First one is picked as the Twitter card image if not set on page.
@@ -167,7 +167,7 @@ sidebar_search_disable = false
 # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
 # add "hide_feedback: true" to the page's front matter.
 [params.ui.feedback]
-enable = true
+enable = false
 # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
 yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
 no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'

content/en/_index.html

@@ -1,7 +1,7 @@
 ---
-title: "The Ellogon Annotation Framework"
-linkTitle: "Ellogon Annotation Framework"
-description: "An <b>open-source</b>, <b>free</b> to use, <b>customisable</b>, <b>collaborative</b> Data Annotation Frameworktool - in the cloud!"
+title: "The Ellogon Annotation Platform"
+linkTitle: "Ellogon Annotation Platform"
+description: "An <b>open-source</b>, <b>free</b> to use, <b>customisable</b>, <b>collaborative</b> Data Annotation Platformtool - in the cloud!"
 ---
 
 <!--
@@ -29,12 +29,12 @@
         <h1 class="hero-title">
           Open Source<br />
           Data Annotation<br />
-          Framework
+          Platform
         </h1>
         <img
           class="img-fluid hero-banner show-mobile-big"
           src="/images/screenshots/2022/DebateLab.png"
-          alt-text="Annotation Framework Screenshot"
+          alt-text="Annotation Platform Screenshot"
         />
         <br />
         <a href="/docs/installation/"
@@ -48,7 +48,7 @@ <h1 class="hero-title">
         <img
           class="img-fluid hero-banner"
           src="/images/screenshots/2022/DebateLab.png"
-          alt-text="Annotation Framework Screenshot"
+          alt-text="Annotation Platform Screenshot"
         />
       </div>
     </div>
@@ -68,11 +68,11 @@ <h1 class="hero-title">
 -->
 
 {{% blocks/lead color="primary" %}}
-**What is the "Ellogon Annotation Framework"?**
+**What is the "Ellogon Annotation Platform"?**
 
-[Ellogon](https://www.ellogon.org) is a natural language enginnering platform, which includes a data Annotation Engine.
+**[Ellogon](https://www.ellogon.org)** is a natural language enginnering infrastructure and platform, which includes a data Annotation Engine.
 
-The **Ellogon Annotation Framework** is a **data labelling tool**, based on [Ellogon](https://www.ellogon.org)'s engine.
+The **[Ellogon Annotation Platform](https://annotation.ellogon.org)** is a **data labelling tool**, based on [Ellogon](https://www.ellogon.org)'s engine.
 
 <div class="row justify-content-center align-items-center">
   <a href="/docs/getting-started/"><button class="hero-big"><i class="fas fa-book mr-2"></i>Learn More</button></a>
@@ -119,7 +119,7 @@ <h1 class="text-center">This is the second Section</h1>
 {{% blocks/feature icon="fa fa-blank" %}}
 {{% /blocks/feature %}}
 
-{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/iit-Demokritos/clarin-el-annotation-tool" url_text="Contribute to the Ellogon Annotation Framework" %}}
+{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/iit-Demokritos/clarin-el-annotation-tool" url_text="Contribute to the Ellogon Annotation Platform" %}}
 We do a [Pull Request](https://github.com/iit-Demokritos/clarin-el-annotation-tool/pulls) contributions workflow on **GitHub**. New users are always welcome!
 {{% /blocks/feature %}}
 

content/en/about/_index.html

@@ -1,5 +1,5 @@
 ---
-title: The Ellogon Annotation Framework
+title: The Ellogon Annotation Platform
 linkTitle: About
 menu:
   main:

content/en/docs/Concepts/architecture.md

@@ -0,0 +1,10 @@
+---
+categories: ["Concepts"]
+tags: ["architecture", "docs"]
+title: "Architecture"
+linkTitle: "Architecture"
+description: >
+  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
+---
+
+

content/en/docs/Contribution guidelines/_index.md

@@ -4,6 +4,7 @@ linkTitle: "Contribution Guidelines"
 weight: 10
 description: >
   How to contribute to the docs
+draft: true
 ---
 
 {{% pageinfo %}}

content/en/docs/Overview/_index.md

@@ -4,6 +4,7 @@ linkTitle: "Overview"
 weight: 1
 description: >
   Here's where your user finds out if your project is for them.
+draft: true
 ---
 
 {{% pageinfo %}}
@@ -33,6 +34,7 @@ Help your user know if your project will help them. Useful information can inclu
 
 Give your users next steps from the Overview. For example:
 
-* [Getting Started](/docs/getting-started/): Get started with $project
+* [Getting Started: Using the cloud services](/docs/getting-started/): Get started with $project
+* [Getting Started: Local Installation](/docs/getting-started/): Get started with $project
 * [Examples](/docs/examples/): Check out some example code!
 

content/en/docs/Reference/_index.md

@@ -4,6 +4,7 @@ linkTitle: "Reference"
 weight: 9
 description: >
   Low level reference docs for your project.
+draft: true
 ---
 
 {{% pageinfo %}}

content/en/docs/Tasks/_index.md

@@ -1,11 +1,11 @@
-
 ---
 title: "Core Tasks"
 linkTitle: "Core Tasks"
 weight: 6
 date: 2017-01-05
 description: >
   What can your user do with your project?
+draft: true
 ---
 
 {{% pageinfo %}}

content/en/docs/Tutorials/_index.md

@@ -1,11 +1,11 @@
-
 ---
 title: "Tutorials"
 linkTitle: "Tutorials"
 weight: 8
 date: 2017-01-04
 description: >
   Show your user how to work through some end to end examples.
+draft: true
 ---
 
 {{% pageinfo %}}

content/en/docs/_index.md

@@ -1,25 +1,57 @@
 
 ---
-title: "Documentation"
+title: "The Ellogon Annotation Platform"
 linkTitle: "Documentation"
+description: >
+  Open Source Data Annotation Platform
 weight: 20
 menu:
   main:
     weight: 20
     pre: "<i class='fas fa-book'></i>"
 ---
 
-{{% pageinfo %}}
-This is a placeholder page that shows you how to use this template site.
-{{% /pageinfo %}}
+## What is the Ellogon Annotation Platform?
 
+Available for direct use at: **[annotation.ellogon.org](https://annotation.ellogon.org)** | **[annotation.vast-project.eu](https://annotation.vast-project.eu)**\
+Old version (Angular JS): **[clarin.ellogon.org](https://clarin.ellogon.org)**
 
-This section is where the user documentation for your project lives - all the information your users need to understand and successfully use your project. 
+The Ellogon Annotation Platform is an **open-source**, **free** to use, **customisable** data annotation tool - in the cloud!
 
-For large documentation sets we recommend adding content under the headings in this section, though if some or all of them don’t apply to your project feel free to remove them or add your own. You can see an example of a smaller Docsy documentation site in the [Docsy User Guide](https://docsy.dev/docs/), which lives in the [Docsy theme repo](https://github.com/google/docsy/tree/master/userguide) if you'd like to copy its docs section. 
+The Ellogon Annotation Platform is a tool for annotating (or labelling) and exploring multiple types of data, with a focus on simplicity, ease of use, extensibility, reliability, productivity and high performance. 
 
-Other content such as marketing material, case studies, and community updates should live in the [About](/about/) and [Community](/community/) pages.
+You can perform different types of labeling with many data formats, especially with formats that encode text and annotation for tasks that relate to natural language processing (NLP). The Ellogon Annotation Platform provides a plethora of Annotation Schemas (encoded in [XML](https://en.wikipedia.org/wiki/XML)) for many NLP tasks (document classification, part-of-speech tagging, named-entity recognition and classification, (aspect & document based) sentiment analysis and polarity detection, argument mining, etc.), while new, user-generated, Annotation Schemas can be providing, extending applicability to new tasks, corpora, and annotation needs.
 
-Find out how to use the Docsy theme in the [Docsy User Guide](https://docsy.dev/docs/). You can learn more about how to organize your documentation (and how we organized this site) in [Organizing Your Content](https://docsy.dev/docs/best-practices/organizing-content/).
+Due to a recent (2021-2022) migration of its backend from [Laravel](https://laravel.com/) ([PHP](https://www.php.net/)) to [Django](https://www.djangoproject.com/) ([Python](https://www.python.org/)), enables the ability to integrate **machine learning** models to supply predictions for labels (**pre-annotation**), or perform continuous active learning. See [seting up machine learning with annotation](#).
 
+Finally, the Ellogon Annotation Platform provides many facilities and tools for visualising annotations and performing comparisons among multiple annotators. See the [platform features](#) for more.
 
+## Annotation Workflow
+
+The Ellogon Annotation Platform offers two deployment channels:
+
+1. **Online, Cloud Services**: This usage type does not involve any form of installation process; users can start using the Ellogon Annotation Platform immediately.
+
+2. **Offline, On-Premise**: In this case, users must download and install the platform on a server of their choice, using technologies such as containers.
+
+Beyond the installation process, which is required only for the second deployment channel (2.), the following steps are typical in an annotation workflow, as supported by the Ellogon Annotation Platform:
+
+1. **Create Accounts**: The annotation team (including the annotators and the process managers) must register with the platform.
+
+2. **Define the Annotation Schema**: A suitable (for the task) annotation schema (from existing available schemas) must be selected. Alternatively, a new annotation schema must be defined (in XML), if task requirements exceed available schemas capabilities.
+
+3. **Import Data**: The data to be annotated must be imported into the platform. Any annotation team member can import data, and can select the rest of the team members that data can be shared.
+
+4. **Annotate Data**: Each annotation team member annotates the data assigned for annotation. Annotation can be collaborative (multiple annotators work simultaneously on data) or stand alone (each annotator creates its own annotation set over data).
+
+5. **Review Annotation**: Annotations from multiple annotators can be visualised, and compared to identify differences (and even correct inconsistencies to retrieve a "gold" annotation). Standard metrics (like inter-rater agreement) can be automatically calculated.
+
+6. **Export Annotated Data**, for further sharing/processing outside the platform.
+
+## Ellogon Annotation Platform Concepts
+
+Visit [concepts]({{% ref "./concepts/" %}}) for more details.
+
+## Ellogon Annotation Platform Components and Architecture
+
+Visit [architecture]({{% ref "./concepts/architecture/" %}}) for more details.

layouts/shortcodes/tab.html

@@ -0,0 +1,14 @@
+<!--https://github.com/alex-shpak/hugo-book-->
+
+{{ if .Parent }}
+  {{ $name := .Get 0 }}
+  {{ $group := printf "tabs-%s" (.Parent.Get 0) }}
+
+  {{ if not (.Parent.Scratch.Get $group) }}
+    {{ .Parent.Scratch.Set $group slice }}
+  {{ end }}
+
+  {{ .Parent.Scratch.Add $group (dict "Name" $name "Content" .Inner) }}
+{{ else }}
+  {{ errorf "%q: 'tab' shortcode must be inside 'tabs' shortcode" .Page.Path }}
+{{ end}}

layouts/shortcodes/tabs.html

@@ -0,0 +1,17 @@
+<!--https://github.com/alex-shpak/hugo-book-->
+
+{{ if .Inner }}{{ end }}
+{{ $id := .Get 0 }}
+{{ $group := printf "tabs-%s" $id }}
+
+<div class="book-tabs">
+{{ range $index, $tab :=  .Scratch.Get $group }}
+  <input type="radio" class="hidden" name="{{ $group }}" id="{{ printf "%s-%d" $group $index }}" {{ if not $index }}checked="checked"{{ end }} />
+  <label for="{{ printf "%s-%d" $group $index }}">
+    {{ $tab.Name }}
+  </label>
+  <div class="book-tabs-content markdown-inner">
+    {{ .Content | markdownify }}
+  </div>
+{{ end }}
+</div>