a0c9c80e0be2c1dd21ce432b057c9974449f88a1
[working/Evergreen.git] / docs / opac / using_the_public_access_catalog.txt
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 libraries in your Evergreen system.
10
11 This search can be as simple as typing keywords into the search box and clicking the _Search_ button. Or you can make your search more precise by limiting your search by fields to search, material type or library location.
12
13 indexterm:[search box]
14
15 The _Homepage_ contains a single search box for you to enter search terms. You can get to the _Homepage_ at any time by clicking the _Another Search_ link from the leftmost link on the bar above your search results in the catalogue, or you can enter a search anywhere you see a search box.
16
17 You can select to search by:
18
19 indexterm:[search, keyword]
20 indexterm:[search, title]
21 indexterm:[search, journal title]
22 indexterm:[search, author]
23 indexterm:[search, subject]
24 indexterm:[search, series]
25 indexterm:[search, bib call number]
26
27 * *Keyword* — finds the terms you enter anywhere in the entire record for an item, including title, author, subject, and other information.
28
29 * *Title* — finds the terms you enter in the title of an item.
30
31 * *Journal Title* — finds the terms you enter in the title of a serial bib record.
32
33 * *Author* — finds the terms you enter in the author of an item.
34
35 * *Subject* — finds the terms you enter in the subject of an item. Subjects are categories assigned to items according to a system such as the Library of Congress Subject Headings.
36
37 * *Series* — finds the terms you enter in the title of a multi-part series.
38
39 * *Bib Call Number* — finds the terms you enter in the call number field of a bib record.
40
41
42 [TIP]
43 =============
44 To search an item copy call number, if different from _Bib Call Number_, use <<numeric_search, _Advanced Search: Numeric_>> 
45 =============
46
47 Formats
48 ^^^^^^^
49
50 You can limit your search by formats based on MARC fixed field type:
51
52 indexterm:[formats, books]
53 indexterm:[formats, audiobooks]
54 indexterm:[formats, video]
55 indexterm:[formats, music]
56
57
58 * *All Books*
59 * *All Music*
60 * *Audiocassette music recording*
61 * *Blu-ray* 
62 * *Braille*
63 * *Cassette audiobook*
64 * *CD Audiobook*
65 * *CD Music recording*
66 * *DVD* 
67 * *E-audio* 
68 * *E-book*
69 * *E-video* 
70 * *Equipment, games, toys*
71 * *Kit*
72 * *Large Print Book*
73 * *Map*
74 * *Microform*
75 * *Music Score*
76 * *Phonograph music recording*
77 * *Phonograph spoken recording*
78 * *Picture*
79 * *Serials and magazines*
80 * *Software and video games*
81 * *VHS*
82
83
84 Libraries
85 +++++++++
86
87 If you are using a catalogue in a library or accessing a library’s online catalogue from its homepage, the search will return items for your local library. If your library has multiple branches, the result will display items available at your branch and all branches of your library system separately.
88
89
90 Advanced Search
91 ~~~~~~~~~~~~~~~
92
93 Advanced searches allow users to perform more complex searches by providing more options. Many kinds of searches can be performed from the _Advanced Search_ screen. You can access by clicking _Advanced Search_ on the catalogue _Homepage_ or search results screen.
94
95 The available search options are the same as on the basic search. But you may use one or many of them simultaneously. If you want to combine more than three search options, use _Add Search Row_ button to add more search input rows. Clicking the _X_ button will close the search input row.
96
97
98 Sort Results
99 ^^^^^^^^^^^^
100
101 indexterm:[advanced search, sort results]
102
103 By default, the search results are in order of greatest to least relevance, see <<order_of_results, Order of Results>>. In the sort results menu you may select to order the search results by relevance, title, author, or publication date.
104
105
106 Search Library
107 ^^^^^^^^^^^^^^
108
109 indexterm:[advanced search, search library]
110
111 The current search library is displayed under _Search Library_ drop down menu. By default it is your library. The search returns results for your local library only. If your library system has multiple branches, use the _Search Library_ box to select different branches or the whole library system.
112
113
114 Limit to Available
115 ^^^^^^^^^^^^^^^^^^
116
117 indexterm:[advanced search, limit to available]
118
119
120 This checkbox is at the bottom line of _Search Library_. Select _Limit to Available_ to limit results to those titles that have items with a circulation status of "available" (by default, either _Available_ or _Reshelving_).
121
122
123 Search Filter
124 ^^^^^^^^^^^^^
125
126 indexterm:[advanced search, search filters]
127
128 You can filter your search by _Item Type_, _Item Form_, _Language_, _Audience_, _Video Format_, _Bib Level_, _Literary Form_, _Search Library_, and _Publication Year_. Publication year is inclusive. For example, if you set _Publication Year_ Between 2005 and 2007, your results can include items published in 2005, 2006 and 2007.
129
130 For each filter type, you may select multiple criteria by holding down the _CTRL_ key as you click on the options. If nothing is selected for a filter, the search will return results as though all options are selected.
131
132
133 anchor:numeric_search[]
134 indexterm:[advanced search, numeric search]
135
136 Numeric Search
137 ^^^^^^^^^^^^^^
138
139 If you have details on the exact item you wish to search for, use the _Numeric Search_ tab on the advanced search page. Use the drop-down menu to select your search by _ISBN_, _ISSN_, _Bib Call Number_, _Call Number (Shelf Browse)_, _LCCN_, _TCN_, or _Item Barcode_. Enter the information and then click the _Search_ button.
140
141 Expert Search
142 ^^^^^^^^^^^^^
143
144 indexterm:[advanced search, expert search]
145
146 If you are familiar with MARC cataloging, you may search by MARC tag in the _Expert Search_ option on the left of the screen. Enter the three-digit tag number, the subfield if relevant, and the value or text that corresponds to the tag. For example, to search by publisher name, enter `260 b Random House`. To search several tags simultaneously, use the _Add Row_ option. Click _Submit_ to run the search. 
147
148 [TIP]
149 =============
150 Use the MARC Expert Search only as a last resort, as it can take much longer to retrieve results than by using indexed fields. For example, rather than running an expert search for "245 a Gone with the wind", simply do a regular title search for "Gone with the wind".
151 =============
152
153 Boolean operators
154 ~~~~~~~~~~~~~~~~~
155
156 indexterm:[search, AND operator]
157 indexterm:[search, OR operator]
158 indexterm:[search, NOT operator]
159 indexterm:[search, boolean]
160
161 Classic search interfaces (that is, those used primarily by librarians) forced users to learn the art of crafting search phrases with Boolean operators. To a large extent this was due to the inability of those systems to provide relevancy ranking beyond a "last in, first out" approach. Thankfully, Evergreen, like most modern search systems, supports a rather sophisticated relevancy ranking system that removes the need for Boolean operators in most cases.
162
163 By default, all terms that have been entered in a search query are joined with an implicit `AND` operator. Those terms are required to appear in the designated fields to produce a matching record: a search for _golden compass_ will search for entries that contain both _golden_ *and* _compass_. 
164
165 Words that are often considered Boolean operators, such as _AND_, _OR_, AND _NOT_, are not special in Evergreen: they are treated as just another search term. For example, a title search for `golden and compass` will not return the title _Golden Compass_. 
166
167 However, Evergreen does support Boolean searching for those rare cases where you might require it, using symbolic operators as follows:
168
169 .Boolean symbolic operators
170 [width="50%",options="header"]
171 |=================================
172 | Operator | Symbol    | Example
173 | AND      | `&&`      | `a && b`
174 | OR       | `\|\|`      | `a \|\| b`
175 | NOT      | `-`_term_ | `a -b`
176 |=================================
177
178 Search Tips
179 ~~~~~~~~~~~
180
181 indexterm:[search, stop words]
182 indexterm:[search, truncation]
183
184 Evergreen tries to approach search from the perspective of a major search engine: the user should simply be able to enter the terms they are looking for as a general keyword search, and Evergreen should return results that are most relevant given those terms. For example, you do not need to enter author's last name first, nor do you need to enter an exact title or subject heading. Evergreen is also forgiving about plurals and alternate verb endings, so if you enter _dogs_, Evergreen will also find items with _dog_. 
185
186 The search engine has no _stop words_ (terms are ignored by the search engine): a title search for `to be or not to be` (in any order) yields a list of titles with those words. 
187
188 * Don’t worry about white space, exact punctuation, or capitalization. 
189
190 . White spaces before or after a word are ignored. So, a search for `[ golden compass ]` gives the same results as a search for `[golden compass]`.
191
192 . A double dash or a colon between words is reduced to a blank space. So, a title search for _golden:compass_ or _golden -- compass_ is equivalent to _golden compass_. 
193
194 . Punctuation marks occurring within a word are removed; the exception is \_. So, a title search for _gol_den com_pass_ gives no result. 
195
196 . Diacritical marks and solitary `&` or `|` characters located anywhere in the search term are removed. Words or letters linked together by `.` (dot) are joined together without the dot. So, a search for _go|l|den & comp.ass_ is equivalent to _golden compass_. 
197
198 . Upper and lower case letters are equivalent. So, _Golden Compass_ is the same as _golden compass_. 
199
200 * Enter your search words in any order. So, a search for _compass golden_ gives the same results as a search for _golden compass_. Adding more search words gives fewer but more specific results. 
201
202 ** This is also true for author searches. Both _David Suzuki_ and _Suzuki, David_ will return results for the same author. 
203
204 * Use specific search terms. Evergreen will search for the words you specify, not the meanings, so choose search terms that are likely to appear in an item description. For example, the search _luxury hotels_ will produce more 
205 relevant results than _nice places to stay_.
206
207 * Search for an exact phrase using double-quotes. For example ``golden compass''. 
208
209 ** The order of words is important for an exact phrase search. _golden compass_ is different than _compass golden_. 
210
211 ** White space, punctuation and capitalization are removed from exact phrases as described above. So a phrase retains its search terms and its relative order, but not special characters and not case. 
212
213 ** Two phrases are joined by and, so a search for _"golden compass"_ _"dark materials"_ is equivalent to _golden compass_ *and* _dark materials_. 
214
215
216 * **Truncation**
217 Words may be right-hand truncated using an asterisk. Use a single asterisk * to truncate any number of characters.
218 (example: _environment* agency_)
219
220
221 Search Methodology
222 ~~~~~~~~~~~~~~~~~~
223
224 anchor:stemming[]
225
226 Stemming 
227 ^^^^^^^^
228
229 indexterm:[search, stemming]
230
231 A search for _dogs_ will also return hits with the word dog and a search for parenting will return results with the words parent and parental. This is because the search uses stemming to help return the most relevant results. That 
232 is, words are reduced to their stem (or root word) before the search is performed. 
233
234 The stemming algorithm relies on common English language patterns - like verbs ending in _ing_ - to find the stems. This is more efficient than looking up each search term in a dictionary and usually produces desirable results. However, it also means the search will sometimes reduce a word to an incorrect stem and cause unexpected results. To prevent a word or phrase from stemming, put it in double-quotes to force an exact search. For example, a search for `parenting` will also return results for `parental`, but a search for `"parenting"` will not.
235
236 Understanding how stemming works can help you to create more relevant searches, but it is usually best not to anticipate how a search term will be stemmed. For example, searching for `gold compass` does not return the same results as `golden compass`, because `-en` is not a regular suffix in English, and therefore the stemming algorithm does not recognize _gold_ as a stem of _golden_. 
237
238
239 anchor:order_of_results[]
240
241 Order of Results
242 ^^^^^^^^^^^^^^^^
243
244 indexterm:[search, order of results]
245
246 By default, the results are listed in order of relevance, similar to a search engine like Google. The relevance is determined using a number of factors, including how often and where the search terms appear in the item description, 
247 and whether the search terms are part of the title, subject, author, or series. The results which best match your search are returned first rather than results appearing in alphabetical or chronological order. 
248
249 In the _Advanced Search_ screen, you may select to order the search results by relevance, title, author, or publication date before you start the search. You can also re-order your search results using the _Sort Results_ dropdown list on 
250 the search result screen.
251
252
253 Search URL
254 ~~~~~~~~~~
255
256 indexterm:[search, URL]
257
258 When performing a search or clicking on the details links, Evergreen constructs a GET request url with the parameters of the search. The url for searches and details in Evergreen are persistent links in that they can be saved, shared and used later.
259
260 Here is a basic search URL structure:
261
262
263 +++[hostname]+++/eg/opac/results?query=[search term]&**qtype**=keyword&fi%3Aitem_type=&**locg**=[location id]
264
265 locg Parameter
266 ^^^^^^^^^^^^^^
267 This is the id of the search location. It is an integer and maches the id of the location the user selected in the location drop down menu.
268
269 qtype Parameter
270 ^^^^^^^^^^^^^^^
271
272 The _qtype_ parameter in the URL represents the search type values and represent one of the following search or request types:
273
274 * Keyword 
275 * Title
276 * Journal Title
277 * Author
278 * Subject
279 * Series
280 * Bib Call Number
281
282 These match the options in the search type drop-down box.
283
284 Sorting
285 ^^^^^^^
286
287 The _sort_ parameter sorts the results on one of these criteria.
288
289 * `sort=pubdate` (publication date) - chronological order
290 * `sort=titlesort` - Alphabetical order
291 * `sort=authorsort` - Alphabetical order on family name first
292
293 To change the sort direction of the results, the _sort_ parameter value has the ".descending" suffix added to it.
294
295 * `sort=titlesort.descending`
296 * `sort=authorsort.descending`
297 * `sort=pubdate.descending`
298
299 In the absence of the _sort_ parameter, the search results default to sorting by relevance.
300
301
302 Search Results
303 ~~~~~~~~~~~~~~
304
305 indexterm:[search results]
306
307 The search results are a list of relevant works from the catalogue. If there are many results, they are divided into several pages. At the top of the list, you can see the total number of results and go back and forth between the pages 
308 by clicking the links that say _Previous_ or _Next_ on top or bottom of the list. You can also click on the adjacent results page number listed. These page number links allow you to skip to that results page, if your search results needed multiple pages to display. Here is an example: 
309
310
311 image::media/catalogue-3.png[catalogue-3]
312
313 Brief information about the title, such as author, edition, publication date, etc. is displayed under each title. The icons beside the brief information indicate formats such as books, audio books, video recordings, and other formats. If you hover your mouse over the icon, a text explanation will show up in a small pop-up box. 
314
315 Clicking a title goes to the title details. Clicking an author searches all works by the author. If you want to place a hold on the title, click _Place Hold_ beside the format icons.
316
317 On the top right, there is a _Limit to Available_ checkbox. Checking this box will filter out those titles with no available copies in the library or libraries at the moment. Usually you will see your search results are re-displayed with fewer titles. 
318
319 The _Sort by_ dropdown list is found at the top of the search results, beside the _Show More Details_ link. Clicking an entry on the list will re-sort your search results accordingly.
320
321
322 Facets: Subjects, Authors, and Series
323 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
324
325 indexterm:[search results, facets: subjects, authors, and series]
326
327 At the left, you may see a list of _Facets of Subjects_, _Authors_, and _Series_. Selecting any one of these links filters your current search results using that subject, author, or series to narrow done your current results. The facet filters can be undone by clicking the link a second time, thus returning your original results before the facet was activated. 
328
329 image::media/catalogue-5.png[catalogue-5]
330
331
332 Availability
333 ^^^^^^^^^^^^
334
335 indexterm:[search results, availability]
336
337 The number of available copies and total copies are displayed under each search result's call number. If you are using a catalogue inside a library or accessing a library’s online catalogue from its homepage, you will see how many copies are available in the library under each title, too. If the library belongs to a multi-branch library system you will see an extra row under each title showing how many copies are available in all branches.
338
339
340 image::media/catalogue-6.png[catalogue-6]
341
342 image::media/catalogue-7.png[catalogue-7]
343
344 You may also click the _Show More Details_ link at the top of the results page, next to the _Limit to available items_ check box, to view each search result's copies' individual call number, status, and shelving location. 
345
346
347 Viewing a record
348 ^^^^^^^^^^^^^^^^
349
350 indexterm:[search results, viewing a record]
351
352 Click on a search result's title to view a detailed record of the title, including descriptive information, location and availability, current holds, and options for placing holds, add to my list, and print/email. 
353
354 image::media/catalogue-8.png[catalogue-8]
355
356
357 Details
358 ^^^^^^^
359
360 indexterm:[search results, details]
361
362 The record shows details such as the cover image, title, author, publication information, and an abstract or summary, if available. 
363
364 Near the bottom of the record, the copy summary shows how many copies are at the library or libraries you have selected, and whether they are available or checked out. It also displays the _Call Number_ and _Shelving Location_ for locating the item on the shelves. You can click _Shelf Browser_ to view items appearing near the current item on the library shelves. Often this is a good way to browse for similar items. You can select _Table of Contents_ to see the book’s table of contents online (if available). You can select _MARC Record_ to display the record in MARC format. You can also select _Awards, Reviews, & Suggested Reads_ and _Additional Content_ to see more details (if available).   
365
366
367 Placing Holds 
368 ^^^^^^^^^^^^^
369
370 indexterm:[search results, placing holds]
371
372 Holds can be placed on either title results or search results page. If the item is available, it will be pulled from the shelf and held for you. If all copies at your local library are checked out, you will be placed on a waiting list and 
373 you will be notified when items become available. 
374
375 On title details page, you can select the _Place Hold_ link in the upper right corner of the record to reserve the item. You will need your library account user name and password. You may choose to be notified by phone or email.
376
377 In the example below, the phone number in your account will automatically show up. Once you select the Enable phone notifications for this hold checkbox, you can supply a different phone number for this hold only. The notification method will be selected automatically if you have set it up in your account references. But you still have a chance to re-select on this screen. You may also suspend the hold temporarily by checking the Suspend box. Click the _Help_ beside it for details. 
378
379 You can view and cancel a hold at anytime. Before your hold is captured, which means an item has been held waiting for you to pick up, you can edit, suspend or activate it. You need log into your patron <<my_account,My Account>> to do it. From your account you can also set up an _Cancel if not filled by_ date for your hold. _Cancel if not filled by_ date means after this date, even though your hold has not been fulfilled you do not need the item anymore.
380
381
382 image::media/catalogue-9.png[catalogue-9]
383
384 Going back 
385 ^^^^^^^^^^
386
387 indexterm:[search results, going back]
388
389 When you are viewing a specific record, you can always go back to your title list by clicking the link _Search Results_ on the top right or left bottom of the page. 
390
391 image::media/catalogue-10.png[catalogue-10]
392
393 You can start a new search at any time by entering new search terms in the search box at the top of the page, or by selecting the _Another Search_ or _Advanced Search_ links in the left-hand sidebar.
394
395 anchor:my_account[]
396
397
398 My Account
399 ~~~~~~~~~~
400
401 // ``First Login Password Update'' the following documentation comes from JSPAC
402 // as of 2013-03-12 this feature did not exist in EG 2.4 TPAC,
403 // so I am commenting it out for now because it will be added in the future
404 // see bug report https://bugs.launchpad.net/evergreen/+bug/1013786
405 // Yamil Suarez 2013-03-12
406
407 ////
408
409
410 First Login Password Update 
411 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
412
413 indexterm:[my account, first login password update]
414
415 Patrons are given temporary passwords when new accounts are created, or forgotten passwords are reset by staff. Patrons MUST change their password to something more secure when they login or for the first time. Once the password is updated, they will not have to repeat this process for subsequent logins. 
416
417 . Open a web browser and go to your Evergreen OPAC 
418 . Click My Account 
419 . Enter your _Username_ and _Password_. 
420   * By default, your username is your library card number. 
421   * Your password is a 4 digit code provided when your account was created. If you have forgotten your password, contact your library to have it reset or use the online the section called ``<<password_reset,Password Reset>>'' tool. 
422 ////
423
424
425 Logging In 
426 ^^^^^^^^^^
427
428 indexterm:[my account, logging in]
429
430 Logging into your account from the online catalog: 
431
432 . Open a web browser and navigate to your Evergreen OPAC. 
433 . Click _My Account_ .
434 . Enter your _Username_ and _Password_. 
435 ** By default, your username is your library card number.
436 ** Your password is a 4 digit code provided when your account was created. If you have forgotten your password, contact your local library to have it reset or use the the section called <<password_reset, Password Reset>> tool. 
437 . Click Login.
438 +
439 ** At the first login, you may be prompted to change your password. 
440 ** If you updated your password, you must enter your _Username_ and _Password_ again. 
441 +
442 . Your _Account Summary_ page displays.
443
444
445 To view your account details, click one of the _My Account_ tabs.
446
447 To start a search, enter a term in the search box at the top of the page and click _Search_! 
448
449 [CAUTION]
450 =================
451 If using a public computer be sure to log out! 
452 =================
453
454 anchor:password_reset[]
455
456 Password Reset
457 ^^^^^^^^^^^^^^
458
459 indexterm:[my account, password reset]
460
461
462 To reset your password: 
463
464 . click on the _Forgot your password?_ link located beside the login button. 
465
466 . Fill in the _Barcode_ and _User name_ text boxes. 
467
468 . A message should appear indicating that your request has been processed and that you will receive an email with further instructions. 
469
470 . An email will be sent to the email addressed you have registered with your Evergreen library. You should click on the link included in the email to open the password reset page. Processing time may vary.
471 +
472 [NOTE]
473 =================
474 You will need to have a valid email account set up in Evergreen for you to reset your password. Otherwise, you will need to contact your library to have your password reset by library staff. 
475 =================
476 +
477
478 . At the reset email page you should enter the new password in the _New password_ field and re-enter it in the _Re-enter new password_ field. 
479
480 . Click _Submit_. 
481
482 . A message should appear on the page indicating that your password has been reset. 
483
484 . Login to your account with your new password. 
485
486
487 Account Summary
488 ^^^^^^^^^^^^^^^
489
490 indexterm:[my account, account summary]
491
492 In the _My Account_, _Account Summary_ you can see your total number of items checked out, items on hold, and items ready for pickup. In addition item summary lists your current fines and payment history are listed there, too.
493
494
495 Items Checked Out 
496 ^^^^^^^^^^^^^^^^^
497
498 indexterm:[my account, items checked out]
499
500 Users can manage items currently checked out, like renew specific items. Users can also view overdue items and see how many renewals they have remaining for specific item. 
501
502
503 Holds
504 ^^^^^ 
505
506 indexterm:[my account, holds]
507
508 From _My Account_, patrons can see _Items on hold_ and _Holds History_ and manage items currently being requested. 
509
510 Actions include: 
511
512 * Suspend - set a period of time during which the hold will not become active, such as during a vacation 
513 * Activate - manually remove the suspension 
514 * Cancel - remove the hold request 
515
516 Edit options include: 
517
518 * Change pick up library 
519 * Change the _Cancel unless filled by_ date, also known as the hold expiration date 
520 * Change the status of the hold to either active or suspended. 
521 * Change the _If suspended, activate on_ date, which reactivates a suspended hold at the specified date
522  
523 To edit items on hold: 
524
525 . Login to _My Account_, click the _Holds_ tab.
526 . Select the hold to modify. 
527 . Click _Edit_ for selected holds. 
528 . Select the change to make and follow the instructions.
529
530
531 Account Preferences 
532 ^^^^^^^^^^^^^^^^^^^
533
534 indexterm:[my account, account preferences]
535
536 From here you can manage display preferences including your _Personal Information_, _Notification Preferences_, and _Search and History Preferences_. 
537
538 For example: 
539
540 * Personal Information
541
542 ** change password - allows patrons to change their password
543
544 ** change email address - allows patrons to change their email address.
545
546
547
548 *  Notification Preferences
549
550 ** _Notify by Email_ by default when a hold is ready for pickup?        
551
552 ** _Notify by Phone_ by default when a hold is ready for pickup?
553
554 ** _Default Phone Number_
555
556
557 * Search and History Preferences
558
559 ** Search hits per page
560
561 ** Preferred pickup location
562
563 ** Keep history of checked out items?
564
565 ** Keep history of holds?
566
567
568 After changing any of these settings, you must click _Save_ to store your preferences.
569  
570
571
572 indexterm:[holds, preferred pickup location ]