Skip to content

Commit 8261b61

Browse files
author
gh-actions
committed
add documentation for version 4
1 parent 44fb30e commit 8261b61

6 files changed

Lines changed: 112 additions & 62 deletions

File tree

4/user-guide/aql/operators.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -136,25 +136,25 @@ <h1 class="menu-title">ANNIS User Guide</h1>
136136
<main>
137137
<h1 id="complete-list-of-operators"><a class="header" href="#complete-list-of-operators">Complete List of Operators</a></h1>
138138
<p>AQL currently includes the following operators:</p>
139-
<table><thead><tr><th style="text-align: center">Operator</th><th style="text-align: left">Description</th><th style="text-align: center">Illustration</th><th style="text-align: left">Notes</th><th></th></tr></thead><tbody>
140-
<tr><td style="text-align: center"><code>.</code></td><td style="text-align: left">direct precedence</td><td style="text-align: center"><img src="../images/A-pred-B.svg" alt="" /></td><td style="text-align: left">For non-terminal nodes, precedence is determined by the right-most and left-most terminal children. In corpora with multiple segmentations the layer on which consecutivity holds may be specified with <code>.layer</code></td><td></td></tr>
141-
<tr><td style="text-align: center"><code>.*</code></td><td style="text-align: left">indirect precedence</td><td style="text-align: center"><img src="../images/A-pred-ind-B.svg" alt="" /></td><td style="text-align: left">For specific sizes of precedence spans, <code>.n,m</code> can be used, e.g. <code>.3,4</code> - between 3 and 4 token distance; the default maximum distance for <code>.*</code> is 50 tokens. As above, segmentation layers may be specified, e.g. <code>.layer,3,4</code></td><td></td></tr>
142-
<tr><td style="text-align: center"><code>^</code></td><td style="text-align: left">directly near</td><td style="text-align: center"><img src="../images/A-pred-B.svg" alt="" /> or <img src="../images/B-pred-A.svg" alt="" /></td><td style="text-align: left">Same as precedence, but in either order. In corpora with multiple segmentations the layer on which consecutivity holds may be specified with <code>^layer</code></td><td></td></tr>
143-
<tr><td style="text-align: center"><code>^*</code></td><td style="text-align: left">indirectly near</td><td style="text-align: center"><img src="../images/A-pred-ind-B.svg" alt="" /> or <img src="../images/B-pred-ind-A.svg" alt="" /></td><td style="text-align: left">Like indirect precedence in either order. The form <code>^n,m</code> can be used, e.g. <code>^3,4</code> - between 3 and 4 token distance; the default maximum distance for <code>^*</code> is 50 tokens. As above, segmentation layers may be specified, e.g. <code>^layer,3,4</code></td><td></td></tr>
144-
<tr><td style="text-align: center"><code>&gt;</code></td><td style="text-align: left">direct dominance</td><td style="text-align: center"><img src="../images/A-dom-B.svg" alt="" /></td><td style="text-align: left">A specific edge type may be specified, e.g. <code>&gt;secedge</code> to find secondary edges. Edge labels are specified in brackets, e.g. <code>&gt;[func=&quot;OA&quot;]</code> for an edge with the function 'object, accusative'</td><td></td></tr>
145-
<tr><td style="text-align: center"><code>&gt;*</code></td><td style="text-align: left">indirect dominance</td><td style="text-align: center"><img src="../images/A-dom-ind-B.svg" alt="" /></td><td style="text-align: left">For specific distance of dominance, <code>&gt;n,m</code> can be used, e.g. <code>&gt;3,4</code> - dominates with 3 to 4 edges distance</td><td></td></tr>
146-
<tr><td style="text-align: center"><code>@*</code></td><td style="text-align: left">part of sub-corpus</td><td style="text-align: center"></td><td style="text-align: left">Left attribute is part of a sub-corpus having the attribute of the right-hand side. For specific distance range in the sub-corpus hierarchy, <code>@n,m</code> can be used.</td><td></td></tr>
147-
<tr><td style="text-align: center"><code>_=_</code></td><td style="text-align: left">identical coverage</td><td style="text-align: center"><img src="../images/A-cov-ident-B.svg" alt="" /></td><td style="text-align: left">Applies when two annotations cover the exact same span of tokens</td><td></td></tr>
148-
<tr><td style="text-align: center"><code>_i_</code></td><td style="text-align: left">inclusion</td><td style="text-align: center"><img src="../images/A-cov-incl-B.svg" alt="" /></td><td style="text-align: left">Applies when one annotation covers a span identical to or larger than another</td><td></td></tr>
149-
<tr><td style="text-align: center"><code>_o_</code></td><td style="text-align: left">overlap</td><td style="text-align: center"><img src="../images/A-cov-over-B.svg" alt="" /></td><td style="text-align: left"></td><td></td></tr>
150-
<tr><td style="text-align: center"><code>_l_</code></td><td style="text-align: left">left aligned</td><td style="text-align: center"><img src="../images/A-cov-left-B.svg" alt="" /></td><td style="text-align: left">Both elements span an area beginning with the same token</td><td></td></tr>
151-
<tr><td style="text-align: center"><code>_r_</code></td><td style="text-align: left">right aligned</td><td style="text-align: center"><img src="../images/A-cov-right-B.svg" alt="" /></td><td style="text-align: left">Both elements span an area ending with the same token</td><td></td></tr>
152-
<tr><td style="text-align: center"><code>==</code></td><td style="text-align: left">value identity</td><td style="text-align: center"><strong>A = B</strong></td><td style="text-align: left">The value of the annotation or token A is identical to that of B (this operator does not bind, i.e. the nodes must be connected by some other criteria too)</td><td></td></tr>
153-
<tr><td style="text-align: center"><code>!=</code></td><td style="text-align: left">value difference</td><td style="text-align: center"><strong>A ≠ B</strong></td><td style="text-align: left">The value of the annotation or token A is different from B (this operator does not bind, i.e. the nodes must be connected by some other criteria too)</td><td></td></tr>
154-
<tr><td style="text-align: center"><code>-&gt;LABEL</code></td><td style="text-align: left">labeled pointing relation</td><td style="text-align: center"><img src="../images/A-point-direct-B.svg" alt="" /></td><td style="text-align: left">A labeled, directed relationship between two elements. Annotations can be specified with <code>-&gt;LABEL[annotation=&quot;VALUE&quot;]</code></td><td></td></tr>
155-
<tr><td style="text-align: center"><code>-&gt;LABEL *</code></td><td style="text-align: left">indirect pointing relation</td><td style="text-align: center"><img src="../images/A-point-ind-B.svg" alt="" /></td><td style="text-align: left">An indirect labeled relationship between two elements. The length of the chain may be specified with <code>-&gt;LABEL n,m</code> for relation chains of length n to m</td><td></td></tr>
156-
<tr><td style="text-align: center"><code>#x:arity=n</code></td><td style="text-align: left">arity</td><td style="text-align: center"><img src="../images/A-arity.svg" alt="" /></td><td style="text-align: left">Specifies the amount of directly dominated children that the searched node has</td><td></td></tr>
157-
<tr><td style="text-align: center"><code>_ident_</code></td><td style="text-align: left">node identity</td><td style="text-align: center"></td><td style="text-align: left">True for two attributes that belong to the same node</td><td></td></tr>
139+
<table><thead><tr><th style="text-align: left">Operator</th><th style="text-align: right">Description</th><th style="text-align: left">Illustration</th><th style="text-align: left">Notes</th></tr></thead><tbody>
140+
<tr><td style="text-align: left"><code>.</code></td><td style="text-align: right">direct precedence</td><td style="text-align: left"><img src="../images/A-pred-B.svg" alt="" /></td><td style="text-align: left">For non-terminal nodes, precedence is determined by the right-most and left-most terminal children. In corpora with multiple segmentations the layer on which consecutivity holds may be specified with <code>.layer</code></td></tr>
141+
<tr><td style="text-align: left"><code>.*</code></td><td style="text-align: right">indirect precedence</td><td style="text-align: left"><img src="../images/A-pred-ind-B.svg" alt="" /></td><td style="text-align: left">For specific sizes of precedence spans, <code>.n,m</code> can be used, e.g. <code>.3,4</code> - between 3 and 4 token distance; the default maximum distance for <code>.*</code> is 50 tokens. As above, segmentation layers may be specified, e.g. <code>.layer,3,4</code></td></tr>
142+
<tr><td style="text-align: left"><code>^</code></td><td style="text-align: right">directly near</td><td style="text-align: left"><img src="../images/A-pred-B.svg" alt="" /> or <img src="../images/B-pred-A.svg" alt="" /></td><td style="text-align: left">Same as precedence, but in either order. In corpora with multiple segmentations the layer on which consecutivity holds may be specified with <code>^layer</code></td></tr>
143+
<tr><td style="text-align: left"><code>^*</code></td><td style="text-align: right">indirectly near</td><td style="text-align: left"><img src="../images/A-pred-ind-B.svg" alt="" /> or <img src="../images/B-pred-ind-A.svg" alt="" /></td><td style="text-align: left">Like indirect precedence in either order. The form <code>^n,m</code> can be used, e.g. <code>^3,4</code> - between 3 and 4 token distance; the default maximum distance for <code>^*</code> is 50 tokens. As above, segmentation layers may be specified, e.g. <code>^layer,3,4</code></td></tr>
144+
<tr><td style="text-align: left"><code>&gt;</code></td><td style="text-align: right">direct dominance</td><td style="text-align: left"><img src="../images/A-dom-B.svg" alt="" /></td><td style="text-align: left">A specific edge type may be specified, e.g. <code>&gt;secedge</code> to find secondary edges. Edge labels are specified in brackets, e.g. <code>&gt;[func=&quot;OA&quot;]</code> for an edge with the function 'object, accusative'</td></tr>
145+
<tr><td style="text-align: left"><code>&gt;*</code></td><td style="text-align: right">indirect dominance</td><td style="text-align: left"><img src="../images/A-dom-ind-B.svg" alt="" /></td><td style="text-align: left">For specific distance of dominance, <code>&gt;n,m</code> can be used, e.g. <code>&gt;3,4</code> - dominates with 3 to 4 edges distance</td></tr>
146+
<tr><td style="text-align: left"><code>@*</code></td><td style="text-align: right">part of sub-corpus</td><td style="text-align: left"></td><td style="text-align: left">Left attribute is part of a sub-corpus having the attribute of the right-hand side. For specific distance range in the sub-corpus hierarchy, <code>@n,m</code> can be used.</td></tr>
147+
<tr><td style="text-align: left"><code>_=_</code></td><td style="text-align: right">identical coverage</td><td style="text-align: left"><img src="../images/A-cov-ident-B.svg" alt="" /></td><td style="text-align: left">Applies when two annotations cover the exact same span of tokens</td></tr>
148+
<tr><td style="text-align: left"><code>_i_</code></td><td style="text-align: right">inclusion</td><td style="text-align: left"><img src="../images/A-cov-incl-B.svg" alt="" /></td><td style="text-align: left">Applies when one annotation covers a span identical to or larger than another</td></tr>
149+
<tr><td style="text-align: left"><code>_o_</code></td><td style="text-align: right">overlap</td><td style="text-align: left"><img src="../images/A-cov-over-B.svg" alt="" /></td><td style="text-align: left"></td></tr>
150+
<tr><td style="text-align: left"><code>_l_</code></td><td style="text-align: right">left aligned</td><td style="text-align: left"><img src="../images/A-cov-left-B.svg" alt="" /></td><td style="text-align: left">Both elements span an area beginning with the same token</td></tr>
151+
<tr><td style="text-align: left"><code>_r_</code></td><td style="text-align: right">right aligned</td><td style="text-align: left"><img src="../images/A-cov-right-B.svg" alt="" /></td><td style="text-align: left">Both elements span an area ending with the same token</td></tr>
152+
<tr><td style="text-align: left"><code>==</code></td><td style="text-align: right">value identity</td><td style="text-align: left"><strong>A = B</strong></td><td style="text-align: left">The value of the annotation or token A is identical to that of B (this operator does not bind, i.e. the nodes must be connected by some other criteria too)</td></tr>
153+
<tr><td style="text-align: left"><code>!=</code></td><td style="text-align: right">value difference</td><td style="text-align: left"><strong>A ≠ B</strong></td><td style="text-align: left">The value of the annotation or token A is different from B (this operator does not bind, i.e. the nodes must be connected by some other criteria too)</td></tr>
154+
<tr><td style="text-align: left"><code>-&gt;LABEL</code></td><td style="text-align: right">labeled pointing relation</td><td style="text-align: left"><img src="../images/A-point-direct-B.svg" alt="" /></td><td style="text-align: left">A labeled, directed relationship between two elements. Annotations can be specified with <code>-&gt;LABEL[annotation=&quot;VALUE&quot;]</code></td></tr>
155+
<tr><td style="text-align: left"><code>-&gt;LABEL *</code></td><td style="text-align: right">indirect pointing relation</td><td style="text-align: left"><img src="../images/A-point-ind-B.svg" alt="" /></td><td style="text-align: left">An indirect labeled relationship between two elements. The length of the chain may be specified with <code>-&gt;LABEL n,m</code> for relation chains of length n to m</td></tr>
156+
<tr><td style="text-align: left"><code>#x:arity=n</code></td><td style="text-align: right">arity</td><td style="text-align: left"><img src="../images/A-arity.svg" alt="" /></td><td style="text-align: left">Specifies the amount of directly dominated children that the searched node has</td></tr>
157+
<tr><td style="text-align: left"><code>_ident_</code></td><td style="text-align: right">node identity</td><td style="text-align: left"></td><td style="text-align: left">True for two attributes that belong to the same node</td></tr>
158158
</tbody></table>
159159
<h2 id="unsupported-operators"><a class="header" href="#unsupported-operators">Unsupported operators</a></h2>
160160
<p>The following operators have been available in the legacy version ANNIS3, but are not yet implemented in the newest ANNIS version.</p>
@@ -165,7 +165,7 @@ <h2 id="unsupported-operators"><a class="header" href="#unsupported-operators">U
165165
<tr><td style="text-align: center"><code>$</code></td><td style="text-align: left">common parent node</td><td style="text-align: center"><img src="../images/A-parent-B.svg" alt="" /></td><td style="text-align: left"></td></tr>
166166
<tr><td style="text-align: center"><code>$*</code></td><td style="text-align: left">common ancestor node</td><td style="text-align: center"><img src="../images/A-ancestor-B.svg" alt="" /></td><td style="text-align: left"></td></tr>
167167
<tr><td style="text-align: center"><code>#x:tokenarity=n</code></td><td style="text-align: left">tokenarity</td><td style="text-align: center"><img src="../images/A-tokenarity.svg" alt="" /></td><td style="text-align: left">Specifies the length of the span of tokens covered by the node</td></tr>
168-
<tr><td style="text-align: center"><code>#x:root</code></td><td style="text-align: left">root</td><td style="text-align: center"><img src="../images/A-root.svg" alt="" /></td><td style="text-align: left">Specifies that the node is not dominated by any other node within its namespace <strong>s</strong></td></tr>
168+
<tr><td style="text-align: center"><code>#x:root</code></td><td style="text-align: left">root</td><td style="text-align: center"><img src="../images/A-root.svg" alt="" /></td><td style="text-align: left">Specifies that the node is not dominated by any other node within its namespace <strong>s</strong></td></tr>
169169
</tbody></table>
170170

