Apache Solr for TYPO3 CMS

h1. tx_solr.search

The search section, you probably already guessed it, provides configuration options for the all things related to actually searching the index, setting query parameters, formatting and processing result documents and the result listing.

{{toc}}

h2. filter

*Since:* version:1.0

*Default:*

*Type:* String

Adds additional parameters to the search initialization.

h2. targetPage

*Since:* version:1.0

*Default:* 0

*Type:* Integer

Sets the target page ID for links. If it is empty or 0, the current page ID will be used.

h2. allowEmptyQuery

*Since:* version:1.0

*Default:* 0

*Options:* 0,1

*Type:* Boolean

If enabled, empty queries are allowed.

h2. form

*Since:* version:1.0

*Default:* simple

*Type:* String

Sets the form style.

h1. query

The query sub-section defines a few query parameters for the query that will be sent to the Solr server later on. Some query parameters are also generated and set by the extension itself, f.e. when using facets.

h2. query.fields

*Since:* version:1.0

*Default:* content^40.0, title^5.0, keywords^2.0, tagsH1^5.0, tagsH2H3^3.0, tagsH4H5H6^2.0, tagsInline^1.0

*Type:* String

Defines what fields to search in the index. Fields are defined as a comma separated list. Each field can be given a boost by appending the boost value separated by the ^ character, that's Lucene query language. The boost value itself is a float value, pay attention to using a dot as the separator for the fractions. Use this option to add more fields to search.

The boost take influence on what score a document gets when searching and thus how documents are ranked and listed in the search results. A higher score will move documents up in the result listing. The boost is a multiplier for the original score value of a document for a search term.

By default if a search term is found in the content field the documents gets scored / ranked higher as if a term was found in the title or keywords field. Although the default should provide a good setting, you can play around with the boost values to find the best ranking for your content.

h2. query.minimumMatch

*Since:* version:1.2 version:2.0

*Default:* (empty)

*See:* http://wiki.apache.org/solr/DisMaxRequestHandler#mm_.28Minimum_.27Should.27_Match.29

*Type:* String

Sets the minimum match _mm_ query parameter.

By default the mm query parameter is set in solrconfig.xml as _2<-35%_. This means that for queries with less than three words they all must match the searched fields of a document. For queries with three or more words at least 65% of them must match rounded up.

Please consult the link to the Solr wiki for a more detailed description of the mm syntax.

h2. query.boostFunction

*Since:* version:1.2 version:2.0

*Default:* (empty)

*See:* http://wiki.apache.org/solr/DisMaxRequestHandler#bf_.28Boost_Functions.29

*Type:* String

Sets the boost function _bf_ query parameter.

Allows to further manipulate the score of a document by using mathematical functions and field values of the current document.

A common use case for boost functions is to rank newer documents higher than older ones.

Please consult the link to the Solr wiki for a more detailed description of boost functions.

h1. results

h2. results.resultsPerPage

*Since:* version:1.0

*Default:* {$plugin.tx_solr.search.results.resultsPerPage}

*Type:* Integer

Sets the number of shown results per page.

h2. results.resultsPerPageSwitchOptions

*Since:* version:1.0

*Default:* 10, 20, 30, 50

*Type:* String

Defines the shown options of possible results per page.

h2. results.fieldProcessingInstructions

*Since:* version:1.0

*Type:* cObject

Mapping of fieldname to processing instructions. Available instructions: timestamp, utf8Decode, skip (removes the field from the result).

h2. results.fieldRenderingInstructions

*Since:* version:1.0

*Type:* cObject

Additional rendering instructions for specified fields.

h2. results.pagebrowser.templateFile

*Since:* version:1.0

*Default:* EXT:solr/resources/templates/pi_results/pagebrowser.htm

*Type:* String

Defines the template used for the pagebrowser.

h2. results.ignorePageBrowser

*Since:* version:1.0

*Default:* 0

*Options:* 0,1

*Type:* Boolean

If enabled, the selected page will be ignored an results by the first record.

h2. results.showDocumentScoreAnalysis

*Since:* version:2.0

*Default:* 0

*Options:* 0,1

*Type:* Boolean

If enabled, the analysis and display of the score analysis for logged in backend users will be initialized.

h1. highlighting

h2. highlighting.highlightFields

*Since:* version:1.0

*Default:* title,content

*Type:* String

Should be a comma- or space-delimited list of fields to generate highlighted snippets for.

h2. highlighting.fragmentSize

*Since:* version:1.0

*Default:* 200

*Type:* Integer

The size, in characters, of fragments to consider for highlighting. "0" indicates that the whole field value should be used (no fragmenting).

h2. highlighting.wrap

*Since:* version:1.0

*Default:* <span class="results-highlight">|</span>

*Type:* String

This is used to format the highlighted parts.

h1. spellchecking

h2. spellchecking.wrap

*Since:* version:1.0

*Default:* |<div class="spelling-suggestions">###LLL:didYouMean### |</div>|

*Type:* String

This is used to format spelling suggestions.

h1. contentElevation

h2. contentElevation.forceElevation

*Since:* version:1.0

*Default:* 1

*Options:* 0,1

*Type:* Boolean

If enabled, query elevation will be activated.

h1. lastSearches

h2. lastSearches.limit

*Since:* version:1.0

*Default:* 10

*Type:* Integer

Defines the number of last searches, that should get minded.

h2. lastSearches.mode

*Since:* version:1.0

*Default:* user

*Options:* user, global

*Type:* String

If mode is user, keywords will get stored into the session. If mode is global keywords will get stored into the database.

Defines the number of last searches, that should get minded.