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.

targetPage¶

Type: Integer
TS Path: plugin.tx_solr.search.targetPage
Default: 0
Since: 1.0

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

Note: This setting can be overwritten by the plugins flexform.

trustedFields¶

Type

String

TS Path

plugin.tx_solr.search.trustedFields

Default

url

Since

3.1

The data in EXT:solr is escaped right after the retrieval from Solr. In rare cases when you need to store HTML in Solr documents you can use this configuration to mark these fields as trusted fields and skip the escaping. Typically this is needed when you want to retrieve html from solr.

The following example shows how to avoid html in the content field:

plugin.tx_solr.search.trustedFields = url, content

initializeWithEmptyQuery¶

Type: Boolean
TS Path: plugin.tx_solr.search.initializeWithEmptyQuery
Default: 0
Options: 0,1
Since: 1.0

If enabled, the results plugin (pi_results) issues a "get everything" query during initialization. This is useful, if you want to create a page that shows all available facets although no search has been issued by the user yet. Note: Enabling this option alone will not show results of the get everything query. To also show the results of the query, see option showResultsOfInitialEmptyQuery below.

showResultsOfInitialEmptyQuery¶

Type: Boolean
TS Path: plugin.tx_solr.search.showResultsOfInitialEmptyQuery
Default: 0
Options: 0,1
Since: 1.0

Requires initializeWithEmptyQuery (above) to be enabled to have any effect. If enabled together with initializeWithEmptyQuery the results of the initial "get everything" query are shown. This way, in combination with a filter you can easily list a predefined set of results.

keepExistingParametersForNewSearches¶

Type: Boolean
TS Path: plugin.tx_solr.search.keepExistingParametersForNewSearches
Default: 0
Options: 0,1
Since: 2.0

When doing a new search, existing parameters like filters will be carried over to the new search. This is useful for a scenario where you want to list all available documents first, then allow the user to filter the documents using facets and finally allow him to specify a search term to refine the search.

ignoreGlobalQParameter¶

Type: Boolean
TS Path: plugin.tx_solr.search.ignoreGlobalQParameter
Default: 0
Options: 0,1
Since: 7.0

In some cases you want EXT:solr to react on the parameter "q" in the url. Normally plugins are bounded to a namespace to allow multiple instances of the search on the same page. In this case you might want to disable this and let EXT:solr only react on the namespaced query parameter (tx_solr[q] by default).

additionalPersistentArgumentNames¶

Type: String
TS Path: plugin.tx_solr.search.additionalPersistentArgumentNames
Since: 8.0

Comma-separated list of additional argument names, that should be added to the persistent arguments that are kept for sub request, like the facet and sorting urls. Hard coded argument names are q, filter and sort.

Till Solr version 6.5.x all parameters of the plugin namespace was added to the url again. With this setting you could enable this behavior again, but only with a whitelist of argument names.

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.

query.allowEmptyQuery¶

Type: Boolean
TS Path: plugin.tx_solr.search.query.allowEmptyQuery
Default: 0
Options: 0,1
Since: 1.4

If enabled, empty queries are allowed.

query.allowedSites¶

Type: String
TS Path: plugin.tx_solr.search.query.allowedSites
Since: 2.2
Default: __solr_current_site

When indexing documents (pages, records, files, ...) into the Solr index, the Solr extension adds a "siteHash". The siteHash is used to allow indexing multiple sites into one index and still have each site only find its own documents. This is achieved by adding a filter on the siteHash.

Sometimes though, you want to search across multiple domains, then the siteHash is a blocker. Using the allowedSites setting you can set a comma-separated list of domains who's documents are allowed to be included in the current domain's search results. The default value is __solr_current_site which is a magic string/variable that is replaced with the current site's domain when querying the Solr server.

Since: 3.0

Version 3.0 introduced a couple more magic keywords that get replaced:

__current_site same as __solr_current_site
__all Adds all domains as allowed sites
* (asterisk character) Everything is allowed as siteHash (same as no siteHash check). This option should only be used when you need a search across multiple system and you know the impact of turning of the siteHash check.

query.getParameter¶

Type: String
TS Path: plugin.tx_solr.search.query.getParameter
Since: 2.2
Default: tx_solr|q

The GET query parameter name used in URLs. Useful for cases f.e. when a website tracking tool does not support the default array GET parameters.

