Koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/searching.pref
Owen Leonard c73967d87c Bug 17018: Split AdvancedSearchTypes for staff and OPAC
This patch adds a new system preference, OpacAdvancedSearchTypes, as an
OPAC-specific version of the AdvancedSearchTypes preference. Values from
AdvancedSearchTypes are copied to OpacAdvancedSearchTypes so that
behavior is consistent.

The patch also alters the output of the "Most popular" page so that:
1. The page heading is correct ("Most popular titles" instead of "Top
issues").
2. The table show both item type and collection whether or not the user
has submitted query with one of those fields as a filter.

To test, apply the patch and run the database update process.

- Go to Administration -> System preferences.
- Search for AdvancedSearchTypes. You should get two results, one for
  the OPAC preference and one for the staff interface.
- Check that the OpacAdvancedSearchTypes settings match the
  AdvancedSearchTypes settings.
- View the advanced search pages in the staff interface and OPAC to
  confirm that the tabs look correct.
- Change the OpacAdvancedSearchTypes and AdvancedSearchTypes settings to
  be different and confirm that each is applied separately to each
  interface.
- Enable the OpacTopissue system preference.
- View the "Most popular" page in the OPAC.
  - The page heading should be correct.
  - The OpacAdvancedSearchTypes settings should be reflected in the
    "Refine your search" sidebar: If "Collection" is checked, a filter
    for collection should appear. If "Item types" is checked, a filter
    for item types should appear.
  - The output of your search should include collection and item type
    regardless of what filters you've submitted.

Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
2022-04-12 17:13:02 +02:00

300 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:
1: automatically.
0: only if * is added.
- "<br />(The * character would be used like so: <cite>Har*</cite> or <cite>*logging</cite>.)"
-
- pref: QueryFuzzy
type: boolean
choices:
1: Try
0: "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:
1: Try
0: "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:
1: Enable
0: 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: TraceCompleteSubfields
default: 0
choices:
1: Force
0: "Don't force"
- subject tracings in the OPAC and staff interface to search only for complete-subfield matches.
-
- pref: TraceSubjectSubdivisions
default: 0
choices:
1: Include
0: "Don't include"
- subdivisions for searches generated by clicking on subject tracings.
-
- pref: UseICUStyleQuotes
default: 0
choices:
1: Use
0: "Don't use"
- 'ICU style quotes ({}) when tracing subjects. The default is to use standard quotes ("").'
-
- pref: IncludeSeeFromInSearches
default: 0
choices:
1: Include
0: "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:
1: Keep
0: "Don't keep"
- patron search history in the staff interface.
-
- pref: BrowseResultSelection
default: 0
choices:
1: Enable
0: Disable
- "browsing search results from the bibliographic record detail page in staff interface."
-
- pref: ElasticsearchCrossFields
default: 0
choices:
1: Enable
0: 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:
1: "Add"
0: "Don't add"
- search history of the unlogged user to the next patron logging in.
-
- Show tabs in the 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, (<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:
1: show
0: "don't show"
- '"More options" on the OPAC and staff interface advanced search pages.'
-
- By default,
- pref: OPACNumbersPreferPhrase
type: boolean
choices:
1: use
0: "don't use"
- 'the operator "phr" in the callnumber and standard number OPAC searches.'
-
- By default,
- pref: IntranetNumbersPreferPhrase
type: boolean
choices:
1: use
0: "don't use"
- 'the operator "phr" in the callnumber and standard number staff interface searches.'
Results display:
-
- pref: numSearchResultsDropdown
type: boolean
default: no
choices:
1: Show
0: "Don't show"
- results per page dropdown on staff interface search results.
-
- pref: OPACnumSearchResultsDropdown
type: boolean
default: no
choices:
1: Show
0: "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.
-
- When limiting search results with a library or library group, limit by the item's
- pref: SearchLimitLibrary
choices:
homebranch: "home library."
holdingbranch: "holding library."
both: "home library and holding library."
-
- pref: displayFacetCount
type: boolean
default: no
choices:
1: Show
0: "Don't show"
- facet counts. The relevance of these numbers highly depends on the value of the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=maxRecordsForFacets">maxRecordsForFacets</a> 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.
-
- Sort facets
- pref: FacetOrder
type: choice
choices:
Alphabetical: "alphabetically"
Usage: "by usage count"
default: Alphabetical
- 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"
-
- 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:
1: "search"
0: "don't search"
- on all variations of the ISBN.
-
- pref: BiblioItemtypeInfo
choices:
1: "Display"
0: "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 <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=item-level_itypes">item-level_itypes</a> system preference is set to bibliographic record.'
-
- pref: PassItemMarcToXSLT
type: boolean
choices:
1: Do
0: "Don't"
- "make item MARC tags available to XSLT stylesheets. Default is \"Don't\", items are displayed using other methods."
-
- pref: ShowHeadingUse
choices:
1: Show
0: "Don't show"
- "whether an authority record contains an established heading that conforms to descriptive cataloguing rules, and can therefore be used as a main/added entry, or subject, or series title."
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."