[jackrabbit-oak] branch trunk updated: OAK-8910 Improve OAK Lucene Index Documentation

[th...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

thomasm pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 3d65a45  OAK-8910 Improve OAK Lucene Index Documentation
3d65a45 is described below

commit 3d65a45edc2f1f529747e321d507c29a1e92b7d2
Author: Thomas Mueller <th...@apache.org>
AuthorDate: Thu Dec 23 14:33:40 2021 +0100

    OAK-8910 Improve OAK Lucene Index Documentation
---
 oak-doc/src/site/markdown/query/lucene.md | 28 +++++++++++++++-------------
 1 file changed, 15 insertions(+), 13 deletions(-)

diff --git a/oak-doc/src/site/markdown/query/lucene.md b/oak-doc/src/site/markdown/query/lucene.md
index a594fc8..34d7b5e 100644
--- a/oak-doc/src/site/markdown/query/lucene.md
+++ b/oak-doc/src/site/markdown/query/lucene.md
@@ -366,24 +366,26 @@ Following are the details about the above mentioned config options which can be
 defined at the property definition level
 
 name
-: Property name. If not defined then property name is set to the node name.
-  If `isRegexp` is true then it defines the regular expression. Can also be set
-  to a relative property.
+: Property name. If not defined, then the property name is set to the node name.
+
+  Can also be set to a relative property, e.g., `jcr:content/metadata/color`.
+  For relative properties, one wildcard (`*`) is supported instead of a node name:
+  `*/color` aggregates the values of the property `color` of all direct child nodes.
+
+  If `isRegexp` is true, then the property name is a regular expression.
 
 isRegexp
-: If set to true then property name would be interpreted as a regular
-  expression and the given definition would be applicable for matching property
-  names. Note that expression should be structured such that it does not
-  match '/'.
-    * `.*` - This property definition is applicable for all properties of given
-      node
+: If set to true, then the property name is interpreted as a regular
+  expression, and the given definition is applicable for matching property names.
+  The expression must not match '/'.
+    * `^[^\/]*$` - Matches all properties of this node.
     * `jcr:content/metadata/.*` - This property definition is
-      applicable for all properties of child node _jcr:content/metadata_
+      applicable for all properties of the child node `jcr:content/metadata`
 
-  Note that the regular expression doesn't match intermediate nodes, so,
-  `jcr:content/.*/.*` would *not* index all properties for all children of
+  The regular expression only matches property names, and not intermediate nodes.
+  `jcr:content/.*/.*` does *not* index all properties for all children of
   `jcr:content`. [OAK-5187][OAK-5187] is an open improvement to track supporting
-  arbitrary intermediate child nodes.
+  regular expression matching for intermediate child nodes.
 
 boost
 : If the property is included in `nodeScopeIndex` then it defines the boost