Docs: making public catalog docs more modular
[Evergreen.git] / docs / opac / using_the_public_access_catalog.adoc
1 Using the Public Access Catalog
2 -------------------------------
3
4 Basic Search
5 ~~~~~~~~~~~~
6
7 indexterm:[OPAC]
8
9 From the OPAC home, you can conduct a basic search of all materials owned by all
10 libraries in your Evergreen system.
11
12 This search can be as simple as typing keywords into the search box and clicking
13 the _Search_ button. Or you can make your search more precise by limiting your 
14 search by fields to search, material type or library location.
15
16 indexterm:[search box]
17
18 The _Homepage_ contains a single search box for you to enter search terms. You 
19 can get to the _Homepage_ at any time by clicking the _Another Search_ link from
20 the leftmost link on the bar above your search results in the catalogue, or you 
21 can enter a search anywhere you see a search box.
22
23 You can select to search by:
24
25 indexterm:[search, keyword]
26 indexterm:[search, title]
27 indexterm:[search, journal title]
28 indexterm:[search, author]
29 indexterm:[search, subject]
30 indexterm:[search, series]
31 indexterm:[search, bib call number]
32
33 * *Keyword*: finds the terms you enter anywhere in the entire record for an 
34 item, including title, author, subject, and other information.
35
36 * *Title*: finds the terms you enter in the title of an item.
37
38 * *Journal Title*: finds the terms you enter in the title of a serial bib 
39 record.
40
41 * *Author*: finds the terms you enter in the author of an item.
42
43 * *Subject*: finds the terms you enter in the subject of an item. Subjects are 
44 categories assigned to items according to a system such as the Library of 
45 Congress Subject Headings.
46
47 * *Series*: finds the terms you enter in the title of a multi-part series.
48
49 [TIP]
50 =============
51 To search an item copy call number, use <<numeric_search, _Advanced Search: 
52 Numeric_>> 
53 =============
54
55 Formats
56 ^^^^^^^
57
58 You can limit your search by formats based on MARC fixed field type:
59
60 indexterm:[formats, books]
61 indexterm:[formats, audiobooks]
62 indexterm:[formats, video]
63 indexterm:[formats, music]
64
65
66 * *All Books*
67 * *All Music*
68 * *Audiocassette music recording*
69 * *Blu-ray* 
70 * *Braille*
71 * *Cassette audiobook*
72 * *CD Audiobook*
73 * *CD Music recording*
74 * *DVD* 
75 * *E-audio* 
76 * *E-book*
77 * *E-video* 
78 * *Equipment, games, toys*
79 * *Kit*
80 * *Large Print Book*
81 * *Map*
82 * *Microform*
83 * *Music Score*
84 * *Phonograph music recording*
85 * *Phonograph spoken recording*
86 * *Picture*
87 * *Serials and magazines*
88 * *Software and video games*
89 * *VHS*
90
91
92 Libraries
93 +++++++++
94
95 If you are using a catalogue in a library or accessing a library’s online 
96 catalogue from its homepage, the search will return items for your local 
97 library. If your library has multiple branches, the result will display items 
98 available at your branch and all branches of your library system separately.
99
100
101 Advanced Search
102 ~~~~~~~~~~~~~~~
103
104 Advanced searches allow users to perform more complex searches by providing more
105 options. Many kinds of searches can be performed from the _Advanced Search_ 
106 screen. You can access by clicking _Advanced Search_ on the catalogue _Homepage_
107 or search results screen.
108
109 The available search options are the same as on the basic search. But you may 
110 use one or many of them simultaneously. If you want to combine more than three 
111 search options, use _Add Search Row_ button to add more search input rows. 
112 Clicking the _X_ button will close the search input row.
113
114
115 Sort Results
116 ^^^^^^^^^^^^
117
118 indexterm:[advanced search, sort results]
119
120 By default, the search results are in order of greatest to least relevance, see
121  <<order_of_results, Order of Results>>. In the sort results menu you may select
122  to order the search results by relevance, title, author, or publication date.
123
124
125 Search Library
126 ^^^^^^^^^^^^^^
127
128 indexterm:[advanced search, search library]
129
130 The current search library is displayed under _Search Library_ drop down menu. 
131 By default it is your library. The search returns results for your local library
132 only. If your library system has multiple branches, use the _Search Library_ box
133 to select different branches or the whole library system.
134
135
136 Limit to Available
137 ^^^^^^^^^^^^^^^^^^
138
139 indexterm:[advanced search, limit to available]
140
141
142 This checkbox is at the bottom line of _Search Library_. Select _Limit to 
143 Available_ to limit results to those titles that have items with a circulation 
144 status of "available" (by default, either _Available_ or _Reshelving_).
145
146 Exclude Electronic Resources
147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
148
149 indexterm:[advanced search, exclude electronic resources]
150
151 This checkbox is below _Limit to Available_.  Select _Exclude Electronic 
152 Resources_ to limit results to those bibliographic records that do not have an 
153 "o" or "s" in the _Item Form_ fixed field (electronic forms) and overrides other
154 form limiters. 
155
156 This feature is optional and will not appear for patrons or staff until enabled.
157
158 [TIP]
159 ===============
160 To display the *Exclude Electronic Resources* checkbox in the advance search 
161 page and search results, set
162 the 'ctx.exclude_electronic_checkbox' setting in config.tt2 to 1.
163 ===============
164
165
166 Search Filter
167 ^^^^^^^^^^^^^
168
169 indexterm:[advanced search, search filters]
170
171 You can filter your search by _Item Type_, _Item Form_, _Language_, _Audience_, 
172 _Video Format_, _Bib Level_, _Literary Form_, _Search Library_, and _Publication
173 Year_. Publication year is inclusive. For example, if you set _Publication Year_
174 Between 2005 and 2007, your results can include items published in 2005, 2006 
175 and 2007.
176
177 For each filter type, you may select multiple criteria by holding down the
178  _CTRL_ key as you click on the options. If nothing is selected for a filter, 
179 the search will return results as though all options are selected.
180
181 Search Filter Enhancements
182 ++++++++++++++++++++++++++
183
184 Enhancements to the Search Filters now makes it easier to view, remove, and modify search filters while viewing search results in the Evergreen OPAC.  Filters that are selected while conducting an advanced search in the Evergreen OPAC now appear below the search box in the search results interface.
185
186 For example, the screenshot below shows a Keyword search for "violin concerto" while filtering on Item Type: Musical sound recording and Shelving Location: Music.
187
188 image::media/searchfilters1.PNG[search using search filters]
189
190 In the search results, the Item Type and Shelving Location filters appear directly below the search box.
191
192 image::media/searchfilters2.PNG[search results with search filter enhancements]
193
194 Each filter can be removed by clicking the X next to the filter name to modify the search within the search results screen.  Below the search box on the search results screen, there is also a link to _Refine My Original Search_, which will bring the user back to the advanced search screen where the original search parameters selected can be viewed and modified.
195
196
197 anchor:numeric_search[]
198 indexterm:[advanced search, numeric search]
199
200 Numeric Search
201 ^^^^^^^^^^^^^^
202
203 If you have details on the exact item you wish to search for, use the _Numeric 
204 Search_ tab on the advanced search page. Use the drop-down menu to select your 
205 search by _ISBN_, _ISSN_, _Bib Call Number_, _Call Number (Shelf Browse)_, 
206 _LCCN_, _TCN_, or _Item Barcode_. Enter the information and then click the 
207 _Search_ button.
208
209 Expert Search
210 ^^^^^^^^^^^^^
211
212 indexterm:[advanced search, expert search]
213
214 If you are familiar with MARC cataloging, you may search by MARC tag in the 
215 _Expert Search_ option on the left of the screen. Enter the three-digit tag 
216 number, the subfield if relevant, and the value or text that corresponds to the 
217 tag. For example, to search by publisher name, enter `260 b Random House`. To 
218 search several tags simultaneously, use the _Add Row_ option. Click _Submit_ to 
219 run the search. 
220
221 [TIP]
222 =============
223 Use the MARC Expert Search only as a last resort, as it can take much longer to 
224 retrieve results than by using indexed fields. For example, rather than running 
225 an expert search for "245 a Gone with the wind", simply do a regular title 
226 search for "Gone with the wind".
227 =============
228
229 Boolean operators
230 ~~~~~~~~~~~~~~~~~
231
232 indexterm:[search, AND operator]
233 indexterm:[search, OR operator]
234 indexterm:[search, NOT operator]
235 indexterm:[search, boolean]
236
237 Classic search interfaces (that is, those used primarily by librarians) forced 
238 users to learn the art of crafting search phrases with Boolean operators. To a 
239 large extent this was due to the inability of those systems to provide relevancy
240 ranking beyond a "last in, first out" approach. Thankfully, Evergreen, like most
241 modern search systems, supports a rather sophisticated relevancy ranking system 
242 that removes the need for Boolean operators in most cases.
243
244 By default, all terms that have been entered in a search query are joined with 
245 an implicit `AND` operator. Those terms are required to appear in the designated
246  fields to produce a matching record: a search for _golden compass_ will search 
247 for entries that contain both _golden_ *and* _compass_. 
248
249 Words that are often considered Boolean operators, such as _AND_, _OR_, and 
250 _NOT_, are not special in Evergreen: they are treated as just another search 
251 term. For example, a title search for `golden and compass` will not return the 
252 title _Golden Compass_. 
253
254 However, Evergreen does support Boolean searching for those rare cases where you
255 might require it, using symbolic operators as follows:
256
257 .Boolean symbolic operators
258 [width="50%",options="header"]
259 |=================================
260 | Operator | Symbol    | Example
261 | AND      | `&&`      | `a && b`
262 | OR       | `\|\|`      | `a \|\| b`
263 | NOT      | `-`_term_ | `a -b`
264 |=================================
265
266 Search Tips
267 ~~~~~~~~~~~
268
269 indexterm:[search, stop words]
270 indexterm:[search, truncation]
271
272 Evergreen tries to approach search from the perspective of a major search 
273 engine: the user should simply be able to enter the terms they are looking for 
274 as a general keyword search, and Evergreen should return results that are most 
275 relevant given those terms. For example, you do not need to enter author's last 
276 name first, nor do you need to enter an exact title or subject heading. 
277 Evergreen is also forgiving about plurals and alternate verb endings, so if you 
278 enter _dogs_, Evergreen will also find items with _dog_. 
279
280 The search engine has no _stop words_ (terms are ignored by the search engine): 
281 a title search for `to be or not to be` (in any order) yields a list of titles 
282 with those words. 
283
284 * Don’t worry about white space, exact punctuation, or capitalization. 
285
286 . White spaces before or after a word are ignored. So, a search for `[ golden 
287 compass ]` gives the same results as a search for `[golden compass]`.
288
289 . A double dash or a colon between words is reduced to a blank space. So, a 
290 title search for _golden:compass_ or _golden -- compass_ is equivalent to 
291 _golden compass_. 
292
293 . Punctuation marks occurring within a word are removed; the exception is \_. 
294 So, a title search for _gol_den com_pass_ gives no result. 
295
296 . Diacritical marks and solitary `&` or `|` characters located anywhere in the 
297 search term are removed. Words or letters linked together by `.` (dot) are 
298 joined together without the dot. So, a search for _go|l|den & comp.ass_ is 
299 equivalent to _golden compass_. 
300
301 . Upper and lower case letters are equivalent. So, _Golden Compass_ is the same 
302 as _golden compass_. 
303
304 * Enter your search words in any order. So, a search for _compass golden_ gives 
305 the same results as a search for _golden compass_. Adding more search words 
306 gives fewer but more specific results. 
307
308 ** This is also true for author searches. Both _David Suzuki_ and _Suzuki, 
309 David_ will return results for the same author. 
310
311 * Use specific search terms. Evergreen will search for the words you specify, 
312 not the meanings, so choose search terms that are likely to appear in an item 
313 description. For example, the search _luxury hotels_ will produce more 
314 relevant results than _nice places to stay_.
315
316 * Search for an exact phrase using double-quotes. For example ``golden compass''. 
317
318 ** The order of words is important for an exact phrase search. _golden compass_ 
319 is different than _compass golden_. 
320
321 ** White space, punctuation and capitalization are removed from exact phrases as
322  described above. So a phrase retains its search terms and its relative order, 
323 but not special characters and not case. 
324
325 ** Two phrases are joined by and, so a search for _"golden compass"_ _"dark 
326 materials"_ is equivalent to _golden compass_ *and* _dark materials_. 
327
328
329 * **Truncation**
330 Words may be right-hand truncated using an asterisk. Use a single asterisk * to 
331 truncate any number of characters.
332 (example: _environment* agency_)
333
334
335 Search Methodology
336 ~~~~~~~~~~~~~~~~~~
337
338 anchor:stemming[]
339
340 Stemming 
341 ^^^^^^^^
342
343 indexterm:[search, stemming]
344
345 A search for _dogs_ will also return hits with the word dog and a search for 
346 parenting will return results with the words parent and parental. This is 
347 because the search uses stemming to help return the most relevant results. That 
348 is, words are reduced to their stem (or root word) before the search is 
349 performed. 
350
351 The stemming algorithm relies on common English language patterns - like verbs 
352 ending in _ing_ - to find the stems. This is more efficient than looking up each
353 search term in a dictionary and usually produces desirable results. However, it 
354 also means the search will sometimes reduce a word to an incorrect stem and 
355 cause unexpected results. To prevent a word or phrase from stemming, put it in 
356 double-quotes to force an exact search. For example, a search for `parenting` 
357 will also return results for `parental`, but a search for `"parenting"` will 
358 not.
359
360 Understanding how stemming works can help you to create more relevant searches, 
361 but it is usually best not to anticipate how a search term will be stemmed. For 
362 example, searching for `gold compass` does not return the same results as 
363 `golden compass`, because `-en` is not a regular suffix in English, and 
364 therefore the stemming algorithm does not recognize _gold_ as a stem of 
365 _golden_. 
366
367
368 anchor:order_of_results[]
369
370 Order of Results
371 ^^^^^^^^^^^^^^^^
372
373 indexterm:[search, order of results]
374
375 By default, the results are listed in order of relevance, similar to a search 
376 engine like Google. The relevance is determined using a number of factors, 
377 including how often and where the search terms appear in the item description, 
378 and whether the search terms are part of the title, subject, author, or series. 
379 The results which best match your search are returned first rather than results 
380 appearing in alphabetical or chronological order. 
381
382 In the _Advanced Search_ screen, you may select to order the search results by 
383 relevance, title, author, or publication date before you start the search. You 
384 can also re-order your search results using the _Sort Results_ dropdown list on 
385 the search result screen.
386
387
388 Search Results
389 ~~~~~~~~~~~~~~
390
391 indexterm:[search results]
392
393 The search results are a list of relevant works from the catalogue. If there are
394 many results, they are divided into several pages. At the top of the list, you 
395 can see the total number of results and go back and forth between the pages 
396 by clicking the links that say _Previous_ or _Next_ on top or bottom of the 
397 list. You can also click on the adjacent results page number listed. These page 
398 number links allow you to skip to that results page, if your search results 
399 needed multiple pages to display. Here is an example: 
400
401
402 image::media/catalogue-3.png[catalogue-3]
403
404 Brief information about the title, such as author, edition, publication date, 
405 etc. is displayed under each title. The icons beside the brief information 
406 indicate formats such as books, audio books, video recordings, and other 
407 formats. If you hover your mouse over the icon, a text explanation will show up 
408 in a small pop-up box. 
409
410 Clicking a title goes to the title details. Clicking an author searches all 
411 works by the author. If you want to place a hold on the title, click _Place 
412 Hold_ beside the format icons.
413
414 On the top right, there is a _Limit to Available_ checkbox. Checking this box 
415 will filter out those titles with no available copies in the library or 
416 libraries at the moment. Usually you will see your search results are 
417 re-displayed with fewer titles. 
418
419 When enabled, under the _Limit to Available_ checkbox, there is an _Exclude 
420 Electronic Resources_ checkbox.  Checking this box will filter out materials 
421 that are cataloged as electronic in form.
422
423 The _Sort by_ dropdown list is found at the top of the search results, beside 
424 the _Show More Details_ link. Clicking an entry on the list will re-sort your 
425 search results accordingly.
426
427
428 Facets: Subjects, Authors, and Series
429 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
430
431 indexterm:[search results, facets: subjects, authors, and series]
432
433 At the left, you may see a list of _Facets of Subjects_, _Authors_, and 
434 _Series_. Selecting any one of these links filters your current search results 
435 using that subject, author, or series to narrow done your current results. The 
436 facet filters can be undone by clicking the link a second time, thus returning 
437 your original results before the facet was activated. 
438
439 image::media/catalogue-5.png[catalogue-5]
440
441
442 Availability
443 ^^^^^^^^^^^^
444
445 indexterm:[search results, availability]
446
447 The number of available copies and total copies are displayed under each search 
448 result's call number. If you are using a catalogue inside a library or accessing
449 a library’s online catalogue from its homepage, you will see how many copies are
450 available in the library under each title, too. If the library belongs to a 
451 multi-branch library system you will see an extra row under each title showing 
452 how many copies are available in all branches.
453
454
455 image::media/catalogue-6.png[catalogue-6]
456
457 image::media/catalogue-7.png[catalogue-7]
458
459 You may also click the _Show More Details_ link at the top of the results page, 
460 next to the _Limit to available items_ check box, to view each search result's 
461 copies' individual call number, status, and shelving location. 
462
463
464 Viewing a record
465 ^^^^^^^^^^^^^^^^
466
467 indexterm:[search results, viewing a record]
468
469 Click on a search result's title to view a detailed record of the title, 
470 including descriptive information, location and availability, current holds, and
471 options for placing holds, add to my list, and print/email. 
472
473 image::media/catalogue-8.png[catalogue-8]
474 image::media/catalogue-8a.png[catalogue-8a]
475
476 Details
477 ~~~~~~~
478
479 indexterm:[search results, details]
480
481 The record shows details such as the cover image, title, author, publication
482 information, and an abstract or summary, if available.
483
484 Near the top of the record, users can easily see the number of copies that
485 are currently available in the system and how many curent holds are on the
486 title. 
487
488 If there are other formats and editions of the same work in the 
489 database, links to those alternate formats will display. The formats used
490 in this section are based on the configurable catalog icon formats.
491
492
493 image::media/other-formats-and-editions.png[other-formats-and-editions]
494
495 The Record Details view shows how many copies are at the library or libraries
496 you have selected, and whether they are available or checked out. It also
497 displays the Call number and Copy Location for locating the item on the shelves.
498 Clicking on Text beside the call number will allow you to send the item's call
499 number by text message, if desired. Clicking the location library link will
500 reveal information about owning library, such as address and open hours.
501
502 Below the local details you can open up various tabs to display more
503 information. You can select Reviews and More to see the book’s summaries and
504 reviews, if available. You can select Shelf Browser to view items appearing near
505 the current item on the library shelves. Often this is a good way to browse for
506 similar items. You can select MARC Record to display the record in MARC format. 
507 If your library offers the service, clicking on Awards, Reviews, and Suggested
508 Reads will reveal that additional information.
509
510 [NOTE]
511 ==========
512 Copies are sorted by (in order): org unit, call number, part label, copy number,
513 and barcode.
514 ==========
515
516
517
518 Placing Holds 
519 ^^^^^^^^^^^^^
520
521 indexterm:[search results, placing holds]
522
523 Holds can be placed on either title results or search results page. If the item 
524 is available, it will be pulled from the shelf and held for you. If all copies 
525 at your local library are checked out, you will be placed on a waiting list and 
526 you will be notified when items become available. 
527
528 On title details page, you can select the _Place Hold_ link in the upper right 
529 corner of the record to reserve the item. You will need your library account 
530 user name and password. You may choose to be notified by phone or email.
531
532 In the example below, the phone number in your account will automatically show 
533 up. Once you select the Enable phone notifications for this hold checkbox, you 
534 can supply a different phone number for this hold only. The notification method 
535 will be selected automatically if you have set it up in your account references.
536 But you still have a chance to re-select on this screen. You may also suspend
537 the hold temporarily by checking the Suspend box. Click the _Help_ beside it for
538 details. 
539
540 You can view and cancel a hold at anytime. Before your hold is captured, which 
541 means an item has been held waiting for you to pick up, you can edit, suspend or
542  activate it. You need log into your patron account to do it. 
543 From your account you can also set up a _Cancel if not filled by_ date for your 
544 hold. _Cancel if not filled by_ date means after this date, even though your 
545 hold has not been fulfilled you do not need the item anymore.
546
547
548 image::media/catalogue-9.png[catalogue-9]
549
550 Permalink 
551 ^^^^^^^^^
552
553 The record summary page offers a link to a shorter permalink that
554  can be used for sharing the record with others. All URL parameters are stripped
555  from the link with the exception of the locg and copy_depth parameters. Those
556  parameters are maintained so that people can share a link that displays just
557  the holdings from one library/system or displays holdings from all libraries
558  with a specific library's holdings floating to the top.
559
560 image::media/using-opac-view-permalink.png[Permalink]
561
562
563 SMS Call Number
564 ^^^^^^^^^^^^^^^
565
566 If configured by the library system administrator, you may send yourself the 
567 call number via SMS message by clicking on the *Text* link, which appears beside
568 the call number.
569
570 image::media/textcn1.png[]
571
572 [WARNING]
573 ==========
574 Carrier charges may apply when using the SMS call number feature.
575 ==========
576
577
578 Going back 
579 ^^^^^^^^^^
580
581 indexterm:[search results, going back]
582
583 When you are viewing a specific record, you can always go back to your title 
584 list by clicking the link _Search Results_ on the top right or left bottom of 
585 the page. 
586
587 image::media/catalogue-10.png[catalogue-10]
588
589 You can start a new search at any time by entering new search terms in the 
590 search box at the top of the page, or by selecting the _Another Search_ or
591 _Advanced Search_ links in the left-hand sidebar.
592