The option expects a string, you can also define an array in the form of arrayName|arrayKey.

Example:

plugin.tx_solr.search.query.getParameter = q

query.queryFields (query.fields)¶

Type: String
TS Path: plugin.tx_solr.search.query.queryFields
Since: 1.0
Default: content^40.0, title^5.0, keywords^2.0, tagsH1^5.0, tagsH2H3^3.0, tagsH4H5H6^2.0, tagsInline^1.0, description^4.0, abstract^1.0, subtitle^1.0, navtitle^1.0, author^1.0
Note: query.fields has been renamed to query.queryFields in version 3.0

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.

query.returnFields¶

Type: String
TS Path: plugin.tx_solr.search.query.returnFields
Since: 3.0
Default: *, score

Limits the fields returned in the result documents, by default returns all field plus the virtual score field.

query.minimumMatch¶

Type: String
TS Path: plugin.tx_solr.search.query.minimumMatch
Since: 1.2, 2.0
Default: (empty)
See: Apache Solr Wiki mm / Minimum Should Match

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.

query.boostFunction¶

Type: String
TS Path: plugin.tx_solr.search.query.boostFunction
Since: 1.2, 2.0
Default: (empty)
See: Apache Solr Wiki / TheDisMaxQueryParser BoostFunction
See: Apache Solr Wiki / Function Queries
Example: recip(ms(NOW,created),3.16e-11,1,1)

A boost function can be useful to influence the relevance calculation and boost some documents to appear more at the beginning of the result list. Technically the parameter will be mapped to the "bf" parameter in the Solr query.

Use cases for example could be:

"Give newer documents a higher priority":

This could be done with a recip function:

recip(ms(NOW,created),3.16e-11,1,1)

"Give documents with a certain field value a higher priority":

This could be done with:

termfreq(type,'tx_solr_file')

query.boostQuery¶

Type: Array
TS Path: plugin.tx_solr.search.query.boostQuery
Since: 2.0
Default: (empty)
See: Apache Solr Wiki / TheDisMaxQueryParser BoostQuery

Sets the boost function bq query parameter.

Allows to further manipulate the score of a document by using Lucene syntax queries. A common use case for boost queries is to rank documents of a specific type higher than others.

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

Example (boosts tt_news documents by factor 10):

plugin.tx_solr.search.query.boostQuery.boostNews = (type:tt_news)^10

query.tieParameter¶

Type: String
TS Path: plugin.tx_solr.search.query.tieParameter
Since: 8.0
See: Lucene Documentation / TheDisMaxQueryParser TieParameter <http://lucene.apache.org/solr/guide/7_0/the-dismax-query-parser.html#the-tie-tie-breaker-parameter>

This parameter ties the scores together. Setting is to "0" (default) uses the maximum score of all computed scores. A value of "1.0" adds all scores. The value is a number between "0.0" and "1.0".

query.filter¶

Type: Array
TS Path: plugin.tx_solr.search.query.filter
Since: 1.0
See: Lucene Documentation / Query Parser Syntax

Allows to predefine filters to apply to a search query. You can add multiple filters through a name to Lucene filter mapping. The filters support stdWrap.

Example:

plugin.tx_solr.search.query.filter {
    pagesOnly = type:pages
    johnsPages = author:John
    badKeywords = {foo}
    badKeywords.wrap = -keywords:|
    badKeywords.data = GP:q
}

Note: When you want to filter for something with whitespaces you might need to quote the filter term.

plugin.tx_solr.search.query.filter {
    johnsDoesPages = author:"John Doe"
}

query.filter.__pageSections¶

Type: comma-separated list of page IDs
TS Path: plugin.tx_solr.search.query.filter.__pageSections
Since: 3.0

This is a magic/reserved filter (thus the double underscore). It limits the query and the results to certain branches/sections of the page tree. Multiple starting points can be provided as a comma-separated list of page IDs.

query.sortBy¶

Type: String
TS Path: plugin.tx_solr.search.query.sortBy
Since: 1.0

Allows to set a custom sorting for the query. By default Solr will sort by relevance, using this setting you can sort by any sortable field.

Needs a Solr field name followed by asc for ascending order or desc for descending.

Example:

plugin.tx_solr.search.query.sortBy = title asc

