diff --git a/README.md b/README.md index 25c7741..a3e6361 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# cql-parser-xqm +# fcs-ql-parser-xqm This software package provides an XQuery module developed at the Digital Academy of the Academy of Sciences and Literature | Mainz that may be used to parse [FCS-QL](https://office.clarin.eu/v/CE-2017-1046-FCS-Specification-v89.pdf) and transform FCS-QL queries into a custom XML format that matches the [provided schema](schema/query.rng). @@ -34,7 +34,7 @@ transforms a CLARIN FCS-QL query into a query element ### Parameters: -**$query?** a query following the syntax of FCS-QL (c.f. https://office.clarin.eu/v/CE-2017-1046-FCS-Specification-v89.pdf) - e.g. `"lorem"` or `[lemma = "ipsum"/l & pos='ADJ']` +**$query?** a query following the syntax of FCS-QL (c.f. https://office.clarin.eu/v/CE-2017-1046-FCS-Specification-v89.pdf) - e.g. `"lorem"` or `[lemma = "ipsum"/id & pos != 'NOUN']` or `[word='test'] within s` ### Returns: @@ -53,39 +53,37 @@ transforms a CLARIN FCS-QL query into a query element ``` or ```xml - - c.title - - any - - fish frog - + + + + and + + lemma + = + ipsum + + + pos + != + NOUN + + + + + ``` or ```xml - - - or - - - - cql.serverChoice - - = - - cat - - - - - cql.serverChoice - - = - - dog - - - + + + + word + = + test + + + s + ``` ---