979b8631d1ac641ea965d2ed27ffe6cb4532673d
[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 [TIP]
40 =============
41 To search an item copy call number, use <<numeric_search, _Advanced Search: Numeric_>> 
42 =============
43
44 Formats
45 ^^^^^^^
46
47 You can limit your search by formats based on MARC fixed field type:
48
49 indexterm:[formats, books]
50 indexterm:[formats, audiobooks]
51 indexterm:[formats, video]
52 indexterm:[formats, music]
53
54
55 * *All Books*
56 * *All Music*
57 * *Audiocassette music recording*
58 * *Blu-ray* 
59 * *Braille*
60 * *Cassette audiobook*
61 * *CD Audiobook*
62 * *CD Music recording*
63 * *DVD* 
64 * *E-audio* 
65 * *E-book*
66 * *E-video* 
67 * *Equipment, games, toys*
68 * *Kit*
69 * *Large Print Book*
70 * *Map*
71 * *Microform*
72 * *Music Score*
73 * *Phonograph music recording*
74 * *Phonograph spoken recording*
75 * *Picture*
76 * *Serials and magazines*
77 * *Software and video games*
78 * *VHS*
79
80
81 Libraries
82 +++++++++
83
84 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.
85
86
87 Advanced Search
88 ~~~~~~~~~~~~~~~
89
90 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.
91
92 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.
93
94
95 Sort Results
96 ^^^^^^^^^^^^
97
98 indexterm:[advanced search, sort results]
99
100 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.
101
102
103 Search Library
104 ^^^^^^^^^^^^^^
105
106 indexterm:[advanced search, search library]
107
108 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.
109
110
111 Limit to Available
112 ^^^^^^^^^^^^^^^^^^
113
114 indexterm:[advanced search, limit to available]
115
116
117 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_).
118
119
120 Search Filter
121 ^^^^^^^^^^^^^
122
123 indexterm:[advanced search, search filters]
124
125 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.
126
127 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.
128
129
130 anchor:numeric_search[]
131 indexterm:[advanced search, numeric search]
132
133 Numeric Search
134 ^^^^^^^^^^^^^^
135
136 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.
137
138 Expert Search
139 ^^^^^^^^^^^^^
140
141 indexterm:[advanced search, expert search]
142
143 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. 
144
145 [TIP]
146 =============
147 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".
148 =============
149
150 Boolean operators
151 ~~~~~~~~~~~~~~~~~
152
153 indexterm:[search, AND operator]
154 indexterm:[search, OR operator]
155 indexterm:[search, NOT operator]
156 indexterm:[search, boolean]
157
158 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.
159
160 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_. 
161
162 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_. 
163
164 However, Evergreen does support Boolean searching for those rare cases where you might require it, using symbolic operators as follows:
165
166 .Boolean symbolic operators
167 [width="50%",options="header"]
168 |=================================
169 | Operator | Symbol    | Example
170 | AND      | `&&`      | `a && b`
171 | OR       | `\|\|`      | `a \|\| b`
172 | NOT      | `-`_term_ | `a -b`
173 |=================================
174
175 Search Tips
176 ~~~~~~~~~~~
177
178 indexterm:[search, stop words]
179 indexterm:[search, truncation]
180
181 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_. 
182
183 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. 
184
185 * Don’t worry about white space, exact punctuation, or capitalization. 
186
187 . 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]`.
188
189 . 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_. 
190
191 . Punctuation marks occurring within a word are removed; the exception is \_. So, a title search for _gol_den com_pass_ gives no result. 
192
193 . 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_. 
194
195 . Upper and lower case letters are equivalent. So, _Golden Compass_ is the same as _golden compass_. 
196
197 * 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. 
198
199 ** This is also true for author searches. Both _David Suzuki_ and _Suzuki, David_ will return results for the same author. 
200
201 * 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 
202 relevant results than _nice places to stay_.
203
204 * Search for an exact phrase using double-quotes. For example ``golden compass''. 
205
206 ** The order of words is important for an exact phrase search. _golden compass_ is different than _compass golden_. 
207
208 ** 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. 
209
210 ** Two phrases are joined by and, so a search for _"golden compass"_ _"dark materials"_ is equivalent to _golden compass_ *and* _dark materials_. 
211
212
213 * **Truncation**
214 Words may be right-hand truncated using an asterisk. Use a single asterisk * to truncate any number of characters.
215 (example: _environment* agency_)
216
217
218 Search Methodology
219 ~~~~~~~~~~~~~~~~~~
220
221 anchor:stemming[]
222
223 Stemming 
224 ^^^^^^^^
225
226 indexterm:[search, stemming]
227
228 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 
229 is, words are reduced to their stem (or root word) before the search is performed. 
230
231 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.
232
233 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_. 
234
235
236 anchor:order_of_results[]
237
238 Order of Results
239 ^^^^^^^^^^^^^^^^
240
241 indexterm:[search, order of results]
242
243 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, 
244 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. 
245
246 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 
247 the search result screen.
248
249
250 Search URL
251 ~~~~~~~~~~
252
253 indexterm:[search, URL]
254
255 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.
256
257 Here is a basic search URL structure:
258
259
260 +++[hostname]+++/eg/opac/results?query=[search term]&**qtype**=keyword&fi%3Aitem_type=&**locg**=[location id]
261
262 locg Parameter
263 ^^^^^^^^^^^^^^
264 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.
265
266 qtype Parameter
267 ^^^^^^^^^^^^^^^
268
269 The _qtype_ parameter in the URL represents the search type values and represent one of the following search or request types:
270
271 * Keyword 
272 * Title
273 * Journal Title
274 * Author
275 * Subject
276 * Series
277 * Bib Call Number
278
279 These match the options in the search type drop-down box.
280
281 Sorting
282 ^^^^^^^
283
284 The _sort_ parameter sorts the results on one of these criteria.
285
286 * `sort=pubdate` (publication date) - chronological order
287 * `sort=titlesort` - Alphabetical order
288 * `sort=authorsort` - Alphabetical order on family name first
289
290 To change the sort direction of the results, the _sort_ parameter value has the ".descending" suffix added to it.
291
292 * `sort=titlesort.descending`
293 * `sort=authorsort.descending`
294 * `sort=pubdate.descending`
295
296 In the absence of the _sort_ parameter, the search results default to sorting by relevance.
297
298
299 Search Results
300 ~~~~~~~~~~~~~~
301
302 indexterm:[search results]
303
304 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 
305 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: 
306
307
308 image::media/catalogue-3.png[catalogue-3]
309
310 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. 
311
312 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.
313
314 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. 
315
316 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.
317
318
319 Facets: Subjects, Authors, and Series
320 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
321
322 indexterm:[search results, facets: subjects, authors, and series]
323
324 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. 
325
326 image::media/catalogue-5.png[catalogue-5]
327
328
329 Availability
330 ^^^^^^^^^^^^
331
332 indexterm:[search results, availability]
333
334 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.
335
336
337 image::media/catalogue-6.png[catalogue-6]
338
339 image::media/catalogue-7.png[catalogue-7]
340
341 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. 
342
343
344 Viewing a record
345 ^^^^^^^^^^^^^^^^
346
347 indexterm:[search results, viewing a record]
348
349 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. 
350
351 image::media/catalogue-8.png[catalogue-8]
352
353
354 Details
355 ^^^^^^^
356
357 indexterm:[search results, details]
358
359 The record shows details such as the cover image, title, author, publication information, and an abstract or summary, if available. 
360
361 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).   
362
363
364 Placing Holds 
365 ^^^^^^^^^^^^^
366
367 indexterm:[search results, placing holds]
368
369 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 
370 you will be notified when items become available. 
371
372 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.
373
374 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. 
375
376 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.
377
378
379 image::media/catalogue-9.png[catalogue-9]
380
381 Going back 
382 ^^^^^^^^^^
383
384 indexterm:[search results, going back]
385
386 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. 
387
388 image::media/catalogue-10.png[catalogue-10]
389
390 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.
391
392 anchor:my_account[]
393
394
395 My Account
396 ~~~~~~~~~~
397
398 // ``First Login Password Update'' the following documentation comes from JSPAC
399 // as of 2013-03-12 this feature did not exist in EG 2.4 TPAC,
400 // so I am commenting it out for now because it will be added in the future
401 // see bug report https://bugs.launchpad.net/evergreen/+bug/1013786
402 // Yamil Suarez 2013-03-12
403
404 ////
405
406
407 First Login Password Update 
408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
409
410 indexterm:[my account, first login password update]
411
412 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. 
413
414 . Open a web browser and go to your Evergreen OPAC 
415 . Click My Account 
416 . Enter your _Username_ and _Password_. 
417   * By default, your username is your library card number. 
418   * 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. 
419 ////
420
421
422 Logging In 
423 ^^^^^^^^^^
424
425 indexterm:[my account, logging in]
426
427 Logging into your account from the online catalog: 
428
429 . Open a web browser and navigate to your Evergreen OPAC. 
430 . Click _My Account_ .
431 . Enter your _Username_ and _Password_. 
432 ** By default, your username is your library card number.
433 ** 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. 
434 . Click Login.
435 +
436 ** At the first login, you may be prompted to change your password. 
437 ** If you updated your password, you must enter your _Username_ and _Password_ again. 
438 +
439 . Your _Account Summary_ page displays.
440
441
442 To view your account details, click one of the _My Account_ tabs.
443
444 To start a search, enter a term in the search box at the top of the page and click _Search_! 
445
446 [CAUTION]
447 =================
448 If using a public computer be sure to log out! 
449 =================
450
451 anchor:password_reset[]
452
453 Password Reset
454 ^^^^^^^^^^^^^^
455
456 indexterm:[my account, password reset]
457
458
459 To reset your password: 
460
461 . click on the _Forgot your password?_ link located beside the login button. 
462
463 . Fill in the _Barcode_ and _User name_ text boxes. 
464
465 . A message should appear indicating that your request has been processed and that you will receive an email with further instructions. 
466
467 . 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.
468 +
469 [NOTE]
470 =================
471 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. 
472 =================
473 +
474
475 . 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. 
476
477 . Click _Submit_. 
478
479 . A message should appear on the page indicating that your password has been reset. 
480
481 . Login to your account with your new password. 
482
483
484 Account Summary
485 ^^^^^^^^^^^^^^^
486
487 indexterm:[my account, account summary]
488
489 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.
490
491
492 Items Checked Out 
493 ^^^^^^^^^^^^^^^^^
494
495 indexterm:[my account, items checked out]
496
497 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. 
498
499
500 Holds
501 ^^^^^ 
502
503 indexterm:[my account, holds]
504
505 From _My Account_, patrons can see _Items on hold_ and _Holds History_ and manage items currently being requested. 
506
507 Actions include: 
508
509 * Suspend - set a period of time during which the hold will not become active, such as during a vacation 
510 * Activate - manually remove the suspension 
511 * Cancel - remove the hold request 
512
513 Edit options include: 
514
515 * Change pick up library 
516 * Change the _Cancel unless filled by_ date, also known as the hold expiration date 
517 * Change the status of the hold to either active or suspended. 
518 * Change the _If suspended, activate on_ date, which reactivates a suspended hold at the specified date
519
520 To edit items on hold: 
521
522 . Login to _My Account_, click the _Holds_ tab.
523 . Select the hold to modify. 
524 . Click _Edit_ for selected holds. 
525 . Select the change to make and follow the instructions.
526
527
528 Account Preferences 
529 ^^^^^^^^^^^^^^^^^^^
530
531 indexterm:[my account, account preferences]
532
533 From here you can manage display preferences including your _Personal Information_, _Notification Preferences_, and _Search and History Preferences_. 
534
535 For example: 
536
537 * Personal Information
538
539 ** change password - allows patrons to change their password
540
541 ** change email address - allows patrons to change their email address.
542
543
544
545 *  Notification Preferences
546
547 ** _Notify by Email_ by default when a hold is ready for pickup?        
548
549 ** _Notify by Phone_ by default when a hold is ready for pickup?
550
551 ** _Default Phone Number_
552
553
554 * Search and History Preferences
555
556 ** Search hits per page
557
558 ** Preferred pickup location
559
560 ** Keep history of checked out items?
561
562 ** Keep history of holds?
563
564
565 After changing any of these settings, you must click _Save_ to store your preferences.
566
567
568 indexterm:[holds, preferred pickup location]