query.phrase¶

Type: Boolean
TS Path: plugin.tx_solr.search.query.phrase
Since: 8.0
Default: 0
See: "pf", "ps", "qs" https://lucene.apache.org/solr/guide/6_6/the-dismax-query-parser.html#TheDisMaxQueryParser-Thepf_PhraseFields_Parameter

This parameter enables the phrase search feature from Apache Solr. Setting is to "0" (default) does not change behaviour from Apache Solr if user searches for two and more words. Enabling phrase search feature influences the document set and/or the scores of documents.

query.phrase.fields¶

Type: String
TS Path: plugin.tx_solr.search.query.phrase.fields
Since: 8.0
Default: content^10.0, title^10.0, tagsH1^10.0, tagsH2H3^10.0, tagsH4H5H6^10.0, tagsInline^10.0, description^10.0, abstract^10.0, subtitle^10.0, navtitle^10.0
See: "pf" parameter https://lucene.apache.org/solr/guide/6_6/the-dismax-query-parser.html#TheDisMaxQueryParser-Thepf_PhraseFields_Parameter

This parameter defines what fields should be used to search in the given phrase. Matched documents will be boosted according to fields boost value. Fields are defined as a comma separated list and same way as queryFields.

Note: The value of this setting has NO influence on explicit phrase search.

query.phrase.slop¶

Type: Integer
TS Path: plugin.tx_solr.search.query.phrase.slop
Since: 8.0
Default: 0
See: "ps" parameter https://lucene.apache.org/solr/guide/6_6/the-dismax-query-parser.html#TheDisMaxQueryParser-Theps_PhraseSlop_Parameter

This parameter defines the "phrase slop" value, which represents the number of positions one word needs to be moved in relation to another word in order to match a phrase specified in a query.

Note: The value of this setting has NO influence on explicit phrase search.

query.phrase.querySlop¶

Type: Integer
TS Path: plugin.tx_solr.search.query.phrase.querySlop
Since: 8.0
Default: 0
See: "qs" parameter https://lucene.apache.org/solr/guide/6_6/the-dismax-query-parser.html#TheDisMaxQueryParser-Theqs_QueryPhraseSlop_Parameter

This parameter defines the "phrase slop" value, which represents the number of positions one word needs to be moved in relation to another word in order to match a phrase specified in a explicit phrase search query. Note: On explicit("double quoted" phrase) phrase search Apache Solr searches in "qf" queryFields

Note: The value of this setting has no influence on implicit phrase search.: On explicit phrase search the Solr searches in qf (plugin.tx_solr.search.query.queryFields) defined fields.

query.bigramPhrase¶

Type: Boolean
TS Path: plugin.tx_solr.search.query.bigramPhrase
Since: 8.0
Default: 0
See: "pf2", "ps2" https://lucene.apache.org/solr/guide/6_6/the-extended-dismax-query-parser.html#TheExtendedDisMaxQueryParser-Thepf2Parameter

This parameter enables the bigram phrase search feature from Apache Solr. Setting is to "0" (default) does not change behaviour from Apache Solr if user searches for three and more words. Enabling bigram phrase search feature influences the scores of documents with phrase occurrences.

query.bigramPhrase.fields¶

Type: String
TS Path: plugin.tx_solr.search.query.bigramPhrase.fields
Since: 8.0
Default: content^10.0, title^10.0, tagsH1^10.0, tagsH2H3^10.0, tagsH4H5H6^10.0, tagsInline^10.0, description^10.0, abstract^10.0, subtitle^10.0, navtitle^10.0
See: "pf2" parameter https://lucene.apache.org/solr/guide/6_6/the-extended-dismax-query-parser.html#TheExtendedDisMaxQueryParser-Thepf2Parameter

This parameter defines what fields should be used to search in the given sentence(three+ words). Matched documents will be boosted according to fields boost value. Fields are defined as a comma separated list and same way as queryFields.

Note: The value of this setting has NO influence on explicit phrase search.

query.bigramPhrase.slop¶

Type: Integer
TS Path: plugin.tx_solr.search.query.bigramPhrase.slop
Since: 8.0
Default: 0
See: "ps2" parameter https://lucene.apache.org/solr/guide/6_6/the-extended-dismax-query-parser.html#TheExtendedDisMaxQueryParser-Theps2Parameter

