templates/doc/ql/poliqarp-plus.html.ep

% layout 'main', title => 'KorAP: Poliqarp+';

%= page_title

<p>The following documentation introduces all features provided by our version of the Poliqarp Query Language and some KorAP specific extensions.</p>

<section id="segments">
  <h3>Simple Segments</h3>

  <p>The atomic elements of Poliqarp queries are segments. Most of the time segments represent words and can be simple queried:</p>
  %# footnote: In the polish national corpus, Poliqarp can join multiple segments when identifying a single word.

  %= doc_query poliqarp => loc('Q_poliqarp_simple', '** Tree')

  <p>Sequences of simple segments are expressed using a space delimiter:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_simpleseq', '** the Tree')

  <p>Simple segments always refer to the surface form of a word. To search for surface forms without case sensitivity, you can use the <code>/i</code> flag.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_simpleci', '** run/i')

  <p>The query above will find all occurrences of the term irrespective of the capitalization of letters.</p>

  <h4 id="regexp">Regular Expressions</h4>

  <p>Segments can also be queried using <%= embedded_link_to 'doc', 'regular expressions', 'ql', 'regexp' %> - by surrounding the segment with double quotes.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_re', '** "r(u|a)n"'), cutoff => 1

  <p>Regular expression segments will always match the whole segment, meaning the above query will find words starting with the first letter of the regular expression and ending with the last letter. To support subqueries, you can use the <code>/x</code> flag.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_rex', '** "r(u|a)n"/x'), cutoff => 1

  <p>The <code>/x</code> will search for all segments that contain a sequence of characters the regular expression matches. That means the above query is equivalent to:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_recontext', '** ".*?r(u|a)n.*?"'), cutoff => 1

  <p>The <code>/x</code> flag can also be used in conjunction with strict expressions to search for substrings:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_simplex', '** part/xi'), cutoff => 1

  <p>The above query will find all occurrences of segments including the defined substring regardless of upper and lower case.</p>

  <blockquote class="warning">
    <p>Beware: Queries with prepended <code>.*</code> expressions can become extremely slow!</p>
    <p>In the original Poliqarp specification, regular expressions can be marked both by double quotes and single quotes. In Poliqarp+ only double quotes are used for regular expressions.</p>
  </blockquote>

  <p>You can again apply the <code>/i</code> flag to regular expressions to search case insensitive.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_rexi', '** "r(u|a)n"/xi'), cutoff => 1

  <h4 id="reserved">Reserved terms</h4>

  <p>The following terms are <em>reserved words</em> in Poliqarp+ and can therefore not be used in short notation of simple segments.
    Use the notation for <%= embedded_link_to 'doc', 'complex segments', 'ql', 'poliqarp-plus#complex'%> to query them (e.g. <code>[orth='contains']</code>):</p>

  <ul>
    <li><code>contains</code></li>
    <li><code>dependency</code></li>
    <li><code>dominates</code></li>
    <li><code>endswith</code></li>
    <li><code>endsWith</code></li>
    <li><code>focus</code></li>
    <li><code>i</code> and <code>I</code></li>
    <li><code>meta</code></li>
    <li><code>matches</code></li>
    <li><code>overlaps</code></li>
    <li><code>relatesTo</code></li>
    <li><code>split</code></li>
    <li><code>startswith</code> and <code>startsWith</code></li>
    <li><code>submatch</code></li>
    <li><code>within</code></li>
    <li><code>x</code> and <code>X</code></li>
  </ul>

</section>

