Use mdbook 0.4.2 also in deploy

.github/workflows/deploy.yml

@@ -8,7 +8,7 @@ jobs:
         uses: actions/checkout@v1
       - name: Get the release version from the GITHUB_REF variable as new SHORT_VERSION variable
         run: echo "SHORT_VERSION=$(echo ${GITHUB_REF} | sed -E 's/^refs\/heads\/.*/develop/' | sed -E 's/^(refs\/tags\/v)?(.*)(\.[0-9]+)$/\2/')" >> $GITHUB_ENV
-      - run: misc/download-mdbook.sh 0.3.5
+      - run: misc/download-mdbook.sh 0.4.2
         env:
           OS_NAME: linux
       - name: Generate the user documentation

.github/workflows/test.yml

@@ -72,4 +72,4 @@ jobs:
           OS_NAME: linux
       - run: mdbook build docs/user-guide/
       - run: mdbook build docs/developer-guide/
-      - run: mdbook build docs/online-help/
+      - run: mdbook build docs/online-help/

.gitignore

@@ -1,21 +1,8 @@
-/.gitignore~
 *.log
-*~
-/.netbeans/
-/node_modules/
-/package-lock.json
-/annis-service/src/main/antlr3/annis/ql/output/
 target/
 *.settings/
-/doc/html/
-/doc/latex/
-/annis-widgets/src/main/webapp/VAADIN/
-rebel.xml
 *.project
 *.classpath
-*.jrebel_disabled
-/.idea/
 *.iml
 *.factorypath
 *.zip
-/bin/

misc/download-mdbook.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-MDBOOK_VERSION=${1:-0.3.1}
+MDBOOK_VERSION=${1:-0.4.2}
 
 install_mdbook=false
 

src/main/webapp/VAADIN/help/aql-regex.html

