Merge branch 'release/3.1.3' into main

.gitlab-ci.yml

@@ -65,7 +65,7 @@ package:
   dependencies:
     - build
   except:
-    - master
+    - main
     - tags
 
 release-image:

README.md

@@ -60,21 +60,17 @@ We use git-flow.
 edit build.gradle and set version number, afterwards:
 
         git commit -am "set version 3.1.1"
-
-        git checkout master
-        git push
-
-        git checkout develop
+        git flow release finish 3.1.2
 
 edit build.gradle and set version number to 3.1.2-SNAPSHOT, afterwards:
 
         git commit -am "start 3.1.2-SNAPSHOT"
-        git push
+        git push origin develop main
 
 in gitlab-ci go to https://gitlab.gwdg.de/dariah-de/textgridrep-portal/-/releases, click on "New Release"
 
 * Tag name: 3.1.1
-* Create from: master
+* Create from: main
 * Message:
 * Release notes:
         * rewritten index.md

build.gradle

 plugins {
     id 'org.springframework.boot' version '2.3.0.RELEASE'
-    id 'com.github.node-gradle.node' version '2.2.0'
+    id 'com.github.node-gradle.node' version '2.2.4'
+    id 'io.miret.etienne.sass' version '1.1.1'
 }
 
 apply plugin: 'java'
@@ -9,7 +10,7 @@ apply plugin: 'jacoco'
 apply plugin: 'war'
 
 group = 'info.textgrid.rep'
-version = '3.1.2'
+version = '3.1.3'
 sourceCompatibility = '1.8'
 
 repositories {
@@ -19,6 +20,10 @@ repositories {
     }
 }
 
