janhoy commented on a change in pull request #908: Change the file format of README files from README.txt to README.md a… URL: https://github.com/apache/lucene-solr/pull/908#discussion_r369847941
########## File path: lucene/queryparser/docs/surround/README.md ########## @@ -0,0 +1,105 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + +# Surround: + +Surround consists of operators (uppercase/lowercase): + +```AND/OR/NOT/nW/nN/()``` as infix and +```AND/OR/nW/nN``` as prefix. + +Distance operators W and N have default n=1, max 99. +Implemented as SpanQuery with slop = (n - 1). +An example prefix form is: + +```20n(aa*, bb*, cc*)``` + +## Description of Surround: + +The name Surround was chosen because of this prefix form +and because it uses the newly introduced span queries +to implement the proximity operators. +The names of the operators and the prefix and suffix +forms have been borrowed from various other query +languages described on the internet. + + +Query terms from the Lucene standard query parser: + +`field:termtext` + +`^ boost` Review comment: Find a better way to represent definition lists like this. Now it looks very messy. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