<section id="complex">
  <h3>Complex Segments</h3>

  <p>Complex segments are expressed in square brackets and contain additional information on the resource of the term under scrutiny by providing key/value pairs, separated by an equal-sign.</p>

  <p>The KorAP implementation of Poliqarp provides three special segment keys: <code>orth</code> for surface forms, <code>base</code> for lemmata, and <code>pos</code> for Part-of-Speech. The following complex query finds all surface forms of the defined word.</p>
  %# There are more special keys in Poliqarp, but KorAP doesn't provide them.

  %= doc_query poliqarp => loc('Q_poliqarp_complexorth', '** [orth=Tree]')

  <p>The query is thus equivalent to:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_simple', '** Tree')

  <p>Complex segments expect simple expressions as values, meaning that the following expression is valid as well:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_complexre', '** [orth="r(u|a)n"/xi]'), cutoff => 1

  <p>Another special key is <code>base</code>, refering to the lemma annotation of the <%= embedded_link_to 'doc', 'default foundry', 'data', 'annotation' %>.
    The following query finds all occurrences of segments annotated as a specified lemma by the default foundry.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_complexlemma', '** [base=Tree]'), cutoff => 1

  <p>The third special key is <code>pos</code>, refering to the part-of-speech annotation of the <%= embedded_link_to 'doc', 'default foundry', 'data', 'annotation' %>.
    The following query finds all attributive adjectives:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_complexpos', '** [pos=ADJA]'), cutoff => 1

  <p>Complex segments requesting further token annotations can have keys following the <code>foundry/layer</code> notation.
    For example to find all occurrences of plural words in a supporting foundry, you can search using the following query:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_complexplural', '** [mate/m=number:pl]'), cutoff => 1

  <p>In case an annotation contains special non-alphabetic and non-numeric characters, the annotation part can be surrounded by single quotes to ensure a verbatim interpretation:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_complexverbatim', '** [mate/o=\'This is an annotation with space characters\']'), cutoff => 1
  
  <h4>Negation</h4>
  <p>Negation of terms in complex expressions can be expressed by prepending the equal sign or the whole expression with an exclamation mark.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_neg1', '** [pos!=ADJA]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_neg2', '** [!pos=ADJA]'), cutoff => 1

  <blockquote class="warning">
    <p>Beware: Negated complex segments can't be searched as a single statement.
      However, they work in case they are part of a <%= embedded_link_to 'doc', 'sequence', 'ql', 'poliqarp-plus#syntagmatic-operators-sequence' %>.</p>

    <p>If the negation refers to an annotation rather than to the surface form of a term, it may be advantageous to specify the annotation layer in the virtual corpus as a constraint (meta data field <tt>foundries</tt>) so that not all occurrences that do not have this annotation layer are found.</p>
  </blockquote>

  <h4 id="empty-segments">Empty Segments</h4>

  <p>A special segment is the empty segment, that matches every word in the index.</p>

  %= doc_query poliqarp => '[]', cutoff => 1

  <p>Empty segments are useful to express distances of words by using <%= embedded_link_to 'doc', 'repetitions', 'ql', 'poliqarp-plus#syntagmatic-operators-repetitions' %>.</p>

  <blockquote class="warning">
    <p>Beware: Empty segments can't be searched as a single statement.
      However, they work in case they are part of a <%= embedded_link_to 'doc', 'sequence', 'ql', 'poliqarp-plus#syntagmatic-operators-sequence' %>.</p>
  </blockquote>
</section>

<section id="spans">
  <h3>Span Segments</h3>

  <p>Not all segments are bound to words - some are bound to concepts spanning multiple words, for example noun phrases, sentences, or paragraphs.
Span segments can be searched for using angular brackets instead of square brackets.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_span', '** <corenlp/c=NP>'), cutoff => 1
    
    <p>Otherwise they can be treated in exactly the same way as simple or complex segments.</p>
</section>

<section id="paradigmatic-operators">
  <h3>Paradigmatic Operators</h3>

  <p>A complex segment can have multiple properties a token requires. For example to search for all words with a certain surface form of a particular lemma (no matter if capitalized or not), you can search for:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_and', '** [orth=run/i & base=Run]'), cutoff => 1

  <p>The ampersand combines multiple properties with a logical AND.
Terms of the complex segment can be negated as introduced before.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_andneg1', '** [orth=run/i & base!=Run]'), cutoff => 1

  <p>The following query is therefore equivalent:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_andneg2', '** [orth=run/i & !base=Run]'), cutoff => 1

  <p>Alternatives can be expressed by using the pipe symbol:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_or', '** [base=run | base=go]'), cutoff => 1

  <p>All these sub expressions can be grouped using round brackets to form complex boolean expressions:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_group', '** [(base=run | base=go) & tt/pos=VVFIN]'), cutoff => 1
</section>

