From 05bccc7f8873e4358c51dc39eabb1dee17ad6211 Mon Sep 17 00:00:00 2001
From: Patrick Jentsch <p.jentsch@uni-bielefeld.de>
Date: Mon, 31 Jul 2023 10:47:37 +0200
Subject: [PATCH] Add more versions to services and documentation

---
 app/services/routes.py                        |  8 ++--
 app/services/services.yml                     | 44 ++++++++++++++++++-
 .../services/file_setup_pipeline.html.j2      | 34 +++++++++++++-
 .../services/spacy_nlp_pipeline.html.j2       | 43 ++++++++++++------
 .../services/tesseract_ocr_pipeline.html.j2   | 31 ++++++++++++-
 .../services/transkribus_htr_pipeline.html.j2 | 33 ++++++++++----
 6 files changed, 160 insertions(+), 33 deletions(-)

diff --git a/app/services/routes.py b/app/services/routes.py
index 9f4cfdc0..8b4ac063 100644
--- a/app/services/routes.py
+++ b/app/services/routes.py
@@ -61,7 +61,7 @@ def file_setup_pipeline():
         return {}, 201, {'Location': job.url}
     return render_template(
         'services/file_setup_pipeline.html.j2',
-        title=service_manifest['name'],
+        service_manifest=service_manifest,
         form=form
     )
 