This parameter defines the "bigram phrase slop" value, which represents the number of positions one word needs to be moved in relation to another word in order to match a phrase specified in a query.

Note: The value of this setting has NO influence on explicit phrase search.

query.trigramPhrase¶

Type: Boolean
TS Path: plugin.tx_solr.search.query.trigramPhrase
Since: 8.0
Default: 0
See: "pf3", "ps3" https://lucene.apache.org/solr/guide/6_6/the-extended-dismax-query-parser.html#TheExtendedDisMaxQueryParser-Thepf3Parameter

This parameter enables the phrase search feature from Apache Solr. Setting is to "0" (default) does not change behaviour from Apache Solr if user searches for two and more words. Enabling phrase search feature influences the scores of documents with phrase occurrences.

query.trigramPhrase.fields¶

Type: String
TS Path: plugin.tx_solr.search.query.trigramPhrase.fields
Since: 8.0
Default: content^10.0, title^10.0, tagsH1^10.0, tagsH2H3^10.0, tagsH4H5H6^10.0, tagsInline^10.0, description^10.0, abstract^10.0, subtitle^10.0, navtitle^10.0
See: "pf3" parameter https://lucene.apache.org/solr/guide/6_6/the-extended-dismax-query-parser.html#TheExtendedDisMaxQueryParser-Thepf3Parameter

This parameter defines what fields should be used to search in the given phrase. Matched documents will be boosted according to fields boost value. Fields are defined as a comma separated list and same way as queryFields.

Note: The value of this setting has NO influence on explicit phrase search.

query.trigramPhrase.slop¶

Type: Integer
TS Path: plugin.tx_solr.search.query.trigramPhrase.slop
Since: 8.0
Default: 0
See: "ps3" parameter https://lucene.apache.org/solr/guide/6_6/the-extended-dismax-query-parser.html#TheExtendedDisMaxQueryParser-Theps3Parameter

This parameter defines the "trigram phrase slop" value, which represents the number of positions one word needs to be moved in relation to another word in order to match a phrase specified in a query.

Note: The value of this setting has NO influence on explicit phrase search.

results¶

results.resultsHighlighting¶

Type: Boolean
TS Path: plugin.tx_solr.search.results.resultsHighlighting
Since: 1.0
Default: 0
See: Apache Solr Wiki / FastVectorHighlighter

En-/disables search term highlighting on the results page.

Note: The FastVectorHighlighter is used by default (Since 4.0) if fragmentSize is set to at least 18 (this is required by the FastVectorHighlighter to work).

results.resultsHighlighting.highlightFields¶

Type: String
TS Path: plugin.tx_solr.search.results.resultsHighlighting.highlightFields
Since: 1.0
Default: content

A comma-separated list of fields to highlight.

Note: The highlighting in Solr (based on FastVectorHighlighter requires a field datatype with termVectors=on, termPositions=on and termOffsets=on which is the case for the content field). If you add other fields here, make sure that you are using a datatype where this is configured.

results.resultsHighlighting.fragmentSize¶

Type: Integer
TS Path: plugin.tx_solr.search.results.resultsHighlighting.fragmentSize
Since: 1.0
Default: 200

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

results.resultsHighlighting.fragmentSeparator¶

Type: String
TS Path: plugin.tx_solr.search.results.resultsHighlighting.fragmentSeparator
Since: 3.0
Default: [...]

When highlighting is activated Solr highlights the fields configured in highlightFields and can return multiple fragments of fragmentSize around the highlighted search word. These fragments are used as teasers in the results list. fragmentSeparator allows to configure the glue string between those fragments.

results.resultsHighlighting.wrap¶

Type: String
TS Path: plugin.tx_solr.search.results.resultsHighlighting.wrap
Since: 1.0
Default: <span class="results-highlight">|</span>

The wrap for search terms to highlight.

results.siteHighlighting¶

Type: Boolean
TS Path: plugin.tx_solr.search.results.siteHighlighting
Since: 2.0
Default: 0

Activates TYPO3's highlighting of search words on the actual pages. The words a user searched for will be wrapped with a span and CSS class csc-sword Highlighting can be styled using the CSS class csc-sword, you need to add the style definition yourself for the complete site.

