Apache Solr Reference Guide Covering Apache Solr 6.0

Standard Highlighter
The standard highlighter (AKA the default highlighter) doesn't require any special indexing parameters on the
fields to highlight. However you can optionally turn on termVectors, termPositions, and termOffsets for
any field to be highlighted. This will avoid having to run documents through the analysis chain at query-time and
will make highlighting significantly faster and use less memory, particularly for large text fields, and even more so
when hl.usePhraseHighlighter is enabled.
Standard Highlighting Parameters
The table below describes Solr's parameters for the Standard highlighter. These parameters can be defined in
the highlight search component, as defaults for the specific request handler, or passed to the request handler
with the query.
Parameter Default Value Description
hl blank (no highlight) When set to true, enables highlighted snippets to be
generated in the query response. If set to false or to
a blank or missing value, disables highlighting.
hl.q blank Specifies an overriding query term for highlighting. If
hl.q is specified, the highlighter will use that term
rather than the main query term.
hl.qparser blank Specifies a qparser to use for the hl.q query. If
blank, will use the defType of the overall query.
hl.fl blank Specifies a list of fields to highlight. Accepts a
comma- or space-delimited list of fields for which
Solr should generate highlighted snippets. If left
blank, highlights the defaultSearchField (or the field
specified the df parameter if used) for the
StandardRequestHandler. For the
DisMaxRequestHandler, the qf fields are used as
defaults.
A '*' 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.snippets 1 Specifies maximum number of highlighted snippets
to generate per field. It is possible for any number of
snippets from zero to this value to be generated.
This parameter accepts per-field overrides.
hl.fragsize 100 Specifies the size, in characters, of fragments to
consider for highlighting. 0 indicates that no
fragmenting should be considered and the whole
field value should be used. This parameter accepts
per-field overrides.
Apache Solr Reference Guide 6.0
315