You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by th...@apache.org on 2018/02/08 15:32:58 UTC
svn commit: r1823568 - in /jackrabbit/site/live/oak/docs:
oak-mongo-js/index.html oak-mongo-js/oak-mongo.js.html
oak-mongo-js/oak.html query/grammar-sql2.html query/grammar-xpath.html
query/query-engine.html
Author: thomasm
Date: Thu Feb 8 15:32:58 2018
New Revision: 1823568
URL: http://svn.apache.org/viewvc?rev=1823568&view=rev
Log:
OAK-936: Site checkin for project Oak Documentation-1.10-SNAPSHOT
Modified:
jackrabbit/site/live/oak/docs/oak-mongo-js/index.html
jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html
jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html
jackrabbit/site/live/oak/docs/query/grammar-sql2.html
jackrabbit/site/live/oak/docs/query/grammar-xpath.html
jackrabbit/site/live/oak/docs/query/query-engine.html
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/index.html?rev=1823568&r1=1823567&r2=1823568&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/index.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/index.html Thu Feb 8 15:32:58 2018
@@ -56,7 +56,7 @@
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Jan 26 2018 12:02:48 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Thu Feb 08 2018 16:31:58 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html?rev=1823568&r1=1823567&r2=1823568&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html Thu Feb 8 15:32:58 2018
@@ -1105,7 +1105,7 @@ var oak = (function(global){
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Jan 26 2018 12:02:48 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Thu Feb 08 2018 16:31:58 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html?rev=1823568&r1=1823567&r2=1823568&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html Thu Feb 8 15:32:58 2018
@@ -4114,7 +4114,7 @@ is inactive.
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Jan 26 2018 12:02:48 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Thu Feb 08 2018 16:31:59 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/query/grammar-sql2.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/grammar-sql2.html?rev=1823568&r1=1823567&r2=1823568&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/grammar-sql2.html (original)
+++ jackrabbit/site/live/oak/docs/query/grammar-sql2.html Thu Feb 8 15:32:58 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-01-26
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-08
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180126" />
+ <meta name="Date-Revision-yyyymmdd" content="20180208" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak SQL-2 Query Grammar</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -135,7 +135,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-01-26<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-08<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -313,6 +313,7 @@ select [jcr:path], [jcr:score], * from [
<br /> } [ AS aliasName ]
</h4>
<p>It is recommended to enclose property names in square brackets.</p>
+<p>For the “excerpt” property, see <a href="query-engine.html#Excerpts_and_Highlighting">Excerpts and Highlighting</a>.</p>
<p>Not listed above are “special” properties such as “[jcr:path]” (the path), “[jcr:score]” (the score), “[rep:suggest()]”.</p>
<p>Examples:</p>
Modified: jackrabbit/site/live/oak/docs/query/grammar-xpath.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/grammar-xpath.html?rev=1823568&r1=1823567&r2=1823568&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/grammar-xpath.html (original)
+++ jackrabbit/site/live/oak/docs/query/grammar-xpath.html Thu Feb 8 15:32:58 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-01-25
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-08
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180125" />
+ <meta name="Date-Revision-yyyymmdd" content="20180208" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak XPath Query Grammar</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -135,7 +135,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-01-25<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-08<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -373,14 +373,18 @@ rep:excerpt( [. | [ relativePath / ] @pr
<br /> | rep:suggest( [.] )
<br /> | rep:facet ( [ relativePath / ] @propertyName )
</h4>
-<p>“rep:excerpt”: include the spellcheck column in the result. Since Oak version 1.8.1, optionally a property name can be specified. See also <a href="lucene.html#Property_Definitions">useInExcerpt</a>.</p>
+<p>“rep:excerpt”: include the excerpt in the result. Since Oak version 1.8.1, optionally a property name can be specified. See <a href="query-engine.html#Excerpts_and_Highlighting">Excerpts and Highlighting</a>.</p>
<p>“rep:spellcheck”: Include the spellcheck in the result. See <a href="query-engine.html#Spellchecking">Spellchecking</a>.</p>
<p>“rep:suggest”: include suggestions in the result. See <a href="query-engine.html#Suggestions">Suggestions</a>.</p>
<p>“rep:facet”: include facets in the result. See <a href="query-engine.html#Facets">Facets</a>.</p>
<p>Examples:</p>
<div class="source">
-<div class="source"><pre class="prettyprint">/jcr:root/content//*[rep:suggest('in ')]/(rep:suggest())
+<div class="source"><pre class="prettyprint">/jcr:root/content//*[jcr:contains(., 'test')]/(rep:excerpt())
+
+/jcr:root/content//*[jcr:contains(., 'test')]/(rep:excerpt(@jcr:title) | rep:excerpt())
+
+/jcr:root/content//*[rep:suggest('in ')]/(rep:suggest())
/jcr:root/content//*[jcr:contains(@jcr:title, 'oak')]/(rep:facet(@tags))
</pre></div></div>
Modified: jackrabbit/site/live/oak/docs/query/query-engine.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/query-engine.html?rev=1823568&r1=1823567&r2=1823568&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/query-engine.html (original)
+++ jackrabbit/site/live/oak/docs/query/query-engine.html Thu Feb 8 15:32:58 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-01-25
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-08
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180125" />
+ <meta name="Date-Revision-yyyymmdd" content="20180208" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – The Query Engine</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -135,7 +135,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-01-25<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-08<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -282,6 +282,8 @@ grep "^#.*$" src/site/markdown/query/que
<li><a href="#Full-Text_Queries">Full-Text Queries</a></li>
+<li><a href="#Excerpts_and_Highlighting">Excerpts and Highlighting</a></li>
+
<li><a href="#Native_Queries">Native Queries</a></li>
<li><a href="#Similarity_Queries">Similarity Queries</a></li>
@@ -484,6 +486,19 @@ jcr:contains(@jcr:title, 'find this')
<p>In the first example, the word “sandwich” has weight four times more than the word “jelly.” For details of boosting, see the Apache Lucene documentation about Score Boosting.</p>
<p>For compatibility with Jackrabbit 2.x, single quoted phrase queries are currently supported. That means the query <tt>contains(., "word ''hello world'' word")</tt> is supported. New applications should not rely on this feature.</p></div>
<div class="section">
+<h3><a name="Excerpts_and_Highlighting"></a>Excerpts and Highlighting</h3>
+<p>If excerpts and highlighting is needed, then queries should contains the “excerpt” property, as follows:</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">/jcr:root/content//*[jcr:contains(., 'test')]/(rep:excerpt())
+</pre></div></div>
+<p>That way, the excerpt and highlighting features of Lucene are used. That is, if a Lucene index is configured for the query, and excerpts are generated (see <a href="lucene.html#Property_Definitions">useInExcerpt</a>). On the other hand, If the query doesn’t contain the excerpt property, for example as follows:</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">/jcr:root/content//*[jcr:contains(., 'test')]
+</pre></div></div>
+<p>and the excerpt is requested after running the query, then the SimpleExcerptProvider utility is used, which generates excerpt from the content, and does highlighting. This is not not recommended; specially highlighting is limited (eg. stopwords are ignored, highlighting is case sensitive). The same problem occurs if excerpts for properties are requested that are not specified in the query.</p></div>
+<div class="section">
<h3><a name="Native_Queries"></a>Native Queries</h3>
<p>To take advantage of features that are available in full-text index implementations such as Apache Lucene and Apache Lucene Solr, so called <tt>native</tt> constraints are supported. Such constraints are passed directly to the full-text index. This is supported for both XPath and SQL-2. For XPath queries, the name of the function is <tt>rep:native</tt>, and for SQL-2, it is <tt>native</tt>. The first parameter is the index type (currently supported are <tt>solr</tt> and <tt>lucene</tt>). The second parameter is the native search query expression. For SQL-2, the selector name (if needed) is the first parameter, just before the language. Examples:</p>