results.resultsPerPage¶

Type: Integer
TS Path: plugin.tx_solr.search.results.resultsPerPage
Since: 1.0
Default: {$plugin.tx_solr.search.results.resultsPerPage}

Sets the number of shown results per page.

results.resultsPerPageSwitchOptions¶

Type: String
TS Path: plugin.tx_solr.search.results.resultsPerPageSwitchOptions
Since: 1.0
Default: 10, 25, 50

Defines the shown options of possible results per page.

results.maxPaginatorLinks¶

Type: Integer
TS Path: plugin.tx_solr.search.results.maxPaginatorLinks
Since: 11.5
Default: 0

Sets the number of shown page links in the paginator.

results.showDocumentScoreAnalysis¶

Type: Boolean
TS Path: plugin.tx_solr.search.results.showDocumentScoreAnalysis
Since: 2.5-dkd
Default: 0
Options: 0,1

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

spellchecking¶

Type: Boolean
TS Path: plugin.tx_solr.search.spellchecking
Since: 1.0
Default: 0

Set plugin.tx_solr.search.spellchecking = 1 to enable spellchecking / did you mean.

spellchecking.searchUsingSpellCheckerSuggestion¶

Type: Boolean
TS Path: plugin.tx_solr.search.spellchecking.searchUsingSpellCheckerSuggestion
Since: 4.0
Default: 0

This setting can be used to trigger a new search automatically when the previous search had no results but suggestions from the spellchecking. In this case the user can directly see the results of the best correction option.

lastSearches¶

Type: Boolean
TS Path: plugin.tx_solr.search.lastSearches
Since: 1.3-dkd
Default: 0

Set plugin.tx_solr.search.lastSearches = 1 to display a list of the last searches.

lastSearches.limit¶

Type: Integer
TS Path: plugin.tx_solr.search.lastSearches.limit
Since: 1.3-dkd
Default: 10

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

lastSearches.mode¶

Type: String
TS Path: plugin.tx_solr.search.lastSearches.mode
Since: 1.3-dkd
Default: user
Options: user, global

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

frequentSearches¶

Type: Boolean
TS Path: plugin.tx_solr.search.frequentSearches
Since: 1.3-dkd, 2.8
Default: 0

Set plugin.tx_solr.search.frequentSearches = 1 to display a list of the frequent / common searches.

frequentSearches.useLowercaseKeywords¶

Type: Boolean
TS Path: plugin.tx_solr.search.frequentSearches.useLowercaseKeywords
Since: 2.9
Default: 0

When enabled, keywords are written to the statistics table in lower case.

frequentSearches.minSize¶

Type: Integer
TS Path: plugin.tx_solr.search.frequentSearches.minSize
Since: 1.3-dkd, 2.8
Default: 14

The difference between frequentSearches.maxSize and frequentSearches.minSize is used for calculating the current step.

frequentSearches.maxSize¶

Type: Integer
TS Path: plugin.tx_solr.search.frequentSearches.maxSize
Since: 1.3-dkd, 2.8
Default: 32

The difference between frequentSearches.maxSize and frequentSearches.minSize is used for calculating the current step.

frequentSearches.limit¶

Type: Integer
TS Path: plugin.tx_solr.search.frequentSearches.limit
Since: 1.3-dkd, 2.8
Default: 20

Defines the maximum size of the list by frequentSearches.select.

frequentSearches.select¶

Type: cObject
TS Path: plugin.tx_solr.search.frequentSearches.select
Since: 1.3-dkd, 2.8

Defines a database connection for retrieving statistics.

sorting¶

Type: Boolean
TS Path: plugin.tx_solr.search.sorting
Since: 1.0
Default: 0

Set plugin.tx_solr.search.sorting = 1 to allow sorting of results.

sorting.defaultOrder¶

Type: String
TS Path: plugin.tx_solr.search.sorting.defaultOrder
Since: 1.0
Default: asc
Options: asc, desc

Sets the default sort order for all sort options.

sorting.options¶

This is a list of sorting options. Each option has a field and label to be used. By default the options title, type, author, and created are configured, plus the virtual relevancy field which is used for sorting by default.

Example:

plugin.tx_solr.search {
    sorting {
        options {
            relevance {
                field = relevance
                label = Relevance
            }

            title {
                field = sortTitle
                label = Title
            }
        }
    }
}

