Skip to content

Commit 159da4d

Browse files
committed
newly compiled documentation
1 parent 1ae6e45 commit 159da4d

File tree

3 files changed

+45
-43
lines changed

3 files changed

+45
-43
lines changed

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

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -177,26 +177,27 @@ <h1 class="menu-title">ANNIS Help</h1>
177177
<main>
178178
<h1 id="complete-list-of-operators"><a class="header" href="#complete-list-of-operators">Complete List of Operators</a></h1>
179179
<p>AQL currently includes the following operators:</p>
180-
<p>| Operator | Description | Illustration | Notes | |
181-
| : -------: | :------------------- | :---------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |
182-
| <code>.</code> | direct precedence | <img src="../images/A-pred-B.svg" alt="" /> | 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> | |
183-
| <code>.*</code> | indirect precedence | <img src="../images/A-pred-ind-B.svg" alt="" /> | 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> | |
184-
| <code>^</code> | directly near | <img src="../images/A-pred-B.svg" alt="" /> or <img src="../images/B-pred-A.svg" alt="" /> | 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> | |
185-
| <code>^*</code> | indirectly near | <img src="../images/A-pred-ind-B.svg" alt="" /> or <img src="../images/B-pred-ind-A.svg" alt="" /> | 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> | |
186-
| <code>&gt;</code> | direct dominance | <img src="../images/A-dom-B.svg" alt="" /> | 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="OA"]</code> for an edge with the function 'object, accusative' | |
187-
| <code>&gt;*</code> | indirect dominance | <img src="../images/A-dom-ind-B.svg" alt="" /> | 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 | |
188-
| <code>@*</code> | part of sub-corpus | | 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. | |
189-
| <code>_=_</code> | identical coverage | <img src="../images/A-cov-ident-B.svg" alt="" /> | Applies when two annotations cover the exact same span of tokens | |
190-
| <code>_i_</code> | inclusion | <img src="../images/A-cov-incl-B.svg" alt="" /> | Applies when one annotation covers a span identical to or larger than another | |
191-
| <code>_o_</code> | overlap | <img src="../images/A-cov-over-B.svg" alt="" /> | | |
192-
| <code>_l_</code> | left aligned | <img src="../images/A-cov-left-B.svg" alt="" /> | Both elements span an area beginning with the same token | |
193-
| <code>_r_</code> | right aligned | <img src="../images/A-cov-right-B.svg" alt="" /> | Both elements span an area ending with the same token | |
194-
| <code>==</code> | value identity | <strong>A = B</strong> | 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) | |
195-
| <code>!=</code> | value difference | <strong>A ≠ B</strong> | 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) | |
196-
| <code>-&gt;LABEL</code> | labeled pointing relation | <img src="../images/A-point-direct-B.svg" alt="" /> | A labeled, directed relationship between two elements. Annotations can be specified with <code>-&gt;LABEL[annotation="VALUE"]</code> | |
197-
| <code>-&gt;LABEL *</code> | indirect pointing relation | <img src="../images/A-point-ind-B.svg" alt="" /> | 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 | |
198-
| <code>#x:arity=n</code> | arity | <img src="../images/A-arity.svg" alt="" /> | Specifies the amount of directly dominated children that the searched node has | |
199-
| <code>_ident_</code> | node identity | | True for two attributes that belong to the same node | |</p>
180+
<div class="table-wrapper"><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>
181+
<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>
182+
<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>
183+
<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>
184+
<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>
185+
<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="OA"]</code> for an edge with the function 'object, accusative'</td></tr>
186+
<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>
187+
<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>
188+
<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>
189+
<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>
190+
<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>
191+
<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>
192+
<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>
193+
<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>
194+
<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>
195+
<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="VALUE"]</code></td></tr>
196+
<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>
197+
<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>
198+
<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>
199+
</tbody></table>
200+
</div>
200201
<h2 id="unsupported-operators"><a class="header" href="#unsupported-operators">Unsupported operators</a></h2>
201202
<p>The following operators have been available in the legacy version ANNIS3, but are not yet implemented in the newest ANNIS version.</p>
202203
<div class="table-wrapper"><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></tr></thead><tbody>
@@ -206,7 +207,7 @@ <h2 id="unsupported-operators"><a class="header" href="#unsupported-operators">U
206207
<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>
207208
<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>
208209
<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>
209-
<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>
210+
<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>
210211
</tbody></table>
211212
</div>
212213
</main>

0 commit comments

Comments
 (0)