@@ -138,7 +138,7 @@ <h1 id="searching-using-regular-expressions"><a class="header" href="#searching-
 <p>When searching for word forms and annotation values, it is possible to
 employ wildcards as placeholders for a variety of characters, using
 Regular Expression syntax (see e.g.
-<a href="http://www.regular-expressions.info/">http://www.regular-expressions.info/</a> for detailed information).
+<a href="http://www.regular-expressions.info/">http://www.regular-expressions.info/</a> for detailed information).<sup class="footnote-reference"><a href="#regex-engine">1</a></sup>
 To search for wildcards use slashes instead of quotation marks to
 surround your search term. For example, you can use the <strong>period (<code>.</code>)</strong>
 to replace any single character:</p>
@@ -193,6 +193,10 @@ <h1 id="searching-using-regular-expressions"><a class="header" href="#searching-
 <p>OR (using a shortcut):</p>
 <pre><code>pos=/VV.*/ -&gt;dep[func!=/.*obj.*/] tok
 </code></pre>
+<div class="footnote-definition" id="regex-engine"><sup class="footnote-definition-label">1</sup>
+<p>While there is the POSIX-standard for regular expressions, different search engines might use slightly different syntax and support different types of search constraints, e.g. when searching for Unicode characters.
+ANNIS used to rely on the <a href="https://www.postgresql.org/docs/9.4/functions-matching.html">PostgreSQL regular expression implementation</a> but now uses the Rust library <code>regex</code>. See <a href="https://docs.rs/regex#syntax">https://docs.rs/regex#syntax</a> for the currently supported regular expresssion syntax, as provided by this library.</p>
+</div>
 
                     </main>
 

src/main/webapp/VAADIN/help/aql.html

@@ -137,6 +137,9 @@ <h1 class="menu-title">ANNIS Help</h1>
                         <h1 id="annis-query-language-aql"><a class="header" href="#annis-query-language-aql">ANNIS Query Language (AQL)</a></h1>
 <p>ANNIS comes with its own query language called ANNIS Query Language (AQL).
 AQL is based on the concept of searching for annotation attributes and relations between them.</p>
+<p>A search is formulated by defining each token, non-terminal node or annotation being searched for as an element. An element can be a token (simply text between quotes: <code>&quot;dogs&quot;</code> or else <code>tok=&quot;dogs&quot;</code>) or an attribute-value pair (such as <code>tok=&quot;dogs&quot;</code>, or optionally with a namespace: <code>tiger:cat=&quot;PP&quot;</code>). Note that different corpora can have completely different annotation names and values - these are not specified by ANNIS. Underspecified tokens or nodes in general may be specified using <code>tok</code> and <code>node</code> respectively.</p>
+<p>Once all elements are declared, relations between the elements (or edges) are specified which must hold between them. The elements are referred back to serially using variable numbers, and linguistic operators bind them together, e.g. <code>#1 &gt; #2</code> meaning the first element dominates the second in a tree or graph. 
+Operators define the possible overlap and adjacency relations between annotation spans, as well as recursive hierarchical relations between nodes. Some operators also allow specific labes to be specified in addition to the operator (see the <a href="aql-operators.html">operator list</a>). </p>
 
                     </main>
 

src/main/webapp/VAADIN/help/print.html

@@ -244,6 +244,9 @@ <h1 id="introduction"><a class="header" href="#introduction">Introduction</a></h
 <div style="break-before: page; page-break-before: always;"></div><h1 id="annis-query-language-aql"><a class="header" href="#annis-query-language-aql">ANNIS Query Language (AQL)</a></h1>
 <p>ANNIS comes with its own query language called ANNIS Query Language (AQL).
 AQL is based on the concept of searching for annotation attributes and relations between them.</p>
+<p>A search is formulated by defining each token, non-terminal node or annotation being searched for as an element. An element can be a token (simply text between quotes: <code>&quot;dogs&quot;</code> or else <code>tok=&quot;dogs&quot;</code>) or an attribute-value pair (such as <code>tok=&quot;dogs&quot;</code>, or optionally with a namespace: <code>tiger:cat=&quot;PP&quot;</code>). Note that different corpora can have completely different annotation names and values - these are not specified by ANNIS. Underspecified tokens or nodes in general may be specified using <code>tok</code> and <code>node</code> respectively.</p>
+<p>Once all elements are declared, relations between the elements (or edges) are specified which must hold between them. The elements are referred back to serially using variable numbers, and linguistic operators bind them together, e.g. <code>#1 &gt; #2</code> meaning the first element dominates the second in a tree or graph. 
+Operators define the possible overlap and adjacency relations between annotation spans, as well as recursive hierarchical relations between nodes. Some operators also allow specific labes to be specified in addition to the operator (see the <a href="aql-operators.html">operator list</a>). </p>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="searching-for-word-forms"><a class="header" href="#searching-for-word-forms">Searching for Word Forms</a></h1>
 <p>To search for word forms in ANNIS, simply select a corpus (in this
 example the freely available <a href="https://corpling.uis.georgetown.edu/gum/">GUM corpus</a>) and enter a search string
@@ -371,7 +374,7 @@ <h1 id="introduction"><a class="header" href="#introduction">Introduction</a></h
 <p>When searching for word forms and annotation values, it is possible to
 employ wildcards as placeholders for a variety of characters, using
 Regular Expression syntax (see e.g.
-<a href="http://www.regular-expressions.info/">http://www.regular-expressions.info/</a> for detailed information).
+<a href="http://www.regular-expressions.info/">http://www.regular-expressions.info/</a> for detailed information).<sup class="footnote-reference"><a href="#regex-engine">1</a></sup>
 To search for wildcards use slashes instead of quotation marks to
 surround your search term. For example, you can use the <strong>period (<code>.</code>)</strong>
 to replace any single character:</p>
@@ -426,6 +429,10 @@ <h1 id="introduction"><a class="header" href="#introduction">Introduction</a></h
 <p>OR (using a shortcut):</p>
 <pre><code>pos=/VV.*/ -&gt;dep[func!=/.*obj.*/] tok
 </code></pre>
+<div class="footnote-definition" id="regex-engine"><sup class="footnote-definition-label">1</sup>
+<p>While there is the POSIX-standard for regular expressions, different search engines might use slightly different syntax and support different types of search constraints, e.g. when searching for Unicode characters.
+ANNIS used to rely on the <a href="https://www.postgresql.org/docs/9.4/functions-matching.html">PostgreSQL regular expression implementation</a> but now uses the Rust library <code>regex</code>. See <a href="https://docs.rs/regex#syntax">https://docs.rs/regex#syntax</a> for the currently supported regular expresssion syntax, as provided by this library.</p>
+</div>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="searching-for-trees"><a class="header" href="#searching-for-trees">Searching for Trees</a></h1>
 <p>In corpora containing hierarchical structures, annotations such as
 syntax trees can be searched for by defining terminal or none-terminal