Koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/searching.pref
Jared Camins-Esakov 8471158160 Bug 8209: "Did you mean?" from authorities
One of the ideas behind authority records is that users who search for
one term should have related terms (according to the authority file)
suggested to them. At the moment, Koha doesn't do that. Adding an
authority searching step to regular searches and displaying any
suggestions in a "Did you mean" bar at the top of the results would be
very useful.

This commit adds a Koha::SuggestionEngine class which is in charge of
getting suggestions from individual suggestion engine plugins, which
much be in the Koha::SuggestionEngine::Plugin::* namespace, and extend
Koha::SuggestionEngine::Base. Suggestions are loaded asynchronously
using AJAX, and a link to a page with suggestions is provided for users
with Javascript turned off.

The AuthorityFile suggestion engine plugin looks up the specified search
terms in the authority file and then suggests searches for records using
matching authorities.

Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>
Rebased 2 August 2012 and incorporated QA feedback

Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de>

Test plan:
- Verified database update added system preference correctly,
  pref defaults to OFF
- Verified search results and detail pages in OPAC and staff
  still worked the same as before
  * for no results
  * with results
- Activated system preference and tested various searches
  * Searches from simple search
  * Searches from advanced search
  * Search links in records
- Deactivated Javascript - verified fallback works correctly

Notes:

- Suggested terms can include autorities with no linked records.
- When combining more than one search option using advanced search
  this results in "no suggestions" more often. Feature works best
  from simple search.

Overall great feature making use of authorities in a user friendly way!

Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>
Rebased on latest master 2012-09-10
Signed-off-by: wajasu <matted-34813@mypacks.net>
2012-09-13 11:34:28 +02:00

181 lines
7 KiB
Text

Searching:
Features:
-
- pref: NoZebra
choices:
yes: "Don't use"
no: Use
- the Zebra search engine. It is recommended to use Zebra; the option to not use Zebra is deprecated and is not guaranteed to work.
-
- When Zebra is not in use, translate the following MARC fields to the following indexes (each line should look something like <code>'indexname' =&gt; '100a,245a,500*',</code>)
- pref: NoZebraIndexes
type: textarea
class: list
-
-
- 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>; REQUIRES ZEBRA).
-
- pref: QueryRemoveStopwords
type: boolean
choices:
yes: Ignore
no: "Don't ignore"
- stopwords specified in Koha when searching. (Only applies when Zebra is off).
-
- 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: 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 Client 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: DidYouMeanFromAuthorities
default: 0
choices:
yes: Suggest
no: "Don't suggest"
- alternate searches based on data in the authority file.
Search Form:
-
- Show tabs in OPAC and staff-side 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>)."
-
- By default,
- pref: expandedSearchOption
type: boolean
choices:
yes: show
no: "don't show"
- '"More options" on the OPAC and staff advanced search pages.'
Results Display:
-
- By default, sort search results in the staff client 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 client.
-
- 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 biblio in the search results
-
- Build facets based on
- pref: maxRecordsForFacets
class: integer
default: 20
- records from the search results.
-
- By default, show
- pref: OPACnumSearchResults
class: integer
- results per page in the OPAC.
-
- 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.