You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sa...@apache.org on 2017/12/04 23:06:16 UTC
[1/4] lucene-solr:master: minor cleanups on highlighting page
Repository: lucene-solr
Updated Branches:
refs/heads/branch_7x 3dc61db1b -> 415990e02
refs/heads/master e00ef343b -> ccedbdd9d
minor cleanups on highlighting page
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/c72c02e5
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/c72c02e5
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/c72c02e5
Branch: refs/heads/master
Commit: c72c02e5257bdcf8165224cca1bc3346805e7eec
Parents: e00ef34
Author: Steve Rowe <sa...@apache.org>
Authored: Fri Dec 1 15:48:59 2017 -0500
Committer: Steve Rowe <sa...@apache.org>
Committed: Mon Dec 4 17:56:30 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/src/highlighting.adoc | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/c72c02e5/solr/solr-ref-guide/src/highlighting.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/highlighting.adoc b/solr/solr-ref-guide/src/highlighting.adoc
index d27ff75..ce60c59 100644
--- a/solr/solr-ref-guide/src/highlighting.adoc
+++ b/solr/solr-ref-guide/src/highlighting.adoc
@@ -74,7 +74,7 @@ Specifies the approximate size, in characters, of fragments to consider for high
+
The default is `<em>`.
-`hl.tag.post`:: </em> |
+`hl.tag.post`::
(`hl.simple.post` for the Original Highlighter) Specifies the “tag” to use after a highlighted term. This can be any string, but is most often an HTML or XML tag.
+
The default is `</em>`.
@@ -196,7 +196,7 @@ This adds substantial weight to the index – similar in size to the compressed
The Unified Highlighter supports these following additional parameters to the ones listed earlier:
-`hl.offsetSource`:: _(blank)_ |
+`hl.offsetSource`::
By default, the Unified Highlighter will usually pick the right offset source (see above). However it may be ambiguous such as during a migration from one offset source to another that hasn't completed.
+
The offset source can be explicitly configured to one of: `ANALYSIS`, `POSTINGS`, `POSTINGS_WITH_TERM_VECTORS`, or `TERM_VECTORS`.
@@ -273,15 +273,15 @@ If set to `false`, or if there is no match in the alternate field either, the al
`hl.formatter`::
Selects a formatter for the highlighted output. Currently the only legal value is `simple`, which surrounds a highlighted term with a customizable pre- and post-text snippet.
-`hl.simple.prehl.simple.post`::
-Specifies the text that should appear before (`hl.simple.pre`) and after (`hl.simple.post`) a highlighted term, when using the simple formatter. The default is `<em>` and `</em>`.
+`hl.simple.pre`, `hl.simple.post`::
+Specifies the text that should appear before (`hl.simple.pre`) and after (`hl.simple.post`) a highlighted term, when using the `simple` formatter. The default is `<em>` and `</em>`.
`hl.fragmenter`::
Specifies a text snippet generator for highlighted text. The standard (default) fragmenter is `gap`, which creates fixed-sized fragments with gaps for multi-valued fields.
+
Another option is `regex`, which tries to create fragments that resemble a specified regular expression.
-`hl.regex.slop`:: 0.6 |
+`hl.regex.slop`::
When using the regex fragmenter (`hl.fragmenter=regex`), this parameter defines the factor by which the fragmenter can stray from the ideal fragment size (given by `hl.fragsize`) to accommodate a regular expression.
+
For instance, a slop of `0.2` with `hl.fragsize=100` should yield fragments between 80 and 120 characters in length. It is usually good to provide a slightly smaller `hl.fragsize` value when using the regex fragmenter.
@@ -291,7 +291,7 @@ The default is `0.6`.
`hl.regex.pattern`::
Specifies the regular expression for fragmenting. This could be used to extract sentences.
-`hl.regex.maxAnalyzedChars`:: 10000 |
+`hl.regex.maxAnalyzedChars`::
Instructs Solr to analyze only this many characters from a field when using the regex fragmenter (after which, the fragmenter produces fixed-sized fragments). The default is `10000`.
+
Note, applying a complicated regex to a huge field is computationally expensive.
@@ -318,13 +318,13 @@ In addition to the initial listed parameters, the following parameters documente
And here are additional parameters supported by the FVH:
-`hl.fragListBuilder`:: weighted |
+`hl.fragListBuilder`::
The snippet fragmenting algorithm. The `weighted` fragListBuilder uses IDF-weights to order fragments. This fragListBuilder is the default.
+
Other options are `single`, which returns the entire field contents as one snippet, or `simple`. You can select a fragListBuilder with this parameter, or modify an existing implementation in `solrconfig.xml` to be the default by adding "default=true".
`hl.fragmentsBuilder`::
-The fragments builder is responsible for formatting the fragments, which uses`<em>` and `</em>` markup by default (if `hl.tag.pre` and `hl.tag.post` are not defined).
+The fragments builder is responsible for formatting the fragments, which uses `<em>` and `</em>` markup by default (if `hl.tag.pre` and `hl.tag.post` are not defined).
+
Another pre-configured choice is `colored`, which is an example of how to use the fragments builder to insert HTML into the snippets for colored highlights if you choose. You can also implement your own if you'd like. You can select a fragments builder with this parameter, or modify an existing implementation in `solrconfig.xml` to be the default by adding "default=true".
@@ -365,14 +365,14 @@ Possible values for the `hl.bs.type` parameter are WORD, LINE, SENTENCE, and CHA
==== The simple Boundary Scanner
-The `simple` boundary scanner scans term boundaries for a specified maximum character value (`hl.bs.maxScan`) and for common delimiters such as punctuation marks (`hl.bs.chars`). The `simple` boundary scanner may be useful for some custom To implement the `simple` boundary scanner, add this code to the `highlighting` section of your `solrconfig.xml` file, adjusting the values as appropriate to your application:
+The `simple` boundary scanner scans term boundaries for a specified maximum character value (`hl.bs.maxScan`) and for common delimiters such as punctuation marks (`hl.bs.chars`). To implement the `simple` boundary scanner, add this code to the `highlighting` section of your `solrconfig.xml` file, adjusting the values as appropriate to your application:
[source,xml]
----
<boundaryScanner name="simple" class="solr.highlight.SimpleBoundaryScanner" default="true">
<lst name="defaults">
- <str name="hl.bs.maxScan">10</str >
- <str name="hl.bs.chars">.,!?\t\n</str >
- </lst >
+ <str name="hl.bs.maxScan">10</str>
+ <str name="hl.bs.chars">.,!?\t\n</str>
+ </lst>
</boundaryScanner>
----
[2/4] lucene-solr:master: minor cleanup on spell checking page
Posted by sa...@apache.org.
minor cleanup on spell checking page
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/ccedbdd9
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/ccedbdd9
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/ccedbdd9
Branch: refs/heads/master
Commit: ccedbdd9d6d4c0f2206095c209b9c3303070ade5
Parents: c72c02e
Author: Steve Rowe <sa...@apache.org>
Authored: Mon Dec 4 18:04:47 2017 -0500
Committer: Steve Rowe <sa...@apache.org>
Committed: Mon Dec 4 18:04:47 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/src/spell-checking.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ccedbdd9/solr/solr-ref-guide/src/spell-checking.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/spell-checking.adoc b/solr/solr-ref-guide/src/spell-checking.adoc
index bafeb78..12818b2 100644
--- a/solr/solr-ref-guide/src/spell-checking.adoc
+++ b/solr/solr-ref-guide/src/spell-checking.adoc
@@ -192,7 +192,7 @@ If set to `true`, this parameter reloads the spellchecker. The results depend on
This parameter specifies the maximum number of suggestions that the spellchecker should return for a term. If this parameter isn't set, the value defaults to `1`. If the parameter is set but not assigned a number, the value defaults to `5`. If the parameter is set to a positive integer, that number becomes the maximum number of suggestions returned by the spellchecker.
`spellcheck.onlyMorePopular`::
-If `true`, Solr will to return suggestions that result in more hits for the query than the existing query. Note that this will return more popular suggestions even when the given query term is present in the index and considered "correct".
+If `true`, Solr will return suggestions that result in more hits for the query than the existing query. Note that this will return more popular suggestions even when the given query term is present in the index and considered "correct".
`spellcheck.maxResultsForSuggest`::
If, for example, this is set to `5` and the user's query returns 5 or fewer results, the spellchecker will report "correctlySpelled=false" and also offer suggestions (and collations if requested). Setting this greater than zero is useful for creating "did-you-mean?" suggestions for queries that return a low number of hits.
[3/4] lucene-solr:branch_7x: minor cleanup on spell checking page
Posted by sa...@apache.org.
minor cleanup on spell checking page
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/b8c9c4e6
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/b8c9c4e6
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/b8c9c4e6
Branch: refs/heads/branch_7x
Commit: b8c9c4e644bfc3ee204205e34b8e0ea0fd9acf50
Parents: 3dc61db
Author: Steve Rowe <sa...@apache.org>
Authored: Mon Dec 4 18:04:47 2017 -0500
Committer: Steve Rowe <sa...@apache.org>
Committed: Mon Dec 4 18:05:41 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/src/spell-checking.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/b8c9c4e6/solr/solr-ref-guide/src/spell-checking.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/spell-checking.adoc b/solr/solr-ref-guide/src/spell-checking.adoc
index bafeb78..12818b2 100644
--- a/solr/solr-ref-guide/src/spell-checking.adoc
+++ b/solr/solr-ref-guide/src/spell-checking.adoc
@@ -192,7 +192,7 @@ If set to `true`, this parameter reloads the spellchecker. The results depend on
This parameter specifies the maximum number of suggestions that the spellchecker should return for a term. If this parameter isn't set, the value defaults to `1`. If the parameter is set but not assigned a number, the value defaults to `5`. If the parameter is set to a positive integer, that number becomes the maximum number of suggestions returned by the spellchecker.
`spellcheck.onlyMorePopular`::
-If `true`, Solr will to return suggestions that result in more hits for the query than the existing query. Note that this will return more popular suggestions even when the given query term is present in the index and considered "correct".
+If `true`, Solr will return suggestions that result in more hits for the query than the existing query. Note that this will return more popular suggestions even when the given query term is present in the index and considered "correct".
`spellcheck.maxResultsForSuggest`::
If, for example, this is set to `5` and the user's query returns 5 or fewer results, the spellchecker will report "correctlySpelled=false" and also offer suggestions (and collations if requested). Setting this greater than zero is useful for creating "did-you-mean?" suggestions for queries that return a low number of hits.
[4/4] lucene-solr:branch_7x: minor cleanups on highlighting page
Posted by sa...@apache.org.
minor cleanups on highlighting page
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/415990e0
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/415990e0
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/415990e0
Branch: refs/heads/branch_7x
Commit: 415990e0247c18a6969bb3dda2a694317fd0d868
Parents: b8c9c4e
Author: Steve Rowe <sa...@apache.org>
Authored: Fri Dec 1 15:48:59 2017 -0500
Committer: Steve Rowe <sa...@apache.org>
Committed: Mon Dec 4 18:05:55 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/src/highlighting.adoc | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/415990e0/solr/solr-ref-guide/src/highlighting.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/highlighting.adoc b/solr/solr-ref-guide/src/highlighting.adoc
index d27ff75..ce60c59 100644
--- a/solr/solr-ref-guide/src/highlighting.adoc
+++ b/solr/solr-ref-guide/src/highlighting.adoc
@@ -74,7 +74,7 @@ Specifies the approximate size, in characters, of fragments to consider for high
+
The default is `<em>`.
-`hl.tag.post`:: </em> |
+`hl.tag.post`::
(`hl.simple.post` for the Original Highlighter) Specifies the “tag” to use after a highlighted term. This can be any string, but is most often an HTML or XML tag.
+
The default is `</em>`.
@@ -196,7 +196,7 @@ This adds substantial weight to the index – similar in size to the compressed
The Unified Highlighter supports these following additional parameters to the ones listed earlier:
-`hl.offsetSource`:: _(blank)_ |
+`hl.offsetSource`::
By default, the Unified Highlighter will usually pick the right offset source (see above). However it may be ambiguous such as during a migration from one offset source to another that hasn't completed.
+
The offset source can be explicitly configured to one of: `ANALYSIS`, `POSTINGS`, `POSTINGS_WITH_TERM_VECTORS`, or `TERM_VECTORS`.
@@ -273,15 +273,15 @@ If set to `false`, or if there is no match in the alternate field either, the al
`hl.formatter`::
Selects a formatter for the highlighted output. Currently the only legal value is `simple`, which surrounds a highlighted term with a customizable pre- and post-text snippet.
-`hl.simple.prehl.simple.post`::
-Specifies the text that should appear before (`hl.simple.pre`) and after (`hl.simple.post`) a highlighted term, when using the simple formatter. The default is `<em>` and `</em>`.
+`hl.simple.pre`, `hl.simple.post`::
+Specifies the text that should appear before (`hl.simple.pre`) and after (`hl.simple.post`) a highlighted term, when using the `simple` formatter. The default is `<em>` and `</em>`.
`hl.fragmenter`::
Specifies a text snippet generator for highlighted text. The standard (default) fragmenter is `gap`, which creates fixed-sized fragments with gaps for multi-valued fields.
+
Another option is `regex`, which tries to create fragments that resemble a specified regular expression.
-`hl.regex.slop`:: 0.6 |
+`hl.regex.slop`::
When using the regex fragmenter (`hl.fragmenter=regex`), this parameter defines the factor by which the fragmenter can stray from the ideal fragment size (given by `hl.fragsize`) to accommodate a regular expression.
+
For instance, a slop of `0.2` with `hl.fragsize=100` should yield fragments between 80 and 120 characters in length. It is usually good to provide a slightly smaller `hl.fragsize` value when using the regex fragmenter.
@@ -291,7 +291,7 @@ The default is `0.6`.
`hl.regex.pattern`::
Specifies the regular expression for fragmenting. This could be used to extract sentences.
-`hl.regex.maxAnalyzedChars`:: 10000 |
+`hl.regex.maxAnalyzedChars`::
Instructs Solr to analyze only this many characters from a field when using the regex fragmenter (after which, the fragmenter produces fixed-sized fragments). The default is `10000`.
+
Note, applying a complicated regex to a huge field is computationally expensive.
@@ -318,13 +318,13 @@ In addition to the initial listed parameters, the following parameters documente
And here are additional parameters supported by the FVH:
-`hl.fragListBuilder`:: weighted |
+`hl.fragListBuilder`::
The snippet fragmenting algorithm. The `weighted` fragListBuilder uses IDF-weights to order fragments. This fragListBuilder is the default.
+
Other options are `single`, which returns the entire field contents as one snippet, or `simple`. You can select a fragListBuilder with this parameter, or modify an existing implementation in `solrconfig.xml` to be the default by adding "default=true".
`hl.fragmentsBuilder`::
-The fragments builder is responsible for formatting the fragments, which uses`<em>` and `</em>` markup by default (if `hl.tag.pre` and `hl.tag.post` are not defined).
+The fragments builder is responsible for formatting the fragments, which uses `<em>` and `</em>` markup by default (if `hl.tag.pre` and `hl.tag.post` are not defined).
+
Another pre-configured choice is `colored`, which is an example of how to use the fragments builder to insert HTML into the snippets for colored highlights if you choose. You can also implement your own if you'd like. You can select a fragments builder with this parameter, or modify an existing implementation in `solrconfig.xml` to be the default by adding "default=true".
@@ -365,14 +365,14 @@ Possible values for the `hl.bs.type` parameter are WORD, LINE, SENTENCE, and CHA
==== The simple Boundary Scanner
-The `simple` boundary scanner scans term boundaries for a specified maximum character value (`hl.bs.maxScan`) and for common delimiters such as punctuation marks (`hl.bs.chars`). The `simple` boundary scanner may be useful for some custom To implement the `simple` boundary scanner, add this code to the `highlighting` section of your `solrconfig.xml` file, adjusting the values as appropriate to your application:
+The `simple` boundary scanner scans term boundaries for a specified maximum character value (`hl.bs.maxScan`) and for common delimiters such as punctuation marks (`hl.bs.chars`). To implement the `simple` boundary scanner, add this code to the `highlighting` section of your `solrconfig.xml` file, adjusting the values as appropriate to your application:
[source,xml]
----
<boundaryScanner name="simple" class="solr.highlight.SimpleBoundaryScanner" default="true">
<lst name="defaults">
- <str name="hl.bs.maxScan">10</str >
- <str name="hl.bs.chars">.,!?\t\n</str >
- </lst >
+ <str name="hl.bs.maxScan">10</str>
+ <str name="hl.bs.chars">.,!?\t\n</str>
+ </lst>
</boundaryScanner>
----