<section id="syntagmatic-operators">
  <h3>Syntagmatic Operators</h3>

  <h4 id="syntagmatic-operators-sequence">Sequences</h4>

  <p>Sequences can be used to search for segments in order. For this, simple expressions are separated by whitespaces.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seq', '** the old man'), cutoff => 1

  <p>However, you can obviously search using complex segments as well:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqcomplex', '** [orth=the][orth=old][orth=man]'), cutoff => 1

  <p>Now you may see the benefit of the empty segment to search for words you don't know:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqcomplexempty', '** [orth=the][][orth=man]'), cutoff => 1

  <p>You are also able to mix segments and spans in sequences, for example to search for a word at the beginning of a sentence (which can be interpreted as the first word after the end of a sentence).</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqspan', '** <base/s=s>[orth=The]'), cutoff => 1

  <h4>Groups</h4>

  ...

  <h4>Alternation</h4>

  <p>Alternations allow for searching alternative segments or sequences of segments, similar to the paradigmatic operator. You already have seen that you can search for a sequence with an alternative adjective in between by typing in:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqor', '** the [orth=old | orth=young] man'), cutoff => 1

  <p>However, this formulation has problems in case you want to search for alternations of sequences rather than terms. In this case you can use syntagmatic alternations and groups:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqorgroup1', '** the (young man | old woman)'), cutoff => 1

  <p>The pipe symbol works the same way as with the paradigmatic alternation, but supports sequences of different length as operands. The above query with an alternative adjective in a sequence can therefore be reformulated as:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqorgroup2', '** the (old | young) man'), cutoff => 1

  <h4 id="syntagmatic-operators-repetitions">Repetition</h4>

  <p>Repetitions in Poliqarp are realized as in <%= embedded_link_to 'doc', 'regular expressions', 'ql', 'regexp' %>, by giving quantifieres in curly brackets.</p>
  <p>To search for a sequence of three occurrences of a defined string, you can formulate your query in any of the following ways - they will have the same results:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_repmanual', '** the the the'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_repsimple', '** the{3}'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_repcomplex', '** [orth=the]{3}'), cutoff => 1

  <p>In difference to regular expressions, the repetition operation won't refer to the match but to the pattern given. So the following query will give you a sequence of three words with a defined substring - but the words don't have to be identical.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_repre', '** "ru.*?"/i{3}'), cutoff => 1

  <p>The same is true for annotations. The following query will find a sequence of 3 to 4 adjectives in a defined context. The adjectives do not have to be identical though.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_repanno', '** [base=the][tt/p=ADJA]{3,4}[tt/p=NOUN]'), cutoff => 1

  <p>In addition to numbered quantities, it is also possible to pass repetition information as Kleene operators <code>?</code>, <code>*</code>, and <code>+</code>.</p>

  <p>To search for a sequence with an optional segment, you can search for:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqopt1', '** [base=the][tt/pos=ADJA]?[base=Tree]'), cutoff => 1

  <p>This query is identical to the numbered quantification of:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqopt2', '** [base=the][tt/pos=ADJA]{,1}[base=Tree]'), cutoff => 1

  <p>To search for the same sequences but with unlimited adjectives in between, you can use the Kleene Star:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqstar', '** [base=the][tt/pos=ADJA]*[base=Tree]'), cutoff => 1

  <p>And to search for this sequence but with at least one adjective in between, you can use the Kleene Plus (all queries are identical):</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqplus1', '** [base=the][tt/pos=ADJA]+[base=Tree]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_seqplus2', '** [base=the][tt/pos=ADJA]{1,}[base=Tree]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_seqplus3', '** [base=the][tt/pos=ADJA][tt/pos=ADJA]*[base=Tree]'), cutoff => 1

  <blockquote class="warning">
    <p>Repetition operators like <code>{,n}</code>, <code>?</code>, and <code>*</code> make segments or groups of segments optional. In case these queries are used separated and not as part of a sequence (and there are no mandatory segments in the query), you will be warned by the system that your query won't be treated as optional.</p>
    <p>Keep in mind that optionality may be somehow <i>inherited</i>, for example an entire query becomes optional as soon as one segment of an alternation is optional.</p>
  </blockquote>

  <p>Repetition can also be used to express distances between segments by using <%= embedded_link_to 'doc', 'empty segments', 'ql', 'poliqarp-plus#empty-segments' %>.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqdistance1', '** [base=the][][base=Tree]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_seqdistance2', '** [base=the][]{2}[base=Tree]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_seqdistance3', '** [base=the][]{2,}[base=Tree]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_seqdistance4', '** [base=the][]{,3}[base=Tree]'), cutoff => 1
  
  <p>Of course, Kleene operators can be used with empty segments as well.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_seqdistanceopt', '** [base=the][]?[base=Tree]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_seqdistancestar', '** [base=the][]*[base=Tree]'), cutoff => 1
  %= doc_query poliqarp => loc('Q_poliqarp_seqdistanceplus', '** [base=the][]+[base=Tree]'), cutoff => 1
    
  <h4>Position</h4>

  <p>Sequences as shown above can all be nested in further complex queries and treated as subqueries (see <%= embedded_link_to 'doc', 'class operators', 'ql', 'poliqarp-plus#class-operators' %> on how to later access these subqueries directly).</p>
  <p>Positional operators compare two matches of subqueries and will match, in case a certain condition regarding the position of both is true.</p>
  <p>The <code>contains()</code> operation will match, when a second subquery matches inside the span of a first subquery.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_poscontains', '** contains(<base/s=s>, [tt/p=KOUS])'), cutoff => 1

  <p>The <code>startsWith()</code> operation will match, when a second subquery matches at the beginning of the span of a first subquery.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_posstartswith', '** startsWith(<base/s=s>, [tt/p=KOUS])'), cutoff => 1

  <p>The <code>endsWith()</code> operation will match, when a second subquery matches at the end of the span of a first subquery.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_posendswith', '** endsWith(<base/s=s>, [opennlp/p=NN])'), cutoff => 1

  <p>The <code>matches()</code> operation will match, when a second subquery has the exact same span as a first subquery.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_posmatches', '** matches(<base/s=s>,[tt/p=CARD][tt/p="N.*"])'), cutoff => 1

  <p>The <code>overlaps()</code> operation will match, when a second subquery has an overlapping span with the first subquery.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_posoverlaps', '** overlaps([][tt/p=ADJA],{1:[tt/p=ADJA]}[])'), cutoff => 1

  <blockquote class="warning">
    <p>Positional operators are still experimental and may change in certain aspects in the future (although the behaviour defined is intended to be stable). There is also known incorrect behaviour which will be corrected in future versions.</p>
    <p>Optional operands in position operators have to be mandatory at the moment and will be reformulated to occur at least once.</p>
    <p>This behaviour may change in the future.</p>
  </blockquote>

  <!--
      <blockquote>
	<p>The KorAP implementation of Poliqarp also supports the postfix <code>within</code> operator, that works similar to the <code>contains()</code> operator, but is not nestable.</p>
      </blockquote>
      -->
      
