Documentation: added "search URL" text inside of "using OPAC" section
[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 * *Cartographic material*
59 * *Computer file*
60 * *Kit*
61 * *Language material* - More commonly referred to as books
62 * *Manuscript cartographic material*
63 * *Manuscript language material*
64 * *Manuscript notated music*
65 * *Mixed materials*
66 * *Musical sound recording* - This includes music on CD or other media.
67 * *Nonmusical sound recording* - This includes books read aloud on CDs or other media. 
68 * *Notated music*
69 * *Projected medium* - More commonly known as video formats like DVDs
70 * *Three-dimensional artifact or naturally occurring object*
71 * *Two-dimensional nonprojectable graphic*
72
73
74 Libraries
75 +++++++++
76
77 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.
78
79
80 Advanced Search
81 ~~~~~~~~~~~~~~~
82
83 Advanced searches allow users to perform more complex searches by providing more options. Many kinds of searches can be performed from the _Advance Search_ screen. You can access by clicking _Advanced Search_ on the catalogue _Homepage_ or search results screen.
84
85 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.
86
87
88 Sort Results
89 ^^^^^^^^^^^^
90
91 indexterm:[advanced search, sort results]
92
93 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.
94
95
96 Search Library
97 ^^^^^^^^^^^^^^
98
99 indexterm:[advanced search, search library]
100
101 The current search library is displayed under _Search Library_ drop down menu. Be 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.
102
103
104 Limit to Available
105 ^^^^^^^^^^^^^^^^^^
106
107 indexterm:[advanced search, limit to available]
108
109
110 This checkbox is at the bottom line of _Search Library_. Select _Limit to Available_ to limit by item’s current circulation status. Titles without available items in the library will not be displayed.
111
112
113 Search Filter
114 ^^^^^^^^^^^^^
115
116 indexterm:[advanced search, search filters]
117
118 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 result items will be published in 2005, 2006 and 2007.
119
120 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.
121
122
123 anchor:numeric_search[]
124 indexterm:[advanced search, numeric search]
125
126 Numeric Search
127 ^^^^^^^^^^^^^^
128
129 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.
130
131 Expert Search
132 ^^^^^^^^^^^^^
133
134 indexterm:[advanced search, expert search]
135
136 If you are familiar with the MARC system, you may search by 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. 
137
138 Search Tips
139 ~~~~~~~~~~~
140
141 indexterm:[searchtips, AND operator]
142 indexterm:[searchtips, boolean]
143
144
145 You do not need to enter author's last name first, nor do you need 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_. 
146
147 * Do not use an _AND_ operator to join search terms. 
148
149 ** An _AND_ operator is automatically used to join all search terms. So, a search for _golden compass_ will search for entries that contain both _golden_ *and* _compass_. 
150
151 ** Boolean operators such as _and_, _or_, _not_ are not considered special and are searched for like any other word. So, a search for _golden and compass_ will not return the title _golden compass_. Putting it another way, there are no _stop_ words that are automatically ignored by the search engine. So, a title search for the _and or not_ of (and in any order) yields a list of titles with those words. 
152
153 * Don’t worry about white space, exact punctuation, or capitalization. 
154
155 . White spaces before or after a word are ignored. So, search for _golden compass_ gives the same results as a search for _golden compass_. 
156
157 . 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_. 
158
159 . Punctuation marks occurring within a word are removed; the exception is \_. So, a title search for _gol_den com_pass_ gives no result. 
160
161 . Diacritical marks, &, or | 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_. 
162
163 . Upper and lower case letters are equivalent. So, _Golden Compass_ is the same as _golden compass_. 
164
165 * 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 and more specific results. 
166
167 ** This is also true for author searches. Both _David Suzuki_ and _Suzuki, David_ will return results for the same author. 
168
169 * 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 
170 relevant results than _nice places_ to stay. 
171
172 * Search for an exact phrase using double-quotes. For example ``golden compass''. 
173
174 ** The order of words is important for an exact phrase search. _golden compass_ is different than _compass golden_. 
175
176 ** 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. 
177
178 ** Two phrases are joined by and, so a search for _"golden compass"_ _"dark materials"_ is equivalent to _golden compass_ *and* _dark materials_. 
179
180 ** To prevent <<stemming,stemming>>, use double quotes around a single word or a phrase. So, a search for parenting will also return results for _parental_ but a search for _parenting_ will not.
181
182 * Truncation
183 Words may be right-hand truncated using an asterisk. Use a single asterisk * to truncate any number of characters.
184 (example: environment* agency)
185
186
187 Search Methodology
188 ~~~~~~~~~~~~~~~~~~
189
190 anchor:stemming[]
191
192 Stemming 
193 ^^^^^^^^
194
195 indexterm:[search methodology, stemming]
196
197 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 
198 is, words are reduced to their stem (or root word) before the search is performed. 
199
200 The stemming algorithm relies on common English language patterns - like verbs ending in _ing_ - to find the stems. This is more efficient that 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. 
201
202 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 for _golden compass_ because the search does not recognize _gold_ as a stem of _golden_. 
203
204
205 anchor:order_of_results[]
206
207 Order of Results
208 ^^^^^^^^^^^^^^^^
209
210 indexterm:[search methodology, order of results]
211
212 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, 
213 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. 
214
215 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 
216 the search result screen.
217
218
219 Search URL
220 ~~~~~~~~~~
221
222 indexterm:[search URL]
223
224 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.
225
226 Here is a basic search URL structure:
227
228
229 +++[hostname]+++/eg/opac/results?query=[search term]&**qtype**=keyword&fi%3Aitem_type=&**locg**=[location id]
230
231 locg Parameter
232 ^^^^^^^^^^^^^^
233 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.
234
235 qtype Parameter
236 ^^^^^^^^^^^^^^^
237
238 The _qtype_ parameter in the URL represents the search type values and represent one of the following search or request types:
239
240
241 * Keyword 
242 * Title
243 * Journal Title
244 * Author
245 * Subject
246 * Series
247 * Bib Call Number
248
249
250 These match the options in the search type drop-down box.
251
252 Sorting
253 ^^^^^^^
254
255 The _sort_ parameter sorts the results on one of these criteria.
256 • sort=pubdate (publication date) - chronological order
257 • sort=titlesort - Alphabetical order
258 • sort=authorsort - Alphabetical order on family name first
259
260 To change the sort direction of the resutls, the _sort_ paremeter value has the ".descending" suffix added to it.
261
262 * sort=titlesort.descending
263 * sort=authorsort.descending
264 * sort=pubdate.descending
265
266 In the absence of the _sort_ parameter, the search results default to sorting by relevance.
267
268
269 Search Results
270 ~~~~~~~~~~~~~~
271
272 indexterm:[search results]
273
274 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 
275 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: 
276
277
278 image::media/catalogue-3.png[catalogue-3]
279
280 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. Have your mouse over the icon, text explanation will show up in a small pop-up box. 
281
282 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.
283
284 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. 
285
286 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.
287
288
289 Facets: Subjects, Authors, and Series
290 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
291
292 indexterm:[search results, facets: subjects, authors, and series]
293
294 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. 
295
296 image::media/catalogue-5.png[catalogue-5]
297
298
299 Availability
300 ^^^^^^^^^^^^
301
302 indexterm:[search results, availability]
303
304 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.
305
306
307 image::media/catalogue-6.png[catalogue-6]
308
309 image::media/catalogue-7.png[catalogue-7]
310
311 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. 
312
313
314 Viewing a record
315 ^^^^^^^^^^^^^^^^
316
317 indexterm:[search results, viewing a record]
318
319 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. 
320
321 image::media/catalogue-8.png[catalogue-8]
322
323
324 Details
325 ^^^^^^^
326
327 indexterm:[search results, details]
328
329 The record shows details such as the cover image, title, author, publication information, and an abstract or summary, if available. 
330
331 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).   
332
333
334 Placing Holds 
335 ^^^^^^^^^^^^^
336
337 indexterm:[search results, placing holds]
338
339 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 
340 you will be notified when items become available. 
341
342 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.
343
344 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. 
345
346 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.
347
348
349 image::media/catalogue-9.png[catalogue-9]
350
351 Going back 
352 ^^^^^^^^^^
353
354 indexterm:[search results, going back]
355
356 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. 
357
358 image::media/catalogue-10.png[catalogue-10]
359
360 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.
361
362 anchor:my_account[]
363
364
365 My Account
366 ~~~~~~~~~~
367
368 // ``First Login Password Update'' the following documentation comes from JSPAC
369 // as of 2013-03-12 this feature did not exist in EG 2.4 TPAC,
370 // so I am commenting it out for now because it will be added in the future
371 // see bug report https://bugs.launchpad.net/evergreen/+bug/1013786
372 // Yamil Suarez 2013-03-12
373
374 ////
375
376
377 First Login Password Update 
378 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
379
380 indexterm:[my account, first login password update]
381
382 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. 
383
384 . Open a web browser and go to your Evergreen OPAC 
385 . Click My Account 
386 . Enter your _Username_ and _Password_. 
387   * By default, your username is your library card number. 
388   * 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. 
389 ////
390
391
392 Logging In 
393 ^^^^^^^^^^
394
395 indexterm:[my account, logging in]
396
397 Logging into your account from the online catalog: 
398
399 . Open a web browser and navigate to your Evergreen OPAC. 
400 . Click _My Account_ .
401 . Enter your _Username_ and _Password_. 
402 ** By default, your username is your library card number.
403 ** 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. 
404 . Click Login.
405 +
406 ** At the first login, you may be prompted to change your password. 
407 ** If you updated your password, you must enter your _Username_ and _Password_ again. 
408 +
409 . Your _Account Summary_ page displays.
410
411
412 To view your account details, click one of the _My Account_ tabs.
413
414 To start a search, enter a term in the search box at the top of the page and click _Search_! 
415
416 [CAUTION]
417 =================
418 If using a public computer be sure to log out! 
419 =================
420
421 anchor:password_reset[]
422
423 Password Reset
424 ^^^^^^^^^^^^^^
425
426 indexterm:[my account, password reset]
427
428
429 To reset your password: 
430
431 . click on the _Forgot your password?_ link located beside the login button. 
432
433 . Fill in the _Barcode_ and _User name_ text boxes. 
434
435 . A message should appear indicating that your request has been processed and that you will receive an email with further instructions. 
436
437 . 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.
438 +
439 [NOTE]
440 =================
441 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. 
442 =================
443 +
444
445 . 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. 
446
447 . Click _Submit_. 
448
449 . A message should appear on the page indicating that your password has been reset. 
450
451 . Login to your account with your new password. 
452
453
454 Account Summary
455 ^^^^^^^^^^^^^^^
456
457 indexterm:[my account, account summary]
458
459 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.
460
461
462 Items Checked Out 
463 ^^^^^^^^^^^^^^^^^
464
465 indexterm:[my account, items checked out]
466
467 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. 
468
469
470 Holds
471 ^^^^^ 
472
473 indexterm:[my account, holds]
474
475 From _My Account_, patrons can see _Items on hold_ and _Holds History_ and manage items currently being requested. 
476
477 Actions include: 
478
479 * Suspend - set a period of time during which the hold will not become active, such as during a vacation 
480 * Activate - manually remove the suspension 
481 * Cancel - remove the hold request 
482
483 Edit options include: 
484
485 * Change pick up library 
486 * Change the _Cancel unless filled by_ date, also known as the hold expiration date 
487 * Change the status of the hold to either active or suspended. 
488 * Change the _If suspended, activate on_ date, which reactivates a suspended hold at the specified date
489  
490 To edit items on hold: 
491
492 . Login to _My Account_, click the _Holds_ tab.
493 . Select the hold to modify. 
494 . Click _Edit_ for selected holds. 
495 . Select the change to make and follow the instructions.
496
497
498 Account Preferences 
499 ^^^^^^^^^^^^^^^^^^^
500
501 indexterm:[my account, account preferences]
502
503 From here you can manage display preferences including your _Personal Information_, _Notification Preferences_, and _Search and History Preferences_. 
504
505 For example: 
506
507 * Personal Information
508
509 ** change password - allows patrons to change their password
510
511 ** change email address - allows patrons to change their email address.
512
513
514
515 *  Notification Preferences
516
517 ** _Notify by Email_ by default when a hold is ready for pickup?        
518
519 ** _Notify by Phone_ by default when a hold is ready for pickup?
520
521 ** _Default Phone Number_
522
523
524 * Search and History Preferences
525
526 ** Search hits per page
527
528 ** Preferred pickup location
529
530 ** Keep history of checked out items?
531
532 ** Keep history of holds?
533
534
535 After changing any of these settings, remember to click _Save_ button.
536  
537
538
539 indexterm:[holds, preferred pickup location ]