Note: As mentioned before relevance is a virtual field that is used to reset the sorting. Sorting by relevance means to have the order provided by the scoring from solr. That the reason why sorting descending on relevance is not possible.

sorting.options.[optionName].label¶

Type: String / stdWrap
TS Path: plugin.tx_solr.search.sorting.options.[optionName].label
Since: 1.0

Defines the name of the option's label. Supports stdWrap.

sorting.options.[optionName].field¶

Type: String / stdWrap
TS Path: plugin.tx_solr.search.sorting.options.[optionName].field
Since: 1.0

Defines the option's field. Supports stdWrap.

sorting.options.[optionName].defaultOrder¶

Type: String
TS Path: plugin.tx_solr.search.sorting.options.[optionName].defaultOrder
Since: 2.2
Default: asc
Options: asc, desc

Sets the default sort order for a particular sort option.

faceting¶

Type: Boolean
TS Path: plugin.tx_solr.search.faceting
Since: 1.0
Default: 0

Set plugin.tx_solr.search.faceting = 1 to enable faceting.

faceting.minimumCount¶

Type: Integer
TS Path: plugin.tx_solr.search.faceting.minimumCount
Since: 1.0
Default: 1
See: Apache Solr Wiki / Faceting mincount Parameter

This indicates the minimum counts for facet fields should be included in the response.

faceting.sortBy¶

Type: String
TS Path: plugin.tx_solr.search.faceting.sortBy
Since: 1.0
Default: count
Options: count, index, 1, 0, true, false, alpha (1.2, 2.0), lex (1.2, 2.0)
See: Apache Solr Wiki / Faceting sortParameter Parameter

Defines how facet options are sorted, by default they are sorted by count of results, highest on top. count, 1, true are aliases for each other.

Facet options can also be sorted alphabetically (lexicographic by indexed term) by setting the option to index. index, 0, false, alpha (from version 1.2 and 2.0), and lex (from version 1.2 and 2.0) are aliases for index.

faceting.limit¶

Type: Integer
TS Path: plugin.tx_solr.search.faceting.limit
Since: 1.0
Default: 10

Number of options to display per facet. If more options are returned by Solr, they are hidden and can be expanded by clicking a "show more" link. This feature uses a small javascript function to collapse/expand the additional options.

faceting.facetLimit¶

Type: Integer
TS Path: plugin.tx_solr.search.faceting.facetLimit
Since: 6.0
Default: 100

Number of options of a facet returned from solr.

faceting.keepAllFacetsOnSelection¶

Type: Boolean
TS Path: plugin.tx_solr.search.faceting.keepAllFacetsOnSelection
Since: 2.2
Default: 0
Options: 0, 1

When enabled selecting an option from a facet will not reduce the number of options available in other facets.

faceting.countAllFacetsForSelection¶

Type: Boolean
TS Path: plugin.tx_solr.search.faceting.countAllFacetsForSelection
Since: 8.0
Default: 0
Options: 0, 1

When `keepAllFacetsOnSelection` is active the count of a facet do not get reduced. You can use `countAllFacetsForSelection` to achieve that.

The following example shows how to keep all options of all facets by keeping the real document count, even when it has zero options:

` plugin.tx_solr.search.faceting.keepAllFacetsOnSelection = 1 plugin.tx_solr.search.faceting.countAllFacetsForSelection = 1 plugin.tx_solr.search.faceting.minimumCount = 0 `````````````````````````````````````````````

faceting.showAllLink.wrap¶

Type: String
TS Path: plugin.tx_solr.search.faceting.showAllLink.wrap
Since: 1.0
Default: <li>|</li>

Defines the output of the "Show more" link, that is rendered if there are more facets given than set by faceting.limit.

faceting.showEmptyFacets¶

Type: Boolean
TS Path: plugin.tx_solr.search.faceting.showEmptyFacets
Since: 1.3
Default: 0
Options: 0, 1

By setting this option to 1, you will allow rendering of empty facets. Usually, if a facet does not offer any options to filter a resultset of documents, the facet header will not be shown. Using this option allows the header still to be rendered when no filter options are provided.

faceting.urlParameterStyle¶