</section>

<section id="class-operators">
  <h3>Class Operators</h3>

  <p>Classes are used to group submatches by surrounding curly brackets and a class number <code>{1:...}</code>. Classes can be used to refer to submatches in a query, similar to captures in regular expressions. In Poliqarp+ classes have multiple purposes, with highlighting being the most intuitive one:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_classes', '** the {1:{2:[]} man}'), cutoff => 1

  <p>In KorAP classes can be defined from 1 to 128. In case a class number is missing, the class defaults to the class number 1: <code>{...}</code> is equal to <code>{1:...}</code>.</p>

  <h4>Match Modification</h4>

  <p>Based on classes, matches may be modified. The <code>focus()</code> operator restricts the span of a match to the boundary of a certain class.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_focus', '** focus(the {Tree})'), cutoff => 1

  <p>The query above will search for a sequence but the match will be limited to the second segment. You can think of the first segment in this query as a <i>positive look-behind zero-length assertion</i> in regular expressions.</p>

  <p>But focus is way more useful if you are searching for matches without knowing the surface form. For example, to find all terms between defined words you can search:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_focusempty', '** focus(the {[]} Tree)'), cutoff => 1

  <p>Or you may want to search for all words following a known sequence immediately:</p>

  %= doc_query poliqarp => loc('Q_poliqarp_focusextension', '** focus(the old and {[]})'), cutoff => 1

  <p><code>focus()</code> is especially useful if you are searching for matches in certain areas,
    for example in quotes using positional operators.
    While not being interested in the whole quote as a match, you can focus on what's really relevant to you.</p>

  %= doc_query poliqarp => loc('Q_poliqarp_focusrelevance', '** focus(contains(she []{,10} said, {Tree}))'), cutoff => 1

  <p>In case a class number is missing, the focus operator defaults to the class number 1: <code>focus(...)</code> is equal to <code>focus(1: ...)</code>.</p>

  <blockquote class="warning">
    <p>As numbers in curly brackets can be ambiguous in certain circumstances, for example <code>[]{3}</code> can be read as either &quot;any word repeated three times&quot; or &quot;any word followed by the number 3 highlighted as class number 1&quot;, numbers should always be expressed as <code>[orth=3]</code> for the latter case.</p>
  </blockquote>
</section>