Skip to content

Commit 52a2e47

Browse files
committed
Added publications and updated the release version.
Change-Id: I8ec3eee5cefad7e83a8be908ded908002cf44274
1 parent 4c97789 commit 52a2e47

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11
![Koral](https://raw.githubusercontent.com/KorAP/Koral/master/misc/koral.png)
22

3-
Koral is a library designed for the translation of different corpus query
4-
languages to KoralQuery, a JSON-LD-based protocol for the common representation
5-
of linguistic queries. This work has been carried out within the KorAP
6-
project (see below) and forms the major part of a Master thesis that is
7-
due to appear. The detailed specifications of KoralQuery will be covered
8-
in that thesis.
9-
10-
As of v0.1, the following corpus query languages (QLs) are supported:
3+
Koral is a translator tool for converting different corpus query
4+
languages to [KoralQuery](https://korap.github.io/Koral/), a JSON-LD-based protocol for the common representation
5+
of linguistic queries. KoralQuery specifications are described extensively in Bingel (2015). This work has been carried out within the KorAP project.
6+
7+
Koral v0.3 supports the following corpus query languages (QLs):
118
* [Cosmas-II QL](http://www.ids-mannheim.de/cosmas2/web-app/hilfe/suchanfrage/)
129
* [ANNIS QL](http://annis-tools.org/aql.html)
1310
* [Poliqarp QL](http://korpus.pl/en/cheatsheet/node3.html) (extended by numerous operators to "PoliqarpPlus" QL)
14-
* [CQL](http://www.loc.gov/standards/sru/cql/spec.html)
15-
16-
You can use the main class QuerySerializer to translate and serialize queries
17-
for you. The usage example below illustrates this. Valid QL identifiers
18-
are `cosmas2`, `annis`, `poliqarp`, `poliqarpplus` and `cql`.
19-
11+
* [CQL] (http://www.loc.gov/standards/sru/cql/spec.html) (for basic search as described in [the CLARIN FCS 1.0 Specification] (https://www.clarin.eu/content/federated-content-search-clarin-fcs) )
12+
* FCSQL (based on [CQP](http://cwb.sourceforge.net/files/CQP_Tutorial/), for advanced search as described in the CLARIN FCS 2.0 specification draft)
2013

2114
## Usage Example
2215

16+
You can use the main class QuerySerializer to translate and serialize queries. Valid QL identifiers are `cosmas2`, `annis`, `poliqarp`, `poliqarpplus` and `cql`.
2317

2418
```java
2519
import de.ids_mannheim.korap.query.serialize.QuerySerialzer;
@@ -30,7 +24,7 @@ System.out.println(qs.toJSON());
3024
```
3125

3226
This will print out the following JSON-LD string for the Koralized query.
33-
The query asks for a sentence element (`<s>`) that is contained in a
27+
The query asks for a sentence element (`<s>`) contained in a
3428
sequence of the surface form *zu* and a token with the part-of-speech tag *ADJA*.
3529
In the KoralQuery string, a containment relation is defined over two
3630
operands, an *s* span and a sequence of two tokens.
@@ -81,15 +75,13 @@ operands, an *s* span and a sequence of two tokens.
8175

8276
## Motivation
8377

84-
Koral enables the design and implementation of corpus query systems
85-
independently of any specific query languages. All the system needs to do on
86-
the query processing side is have the query translated to KoralQuery (see usage)
87-
and feed the translated query to its search engine. In particular, several query
88-
languages can be supported without further adjustments to the search engine.
78+
Koral allows designing and implementating corpus query systems
79+
independent of any specific query languages. The systems only need to have Koral translate a query to a KoralQuery (see usage)
80+
and feed the translated query to its search engine. Several query languages can be supported without further adjustments to the search engine.
8981

9082
Koral and KoralQuery have been designed and developed within the
9183
[KorAP Project](http://korap.ids-mannheim.de/), and are used in KorAP to
92-
translate queries to a common format before sending them to the backend.
84+
translate queries to a common format before sending them to its search engine.
9385

9486
## Installation
9587

@@ -111,6 +103,12 @@ There is also a command line version. After installation, simply run
111103
* At least [Maven 3.2.1](https://maven.apache.org/)
112104
* Further dependencies are resolved by Maven.
113105

106+
## Publications
107+
108+
J. Bingel, "Instantiation and implementation of a corpus query lingua franca," M.S. thesis, University of Heidelberg, Heidelberg, 2015.
109+
110+
J. Bingel and N. Diewald, "KoralQuery – a General Corpus Query Protocol," in Proceedings of the Workshop on Innovative Corpus Query and Visualization Tools at NODALIDA 2015, Vilnius, 2015, pp. 1-5.
111+
114112
## Authorship
115113

116114
Koral and KoralQuery were developed by Joachim Bingel,

0 commit comments

Comments
 (0)