Type: Option/String (index or assoc)
TS Path: plugin.tx_solr.search.faceting.urlParameterStyle
Since: 11.1
Default: index
Note: On assoc, the setting faceting.urlParameterSort will be enabled and can not be disabled.

Allows to change the url style of facets. This can be legacy index or more modern associative style.

Index style: tx_solr[filter][0]=type:pages Associative style: tx_solr[filter][type:pages]=1

faceting.urlParameterSort¶

Type: Boolean
TS Path: plugin.tx_solr.search.faceting.urlParameterSort
Since: 11.1
Default: 0
Note: On faceting.urlParameterStyle = assoc, this setting can not be disabled.

Allows to enable sorting of url parameters, so the single state of facets is associated with same url, no matter in which order the facets were selected

faceting.facetLinkUrlParameters¶

Type: String
TS Path: plugin.tx_solr.search.faceting.facetLinkUrlParameters
Since: 2.8

Allows to add URL GET parameters to the links build in facets.

faceting.facetLinkUrlParameters.useForFacetResetLinkUrl¶

Type: Boolean
TS Path: plugin.tx_solr.search.faceting.facetLinkUrlParameters.useForFacetResetLinkUrl
Since: 2.8

Allows to prevent adding the URL parameters to the facets reset link by setting the option to 0.

faceting.facets.[facetName].[type]¶

Type: Array
TS Path: plugin.tx_solr.search.faceting.facets.[facetName].[type]
Since: 2.0

When setting a special type for a facet you can set further options for this type using this array.

Example (numericRange facet displayed as a slider):

plugin.tx_solr.search.faceting.facets.size {
     field = size_intS
     label = Size

     type = numericRange
     numericRange {
         start = 0
         end = 100
         gap = 1
    }
}

elevation¶

Type: Boolean
TS Path: plugin.tx_solr.search.elevation
Since: 3.0
Default: 0

Set plugin.tx_solr.search.elevation = 1 to enable content elevation in search results.

elevation.forceElevation¶

Type: Boolean
TS Path: plugin.tx_solr.search.elevation.forceElevation
Since: 3.0
Default: 1

Forces content elevation to be active.

elevation.markElevatedResults¶

Type: Boolean
TS Path: plugin.tx_solr.search.elevation.markElevatedResults
Since: 3.0
Default: 1

If enabled, elevated results are marked with CSS class "results-elevated".

variants¶

By using variants you can shrink down multiple documents with the same value in one field into one document and make similar documents available in the variants property. By default the field variantId is used as Solr collapsing criteria. This can be used e.g. as one approach of deduplication to group similar documents into on "root" SearchResult.

To use the different variants of the documents you can access "document.variants" to access the expanded documents.

This can be used for example for de-duplication to list variants of the same document below a certain document.

Note: Internally this is implemented with Solr field collapsing

Warning

If you're additionally using the grouping feature, the variants feature will be deactivated completely.

Type: Boolean
TS Path: plugin.tx_solr.search.variants
Since: 6.0
Default: 0

Set plugin.tx_solr.search.variants = 1 to enable the variants in search results.

variants.expand¶

Used to expand the document variants to the document.variants property.

Type: Boolean
TS Path: plugin.tx_solr.search.variants.expand
Since: 6.0
Default: 1

variants.variantField¶

Used to expand the document variants to the document.variants property.

Note:: The field must be a numeric field or a string field! Not a text field!

Type: String
TS Path: plugin.tx_solr.search.variants.variantField
Since: 6.0
Default: variantId

variants.limit¶

Limit of expanded documents.

Though this setting limits the returned variants, you still can get the number of existing variants, it's set in "document.variantsNumFound" (since EXT:solr 10)

Type: Integer
TS Path: plugin.tx_solr.search.variants.limit
Since: 6.0
Default: 10

grouping¶

The Solr grouping feature can be used to group documents based on a Solr field or a set of Solr queries.

Note

The grouping feature has a higher value than the collapsing/variant feature. So if you use the grouping feature, the variant feature is deactivated.

The following example shows how to group documents based on the "type" field:

plugin.tx_solr {
    search {
        grouping = 1
        grouping {
            numberOfGroups = 5
            numberOfResultsPerGroup = 5
            allowGetParameterSwitch = 0
            groups {
                typeGroup {
                    field = type
                }
            }
        }
    }
}

