Nick Clemens
181267bd2b
This patch prepares Koha to officially no longer support Elasticsearch 5.X It adds a new system preference 'ElasticsearchCrossFields' to allow users to choose whether or not to enable this feature It updates the about page to add a deprecation warning if a site is running ES5 To test: 1 - Be running Koha with Elasticsearch 5.X 2 - Attempt to search Error: Unable to perform your search. Please try again. 3 - Apply patch 4 - Update database 5 - Searching works 6 - Find syspref 'ElasticsearchCrossFields' 7 - Enable it 8 - Searching is now broken 9 - Check the about page 10 - you can now see the Elasticsearch version 11 - The systeminformation tab has a deprectaion warning 12 - Set SearchEngine preference to 'Zebra' 13 - View the about page - no warnings 14 - Test again with ES6 - searching should "work" with either pref setting 15 - There should be no warning on about pages Signed-off-by: Victor Grousset/tuxayo <victor@tuxayo.net> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
285 lines
12 KiB
Text
285 lines
12 KiB
Text
Searching:
|
|
Features:
|
|
-
|
|
- Perform wildcard searching (where, for example, <cite>Har</cite> would match <cite>Harry</cite> and <cite>harp</cite>)
|
|
- pref: QueryAutoTruncate
|
|
type: boolean
|
|
choices:
|
|
yes: automatically.
|
|
no: only if * is added.
|
|
- "<br />(The * character would be used like so: <cite>Har*</cite> or <cite>*logging</cite>.)"
|
|
-
|
|
- pref: QueryFuzzy
|
|
type: boolean
|
|
choices:
|
|
yes: Try
|
|
no: "Don't try"
|
|
- to match similarly spelled words in a search (for example, a search for <cite>flang</cite> would also match <cite>flange</cite> and <cite>fang</cite>; Currently only affects Zebra searches. Any Elasticsearch term can be made fuzzy by adding a ~ directly after the term.).
|
|
-
|
|
- pref: QueryStemming
|
|
type: boolean
|
|
choices:
|
|
yes: Try
|
|
no: "Don't try"
|
|
- to match words of the same base in a search (for example, a search for <cite>enabling</cite> would also match <cite>enable</cite> and <cite>enabled</cite>; REQUIRES ZEBRA).
|
|
-
|
|
- pref: QueryWeightFields
|
|
type: boolean
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
- ranking of search results by relevance (REQUIRES ZEBRA).
|
|
-
|
|
- pref: QueryRegexEscapeOptions
|
|
default: escape
|
|
choices:
|
|
escape: Escape
|
|
unescape_escaped: Unescape escaped
|
|
dont_escape: Don't escape
|
|
- "regular expressions within query strings. If \"Escape\" is selected occurences of \"/\" in search terms will be automatically escaped, and regular expressions interpreted as regular strings. If \"Unescape escaped\" is selected this will allow writing regular expressions \"\/like this\/\" while \"/this/\", \"or/this\" will be escaped and interpreted as regular strings. (Elasticsearch only.)"
|
|
-
|
|
- pref: OpacGroupResults
|
|
default: 0
|
|
choices:
|
|
yes: Use
|
|
no: "Don't use"
|
|
- PazPar2 to group similar results on the OPAC. This requires that PazPar2 is set up and running.
|
|
-
|
|
- pref: TraceCompleteSubfields
|
|
default: 0
|
|
choices:
|
|
yes: Force
|
|
no: "Don't force"
|
|
- subject tracings in the OPAC and staff interface to search only for complete-subfield matches.
|
|
-
|
|
- pref: TraceSubjectSubdivisions
|
|
default: 0
|
|
choices:
|
|
yes: Include
|
|
no: "Don't include"
|
|
- subdivisions for searches generated by clicking on subject tracings.
|
|
-
|
|
- pref: UseICU
|
|
default: 0
|
|
choices:
|
|
yes: Using
|
|
no: "Not using"
|
|
- 'ICU Zebra indexing. Please note: This setting will not affect Zebra indexing, it should only be used to tell Koha that you have activated ICU indexing if you have actually done so, since there is no way for Koha to figure this out on its own.'
|
|
-
|
|
- pref: IncludeSeeFromInSearches
|
|
default: 0
|
|
choices:
|
|
yes: Include
|
|
no: "Don't include"
|
|
- "<em>see from</em> (non-preferred form) headings in bibliographic searches. Please note: you will need to reindex your bibliographic database when changing this preference."
|
|
-
|
|
- pref: EnableSearchHistory
|
|
default: 0
|
|
choices:
|
|
yes: Keep
|
|
no: "Don't keep"
|
|
- patron search history in the staff interface.
|
|
-
|
|
- pref: BrowseResultSelection
|
|
default: 0
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
- "browsing search results from the bibliographic record detail page in staff interface."
|
|
-
|
|
- pref: ElasticsearchCrossFields
|
|
default: 0
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
- "the cross_fields option for Elasticsearch searches, supported in Elasticsearch 6.X and above."
|
|
- "See documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#type-cross-fields"
|
|
Search form:
|
|
-
|
|
- pref : LoadSearchHistoryToTheFirstLoggedUser
|
|
default: 0
|
|
choices:
|
|
yes: "Add"
|
|
no : "Don't add"
|
|
- search history of the unlogged user to the next patron logging in.
|
|
-
|
|
- Show tabs in the OPAC and staff interface advanced search for limiting searches on the
|
|
- pref: AdvancedSearchTypes
|
|
class: long
|
|
- "fields (separate values with |). Tabs appear in the order listed.<br/>"
|
|
- "<em>Currently supported values</em>: Item types (<strong>itemtypes</strong>), Collection Codes (<strong>ccode</strong>) and Shelving Location (<strong>loc</strong>)."
|
|
-
|
|
- Limit the languages listed in the advanced search drop-down to the
|
|
- pref: AdvancedSearchLanguages
|
|
class: long
|
|
- "ISO 639-2 language codes (separate values with | or ,)."
|
|
- "For example, to limit listing to French and Italian, enter <em>ita|fre</em>."
|
|
-
|
|
- By default,
|
|
- pref: expandedSearchOption
|
|
type: boolean
|
|
choices:
|
|
yes: show
|
|
no: "don't show"
|
|
- '"More options" on the OPAC and staff interface advanced search pages.'
|
|
-
|
|
- By default,
|
|
- pref: OPACNumbersPreferPhrase
|
|
type: boolean
|
|
choices:
|
|
yes: use
|
|
no: "don't use"
|
|
- 'the operator "phr" in the callnumber and standard number OPAC searches.'
|
|
-
|
|
- By default,
|
|
- pref: IntranetNumbersPreferPhrase
|
|
type: boolean
|
|
choices:
|
|
yes: use
|
|
no: "don't use"
|
|
- 'the operator "phr" in the callnumber and standard number staff interface searches.'
|
|
Results display:
|
|
-
|
|
- pref: numSearchResultsDropdown
|
|
type: boolean
|
|
default: no
|
|
choices:
|
|
yes: Show
|
|
no: "Don't show"
|
|
- results per page dropdown on staff interface search results.
|
|
-
|
|
- pref: OPACnumSearchResultsDropdown
|
|
type: boolean
|
|
default: no
|
|
choices:
|
|
yes: Show
|
|
no: "Don't show"
|
|
- results per page dropdown on OPAC search results.
|
|
-
|
|
- By default, sort search results in the staff interface by
|
|
- pref: defaultSortField
|
|
default: relevance
|
|
choices:
|
|
relevance: relevance
|
|
popularity: total number of checkouts
|
|
call_number: call number
|
|
pubdate: date of publication
|
|
acqdate: date added
|
|
title: title
|
|
author: author
|
|
- ','
|
|
- pref: defaultSortOrder
|
|
choices:
|
|
asc: ascending.
|
|
dsc: descending.
|
|
az: from A to Z.
|
|
za: from Z to A.
|
|
-
|
|
- pref: displayFacetCount
|
|
type: boolean
|
|
default: no
|
|
choices:
|
|
yes: Show
|
|
no: "Don't show"
|
|
- facet counts. The relevance of these numbers highly depends on the value of the maxRecordsForFacets preference. Applies to OPAC and staff interface.
|
|
-
|
|
- By default, show
|
|
- pref: numSearchResults
|
|
class: integer
|
|
- results per page in the staff interface.
|
|
-
|
|
- For records with many items, only check the availability status for the first
|
|
- pref: MaxSearchResultsItemsPerRecordStatusCheck
|
|
class: integer
|
|
- items.
|
|
- <br/>Availability statuses may show incorrectly in search results if a record has more items than the limit set. Statuses will display correctly in the record details.
|
|
- <br/>Leave empty for no limit.
|
|
-
|
|
- By default, sort search results in the OPAC by
|
|
- pref: OPACdefaultSortField
|
|
default: relevance
|
|
choices:
|
|
relevance: relevance
|
|
popularity: total number of checkouts
|
|
call_number: call number
|
|
pubdate: date of publication
|
|
acqdate: date added
|
|
title: title
|
|
author: author
|
|
- ","
|
|
- pref: OPACdefaultSortOrder
|
|
choices:
|
|
asc: ascending.
|
|
dsc: descending.
|
|
az: from A to Z.
|
|
za: from Z to A.
|
|
-
|
|
-
|
|
- Show up to
|
|
- pref: maxItemsInSearchResults
|
|
class: integer
|
|
- items per bibliographic record in the search results
|
|
-
|
|
- Build facets based on
|
|
- pref: maxRecordsForFacets
|
|
class: integer
|
|
default: 20
|
|
- records from the search results.
|
|
-
|
|
- Show up to
|
|
- pref: FacetMaxCount
|
|
class: integer
|
|
default: 20
|
|
- facets for each category.
|
|
-
|
|
- By default, show
|
|
- pref: OPACnumSearchResults
|
|
class: integer
|
|
- results per page in the OPAC.
|
|
-
|
|
- "Show facets for"
|
|
- pref: DisplayLibraryFacets
|
|
type: choice
|
|
choices:
|
|
home: "home library"
|
|
holding: "holding library"
|
|
both: "both home and holding library"
|
|
-
|
|
- pref: OPACItemsResultsDisplay
|
|
type: boolean
|
|
choices:
|
|
yes: Show
|
|
no: "Don't show"
|
|
- "an item's library, location and call number in OPAC search results."
|
|
-
|
|
- Truncate facets length to
|
|
- pref: FacetLabelTruncationLength
|
|
class: integer
|
|
- characters, in OPAC/staff interface.
|
|
-
|
|
- Use the following text as separator for UNIMARC authors facets
|
|
- pref: UNIMARCAuthorsFacetsSeparator
|
|
class: short
|
|
-
|
|
- When searching on the ISBN index,
|
|
- pref: SearchWithISBNVariations
|
|
choices:
|
|
yes: "search"
|
|
no: "don't search"
|
|
- on all variations of the ISBN.
|
|
-
|
|
- pref: BiblioItemtypeInfo
|
|
choices:
|
|
yes: "Display"
|
|
no: "Don't display"
|
|
- " Koha record level itemtype info on detail and result pages in the OPAC and staff interface. This info also displays if the item-level_itypes system preference is set to bibliographic record."
|
|
Did you mean/spell checking:
|
|
-
|
|
- "Swedish service for spellchecking.<br/>"
|
|
- LIBRIS Spellchecking API key
|
|
- pref: LibrisKey
|
|
- "Can be obtained at http://api.libris.kb.se/bibspell."
|
|
-
|
|
- LIBRIS base URL
|
|
- pref: LibrisURL
|
|
- "Please only change this if you are sure it needs changing."
|