Author: catholicon
Date: Thu Apr 7 04:10:51 2016
New Revision: 1738087
URL: http://svn.apache.org/viewvc?rev=1738087&view=rev
Log:
OAK-4167: Update suggestion/spellcheck versions according to 1.2.14 (which
would contain the backports)
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md?rev=1738087&r1=1738086&r2=1738087&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md Thu Apr 7
04:10:51 2016
@@ -378,7 +378,7 @@ Property name can be one of following
4. The string `:nodeName` - this special case indexes node name as if it's a
virtual property of the node being indexed. Setting this along with
`nodeScopeIndex=true` is akin to setting `indexNodeName=true` on indexing
- rule. (`@since Oak 1.3.15`)
+ rule. (`@since Oak 1.3.15, 1.2.14`)
<a name="path-restrictions"></a>
##### Evaluate Path Restrictions
@@ -1002,7 +1002,7 @@ Once the above configuration has been do
updated every 10 minutes but that can be changed by setting the property
`suggestUpdateFrequencyMinutes` in `suggestion` node under the index definition
node to a different value.
-_Note that up till Oak 1.3.14, `suggestUpdateFrequencyMinutes` was to be setup
at
+_Note that up till Oak 1.3.14/1.2.14, `suggestUpdateFrequencyMinutes` was to
be setup at
index definition node itself. That is is still supported for backward
compatibility,
but having a separate `suggestion` node is preferred._
@@ -1028,7 +1028,7 @@ property.
- useInSuggest = true
```
-`@since Oak 1.3.12` the index Analyzer can be used to perform a have more fine
grained suggestions, e.g. single words
+`@since Oak 1.3.12, 1.2.14` the index Analyzer can be used to perform a have
more fine grained suggestions, e.g. single words
(whereas default suggest configuration returns entire property values, see
[OAK-3407]: https://issues.apache.org/jira/browse/OAK-3407).
Analyzed suggestions can be enabled by setting "suggestAnalyzed" property to
true, e.g.:
@@ -1042,13 +1042,13 @@ Analyzed suggestions can be enabled by s
- suggestUpdateFrequencyMinutes = 20
- suggestAnalyzed = true
```
-_Note that up till Oak 1.3.14, `suggestAnalyzed` was to be setup at index
definition node itself. That is is still
+_Note that up till Oak 1.3.14/1.2.14, `suggestAnalyzed` was to be setup at
index definition node itself. That is is still
supported for backward compatibility, but having a separate `suggestion` node
is preferred._
Setting up `useInSuggest=true` for a property definition having
`name=:nodeName` would add node names to
suggestion dictionary (See [property name](#property-names) for node name
indexing)
-Since, Oak 1.3.16, very little support exists for queries with
`ISDESCENDANTNODE` constraint to subset suggestions
+Since, Oak 1.3.16/1.2.14, very little support exists for queries with
`ISDESCENDANTNODE` constraint to subset suggestions
on a sub-tree. It requires `evaluatePathRestrictions=true` on index
definition. e.g.
```
SELECT rep:suggest() FROM [nt:base] WHERE SUGGEST('test') AND
ISDESCENDANTNODE('/a/b')
@@ -1073,7 +1073,7 @@ properties terms to be used for spellche
Sample configuration for spellchecking based on terms contained in `jcr:title`
property.
-Since Oak 1.3.11, the each suggestion would be returned per row.
+Since Oak 1.3.11/1.2.14, the each suggestion would be returned per row.
```
/oak:index/lucene-spellcheck
@@ -1092,7 +1092,7 @@ Since Oak 1.3.11, the each suggestion wo
- useInSpellcheck = true
```
-Since, Oak 1.3.16, very little support exists for queries with
`ISDESCENDANTNODE` constraint to subset suggestions
+Since, Oak 1.3.16/1.2.14, very little support exists for queries with
`ISDESCENDANTNODE` constraint to subset suggestions
on a sub-tree. It requires `evaluatePathRestrictions=true` on index
definition. e.g.
```
SELECT rep:suggest() FROM [nt:base] WHERE SUGGEST('test') AND
ISDESCENDANTNODE('/a/b')
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md?rev=1738087&r1=1738086&r2=1738087&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md
(original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md Thu
Apr 7 04:10:51 2016
@@ -175,7 +175,7 @@ index, in a special property named `rep:
Clients wanting to obtain spellchecks could use the following JCR code:
-`@until Oak 1.3.10` spellchecks are returned flat.
+`@until Oak 1.3.10, 1.2.13` spellchecks are returned flat.
QueryManager qm = ...;
String xpath = "/jcr:root[rep:spellcheck('helo')]/(rep:spellcheck())";
@@ -190,7 +190,7 @@ The `spellchecks` String would be have t
[hello, hold]
-`@since Oak 1.3.11` each spellcheck would be returned per row.
+`@since Oak 1.3.11, 1.2.14` each spellcheck would be returned per row.
QueryManager qm = ...;
String xpath = "/jcr:root[rep:spellcheck('helo')]/(rep:spellcheck())";
@@ -223,7 +223,7 @@ suggested and scored by the used underly
Clients wanting to obtain suggestions could use the following JCR code:
-`@until Oak 1.3.10` suggestions are returned flat.
+`@until Oak 1.3.10, 1.2.13` suggestions are returned flat.
QueryManager qm = ...;
String xpath = "/jcr:root[rep:suggest('in ')]/(rep:suggest())";
@@ -239,7 +239,7 @@ The `suggestions` String would be have t
[{term=in 2015 a red fox is still a fox,weight=1.5}, {term=in 2015 my fox
is red, like mike's fox and john's fox,weight=0.7}]
-`@since Oak 1.3.11` each suggestion would be returned per row.
+`@since Oak 1.3.11, 1.2.14` each suggestion would be returned per row.
QueryManager qm = ...;
String xpath = "/jcr:root[rep:suggest('in ')]/(rep:suggest())";
