svn commit: r1685748 - /jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md

[to...@apache.org]

Author: tommaso
Date: Tue Jun 16 09:38:28 2015
New Revision: 1685748

URL: http://svn.apache.org/r1685748
Log:
OAK-2176 - added sample Lucene index configuration in docs

Modified:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.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=1685748&r1=1685747&r2=1685748&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 Tue Jun 16 09:38:28 2015
@@ -805,6 +805,26 @@ In order to use Lucene index to perform
 Once the above configuration has been done, by default, the Lucene suggester is updated every 10 minutes but that can be 
 changed by setting the property `suggestUpdateFrequencyMinutes` in the index definition node to a different value.
 
+Sample configuration for suggestions based on terms contained in `jcr:description` property.
+
+```
+/oak:index/lucene-suggest
+  - jcr:primaryType = "oak:QueryIndexDefinition"
+  - compatVersion = 2
+  - type = "lucene"
+  - async = "async"
+  - suggestUpdateFrequencyMinutes = 60
+  + indexRules
+    - jcr:primaryType = "nt:unstructured"
+    + nt:base
+      + properties
+        - jcr:primaryType = "nt:unstructured"
+        + jcr:description
+          - propertyIndex = true
+          - analyzed = true
+          - useForSuggest = true
+```
+
 ##### Spellchecking
 
 `@since Oak 1.1.17, 1.0.13`