@@ -110,7 +110,7 @@ def tesseract_ocr_pipeline():
     user_tesseract_ocr_pipeline_models_count = len(current_user.tesseract_ocr_pipeline_models.all())
     return render_template(
         'services/tesseract_ocr_pipeline.html.j2',
-        title=service_manifest['name'],
+        service_manifest=service_manifest,
         form=form,
         tesseract_ocr_pipeline_models=tesseract_ocr_pipeline_models,
         user_tesseract_ocr_pipeline_models_count=user_tesseract_ocr_pipeline_models_count
@@ -169,7 +169,7 @@ def transkribus_htr_pipeline():
         return {}, 201, {'Location': job.url}
     return render_template(
         'services/transkribus_htr_pipeline.html.j2',
-        title=service_manifest['name'],
+        service_manifest=service_manifest,
         form=form,
         transkribus_htr_pipeline_models=transkribus_htr_pipeline_models
     )
@@ -215,7 +215,7 @@ def spacy_nlp_pipeline():
         return {}, 201, {'Location': job.url}
     return render_template(
         'services/spacy_nlp_pipeline.html.j2',
-        title=service_manifest['name'],
+        service_manifest=service_manifest,
         form=form,
         spacy_nlp_pipeline_models=spacy_nlp_pipeline_models,
         user_spacy_nlp_pipeline_models_count=user_spacy_nlp_pipeline_models_count
diff --git a/app/services/services.yml b/app/services/services.yml
index a686f683..1d50fd1c 100644
--- a/app/services/services.yml
+++ b/app/services/services.yml
@@ -7,22 +7,39 @@ file-setup-pipeline:
     0.1.0:
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/file-setup-pipeline/-/releases/v0.1.0'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/file-setup-pipeline/-/tree/v0.1.0'
 tesseract-ocr-pipeline:
   name: 'Tesseract OCR Pipeline'
   publisher: 'Bielefeld University - CRC 1288 - INF'
-  latest_version: '0.1.1'
+  latest_version: '0.1.3'
   versions:
     0.1.0:
       methods:
         - 'binarization'
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/releases/v0.1.0'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/tree/v0.1.0'
     0.1.1:
       methods:
         - 'binarization'
         - 'ocropus_nlbin_threshold'
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/releases/v0.1.1'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/tree/v0.1.1'
+    0.1.2:
+      methods:
+        - 'binarization'
+        - 'ocropus_nlbin_threshold'
+      publishing_year: 2023
+      url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/releases/v0.1.2'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/tree/v0.1.2'
+    0.1.3:
+      methods:
+        - 'binarization'
+        - 'ocropus_nlbin_threshold'
+      publishing_year: 2023
+      url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/releases/v0.1.3'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/tesseract-ocr-pipeline/-/tree/v0.1.3'
 transkribus-htr-pipeline:
   name: 'Transkribus HTR Pipeline'
   publisher: 'Bielefeld University - CRC 1288 - INF'
@@ -33,28 +50,51 @@ transkribus-htr-pipeline:
         - 'binarization'
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/transkribus-htr-pipeline/-/releases/v0.1.0'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/transkribus-htr-pipeline/-/tree/v0.1.0'
     0.1.1:
       methods:
         - 'binarization'
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/transkribus-htr-pipeline/-/releases/v0.1.1'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/transkribus-htr-pipeline/-/tree/v0.1.1'
 spacy-nlp-pipeline:
   name: 'SpaCy NLP Pipeline'
   publisher: 'Bielefeld University - CRC 1288 - INF'
-  latest_version: '0.1.2'
+  latest_version: '0.1.5'
   versions:
     0.1.0:
       methods:
         - 'encoding_detection'
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/releases/v0.1.0'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/tree/v0.1.0'
     0.1.1:
       methods:
         - 'encoding_detection'
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/releases/v0.1.1'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/tree/v0.1.1'
     0.1.2:
       methods:
         - 'encoding_detection'
       publishing_year: 2022
       url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/releases/v0.1.2'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/tree/v0.1.2'
+    0.1.3:
+      methods:
+        - 'encoding_detection'
+      publishing_year: 2023
+      url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/releases/v0.1.3'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/tree/v0.1.3'
+    0.1.4:
+      methods:
+        - 'encoding_detection'
+      publishing_year: 2023
+      url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/releases/v0.1.4'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/tree/v0.1.4'
+    0.1.5:
+      methods:
+        - 'encoding_detection'
+      publishing_year: 2023
+      url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/releases/v0.1.5'
+      code_url: 'https://gitlab.ub.uni-bielefeld.de/sfb1288inf/spacy-nlp-pipeline/-/tree/v0.1.5'
diff --git a/app/templates/services/file_setup_pipeline.html.j2 b/app/templates/services/file_setup_pipeline.html.j2
index 0f046e98..64f40c87 100644
--- a/app/templates/services/file_setup_pipeline.html.j2
+++ b/app/templates/services/file_setup_pipeline.html.j2
@@ -7,7 +7,7 @@
 <div class="container">
   <div class="row">
     <div class="col s12">
-      <h1 id="title">{{ title }}</h1>
+      <h1 id="title">{{ service_manifest.name }}</h1>
     </div>
 
     <div class="col s12 m3 push-m9">
@@ -52,7 +52,14 @@
                 {{ wtf.render_field(form.images, accept='image/jpeg, image/png, image/tiff', placeholder='Choose JPEG, PNG or TIFF files') }}
               </div>
               <div class="col s12 l3">
-                {{ wtf.render_field(form.version, material_icon='apps') }}
+                <div class="input-field">
+                  <i class="material-icons prefix">apps</i>
+                  {{ form.version() }}
+                  {{ form.version.label }}
+                  <span class="helper-text">
+                    <a class="modal-trigger tooltipped" href="#versions-modal" data-position="bottom" data-tooltip="See more information about versions"><i class="material-icons service-color-text text-darken" data-service="file-setup-pipeline">help_outline</i></a>
+                  </span>
+                </div>
               </div>
             </div>
           </div>
@@ -65,3 +72,26 @@
   </div>
 </div>
 {% endblock page_content %}
+
+{% block modals %}
+{{ super() }}
+<div id="versions-modal" class="modal">
+  <div class="modal-content">
+    <h4>File Setup Pipeline versions</h4>
+    <ul class="collapsible popout" id="file-setup-pipeline-versions">
+      {% for version, version_info in service_manifest.versions.items() %}
+      <li id="file-setup-pipeline-version-{{ version }}">
+        <div class="collapsible-header"><i class="material-icons">widgets</i>{{ service_manifest.publisher }} ({{ version_info.publishing_year }}), {{ service_manifest.name }} {{ version }}</div>
+        <div class="collapsible-body">
+          <p><b>Release</b>: <a href="{{ version_info.url }}">{{ version_info.url }}</a></p>
+          <p><b>Code</b>: <a href="{{ version_info.code_url }}">{{ version_info.code_url }}</a></p>
+        </div>
+      </li>
+      {% endfor %}
+    </ul>
+  </div>
+  <div class="modal-footer">
+    <a href="#!" class="modal-close waves-effect waves-light btn">Close</a>
+  </div>
+</div>
+{% endblock modals %}
diff --git a/app/templates/services/spacy_nlp_pipeline.html.j2 b/app/templates/services/spacy_nlp_pipeline.html.j2
index a7bf214c..d281a0ed 100644
--- a/app/templates/services/spacy_nlp_pipeline.html.j2
+++ b/app/templates/services/spacy_nlp_pipeline.html.j2
@@ -7,7 +7,7 @@
 <div class="container">
   <div class="row">
     <div class="col s12">
-      <h1 id="title">{{ title }}</h1>
+      <h1 id="title">{{ service_manifest.name }}</h1>
     </div>
 
     <div class="col s12 m3 push-m9">
@@ -81,7 +81,14 @@
                 </div>
               </div>
               <div class="col s12 l3">
-                {{ wtf.render_field(form.version, material_icon='apps') }}
+                <div class="input-field">
+                  <i class="material-icons prefix">apps</i>
+                  {{ form.version() }}
+                  {{ form.version.label }}
+                  <span class="helper-text">
+                    <a class="modal-trigger tooltipped" href="#versions-modal" data-position="bottom" data-tooltip="See more information about versions"><i class="material-icons" style="color:#0064A3;">help_outline</i></a>
+                  </span>
+                </div>
               </div>
               <div class="col s12">
                 <span class="card-title">Preprocessing</span>
@@ -120,18 +127,6 @@
 
 {% block modals %}
 {{ super() }}
-<div id="progress-modal" class="modal">
-  <div class="modal-content">
-    <h4><i class="material-icons prefix">file_upload</i> Uploading files...</h4>
-    <div class="progress">
-      <div class="determinate" style="width: 0%"></div>
-    </div>
-  </div>
-  <div class="modal-footer">
-    <a href="#!" class="modal-close waves-effect waves-light btn red abort-request">Cancel</a>
-  </div>
-</div>
-
 <div id="models-modal" class="modal">
   <div class="modal-content">
     <h4>spaCy NLP Pipeline models</h4>
@@ -162,6 +157,26 @@
     <a href="#!" class="modal-close waves-effect waves-light btn">Close</a>
   </div>
 </div>
+
+<div id="versions-modal" class="modal">
+  <div class="modal-content">
+    <h4>SpaCy NLP Pipeline versions</h4>
+    <ul class="collapsible popout" id="spacy-nlp-pipeline-versions">
+      {% for version, version_info in service_manifest.versions.items() %}
+      <li id="spacy-nlp-pipeline-version-{{ version }}">
+        <div class="collapsible-header"><i class="material-icons">widgets</i>{{ service_manifest.publisher }} ({{ version_info.publishing_year }}), {{ service_manifest.name }} {{ version }}</div>
+        <div class="collapsible-body">
+          <p><b>Release</b>: <a href="{{ version_info.url }}">{{ version_info.url }}</a></p>
+          <p><b>Code</b>: <a href="{{ version_info.code_url }}">{{ version_info.code_url }}</a></p>
+        </div>
+      </li>
+      {% endfor %}
+    </ul>
+  </div>
+  <div class="modal-footer">
+    <a href="#!" class="modal-close waves-effect waves-light btn">Close</a>
+  </div>
+</div>
 {% endblock modals %}
 
 {% block scripts %}
diff --git a/app/templates/services/tesseract_ocr_pipeline.html.j2 b/app/templates/services/tesseract_ocr_pipeline.html.j2
index 69be6889..fdba533e 100644
--- a/app/templates/services/tesseract_ocr_pipeline.html.j2
+++ b/app/templates/services/tesseract_ocr_pipeline.html.j2
@@ -7,7 +7,7 @@
 <div class="container">
   <div class="row">
     <div class="col s12">
-      <h1 id="title">{{ title }}</h1>
+      <h1 id="title">{{ service_manifest.name }}</h1>
     </div>
 
     <div class="col s12 m3 push-m9">
@@ -66,7 +66,14 @@
                 </div>
               </div>
               <div class="col s12 l3">
-                {{ wtf.render_field(form.version, material_icon='apps') }}
+                <div class="input-field">
+                  <i class="material-icons prefix">apps</i>
+                  {{ form.version() }}
+                  {{ form.version.label }}
+                  <span class="helper-text">
+                    <a class="modal-trigger tooltipped" href="#versions-modal" data-position="bottom" data-tooltip="See more information about versions"><i class="material-icons" style="color:#00A58B;">help_outline</i></a>
+                  </span>
+                </div>
               </div>
               <div class="col s12">
                 <span class="card-title">Preprocessing</span>
@@ -142,6 +149,26 @@
     <a href="#!" class="modal-close waves-effect waves-light btn">Close</a>
   </div>
 </div>
+
+<div id="versions-modal" class="modal">
+  <div class="modal-content">
+    <h4>Tesseract OCR Pipeline versions</h4>
+    <ul class="collapsible popout" id="tesseract-ocr-pipeline-versions">
+      {% for version, version_info in service_manifest.versions.items() %}
+      <li id="tesseract-ocr-pipeline-version-{{ version }}">
+        <div class="collapsible-header"><i class="material-icons">widgets</i>{{ service_manifest.publisher }} ({{ version_info.publishing_year }}), {{ service_manifest.name }} {{ version }}</div>
+        <div class="collapsible-body">
+          <p><b>Release</b>: <a href="{{ version_info.url }}">{{ version_info.url }}</a></p>
+          <p><b>Code</b>: <a href="{{ version_info.code_url }}">{{ version_info.code_url }}</a></p>
+        </div>
+      </li>
+      {% endfor %}
+    </ul>
+  </div>
+  <div class="modal-footer">
+    <a href="#!" class="modal-close waves-effect waves-light btn">Close</a>
+  </div>
+</div>
 {% endblock modals %}
 
 {% block scripts %}
diff --git a/app/templates/services/transkribus_htr_pipeline.html.j2 b/app/templates/services/transkribus_htr_pipeline.html.j2
index 50eb3b6e..3aa58cec 100644
--- a/app/templates/services/transkribus_htr_pipeline.html.j2
+++ b/app/templates/services/transkribus_htr_pipeline.html.j2
@@ -7,7 +7,7 @@
 <div class="container">
   <div class="row">
     <div class="col s12">
-      <h1 id="title">{{ title }}</h1>
+      <h1 id="title">{{ service_manifest.name }}</h1>
     </div>
 
     <div class="col s12 m3 push-m9">
@@ -62,7 +62,7 @@
                   {{ form.model() }}
                   {{ form.model.label }}
                   <span class="helper-text">
-                    <a class="modal-trigger" href="#models-modal">More details about models</a>
+                    <a class="modal-trigger tooltipped" href="#models-modal" data-position="bottom" data-tooltip="See more information about models"><i class="material-icons service-color-text text-darken" data-service="transkribus-htr-pipeline">help_outline</i></a>
                   </span>
                   {% for error in form.model.errors %}
                   <span class="helper-text error-color-text">{{ error }}</span>
@@ -70,7 +70,14 @@
                 </div>
               </div>
               <div class="col s12 l3">
-                {{ wtf.render_field(form.version, material_icon='apps') }}
+                <div class="input-field">
+                  <i class="material-icons prefix">apps</i>
+                  {{ form.version() }}
+                  {{ form.version.label }}
+                  <span class="helper-text">
+                    <a class="modal-trigger tooltipped" href="#versions-modal" data-position="bottom" data-tooltip="See more information about versions"><i class="material-icons service-color-text text-darken" data-service="transkribus-htr-pipeline">help_outline</i></a>
+                  </span>
+                </div>
               </div>
               <div class="col s12">
                 <span class="card-title">Preprocessing</span>
@@ -128,15 +135,23 @@
   </div>
 </div>
 
-<div id="progress-modal" class="modal">
+<div id="versions-modal" class="modal">
   <div class="modal-content">
-    <h4><i class="material-icons left">file_upload</i>Uploading files...</h4>
-    <div class="progress">
-      <div class="determinate" style="width: 0%"></div>
-    </div>
+    <h4>SpaCy NLP Pipeline versions</h4>
+    <ul class="collapsible popout" id="spacy-nlp-pipeline-versions">
+      {% for version, version_info in service_manifest.versions.items() %}
+      <li id="spacy-nlp-pipeline-version-{{ version }}">
+        <div class="collapsible-header"><i class="material-icons">widgets</i>{{ service_manifest.publisher }} ({{ version_info.publishing_year }}), {{ service_manifest.name }} {{ version }}</div>
+        <div class="collapsible-body">
+          <p><b>Release</b>: <a href="{{ version_info.url }}">{{ version_info.url }}</a></p>
+          <p><b>Code</b>: <a href="{{ version_info.code_url }}">{{ version_info.code_url }}</a></p>
+        </div>
+      </li>
+      {% endfor %}
+    </ul>
   </div>
   <div class="modal-footer">
-    <a href="#!" class="modal-close waves-effect waves-light btn red abort-request">Cancel</a>
+    <a href="#!" class="modal-close waves-effect waves-light btn">Close</a>
   </div>
 </div>
 {% endblock modals %}