mirror of
https://gitlab.ub.uni-bielefeld.de/sfb1288inf/nopaque.git
synced 2025-06-12 17:10:41 +00:00
Querybuilder 1.0
This commit is contained in:
Inga Kirschnick
169
app/templates/main/manual/_09_query_builder.html.j2
Normal file
169
app/templates/main/manual/_09_query_builder.html.j2
Normal file
@ -0,0 +1,169 @@
|
||||
<h2>Query Builder Tutorial</h2>
|
||||
|
||||
<p>The query builder helps you to make a query in the form of the Corpus Query
|
||||
Language (CQL) to your text. You can use the CQL to filter out various types of
|
||||
text parameters, for example, a specific word, a lemma, or you can set part-of-speech
|
||||
tags (pos) that indicate the type of word you are looking for (a noun, an
|
||||
adjective, etc.). In addition, you can also search for structural attributes,
|
||||
or specify your query for a token (word, lemma, pos) via entity typing. And of
|
||||
course everything can be combined. You can find examples for different queries
|
||||
under the tab "Examples".</p>
|
||||
<p></p>
|
||||
<br>
|
||||
|
||||
<div style="border: 1px solid; padding-left: 20px; margin-right: 400px; margin-bottom: 40px;">
|
||||
<h5>Content</h5>
|
||||
<ol style="list-style-type:disc">
|
||||
<li><a href="#add-new-token-tutorial">Add new token to your query</a></li>
|
||||
<li><a href="#edit-options-tutorial">Options to edit your query</a></li>
|
||||
<li><a href="#add-structural-attribute-tutorial">Add structural Attributes to your query</a></li>
|
||||
<li><a href="#general-options-query-builder">General options</a></li>
|
||||
</ol>
|
||||
</div>
|
||||
|
||||
{# Add Token Tutorial #}
|
||||
<div>
|
||||
<hr>
|
||||
<p></p>
|
||||
<br>
|
||||
<h3 id="add-new-token-tutorial">Add new token to your Query</h3>
|
||||
<p>If you are only looking for a specific token, you can click on the left
|
||||
button and select the type of token you are looking for from the drop-down menu.
|
||||
By default "Word" is selected. </p>
|
||||
|
||||
<h4>Word and Lemma</h4>
|
||||
<p>If you want to search for a specific word or lemma and the respective
|
||||
category is selected in the drop-down menu, you can type in the word or lemma
|
||||
of your choice in the input field. You can confirm your entry by clicking the
|
||||
Submit button on the right. You can also use the options below to modify your
|
||||
token request before pressing the submit button. These options are explained
|
||||
further here.</p>
|
||||
<img src="static/images/manual/query_builder/word_lemma.gif" alt="word and lemma explanation" width="100%;" style="margin-bottom:20px;">
|
||||
<br>
|
||||
|
||||
<h4>English pos, german pos or simple_pos</h4>
|
||||
<p>You can choose between the options "english pos", "german pos" and
|
||||
"simple_pos" to search for different parts-of-speech. You can find an overview
|
||||
of all tags under the "Tagsets" tab.</p>
|
||||
<img src="static/images/manual/query_builder/pos.gif" alt="part-of-speech-tag explanation" width="100%;" style="margin-bottom:20px;">
|
||||
|
||||
<h4>Empty Token</h4>
|
||||
<p>Here you can search for an empty token. This selection should never stand
|
||||
alone and should always be extended with an incidence modifier or stand in a
|
||||
larger query, because otherwise all possible tokens would be searched for and
|
||||
the program would crash.</p>
|
||||
<p></p>
|
||||
<br>
|
||||
</div>
|
||||
|
||||
{# Edit Options Tutorial #}
|
||||
<div>
|
||||
<hr>
|
||||
<p></p>
|
||||
<br>
|
||||
<h3 id="edit-options-tutorial">Options to edit your token</h3>
|
||||
<p>You have the possibility to extend or specify your searched token with
|
||||
certain factors. For this the query builder offers some fixed options. You can
|
||||
find more information about the options in the Corpus Query Language Tutorial.</p>
|
||||
<br>
|
||||
|
||||
<h4>Wildcard Character</h4>
|
||||
<p>A wildcard character replaces any character and is represented in the form of a dot. </p>
|
||||
<br>
|
||||
|
||||
<h4>Option Group</h4>
|
||||
<p>With an option group you can search for different variants of a token. The
|
||||
variants are not limited, so you can manually enter more options in the same
|
||||
format. "Option1" and "option2" must be replaced accordingly. </p>
|
||||
<img src="static/images/manual/query_builder/option_group.gif" alt="option group explanation" width="100%;" style="margin-bottom:20px;">
|
||||
<p></p>
|
||||
<br>
|
||||
|
||||
<h4>Incidence Modifiers</h4>
|
||||
<p>With the Incidence Modifiers you can determine the occurrence of single
|
||||
tokens. For example you can use "?" to indicate that the token occurs either
|
||||
not at all or once: <br>
|
||||
[word = "is"] [word="it"] [word="your"] [word="litte"]? [word = "dog"] <br>
|
||||
Here the word "little" should occur either once or not at all. With
|
||||
[word="dogs?"] the search is for "dog "or "dogs". </p>
|
||||
<br>
|
||||
|
||||
<h4>Ignore Case</h4>
|
||||
<p>With the check mark at Ignore Case the upper and lower case is ignored.
|
||||
This is marked with a "%c". By default (if not checked) it is case sensitive.</p>
|
||||
<br>
|
||||
|
||||
<h4>"or" & "and"</h4>
|
||||
<p>"Or" ( | ) and "and" ( & ) are conditions you can put on a token. With "or"
|
||||
one of the two conditions must be fulfilled, with "and" both conditions must be
|
||||
fulfilled. For example, the word must be called "will" AND be a verb, only then
|
||||
it will be displayed. Note that "and" is not responsible for lining up tokens in
|
||||
this case. For this you can simply string them together: <br>
|
||||
[word="I"] [word="will" & simple_pos="VERB"] [word="go"].</p>
|
||||
<img src="static/images/manual/query_builder/or_and.gif" alt="part-of-speech-tag explanation" width="100%;" style="margin-bottom:20px;">
|
||||
<p></p>
|
||||
<br>
|
||||
</div>
|
||||
|
||||
{# Add Structural Attributes Tutorial #}
|
||||
<div>
|
||||
<hr>
|
||||
<p></p>
|
||||
<br>
|
||||
<h3 id="add-structural-attribute-tutorial">Add structural attributes to your query</h3>
|
||||
<p>You can use structural attributes to search specifically for structures in
|
||||
the text or to further narrow down your previous search query. </p>
|
||||
<br>
|
||||
|
||||
<h4>Sentence</h4>
|
||||
With "Sentence" (<s></s>) you can search for sentences within your text.
|
||||
This search can of course be specified if you search for particular tokens or
|
||||
entities between the sentence tags (<s></s>). For example, you can search for
|
||||
sentences that contain only a noun, verb, and adjective. <br>
|
||||
After clicking on Sentence you will see a <div class="chip" style="background-color:#FD9720;">Sentence Start</div>.
|
||||
When you are done with your query or the content
|
||||
between the Sentence tags, you have to click the Sentence button one more time
|
||||
to close it. The corresponding button is called
|
||||
<div class="chip" style="background-color:#FD9720;">Sentence End</div>.<br>
|
||||
<br>
|
||||
|
||||
<h4>Entities</h4>
|
||||
<p>With entities, i.e. units of meaning, you search for text sections that
|
||||
follow a certain code. For example, persons, dates, certain events. You can
|
||||
select the codes using the drop-down menus. You can find an explanation of
|
||||
the respective abbreviations under the tab "Tagsets". <br>
|
||||
You can also search for unspecified entities by selecting "Add entity of any type".</p>
|
||||
To close the entity query you started, you have to click the entity button one more time. This will make the <div class="chip" style="background-color:#A6E22D;">Entity End</div> element appear in your query.
|
||||
<img src="static/images/manual/query_builder/entity.gif" alt="entity explanation" width="100%;" style="margin-bottom:20px;">
|
||||
<p></p>
|
||||
<br>
|
||||
|
||||
<h4>Meta Data</h4>
|
||||
<p>With the meta data you can annotate your text and add specific conditions.
|
||||
You can select a category on the left and enter your desired value on the right.
|
||||
The selected metadata will apply to your entire request and will be added at the end.</p>
|
||||
<img src="static/images/manual/query_builder/meta_data.gif" alt="meta data explanation" width="100%;" style="margin-bottom:20px;">
|
||||
<p></p>
|
||||
<br>
|
||||
|
||||
</div>
|
||||
|
||||
{# General Options Tutorial #}
|
||||
<div>
|
||||
<hr>
|
||||
<p></p>
|
||||
<br>
|
||||
<h3 id="general-options-query-builder">General Options of the query builder</h3>
|
||||
<p>You have several options to edit your query after adding it to the preview.</p>
|
||||
|
||||
<h4>Deleting the elements</h4>
|
||||
<p>You can delete the added elements from the query by clicking the X behind the respective content.</p>
|
||||
<img src="static/images/manual/query_builder/delete.gif" alt="delete explanation" width="100%;" style="margin-bottom:20px;">
|
||||
|
||||
<h4>Move the elements of your query</h4>
|
||||
<p>You can drag and drop elements to customize your query.</p>
|
||||
<img src="static/images/manual/query_builder/drag_and_drop.gif" alt="Drag&Drop explanation" width="100%;" style="margin-bottom:20px;">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
170
app/templates/main/manual/_10_tagsets.html.j2
Normal file
170
app/templates/main/manual/_10_tagsets.html.j2
Normal file
@ -0,0 +1,170 @@
|
||||
<div id="simple_pos-tagset">
|
||||
<h5>simple_pos tagset</h5>
|
||||
<ul>
|
||||
<li>ADJ: adjective</li>
|
||||
<li>ADP: adposition</li>
|
||||
<li>ADV: adverb</li>
|
||||
<li>AUX: auxiliary verb</li>
|
||||
<li>CONJ: coordinating conjunction</li>
|
||||
<li>DET: determiner</li>
|
||||
<li>INTJ: interjection</li>
|
||||
<li>NOUN: noun</li>
|
||||
<li>NUM: numeral</li>
|
||||
<li>PART: particle</li>
|
||||
<li>PRON: pronoun</li>
|
||||
<li>PROPN: proper noun</li>
|
||||
<li>PUNCT: punctuation</li>
|
||||
<li>SCONJ: subordinating conjunction</li>
|
||||
<li>SYM: symbol</li>
|
||||
<li>VERB: verb</li>
|
||||
<li>X: other</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="english-ent_type-tagset">
|
||||
<h5>English ent_type tagset</h5>
|
||||
<ul>
|
||||
<li>CARDINAL: Numerals that do not fall under another type</li>
|
||||
<li>DATE: Absolute or relative dates or periods</li>
|
||||
<li>EVENT: Named hurricanes, battles, wars, sports events, etc.</li>
|
||||
<li>FAC: Buildings, airports, highways, bridges, etc.</li>
|
||||
<li>GPE: Countries, cities, states</li>
|
||||
<li>LANGUAGE: Any named language</li>
|
||||
<li>LAW: Named documents made into laws.</li>
|
||||
<li>LOC: Non-GPE locations, mountain ranges, bodies of water</li>
|
||||
<li>MONEY: Monetary values, including unit</li>
|
||||
<li>NORP: Nationalities or religious or political groups</li>
|
||||
<li>ORDINAL: "first" "second" etc.</li>
|
||||
<li>ORG: Companies, agencies, institutions, etc.</li>
|
||||
<li>PERCENT: Percentage, including "%"</li>
|
||||
<li>PERSON: People, including fictional</li>
|
||||
<li>PRODUCT: Objects, vehicles, foods, etc. (not services)</li>
|
||||
<li>QUANTITY: Measurements, as of weight or distance</li>
|
||||
<li>TIME: Times smaller than a day</li>
|
||||
<li>WORK_OF_ART: Titles of books, songs, etc.</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="english-pos-tagset">
|
||||
<h5>English pos tagset</h5>
|
||||
<ul>
|
||||
<li>ADD: email</li>
|
||||
<li>AFX: affix</li>
|
||||
<li>CC: conjunction, coordinating</li>
|
||||
<li>CD: cardinal number</li>
|
||||
<li>DT: determiner</li>
|
||||
<li>EX: existential there</li>
|
||||
<li>FW: foreign word</li>
|
||||
<li>HYPH: punctuation mark, hyphen</li>
|
||||
<li>IN: conjunction, subordinating or preposition</li>
|
||||
<li>JJ: adjective</li>
|
||||
<li>JJR: adjective, comparative</li>
|
||||
<li>JJS: adjective, superlative</li>
|
||||
<li>LS: list item marker</li>
|
||||
<li>MD: verb, modal auxiliary</li>
|
||||
<li>NFP: superfluous punctuation</li>
|
||||
<li>NN: noun, singular or mass</li>
|
||||
<li>NNP: noun, proper singular</li>
|
||||
<li>NNPS: noun, proper plural</li>
|
||||
<li>NNS: noun, plural</li>
|
||||
<li>PDT: predeterminer</li>
|
||||
<li>POS: possessive ending</li>
|
||||
<li>PRP: pronoun, personal</li>
|
||||
<li>PRP$: pronoun, possessive RB: adverb</li>
|
||||
<li>RBR: adverb, comparative</li>
|
||||
<li>RBS: adverb, superlative</li>
|
||||
<li>RP: adverb, particle</li>
|
||||
<li>SYM: symbol</li>
|
||||
<li>TO: infinitival "to"</li>
|
||||
<li>UH: interjection</li>
|
||||
<li>VB: verb, base form</li>
|
||||
<li>VBD: verb, past tense</li>
|
||||
<li>VBG: verb, gerund or present participle</li>
|
||||
<li>VBN: verb, past participle</li>
|
||||
<li>VBP: verb, non-3rd person singular present</li>
|
||||
<li>VBZ: verb, 3rd person singular present</li>
|
||||
<li>WDT: wh-determiner</li>
|
||||
<li>WP: wh-pronoun, personal</li>
|
||||
<li>WP$: wh-pronoun, possessive</li>
|
||||
<li>WRB: wh-adverb</li>
|
||||
<li>XX: unknown</li>
|
||||
<li>``: opening quotation mark</li>
|
||||
<li>$: symbol, currency</li>
|
||||
<li>"": closing quotation mark</li>
|
||||
<li>: punctuation mark, comma</li>
|
||||
<li>-LRB-: left round bracket</li>
|
||||
<li>-RRB-: right round bracket</li>
|
||||
<li>.: punctuation mark, sentence closer</li>
|
||||
<li>:: punctuation mark, colon or ellipsis</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="german-ent_type-tagset">
|
||||
<h5>German ent_type tagset</h5>
|
||||
<ul>
|
||||
<li>LOC: Non-GPE locations, mountain ranges, bodies of water</li>
|
||||
<li>MISC: Miscellaneous entities, e.g. events, nationalities, products or works of art</li>
|
||||
<li>ORG: Companies, agencies, institutions, etc.</li>
|
||||
<li>PER: Named person or family.</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="german-pos-tagset">
|
||||
<h5>German pos tagset</h5>
|
||||
<ul>
|
||||
<li>ADJA: adjective, attributive</li>
|
||||
<li>ADJD: adjective, adverbial or predicative</li>
|
||||
<li>ADV: adverb</li>
|
||||
<li>APPO: postposition</li>
|
||||
<li>APPR: preposition; circumposition left</li>
|
||||
<li>APPRART: preposition with article</li>
|
||||
<li>APZR: circumposition right</li>
|
||||
<li>ART: definite or indefinite article</li>
|
||||
<li>CARD: cardinal number</li>
|
||||
<li>FM: foreign language material</li>
|
||||
<li>ITJ: interjection</li>
|
||||
<li>KOKOM: comparative conjunction</li>
|
||||
<li>KON: coordinate conjunction</li>
|
||||
<li>KOUI: subordinate conjunction with \zu\ and infinitive</li>
|
||||
<li>KOUS: subordinate conjunction with sentence</li>
|
||||
<li>NE: proper noun</li>
|
||||
<li>NN: noun, singular or mass</li>
|
||||
<li>NNE: proper noun</li>
|
||||
<li>PDAT: attributive demonstrative pronoun</li>
|
||||
<li>PDS: substituting demonstrative pronoun</li>
|
||||
<li>PIAT: attributive indefinite pronoun without determiner</li>
|
||||
<li>PIS: substituting indefinite pronoun</li>
|
||||
<li>PPER: non-reflexive personal pronoun</li>
|
||||
<li>PPOSAT: attributive possessive pronoun</li>
|
||||
<li>PPOSS: substituting possessive pronoun</li>
|
||||
<li>PRELAT: attributive relative pronoun</li>
|
||||
<li>PRELS: substituting relative pronoun</li>
|
||||
<li>PRF: reflexive personal pronoun</li>
|
||||
<li>PROAV: pronominal adverb</li>
|
||||
<li>PTKA: particle with adjective or adverb</li>
|
||||
<li>PTKANT: answer particle</li>
|
||||
<li>PTKNEG: negative particle</li>
|
||||
<li>PTKVZ: separable verbal particle</li>
|
||||
<li>PTKZU: "zu" before infinitive</li>
|
||||
<li>PWAT: attributive interrogative pronoun</li>
|
||||
<li>PWAV: adverbial interrogative or relative pronoun</li>
|
||||
<li>PWS: substituting interrogative pronoun</li>
|
||||
<li>TRUNC: word remnant</li>
|
||||
<li>VAFIN: finite verb, auxiliary</li>
|
||||
<li>VAIMP: imperative, auxiliary</li>
|
||||
<li>VAINF: infinitive, auxiliary</li>
|
||||
<li>VAPP: perfect participle, auxiliary</li>
|
||||
<li>VMFIN: finite verb, modal</li>
|
||||
<li>VMINF: infinitive, modal</li>
|
||||
<li>VMPP: perfect participle, modal</li>
|
||||
<li>VVFIN: finite verb, full</li>
|
||||
<li>VVIMP: imperative, full</li>
|
||||
<li>VVINF: infinitive, full</li>
|
||||
<li>VVIZU: infinitive with "zu" full</li>
|
||||
<li>VVPP: perfect participle, full</li>
|
||||
<li>XY: non-word containing non-letter</li>
|
||||
<li>$(: other sentence-internal punctuation mark</li>
|
||||
<li>$,: comma</li>
|
||||
<li>$.: sentence-final punctuation mark</li>
|
||||
</ul>
|
||||
</div>
|
||||
Reference in New Issue
Block a user