171171
</main>

4/user-guide/configuration/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,14 @@ <h1 id="configuration-of-annis"><a class="header" href="#configuration-of-annis"
138138
<p>For the desktop version of ANNIS, you most probably don't need to change any of the default configuration and you can skip this section.
139139
If you are installing ANNIS on a server however, you might want to tweak the settings.
140140
The <a href="http://en.wikipedia.org/w/index.php?title=.properties&amp;oldid=521500688">Java Properties</a>, <a href="https://toml.io/">TOML</a> and <a href="http://www.json.org/">JSON</a> file formats are used for different kind of configuration.</p>
141-
<p>ANNIS uses the Spring Boot configuration system and thus it will search for a Java Properties based configuration file named <code>application.properties</code> in the current working directory or a <code>config</code> sub-directory of the working directory.<sup class="footnote-reference"><a href="#working-dir">1</a></sup>
142-
You can also use the command line argument <code>--spring.config.location=file:/&lt;location-on-disk&gt;</code> to specify a specific configuration file.
143-
More search paths for configurations files are documented in the <a href="https://docs.spring.io/spring-boot/docs/2.3.x/reference/html/spring-boot-features.html#boot-features-external-config-application-property-files">Spring Boot documentation</a>.</p>
141+
<p>ANNIS uses the Spring Boot configuration system and thus it will search for a Java Properties based configuration file named <code>application.properties</code> in the current working directory or a <code>config</code> sub-directory of the working directory.</p>
142+
<div class="warning">
143+
Depending on how you start ANNIS, the working directory can be different.
144+
<p>When using <code>java -jar /path/to/annis-server.jar</code>, the working directory is the same as the working directory of your current shell.
145+
If you start ANNIS by treating it like an executable file, e.g. by running <code>/path/to/annis-server.jar</code> directly, <strong>the directory containing the jar is used as the working directory</strong> of the application per default.</p>
146+
</div>
147+
<p>To avoid confusion from where the file is loaded from, you can specify the configuration file location by passing the command line argument <code>--spring.config.location=file:/&lt;location-on-disk&gt;</code> when starting ANNIS.</p>
148+
<p>More search paths for configurations files are documented in the <a href="https://docs.spring.io/spring-boot/docs/2.3.x/reference/html/spring-boot-features.html#boot-features-external-config-application-property-files">Spring Boot documentation</a>.</p>
144149
<p>The following is an example configuration with ANNIS-specific configuration values.</p>
145150
<pre><code class="language-properties"># The port on which this service is listening
146151
server.port=5712
@@ -176,11 +181,6 @@ <h1 id="configuration-of-annis"><a class="header" href="#configuration-of-annis"
176181
spring.datasource.url=jdbc:h2:file:${user.home}/.annis/v4/frontend_data.h2
177182
</code></pre>
178183
<p>Being a Spring Boot application, ANNIS configuration properties also be directly given as <a href="https://docs.spring.io/spring-boot/docs/2.3.x/reference/html/spring-boot-features.html#boot-features-external-config-command-line-args">command line argument</a>.</p>
179-
<div class="footnote-definition" id="working-dir"><sup class="footnote-definition-label">1</sup>
180-
<p>Depending on how you start ANNIS, the working directory can be different.
181-
When using <code>java -jar /path/to/annis-server.jar</code>, the working directory is the same as the working directory of your current shell.
182-
If you start ANNIS by treating it like an executable file, e.g. by running <code>/path/to/annis-server.jar</code> directly, the directory containing the jar is used as the working directory of the application per default.</p>
183-
</div>
184184

185185
</main>
186186

0 commit comments

Comments
 (0)