Bug 20334: Improve syspref description and set more sensible defaults
[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                   yes: automatically.
9                   no: 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                   yes: Try
16                   no: "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>; REQUIRES ZEBRA).
18         -
19             - pref: QueryStemming
20               type: boolean
21               choices:
22                   yes: Try
23                   no: "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                   yes: Enable
30                   no: 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: OpacGroupResults
42               default: 0
43               choices:
44                   yes: Use
45                   no: "Don't use"
46             - PazPar2 to group similar results on the OPAC. This requires that PazPar2 is set up and running.
47         -
48             - pref: TraceCompleteSubfields
49               default: 0
50               choices:
51                   yes: Force
52                   no: "Don't force"
53             - subject tracings in the OPAC and Staff Client to search only for complete-subfield matches.
54         -
55             - pref: TraceSubjectSubdivisions
56               default: 0
57               choices:
58                   yes: Include
59                   no: "Don't include"
60             - subdivisions for searches generated by clicking on subject tracings.
61         -
62             - pref: UseICU
63               default: 0
64               choices:
65                   yes: Using
66                   no: "Not using"
67             - '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.'
68         -
69             - pref: UseQueryParser
70               default: 1
71               choices:
72                   yes: Try
73                   no: "Do not try"
74             - 'to use the QueryParser module for parsing queries. Please note: enabling this will have no impact if you do not have QueryParser installed, and everything will continue to work as usual.'
75         -
76             - pref: IncludeSeeFromInSearches
77               default: 0
78               choices:
79                   yes: Include
80                   no: "Don't include"
81             - "<i>see from</i> (non-preferred form) headings in bibliographic searches. Please note: you will need to reindex your bibliographic database when changing this preference."
82         -
83             - pref: EnableSearchHistory
84               default: 0
85               choices:
86                   yes: Keep
87                   no: "Don't keep"
88             - patron search history in the staff client.
89         -
90             - pref: BrowseResultSelection
91               default: 0
92               choices:
93                   yes: Enable
94                   no: Disable
95             - "browsing search results from the bibliographic record detail page in staff client."
96     Search Form:
97         -
98             - Load the unlogged history to the next user.
99             - pref : LoadSearchHistoryToTheFirstLoggedUser
100               default: 0
101               choices:
102                    yes: "Load"
103                    no : "Don't load"
104             - history to the next client.
105         -
106             - Show tabs in OPAC and staff-side 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 Codes (<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                   yes: show
123                   no: "don't show"
124             - '"More options" on the OPAC and staff advanced search pages.'
125         -
126             - By default,
127             - pref: OPACNumbersPreferPhrase
128               type: boolean
129               choices:
130                   yes: use
131                   no: "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                   yes: use
139                   no: "don't use"
140             - 'the operator "phr" in the callnumber and standard number staff client searches'
141     Results Display:
142         -
143             - By default, sort search results in the staff client by
144             - pref: defaultSortField
145               default: relevance
146               choices:
147                   relevance: relevance
148                   popularity: total number of checkouts
149                   call_number: call number
150                   pubdate: date of publication
151                   acqdate: date added
152                   title: title
153                   author: author
154             - ','
155             - pref: defaultSortOrder
156               choices:
157                   asc: ascending.
158                   dsc: descending.
159                   az: from A to Z.
160                   za: from Z to A.
161         -
162             - pref: displayFacetCount
163               type: boolean
164               default: no
165               choices:
166                   yes: Show
167                   no: "Don't show"
168             - facet counts. The relevance of these numbers highly depends on the value of the maxRecordsForFacets preference. Applies to OPAC and staff interface.
169         -
170             - By default, show
171             - pref: numSearchResults
172               class: integer
173             - results per page in the staff client.
174         -
175             - For records with many items, only check the availability status for the first
176             - pref: MaxSearchResultsItemsPerRecordStatusCheck
177               class: integer
178             - items.
179             - <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.
180             - <br/>Leave empty for no limit.
181         -
182             - By default, sort search results in the OPAC by
183             - pref: OPACdefaultSortField
184               default: relevance
185               choices:
186                   relevance: relevance
187                   popularity: total number of checkouts
188                   call_number: call number
189                   pubdate: date of publication
190                   acqdate: date added
191                   title: title
192                   author: author
193             - ","
194             - pref: OPACdefaultSortOrder
195               choices:
196                   asc: ascending.
197                   dsc: descending.
198                   az: from A to Z.
199                   za: from Z to A.
200             -
201         -
202             - Show up to
203             - pref: maxItemsInSearchResults
204               class: integer
205             - items per bibliographic record in the search results
206         -
207             - Build facets based on
208             - pref: maxRecordsForFacets
209               class: integer
210               default: 20
211             - records from the search results.
212         -
213             - Show up to
214             - pref: FacetMaxCount
215               class: integer
216               default: 20
217             - facets for each category.
218         -
219             - By default, show
220             - pref: OPACnumSearchResults
221               class: integer
222             - results per page in the OPAC.
223         -
224             - "Show facets for"
225             - pref: DisplayLibraryFacets
226               type: choice
227               choices:
228                   home: "home library"
229                   holding: "holding library"
230                   both: "both home and holding library"
231         -
232             - pref: OPACItemsResultsDisplay
233               type: boolean
234               choices:
235                   yes: Show
236                   no: "Don't show"
237             - "an item's library, location and call number in OPAC search results."
238         -
239             - Truncate facets length to
240             - pref: FacetLabelTruncationLength
241               class: integer
242             - characters, in OPAC/staff interface.
243         -
244             - Use the following text as separator for UNIMARC authors facets
245             - pref: UNIMARCAuthorsFacetsSeparator
246               class: short
247         -
248             - When searching on the ISBN index,
249             - pref: SearchWithISBNVariations
250               choices:
251                   yes: "search"
252                   no: "don't search"
253             - on all variations of the ISBN. Note that this preference has no effect if UseQueryParser is on.
254     Did you Mean/Spell checking:
255         -
256             - "Swedish service for spellchecking.<br/>"
257             - LIBRIS Spellchecking API key
258             - pref: LibrisKey
259             - "Can be obtained at http://api.libris.kb.se/bibspell."
260         -
261             - LIBRIS base URL
262             - pref: LibrisURL
263             - "Please only change this if you are sure it needs changing."