The next example shows how to group documents based on queries:

plugin.tx_solr {
    search {
        grouping = 1
        grouping {
            numberOfGroups = 5
            numberOfResultsPerGroup = 5
            allowGetParameterSwitch = 0
            groups {
                pidQuery {
                    queries {
                        lessThenTen = pid:[0 TO 10]
                        lessThen30 = pid:[11 TO 30]
                        rest = pid:[30 TO *]
                    }
                }
            }
        }
    }
}

grouping.numberOfGroups¶

Type: Integer
TS Path: plugin.tx_solr.search.grouping.numberOfGroups
Default: 5
Since: 12.0

grouping.numberOfResultsPerGroup¶

Type: Integer
TS Path: plugin.tx_solr.search.grouping.numberOfResultsPerGroup
Default: 5
Since: 12.0

grouping.allowGetParameterSwitch¶

Type: Boolean
TS Path: plugin.tx_solr.search.grouping.allowGetParameterSwitch
Default: 0
Since: 12.0

If set, grouping can be disabled via "tx_solr[grouping]=off"

grouping.groups.[groupName].field¶

Type: String
TS Path: plugin.tx_solr.search.grouping.[groupName].field
Default: empty
Since: 12.0

Defines the Solr field where a group should be build on.

Note: Use either field or queries no mix. Groups with field are field groups, groups with queries are query groups.

grouping.groups.[groupName].queries¶

Type: Array
TS Path: plugin.tx_solr.search.grouping.[groupName].queries
Default: empty
Since: 12.0

Defines an array of queries to group the results in.

Note: Use either field or queries no mix. Groups with field are field groups, groups with queries are query groups.

tx_solr.search¶

targetPage¶

trustedFields¶

initializeWithEmptyQuery¶

showResultsOfInitialEmptyQuery¶

keepExistingParametersForNewSearches¶

ignoreGlobalQParameter¶

additionalPersistentArgumentNames¶

query¶

query.allowEmptyQuery¶

query.allowedSites¶

query.getParameter¶

query.queryFields (query.fields)¶

query.returnFields¶

query.minimumMatch¶

query.boostFunction¶

query.boostQuery¶

query.tieParameter¶

query.filter¶

query.filter.__pageSections¶

query.sortBy¶

query.phrase¶

query.phrase.fields¶

query.phrase.slop¶

query.phrase.querySlop¶

query.bigramPhrase¶

query.bigramPhrase.fields¶

query.bigramPhrase.slop¶

query.trigramPhrase¶

query.trigramPhrase.fields¶

query.trigramPhrase.slop¶

results¶

results.resultsHighlighting¶

results.resultsHighlighting.highlightFields¶

results.resultsHighlighting.fragmentSize¶

results.resultsHighlighting.fragmentSeparator¶

results.resultsHighlighting.wrap¶

results.siteHighlighting¶

results.resultsPerPage¶

results.resultsPerPageSwitchOptions¶

results.maxPaginatorLinks¶

results.showDocumentScoreAnalysis¶

spellchecking¶

spellchecking¶

spellchecking.searchUsingSpellCheckerSuggestion¶

lastSearches¶

lastSearches¶

lastSearches.limit¶

lastSearches.mode¶

frequentSearches¶

frequentSearches¶

frequentSearches.useLowercaseKeywords¶

frequentSearches.minSize¶

frequentSearches.maxSize¶

frequentSearches.limit¶

frequentSearches.select¶

sorting¶

sorting¶

sorting.defaultOrder¶

sorting.options¶

sorting.options.[optionName].label¶

sorting.options.[optionName].field¶

sorting.options.[optionName].defaultOrder¶

faceting¶

faceting¶

faceting.minimumCount¶

faceting.sortBy¶

faceting.limit¶

faceting.facetLimit¶

faceting.keepAllFacetsOnSelection¶

faceting.countAllFacetsForSelection¶

faceting.showAllLink.wrap¶

faceting.showEmptyFacets¶

faceting.urlParameterStyle¶

faceting.urlParameterSort¶

faceting.facetLinkUrlParameters¶

faceting.facetLinkUrlParameters.useForFacetResetLinkUrl¶

faceting.facets¶

faceting.facets.[facetName] - single facet configuration¶

faceting.facets.[facetName].additionalExcludeTags¶