diff --git a/solr/core/src/resources/apispec/core.SchemaEdit.addField.json b/solr/core/src/resources/apispec/core.SchemaEdit.addField.json index b8cb40bd065..19265abcc82 100644 --- a/solr/core/src/resources/apispec/core.SchemaEdit.addField.json +++ b/solr/core/src/resources/apispec/core.SchemaEdit.addField.json @@ -82,7 +82,7 @@ }, "termPayloads": { "type": "boolean", - "description": "If true, term payloads will be stored for use with highlighting. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false. Do not enable this if using the PostingsHighlighter.", + "description": "If true, term vectors will include payloads. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to false.", "default": "false" }, "useDocValuesAsStored": { diff --git a/solr/solr-ref-guide/src/highlighting.adoc b/solr/solr-ref-guide/src/highlighting.adoc index 7207ce94277..77fae072608 100644 --- a/solr/solr-ref-guide/src/highlighting.adoc +++ b/solr/solr-ref-guide/src/highlighting.adoc @@ -35,7 +35,7 @@ You only need to set the `hl` and often `hl.fl` parameters to get results. The f |=== |Parameter |Default |Description |hl |false |Use this parameter to enable or disable highlighting. -|hl.method |original |The highlighting implementation to use. Acceptable values are: `unified`, `original`, `fastVector`, and `postings`. See the <> section below for more details on the differences between the available highlighters. +|hl.method |original |The highlighting implementation to use. Acceptable values are: `unified`, `original`, `fastVector`. See the <> section below for more details on the differences between the available highlighters. |hl.fl |_(df=)_ |Specifies a list of fields to highlight. Accepts a comma- or space-delimited list of fields for which Solr should generate highlighted snippets. A wildcard of `\*` (asterisk) can be used to match field globs, such as `text_*` or even `\*` to highlight on all fields where highlighting is possible. When using `\*`, consider adding `hl.requireFieldMatch=true`. |hl.q |_(q=)_ |A query to use for highlighting. This parameter allows you to highlight different terms than those being used to retrieve documents. |hl.qparser |_(defType=)_ |The query parser to use for the `hl.q` query. @@ -137,13 +137,6 @@ This highlighter's query-representation is less advanced than the Original or Un + Note that both the FastVector and Original Highlighters can be used in conjunction in a search request to highlight some fields with one and some the other. In contrast, the other highlighters can only be chosen exclusively. -The Postings Highlighter:: (`hl.method=postings`) -+ -The Postings Highlighter is the ancestor of the Unified Highlighter, supporting a subset of its options and none of its index configuration flexibility - it _requires_ `storeOffsetsWithPositions` on all fields to highlight. -This option is here for backwards compatibility; it's deprecated. -In 7.0, it is internally implemented as a reconfiguration of the Unified Highlighter. -See older reference guide editions for its options. - The Unified Highlighter is exclusively configured via search parameters. In contrast, some settings for the Original and FastVector Highlighters are set in `solrconfig.xml`. There's a robust example of the latter in the "```techproducts```" configset. In addition to further information below, more information can be found in the {solr-javadocs}/solr-core/org/apache/solr/highlight/package-summary.html[Solr javadocs]. diff --git a/solr/solrj/src/java/org/apache/solr/common/params/HighlightParams.java b/solr/solrj/src/java/org/apache/solr/common/params/HighlightParams.java index 37412142ef8..ef254ccd534 100644 --- a/solr/solrj/src/java/org/apache/solr/common/params/HighlightParams.java +++ b/solr/solrj/src/java/org/apache/solr/common/params/HighlightParams.java @@ -32,8 +32,7 @@ public interface HighlightParams { // KEY: // OH = (original) Highlighter (AKA the standard Highlighter) // FVH = FastVectorHighlighter - // PH = PostingsHighlighter - // UH = UnifiedHighlighter + // UH = UnifiedHighlighter (evolved from PostingsHighlighter) // query interpretation public static final String Q = HIGHLIGHT+".q"; // all @@ -43,7 +42,7 @@ public interface HighlightParams { public static final String HIGHLIGHT_MULTI_TERM = HIGHLIGHT+".highlightMultiTerm"; // all // if no snippets... - public static final String DEFAULT_SUMMARY = HIGHLIGHT + ".defaultSummary"; // UH, PH + public static final String DEFAULT_SUMMARY = HIGHLIGHT + ".defaultSummary"; // UH public static final String ALTERNATE_FIELD = HIGHLIGHT+".alternateField"; // OH, FVH public static final String ALTERNATE_FIELD_LENGTH = HIGHLIGHT+".maxAlternateFieldLength"; // OH, FVH public static final String HIGHLIGHT_ALTERNATE = HIGHLIGHT+".highlightAlternate"; // OH, FVH @@ -59,11 +58,11 @@ public interface HighlightParams { public static final String BOUNDARY_SCANNER = HIGHLIGHT+".boundaryScanner"; // FVH public static final String BS_MAX_SCAN = HIGHLIGHT+".bs.maxScan"; // FVH public static final String BS_CHARS = HIGHLIGHT+".bs.chars"; // FVH - public static final String BS_TYPE = HIGHLIGHT+".bs.type"; // FVH, UH, PH - public static final String BS_LANGUAGE = HIGHLIGHT+".bs.language"; // FVH, UH, PH - public static final String BS_COUNTRY = HIGHLIGHT+".bs.country"; // FVH, UH, PH - public static final String BS_VARIANT = HIGHLIGHT+".bs.variant"; // FVH, UH, PH - public static final String BS_SEP = HIGHLIGHT+".bs.separator"; // UH, PH + public static final String BS_TYPE = HIGHLIGHT+".bs.type"; // FVH, UH + public static final String BS_LANGUAGE = HIGHLIGHT+".bs.language"; // FVH, UH + public static final String BS_COUNTRY = HIGHLIGHT+".bs.country"; // FVH, UH + public static final String BS_VARIANT = HIGHLIGHT+".bs.variant"; // FVH, UH + public static final String BS_SEP = HIGHLIGHT+".bs.separator"; // UH // formatting public static final String FORMATTER = HIGHLIGHT+".formatter"; // OH @@ -73,18 +72,18 @@ public interface HighlightParams { public static final String SIMPLE_PRE = HIGHLIGHT+"."+SIMPLE+".pre"; // OH public static final String SIMPLE_POST = HIGHLIGHT+"."+SIMPLE+".post"; // OH public static final String FRAGMENTS_BUILDER = HIGHLIGHT+".fragmentsBuilder"; // FVH - public static final String TAG_PRE = HIGHLIGHT + ".tag.pre"; // FVH, UH, PH - public static final String TAG_POST = HIGHLIGHT + ".tag.post"; // FVH, UH, PH - public static final String TAG_ELLIPSIS= HIGHLIGHT + ".tag.ellipsis"; // FVH, UH, PH - public static final String MULTI_VALUED_SEPARATOR = HIGHLIGHT + ".multiValuedSeparatorChar"; // FVH, PH + public static final String TAG_PRE = HIGHLIGHT + ".tag.pre"; // FVH, UH + public static final String TAG_POST = HIGHLIGHT + ".tag.post"; // FVH, UH + public static final String TAG_ELLIPSIS= HIGHLIGHT + ".tag.ellipsis"; // FVH, UH + public static final String MULTI_VALUED_SEPARATOR = HIGHLIGHT + ".multiValuedSeparatorChar"; // FVH // ordering public static final String PRESERVE_MULTI = HIGHLIGHT+".preserveMulti"; // OH public static final String FRAG_LIST_BUILDER = HIGHLIGHT+".fragListBuilder"; // FVH - public static final String SCORE = "score"; // UH, PH - public static final String SCORE_K1 = HIGHLIGHT +"."+SCORE+".k1"; // UH, PH - public static final String SCORE_B = HIGHLIGHT +"."+SCORE+".b"; // UH, PH - public static final String SCORE_PIVOT = HIGHLIGHT +"."+SCORE+".pivot"; // UH, PH + public static final String SCORE = "score"; // UH + public static final String SCORE_K1 = HIGHLIGHT +"."+SCORE+".k1"; // UH + public static final String SCORE_B = HIGHLIGHT +"."+SCORE+".b"; // UH + public static final String SCORE_PIVOT = HIGHLIGHT +"."+SCORE+".pivot"; // UH // misc public static final String MAX_CHARS = HIGHLIGHT+".maxAnalyzedChars"; // all