Bug 34979: Fix mistakes in system preference files highlighted by unit test
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / searching.pref
1 Searching:
2     Features:
3         -
4             - Perform wildcard searching (where, for example, <cite>Har</cite> would match <cite>Harry</cite> and <cite>harp</cite>)
5             - pref: QueryAutoTruncate
6               type: boolean
7               choices:
8                   1: automatically.
9                   0: only if * is added.
10             - "<br />(The * character would be used like so: <cite>Har*</cite> or <cite>*logging</cite>.)"
11         -
12             - pref: QueryFuzzy
13               type: boolean
14               choices:
15                   1: Try
16                   0: "Don't try"
17             - 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.).
18         -
19             - pref: QueryStemming
20               type: boolean
21               choices:
22                   1: Try
23                   0: "Don't try"
24             - 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).
25         -
26             - pref: QueryWeightFields
27               type: boolean
28               choices:
29                   1: Enable
30                   0: Disable
31             - ranking of search results by relevance (REQUIRES ZEBRA).
32         -
33             - pref: QueryRegexEscapeOptions
34               default: escape
35               choices:
36                   escape: Escape
37                   unescape_escaped: Unescape escaped
38                   dont_escape: Don't escape
39             - "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.)"
40         -
41             - pref: TraceCompleteSubfields
42               default: 0
43               choices:
44                   1: Force
45                   0: "Don't force"
46             - subject tracings in the OPAC and staff interface to search only for complete-subfield matches.
47         -
48             - pref: TraceSubjectSubdivisions
49               default: 0
50               choices:
51                   1: Include
52                   0: "Don't include"
53             - subdivisions for searches generated by clicking on subject tracings.
54         -
55             - pref: UseICUStyleQuotes
56               default: 0
57               choices:
58                   1: Use
59                   0: "Don't use"
60             - 'ICU style quotes ({}) when tracing subjects. The default is to use standard quotes ("").'
61         -
62             - pref: IncludeSeeFromInSearches
63               default: 0
64               choices:
65                   1: Include
66                   0: "Don't include"
67             - "<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."
68         -
69             - pref: EnableSearchHistory
70               default: 0
71               choices:
72                   1: Keep
73                   0: "Don't keep"
74             - patron search history in the staff interface.
75         -
76             - pref: BrowseResultSelection
77               default: 0
78               choices:
79                   1: Enable
80                   0: Disable
81             - "browsing search results from the bibliographic record detail page in staff interface."
82         -
83             - pref: ElasticsearchCrossFields
84               default: 0
85               choices:
86                   1: Enable
87                   0: Disable
88             - "the cross_fields option for Elasticsearch searches, supported in Elasticsearch 6.X and above."
89             - "See documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#type-cross-fields"
90         -
91             - pref: SavedSearchFilters
92               default: 0
93               choices:
94                   1: Enable
95                   0: Disable
96             - "the option for staff with permission to create/edit custom saved search filters."
97     Search form:
98         -
99             - pref: LoadSearchHistoryToTheFirstLoggedUser
100               default: 0
101               choices:
102                    1: "Add"
103                    0: "Don't add"
104             - search history of the unlogged user to the next patron logging in.
105         -
106             - Show tabs in the staff interface advanced search for limiting searches on the
107             - pref: AdvancedSearchTypes
108               class: long
109             - "fields (separate values with |). Tabs appear in the order listed.<br/>"
110             - "<em>Currently supported values</em>: Item types (<strong>itemtypes</strong>), Collection, (<strong>ccode</strong>) and Shelving location (<strong>loc</strong>)."
111         -
112             - Limit the languages listed in the advanced search drop-down to the
113             - pref: AdvancedSearchLanguages
114               class: long
115             - "ISO 639-2 language codes (separate values with | or ,)."
116             - "For example, to limit listing to French and Italian, enter <em>ita|fre</em>."
117         -
118             - By default,
119             - pref: expandedSearchOption
120               type: boolean
121               choices:
122                   1: show
123                   0: "don't show"
124             - '"More options" on the OPAC and staff interface advanced search pages.'
125         -
126             - By default,
127             - pref: OPACNumbersPreferPhrase
128               type: boolean
129               choices:
130                   1: use
131                   0: "don't use"
132             - 'the operator "phr" in the callnumber and standard number OPAC searches.'
133         -
134             - By default,
135             - pref: IntranetNumbersPreferPhrase
136               type: boolean
137               choices:
138                   1: use
139                   0: "don't use"
140             - 'the operator "phr" in the callnumber and standard number staff interface searches.'
141     Results display:
142         -
143             - pref: numSearchResultsDropdown
144               type: boolean
145               default: no
146               choices:
147                   1: Show
148                   0: "Don't show"
149             - results per page dropdown on staff interface search results.
150         -
151             - pref: OPACnumSearchResultsDropdown
152               type: boolean
153               default: no
154               choices:
155                   1: Show
156                   0: "Don't show"
157             - results per page dropdown on OPAC search results.
158         -
159             - By default, sort search results in the staff interface by
160             - pref: defaultSortField
161               default: relevance
162               choices:
163                   relevance: relevance
164                   popularity: total number of checkouts
165                   call_number: call number
166                   pubdate: date of publication
167                   acqdate: date added
168                   title: title
169                   author: author
170             - ','
171             - pref: defaultSortOrder
172               choices:
173                   asc: ascending.
174                   dsc: descending.
175                   az: from A to Z.
176                   za: from Z to A.
177         -
178             - By default, sort search results from author links in MARC21 detail pages and result lists by
179             - pref: AuthorLinkSortBy
180               default: default
181               choices:
182                   default: default sort field and order specified in defaultSortField or OPACdefaultSortField
183                   call_number: call number
184                   pubdate: date of publication
185                   acqdate: date added
186                   title: title
187             - ','
188             - pref: AuthorLinkSortOrder
189               choices:
190                   asc: ascending
191                   dsc: descending
192                   az: from A to Z
193                   za: from Z to A
194             - .
195         -
196             - When limiting search results with a library or library group, limit by the item's
197             - pref: SearchLimitLibrary
198               choices:
199                   homebranch: "home library."
200                   holdingbranch: "holding library."
201                   both: "home library and holding library."
202         -
203             - pref: displayFacetCount
204               type: boolean
205               default: no
206               choices:
207                   1: Show
208                   0: "Don't show"
209             - 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.
210         -
211             - By default, show
212             - pref: numSearchResults
213               class: integer
214             - results per page in the staff interface.
215         -
216             - For records with many items, only check the availability status for the first
217             - pref: MaxSearchResultsItemsPerRecordStatusCheck
218               class: integer
219             - items.
220             - <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.
221             - <br/>Leave empty for no limit.
222         -
223             - By default, sort search results in the OPAC by
224             - pref: OPACdefaultSortField
225               default: relevance
226               choices:
227                   relevance: relevance
228                   popularity: total number of checkouts
229                   call_number: call number
230                   pubdate: date of publication
231                   acqdate: date added
232                   title: title
233                   author: author
234             - ","
235             - pref: OPACdefaultSortOrder
236               choices:
237                   asc: ascending.
238                   dsc: descending.
239                   az: from A to Z.
240                   za: from Z to A.
241             -
242         -
243             - Show up to
244             - pref: maxItemsInSearchResults
245               class: integer
246             - items per bibliographic record in the search results
247         -
248             - Build facets based on
249             - pref: maxRecordsForFacets
250               class: integer
251               default: 20
252             - records from the search results.
253         -
254             - Show up to
255             - pref: FacetMaxCount
256               class: integer
257               default: 20
258             - facets for each category.
259         -
260             - Sort facets
261             - pref: FacetOrder
262               type: choice
263               choices:
264                   Alphabetical: "alphabetically"
265                   Usage: "by usage count"
266               default: Alphabetical
267             - for each category.
268         -
269             - By default, show
270             - pref: OPACnumSearchResults
271               class: integer
272             - results per page in the OPAC.
273         -
274             - "Show facets for"
275             - pref: DisplayLibraryFacets
276               type: choice
277               choices:
278                   home: "home library"
279                   holding: "holding library"
280                   both: "both home and holding library"
281         -
282             - Truncate facets length to
283             - pref: FacetLabelTruncationLength
284               class: integer
285             - characters, in OPAC/staff interface (REQUIRES ZEBRA).
286         -
287             - Use the following text as separator for UNIMARC authors facets
288             - pref: UNIMARCAuthorsFacetsSeparator
289               class: short
290         -
291             - When searching on the ISBN index,
292             - pref: SearchWithISBNVariations
293               choices:
294                   1: "search"
295                   0: "don't search"
296             - on all variations of the ISBN.
297         -
298             - When searching on the ISSN index,
299             - pref: SearchWithISSNVariations
300               choices:
301                   1: "search"
302                   0: "don't search"
303             - on all variations of the ISSN.
304         -
305             - pref: RetainCatalogSearchTerms
306               choices:
307                   0: "Don't retain"
308                   1: "Retain"
309             - search terms between searches when searching from the 'search the catalog' tab in the staff interface header.
310         -
311             - pref: RetainPatronsSearchTerms
312               choices:
313                   0: "Don't retain"
314                   1: "Retain"
315             - search terms between searches when searching from the 'checkout' and 'search patrons' tab in the staff interface header.
316         -
317             - pref: BiblioItemtypeInfo
318               choices:
319                   1: "Show"
320                   0: "Don't show"
321             - ' 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.'
322         -
323             - pref: PassItemMarcToXSLT
324               type: boolean
325               choices:
326                   1: Do
327                   0: "Don't"
328             - "make item MARC fields (MARC21 952, UNIMARC 995) available to XSLT stylesheets for OPAC and staff interface results pages."
329             - "<br/>Default is \"Don't\", items are displayed using other methods."
330         -
331             - pref: ShowHeadingUse
332               choices:
333                   1: Show
334                   0: "Don't show"
335             - "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."
336     Did you mean/spell checking:
337         -
338             - "Swedish service for spellchecking.<br/>"
339             - LIBRIS Spellchecking API key
340             - pref: LibrisKey
341             - "Can be obtained at http://api.libris.kb.se/bibspell."
342         -
343             - LIBRIS base URL
344             - pref: LibrisURL
345               class: url
346             - "Please only change this if you are sure it needs changing."