+configurations {
+  closureCompiler
+}
+
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.apache.tomcat.embed:tomcat-embed-jasper'
@@ -27,11 +32,15 @@ dependencies {
     implementation 'io.jsonwebtoken:jjwt:0.9.1'
     implementation 'com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider'
     implementation 'com.atlassian.commonmark:commonmark:0.14.0'
+    implementation 'com.atlassian.commonmark:commonmark-ext-heading-anchor:0.14.0'
+    implementation 'com.atlassian.commonmark:commonmark-ext-gfm-tables:0.14.0'
+    implementation 'com.atlassian.commonmark:commonmark-ext-yaml-front-matter:0.14.0'
     implementation 'info.textgrid.middleware.clients:textgrid-clients:3.4.3'
     developmentOnly("org.springframework.boot:spring-boot-devtools")
     testImplementation('org.springframework.boot:spring-boot-starter-test') {
         exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
     }
+    closureCompiler 'com.google.javascript:closure-compiler:v20200614'
 }
 
 test {
@@ -56,26 +65,66 @@ node {
     download = true
 }
 
+task compileJs(type: JavaExec) {
+  classpath configurations.closureCompiler
+  main = 'com.google.javascript.jscomp.CommandLineRunner'
+
+  def closureArgs = []
+  //append all your command line options here
+  // https://github.com/google/closure-compiler/wiki/Flags-and-Options
+  closureArgs << "--compilation_level=SIMPLE"
+  // possible values: https://github.com/leobia/JsGradleCompiler#use-the-plugin
+  closureArgs << "--language_in=ECMASCRIPT_2020"
+  closureArgs << "--language_out=ECMASCRIPT5"
+  //closureArgs << "--formatting=PRETTY_PRINT"
+  closureArgs << "--create_source_map=./build/js/main.js.map"
+  closureArgs << "--source_map_include_content"
+  closureArgs << "--output_wrapper=//# sourceMappingURL=main.js.map\n%output%"
+  closureArgs << "--js_output_file=./build/js/main.min.js"
+  closureArgs << "./src/main/javascript/"
+
+  args closureArgs
+}
+
 // npm install should be run before processResources
 processResources.dependsOn npmInstall
+processResources.dependsOn compileSass
+processResources.dependsOn compileJs
 
 // copy static files to web application
 processResources {
     from ('docs') {
         into 'docs'
     }
+    from ('docs/images') {
+        into '/static/docs/images'
+    }
     from('node_modules/font-awesome/fonts') {
         into 'static/fonts'
     }
     from ('node_modules/jquery/dist/jquery.min.js') {
         into 'static/js'
     }
+    from ('node_modules/@sentry/browser/build/bundle.min.js') {
+        rename '(.*)', 'sentry.$1'
+        into 'static/js'
+    }
     from ('node_modules/openseadragon/build/openseadragon/openseadragon.min.js') {
         into 'static/js'
     }
     from ('node_modules/openseadragon/build/openseadragon/images') {
         into 'static/images/openseadragon'
     }
+    from ("${buildDir}/sass/") {
+        into 'static/css'
+    }
+    from ("${buildDir}/js/") {
+        into 'static/js'
+    }
+}
+
+compileSass {
+  style = compressed
 }
 
 test {

docs/README.md

@@ -39,16 +39,59 @@ Linking between pages is possible, adress them by their relative adress in the `
 ```markdown
 Find more info on the [syntax](/docs/syntax) page.
 ```
+### Linking within pages / Heading anchors
+The [Heading anchor](https://github.com/atlassian/commonmark-java#heading-anchor) extension is activated which generates IDs for heading elements. Which could be used as anchors, this means that you can link to them.
+
+An Example:
+
+A Marddown snippet
+
+        # Eine Überschrift
+
+        ## Eine Unterüberschrift 
+
+will be rendered as HTML Elements
+
+        <h1 id="eine-überschrift">Eine Überschrift</h1>
+ 
+        <h2 id="eine-unterüberschrift">Eine Unterüberschrift</h2>
+
+which means the ID will be lowercase with hyphens (`-`) instead of spaces. So you can link to them in Markdown like
+
+        Siehe [Kapitel 1](#eine-überschrift) und [Kapitel 1.1](#eine-unterüberschrift)
+
+Which allwos creation of a TOC for example. You can also reference headings or subheadings on other pages
+
+        see the [voyant-example](/docs/voyant#beispiel)
+
+If you are unsure which ID was generated for a heading inspect the element with the developer tool of your web browser. In Firefox for example you can do this with a click on the heading and the context menu entry "Inspect Element"("Element untersuchen"), which will reveal the id:
+
+![inspecting the anchor id](images/inspect-anchor.png)
+
 
 ### Images
 
-There is no place for placing own images yet, I will work on it and update this document accordingly. Feel free to ask if you need this feature urgently.
+Own images can be placed in the `images` subfolder of this directory. They are referenced by their relative path like this:
+
+```
+  ![The reading owl](images/owl-reading.png)
+```
+
+This will be rendered as:
+
+![The reading owl](images/owl-reading.png)
 
 ### Markdown parser in use / supported syntax / extensions
 
 For parsing Markdwon and rendering HTML the [commonmark-java](https://github.com/atlassian/commonmark-java) library is used. Currently implemented by this library is the [CommonMark Spec 0.29](https://spec.commonmark.org/0.29/). Look at the [CommonMark Dingus](http://spec.commonmark.org/dingus/) for testing and previewing the syntax.
 
-Currently there are no extensions activated, but there are some [available](https://github.com/atlassian/commonmark-java#extensions), if you need one just ask.
+Currently there are two extensions activated, there are some [more available](https://github.com/atlassian/commonmark-java#extensions), if you need one just ask.
+
+Active extensions:
+
+* [Heading anchor](https://github.com/atlassian/commonmark-java#heading-anchor)
+* [Tables](https://github.com/atlassian/commonmark-java#tables)
+* [YAML front matter](https://github.com/atlassian/commonmark-java#yaml-front-matter)
 
 If there is a need for even more extensions or different syntax we may painlessly switch to [flexmark-java](https://github.com/vsch/flexmark-java) for parsing, which is a commonmark-java fork wich supports a lot more different markdown flavours and extensions.
 

docs/annotate.en.md

-# TODO
\ No newline at end of file
+# Unfortunately this document is available in German only. An English version will be available shortly.
\ No newline at end of file

docs/download.de.md

-# TODO
\ No newline at end of file
+# Herunterladen
+
+Sie können die in TextGridRep enthaltenen Objekte in verschiedenen Formaten herunterladen. Welche [Arten von Objekten](https://wiki.de.dariah.eu/display/TextGrid/TextGrid-Objekte) es gibt, erklärt ausführlich das TextGrid Nutzerhandbuch.
+
+## Unterscheidung von Objekten in TextGridRep
+
+Nach einer Suchanfrage zu "Herder Ideen" haben Sie beispielsweise folgende Katalogansicht:
+
+![ListeNachSuche - Download](images/liste-download.png)
+
+Die verschiedenen Objekttypen wie **Texte, Editionen, oder Werke** sind durch Symbole neben dem Titel des Objekts gekennzeichnet.
+Hier ist ein Beispiel für den Typ **Edition**:
+
+![Icon1 - Download](images/icon1ok-download.png)
+
+Und hier für den Typ **Text**:
+
+![Icon2 - Download](images/icon2ok-download.png)
+
+Bei Editionen und Aggegrationen können Sie in der Katalogansicht lediglich die Metadaten über "Herunterladen" erreichen, nicht aber das Objekt Werk und den dazugehörigen Volltext. 
+
+## Texte herunterladen
+
+**Benutzerinnen und Benutzer sind häufig daran interessiert, einzelne Texte oder Textsammlungen** herunterzuladen. Dazu ist es sinnvoll, die Suchergebnisse nach Dateityp "txt/xml" oder "text/tg.work+xml" (auf der linken Seite im Menu auswählbar) zu filtern. 
+Im Screenshot sehen Sie am Beispiel von Goethes "Faust. Der Tragödie erster Teil" die Auswahl des Filters: Dateityp "text/tg.work+xml". Um danach direkt zum Text zu gelangen, klicken Sie  auf die Überschrift.
+
+![Dateityp/Textauswahl - Download](images/Screenshot2-download.png)
+
+Die textuellen Ressourcen sind als XML-TEI, Plain Text (txt), E-Book (epub) oder im HTML-Format verfügbar. Sie können auch eine Zip-Datei herunterladen, die XML-Dateien mit den Metadaten und der Hauptressource (in TEI-XML) enthält. Im nächsten Screenshot sehen Sie die verschiedenen Formate im Menü links. Zu dieser Ansicht auf Objektebene gelangen Sie wie oben beschrieben über die Titelauswahl in der Katalogansicht (Klicken auf die Titelüberschrift).
+
+![Dateityp/Listeformate - Download](images/listeformate-download.png)
\ No newline at end of file

docs/download.en.md

-# TODO
\ No newline at end of file
+# Unfortunately this document is available in German only. An English version will be available shortly.
\ No newline at end of file

docs/errata.de.md

+# Errata
+
+Aktuell beziehen sich die Errata nur auf Werke aus der [Digitalen Bibliothek bei TextGrid](https://textgrid.de/digitale-bibliothek).
+Da die bibliografischen Metadaten der [Digitalen Bibliothek](https://textgrid.de/digitale-bibliothek) aus der Vorlage extrahiert wurden, sind Fehler ebensowenig auszuschließen wie in einem gedruckten Werk. Einmal im TextGrid Repository veröffentlicht, können diese bekannten ‘Druckfehler’ nur bei einer Revision (ähnlich einer Neuauflage) des Gesamtwerks (der Digitalen Bibliothek) verbessert werden. Bis zu dieser Revision werden bekannte Errata hier aufgeführt. Gleiches gilt für alle anderen Werke im TextGrid Repository ebenfalls - dort sind Revisionen aufgrund der kleineren Korpora allerdings leichter.
+Sollten Sie selbst ähnliche Errata auffinden, melden Sie diese bitte an: [info@textgrid.de](info@textgrid.de)
+
+1.  [Lazarillo de Tormes](https://hdl.handle.net/11858/00-1734-0000-0004-338C-9): Hier wurde als Autor fälschlicherweise Hurtado de Mendoza eingetragen:
+TextGrid Repository (2012). Mendoza, Diego Hurtado. Lazarillo de Tormes. Digitale Bibliothek.  
+   Richtig: *Anonym*. Lazarillo de Tormes.
+   In den Notizen zum Werk ist dies bereits richtig vermerkt: “Es handelt sich hier um ein anonymes Werk verschiedener Autoren, das u.a. auch Hurtado de Mendoza zugeschrieben wird. Entstanden vor 1530. Erstdruck: vermutlich Burgos 1552/53 (Text verloren). Die frühesten drei erhaltenen Drucke sind: Burgos 1554, Alcalá 1554 und Amberes 1554. Alle drei basieren auf verlorenen Editionen und nicht auf Manuskripten. Hier nach Übers. v. I.G. Keil.”
+
+2. Im Fall der Brüder Paul und Josef Weidmann ist die Beteiligung an der Autorschaft oft nicht eindeutig geklärt, die Metadaten verschiedener Quellen widersprechen sich:
+  Beispiel das Drama [Der Dorfbarbier](https://hdl.handle.net/11858/00-1734-0000-0005-97BA-0): Hier wird Paul Weidmann als Autor geführt, aber in den Notizen steht der Name des Bruders: "Komponiert von Johann Baptist Schenk. Libretto in Zusammenarbeit mit Josef Weidmann. Uraufführung am 30.10.1796, Kärntnertor-Theater, Wien."  
+    Auch die [Deutsche Digitale Bibliothek](https://www.archivportal-d.de/item/AA6SRIM6C2DEQS6XRL6YSIYB3PJCSD7A?query=affiliate_fct_role_normdata%3A%28%22http%3A%2F%2Fd-nb.info%2Fgnd%2F119497921_1_affiliate_fct_involved%22%29&isThumbnailFiltered=false&rows=20&offset=0&viewType=list&hitNumber=4) löst diesen Widerspruch nicht auf. Genaue Erläuterung bietet die Seite zu Paul Weidmann bei der [Deutschen Bibliographie](https://www.deutsche-biographie.de/sfz84785.html).

docs/errata.en.md

+# Unfortunately this document is available in German only. An English version will be available shortly.
\ No newline at end of file