Taiga #333 - Move XSLT material type information to cataloguing guides
[kohadocs.git] / source / opac.rst
1 .. include:: images.rst
2
3 OPAC
4 ====
5
6 This chapter assumes that you have the following preferences set as
7 follows:
8
9 -  :ref:`opacthemes` = bootstrap
10
11 -  :ref:`OPACXSLTResultsDisplay` = default
12
13 -  :ref:`OPACXSLTDetailsDisplay` = default
14
15 -  :ref:`DisplayOPACiconsXSLT` = show
16
17 -  :ref:`TagsEnabled` = Allow
18
19 -  :ref:`TagsInputOnDetail` =Allow
20
21 -  :ref:`TagsInputOnList` = Allow
22
23 -  :ref:`reviewson` = Allow
24
25 -  :ref:`ShowReviewer` = Allow
26
27 -  :ref:`ShowReviewerPhoto` =Allow
28
29 -  :ref:`OPACFRBRizeEditions` = Show
30
31 -  :ref:`OPACAmazonCoverImages` = Show
32
33 -  :ref:`XISBN` = Use
34
35 -  :ref:`OPACSearchForTitleIn` = Default set of
36    links
37
38 -  :ref:`OPACShowCheckoutName` = Don't show
39
40 -  :ref:`RequestOnOpac` = Allow
41
42 -  :ref:`AutoResumeSuspendedHolds` = Allow
43
44 -  :ref:`OpacBrowseResults` = Enable
45
46 -  :ref:`SuspendHoldsOpac` = Allow
47
48 -  :ref:`OPACShowBarcode` = Don't show
49
50 -  :ref:`OpacSeparateHoldings <opacseparateholdings-&-opacseparateholdingsbranch-label>` = Don't separate
51
52 -  :ref:`OpacSeparateHoldingsBranch <opacseparateholdings-&-opacseparateholdingsbranch-label>` = home library
53
54 -  :ref:`DisplayLibraryFacets` = holding library
55
56 If your system preferences are set differently your displays may differ.
57
58 .. _search-results-label:
59
60 Search Results
61 ---------------------------------------
62
63 To search the OPAC you can either choose to enter your search words in
64 the box at the top of the OPAC or click on the 'Advanced Search' link to
65 perform a more detailed search.
66
67 |image937|
68
69 For more on searching check the '`Searching <#searching>`__' chapter in
70 this manual.
71
72 .. _results-overview-label:
73
74 Results Overview
75 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76
77 After performing a search the number of results found for your search
78 will appear above the results
79
80 |image938|
81
82 By default your search results will be sorted based on your
83 :ref:`OPACdefaultSortField and OPACdefaultSortOrder <opacdefaultsortfield-and-opacdefaultsortorder-label>`
84 system preference values. To change this you can choose another sorting
85 method from the pull down on the right.
86
87 |image939|
88
89 Under each title on your results list a series of values from your
90 leader will appear. It is important to note that this has nothing to do
91 with the item types or collection codes you have applied to your
92 records, this data is all pulled from your fixed fields. This can be
93 turned on or off with the
94 :ref:`DisplayOPACiconsXSLT` system preference.
95
96 |image940|
97
98 Below each title you will see the availability for the items attached to
99 the record.
100
101     **Note**
102
103     Even if you filtered on one library location all locations that hold
104     the item will appear on the search results.
105
106     **Important**
107
108     An item's hold status doesn't not affect whether or not the item is
109     'available' until the item is in 'waiting' status. Items with
110     on-shelf holds will show as available until a librarian has pulled
111     them from the shelf and checked the item in make it show 'waiting'.
112
113 |image941|
114
115 If you have turned on :ref:`Enhanced Content`
116 preferences you may have book jackets on your search results.
117
118 |image942|
119
120 If you have set your :ref:`Did you mean? <did-you-mean?-label>` options you will
121 see a yellow bar across the top of your results will other related
122 searches.
123
124 |image943|
125
126 If you performed an advanced search you see an option to go back and
127 edit your advanced search blow the list of results pages.
128
129 |image1295|
130
131 .. _filters-label:
132
133 Filters
134 ~~~~~~~~~~~~~~~~~~~~~~~~~
135
136 To filter your results click on the links below the 'Refine Your Search'
137 menu on the left of your screen
138
139 |image944|
140
141 Depending on your setting for the
142 :ref:`DisplayLibraryFacets` system preference you
143 will see filters for your home, holding or both libraries.
144
145 |image1296|
146
147 After clicking a facet you can remove that filter from your results by
148 clicking the small 'x' that appears to the right of the facet.
149
150 |image1297|
151
152 .. _search-rss-feeds-label:
153
154 Search RSS Feeds
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156
157 You will be able to subscribe to your search results as an RSS feed by
158 clicking the RSS icon in your address bar or next to the number of
159 results. To learn more about what RSS feeds are check out `this tutorial
160 video <http://www.youtube.com/watch?v=0klgLsSxGsU>`__.
161
162 |image945|
163
164 Subscribing to search results as RSS feeds will allow you to see when a
165 new item is added to the catalog in your area of interest.
166
167 .. _bibliographic-record-label:
168
169 Bibliographic Record
170 --------------------------------------
171
172 When you click on a title from the search results, you're brought to the
173 bibliographic detail of the record. This page is broken down in several
174 different areas.
175
176 At the top of your screen will be the title and the GMD:
177
178 |image946|
179
180 Below the title the authors will be listed. These come from your 1xx and
181 7xx fields. Clicking the author will run a search for other titles with
182 that author.
183
184 |image947|
185
186 If you have an authority file you will see a magnifying glass to the
187 right of author (and other) authorities. Clicking that magnifying glass
188 will take you directly to the authority record.
189
190 |image948|
191
192 If you have your :ref:`DisplayOPACiconsXSLT`
193 preference set to 'show' you will see a material type that is determined
194 by values in your fixed fields (learn more in the :ref:`XSLT material 
195 type icons <_material-type-cataloging-guide-label>` catalouging guide.
196
197 |image949|
198
199 Next you'll see the description of the record you're viewing:
200
201 |image950|
202
203 Following that information you'll find the subject headings which can be
204 clicked to search for other titles on similar topics
205
206 |image951|
207
208 If your record has a table of contents or summary it will appear next to
209 the 'Summary' or 'Table of Contents' label
210
211 |image952|
212
213 If your record has data in the 856 fields you'll see the links to the
214 right of the 'Online Resources' label
215
216 |image953|
217
218 If the title you're viewing is in a public list then you'll see a list
219 of those to the right of the 'List(s) this item appears in' label and if
220 it has tags they will appear below the 'Tags from this library' label
221
222 |image954|
223
224 In the tabs below the details you will find your holdings data
225
226 |image955|
227
228 Any notes (5xx fields) that have been cataloged will appear under 'Title
229 Notes'
230
231 |image956|
232
233 If you're allowing comments they will appear in the next tab
234
235 |image957|
236
237 And finally if you have enabled FRBR and you have other editions of the
238 title in your collection you will see the 'Editions' tab.
239
240 |image958|
241
242 To the right of the details you'll find a series of boxes. The first box
243 is a list of buttons to help navigate the search results. From there you
244 can see the next or previous result from your search or return to the
245 results.
246
247 |image959|
248
249 Clicking Browse Results at the top of the right column will open up your
250 search results on the detail page
251
252 |image960|
253
254 Below the search buttons you'll find the links to place a hold, print
255 the record, save the record to your lists, or add it to your cart
256
257 |image961|
258
259 Clicking 'More Searches' will show the list of libraries you entered in
260 your :ref:`OPACSearchForTitleIn` preference
261
262 |image962|
263
264 Under the 'Save Record' label you will find a series of file formats you
265 can save the record as. This list can be customized by altering the
266 :ref:`OpacExportOptions` system preference.
267
268 |image963|
269
270 If at any time you want to change the view from the 'Normal' view to see
271 the Marc or the ISBD you can click the tabs across the top of the record
272
273 |image964|
274
275 .. _lists-&-cart-label:
276
277 Lists & Cart
278 ---------------------------------
279
280 A cart is a temporary holding place for records you're interested in
281 finding during this session. That means that once you log out of the
282 OPAC or close the browser you lose the items in your cart. A list is a
283 more permanent location for saving items. To learn more about lists,
284 check the `Lists in the Staff Client <#stafflists>`__ chapter of this
285 manual.
286
287 .. _lists-label:
288
289 Lists
290 ~~~~~~~~~~~~~~~~~~~~~~
291
292 Patrons can manage their own private lists by visiting the 'my lists'
293 section of their account.
294
295 |image965|
296
297 .. _creating-lists-label:
298
299 Creating Lists
300 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
301
302 Lists can also be created by choosing the 'New List' option in the 'Add
303 to' menu on the search results
304
305 |image966|
306
307 To create a list the patron simply needs to click the 'New List' link
308 and populate the form that appears
309
310 |image967|
311
312 The only field required is the 'List Name,' but the patron can also
313 choose how they want the list sorted and if the list is public or
314 private.
315
316 -  A Private List is managed by you and can be seen only by you
317    (depending on your permissions settings below)
318
319 -  A Public List can be seen by everybody, but managed only by you
320    (depending on your permissions settings below)
321
322     **Important**
323
324     If you aren't allowing patrons to create public lists with the
325     :ref:`OpacAllowPublicListCreation`
326     preference then patrons will only be able to create private lists.
327
328     |image968|
329
330 -  Finally decide what your permissions will be on the list. You can all
331    or disallow:
332
333    -  anyone else to add entries
334
335    -  anyone to remove his own contributed entries
336
337       -  **Note**
338
339              The owner of a list is always allowed to add entries, but
340              needs permission to remove.
341
342    -  anyone to remove other contributed entries Â  Â 
343
344 .. _adding-titles-to-lists-label:
345
346 Adding titles to Lists
347 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
348
349 Titles can be added to lists from the search results and/or from the
350 bibliographic record. On the search results options to add items to the
351 list appear below each result and across the top of the results page
352
353 |image969|
354
355 To add a single title to a list, click the 'Save to Lists' option and
356 then choose the list you'd like to add the title to. To add multiple
357 titles to a list check the boxes on the left of the titles you want to
358 add and then choose the list you want to add the titles to from the 'Add
359 too' pull down at the top of the screen.
360
361 .. _viewing-lists-contents-label:
362
363 Viewing Lists Contents
364 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
365
366 To view the contents of a list, click on the list name under the Lists
367 button.
368
369 |image970|
370
371 The contents of the list will look similar to your search results pages
372 except that there will be different menu options across the top of the
373 list.
374
375 |image971|
376
377 To the right of the list title there is an RSS icon that will allow you
378 to subscribe to updates to the list.
379
380 Using the menu options above the list you can place multiple items on
381 hold, download the list contents, email the list or print the list out.
382
383 -  To place a hold on one or more list items check the box to the left
384    of the item and click the 'Place Hold' link at the top
385
386 -  To download the list contents click the 'Download List' link and
387    choose the format you'd like to download the list in
388
389 -  To email the list contents to someone, click the 'Send List' link and
390    enter in your email details in the form that pops up (:ref:`view a sample
391    Lists email <example-email-from-list-label>`)
392
393    |image972|
394
395 -  To print the contents of your list out click the 'Print List' link
396
397 .. _managing-lists-label:
398
399 Managing Lists
400 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
401
402 Once the list is saved patrons can begin adding items to it. From the
403 'my lists' tab on the patron record the patron can edit and delete the
404 lists they have created by clicking the appropriate link to the right of
405 the list name.
406
407 |image973|
408
409 To edit the list's title or sorting patrons click the 'Edit' link to the
410 right of the list description.
411
412 |image974|
413
414 When clicking 'Delete' next to a list you will be asked to confirm that
415 you want to delete the list.
416
417 |image975|
418
419 The list will not be deleted until the 'Confirm' button is clicked to
420 the right of the list you'd like to delete.
421
422 If the library is allowing you to share private lists with the
423 :ref:`OpacAllowSharingPrivateLists`
424 preference then you will see the 'Share' link on your list of lists and
425 the 'Share list' link at the top of each individual list. Clicking this
426 will ask you to enter the email address of a patron.
427
428 |image1298|
429
430 Once the email address is entered Koha will present you with a
431 confirmation message
432
433 |image976|
434
435 and will send a message to that patron.
436
437 .. _cart-label:
438
439 Cart
440 ~~~~~~~~~~~~~~~~~~~~
441
442 .. _adding-titles-to-the-cart-label:
443
444 Adding titles to the Cart
445 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
446
447 Titles can be added to the cart from the search results and/or from the
448 bibliographic record. On the search results options to add items to the
449 cart appear below each result and across the top of the results page
450
451 |image977|
452
453 Clicking the 'Add to Cart' button will add the one title to your cart.
454 To add multiple titles at once, check the box to the left of each result
455 and then choose 'Cart' from the 'Add to' pull down at the top of the
456 screen. Once titles are added to the cart you will be presented with a
457 confirmation
458
459 |image978|
460
461 From the results you will see which items are in your cart and will be
462 able to remove those items by clicking '(remove)'.
463
464 |image1299|
465
466 .. _managing-the-cart-label:
467
468 Managing the Cart
469 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
470
471 Once you have titles in your cart you can manage the contents by
472 clicking on the 'Cart' button usually found at the top of the screen.
473 Your cart will open in a new window.
474
475 |image979|
476
477 From this window you are presented with several options. Across the top
478 of the cart are several buttons.
479
480 First is the 'More details' button. Clicking this will show you
481 additional information about the titles in your cart (ISBNs, Subjects,
482 Publisher Info, Notes and more).
483
484 |image1300|
485
486 Next is the option to send the contents of your cart to an email
487 address. This is handy if you want to send the resources you found at
488 the library to your home email account to refer to later or to send to a
489 patron researching a specific topic. Clicking this link will open up a
490 new window that asks for the email address and message to send. :ref:`View a
491 sample Cart email <example-email-from-cart-label>`.
492
493 |image980|
494
495     **Important**
496
497     The cart can only be emailed by logged in users. This will prevent
498     your cart email function from being used for spamming.
499
500 In addition to sending your cart you can download the contents of your
501 cart in several pre-defined formats or using a :ref:`CSV
502 Profile <csv-profiles-label>` that you defined in the Tools module.
503
504 |image981|
505
506 Finally you can print out the contents of your cart by choosing the
507 'Print' link.
508
509 In addition to the various different ways to save the contents of your
510 cart, there are ways to add value to the data in your cart. By selecting
511 one or more titles from the cart you can add them to a list (click 'Add
512 to a List'), place hold(s) (click 'Place hold'), or tag them (click
513 'Tag'). All of these operations follow the same procedure as they do
514 when performing them in the OPAC.
515
516 .. _placing-holds-label:
517
518 Placing Holds
519 ----------------------------------
520
521 Patrons can place holds on items via the OPAC if they're logged in and
522 you have the :ref:`RequestOnOpac` preference set to
523 'Allow'. If the item can be placed on hold the option to place it on
524 hold will appear in several different places.
525
526 -  When viewing a list or search results page you'll see the option to
527    place hold on multiple items by checking the boxes to the left of the
528    results and clicking 'Place Hold' at the top
529
530    |image982|
531
532 -  When viewing a list or search results page you'll see the option to
533    place the item on hold below the basic information about the title
534
535    |image983|
536
537 -  When viewing an individual title you'll see the option to place a
538    hold in the box on the right side of the screen
539
540    |image984|
541
542 No matter which of the above links you click to place your hold you'll
543 be brought to the same hold screen.
544
545 |image985|
546
547 -  Check the box to the left of the items you'd like to place on hold
548
549 -  The title includes a link back to the detail page for the record
550
551 -  The priority shows where in the holds queue this hold will fall
552
553 -  If allowed by your
554    :ref:`OPACAllowUserToChooseBranch`
555    preference the patron can choose where they'd like to pick up their
556    hold
557
558 -  If you would like to see more options you can click 'Show more
559    options'
560
561    Place Hold Form with More Options
562
563    -  If you have the
564       :ref:`AllowHoldItemTypeSelection`
565       preference set to 'Allow' and the record had more than one item
566       type attached you will see an option to choose to limit the hold
567       to a specific item type
568
569       |image1301|
570
571 -  If allowed by your
572    :ref:`OPACAllowHoldDateInFuture`
573    preference, the 'Hold Starts on Date' column will show. This field
574    allows the patron to have their hold start on a future date.
575
576 -  By default holds placed in the system remain until canceled, but if
577    the patron fills in a 'Hold Not Needed After' date then the hold has
578    an expiration date.
579
580    -  **Important**
581
582           Expired holds are removed by the :ref:`Expired Holds Cron
583           Job <expired-holds-label>`, this is not an automatic process
584           and must be set up by your system administrator
585
586 -  If allowed by the :ref:`OpacHoldNotes` preference then
587    patrons can leave notes about their holds for the library by clicking
588    the 'Edit notes' button
589
590    |image986|
591
592 -  Depending on the rules you set regarding item specific holds in your
593    :ref:`circulation and fines rules <circulation-and-fine-rules-label>` the patron will be
594    allowed to choose whether to place the hold on the next available
595    copy and/or a specific copy
596
597    |image987|
598
599 After clicking the Place Hold button the patron will be brought to their
600 account page where they'll see all of the items they have on hold.
601
602 .. _enhanced-content-label:
603
604 Enhanced Content
605 -------------------------------------------
606
607 .. _opac-tagging-label:
608
609 Tagging
610 ~~~~~~~~~~~~~~~~~~~~~~~~~~
611
612 Depending on your settings for the :ref:`TagsEnabled`,
613 :ref:`TagsInputOnList` and
614 :ref:`TagsInputOnDetail` preferences you may be able
615 to add tags to bibliographic records from the search results and/or
616 bibliographic records. If you are allowing patrons to add tags from the
617 search results screen you will see an input box below each result and a
618 'Tag' option at the top of the screen.
619
620 |image988|
621
622 To add a tag to one item, type the tabs (separated by commas) in the
623 'New tag' box and click 'Add'. You will be presented with a confirmation
624 of your tags being added.
625
626 |image989|
627
628 From the results you can also tag items in bulk by clicking the
629 checkboxes on the left and then clicking the 'Tag' button at the top.
630 After clicking the button it will change into an input box for you to
631 add tags to all of the items you have selected.
632
633 |image990|
634
635 .. _comments-label:
636
637 Comments
638 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
639
640 Patrons can leave comments in the OPAC if you have the
641 :ref:`reviewson` preference set to allow this. Each
642 bibliographic record has a comments tab below the bibliographic
643 information.
644
645 |image991|
646
647 If the patron is logged in they will see a link to add a comment to the
648 item. Clicking this link will open a pop up window with a box for their
649 comments.
650
651 |image992|
652
653 Once the comment has been typed and the 'Submit' button clicked, the
654 patron will see their comment as pending and other patrons will simply
655 see that there are no comments on the item.
656
657 |image993|
658
659 Once the comment is approved the patron will see the number of comments
660 on the 'Comments' tab and their comment labeled amongst the other
661 comments. If you have set your
662 :ref:`ShowReviewerPhoto` preference to 'Show' then
663 you'll see the patron's photo pulled from the
664 `Libravatar <https://www.libravatar.org>`__ library.
665
666 |image994|
667
668 Other patrons will see the comment with the name of the patron who left
669 the comment (unless you have set the :ref:`ShowReviewer`
670 preference to not show patron names).
671
672 |image995|
673
674 If you have your :ref:`OpacShowRecentComments`
675 set to show then you'll see the approved comments on that page.
676
677 |image996|
678
679 From this page patrons can subscribe to the recent comments using RSS if
680 they would like.
681
682 .. _zotero-label:
683
684 Zotero
685 ~~~~~~~~~~~~~~~~~~~~
686
687 Zotero is a Firefox add on that allows for the saving and generating of
688 a bibliography. Learn more about and download Zotero at
689 http://zotero.org.
690
691 When on the search results in the Koha OPAC, if you have Zotero
692 installed, you will see a folder icon in the address bar to the right of
693 the URL. Clicking that folder will open up a list of titles on the page
694 for you to pick from to add to Zotero.
695
696 |image997|
697
698 Select the titles you want to add to Zotero and then click the 'OK'
699 button. This will add the title to Zotero. You can see the title by
700 opening your Zotero library.
701
702 |image998|
703
704 .. _custom-rss-feeds-label:
705
706 Custom RSS Feeds
707 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
708
709 Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for any SQL
710 query (for example a new acquisitions RSS feed). rss.pl is run on the
711 command line to produce an RSS XML document.
712
713 The output should be placed in a directory accessible to the OPAC (or
714 staff) web interface so that users can download the RSS feed.
715
716 An example of usage can be found at: misc/cronjobs/rss.pl
717 lastAcquired.conf
718
719 Normally rss.pl should be run periodically (e.g., daily) to keep the
720 feed up-to-date.
721
722 The configuration file (e.g., lastAcquired.conf) lists
723
724 -  name of the template file to use
725
726 -  path of output file
727
728 -  SQL query
729
730 rss.pl runs the SQL query, then feeds the output of the query through
731 the template to produce the output file.
732
733     **Important**
734
735     To use custom RSS feeds you need to turn on the rss.pl cron job.
736
737 .. _opac-self-registration-label:
738
739 OPAC Self Registration
740 ----------------------------------------------
741
742 If you allow it, patrons can register for their own accounts via the
743 OPAC. If you have the
744 :ref:`PatronSelfRegistration` preference set to
745 'Allow' then patrons will see a link to register below the log in box on
746 the right of the main OPAC page.
747
748 |image999|
749
750 When the patron clicks the 'Register here' link they will be brough to a
751 registration page. The options on the registration page can be conrolled
752 by editing the
753 :ref:`PatronSelfRegistrationBorrowerMandatoryField`
754 and the
755 :ref:`PatronSelfRegistrationBorrowerUnwantedField`
756 preferences.
757
758 |image1000|
759
760 Once the patron has confirmed submitted their registration they will
761 either be sent an email to confirm their account (if you have the
762 :ref:`PatronSelfRegistrationVerifyByEmail`
763 preference to require this) or presented with their new username and
764 password.
765
766 |image1001|
767
768 Patrons registered in this way will not have a cardnumber until assigned
769 one by the library, but will have access to all OPAC functionality
770 immediately. For this reason it is recommended that you:
771
772 -  set up a provisional :ref:`patron category <adding-a-patron-category-label>` for self
773    registered patrons (such as 'Self Registered) instead of using an
774    existing patron category and set that value in the
775    :ref:`PatronSelfRegistrationDefaultCategory`
776    preference
777
778 -  give this patron category minimal circulation privileges in the
779    :ref:`Circulation and Fine Rules` (such as allowing a
780    couple holds, but no check outs)
781
782 That way patrons will either have to come in to the library to verify
783 their identity before given a cardnumber and the ability to check items
784 out or the library will have to come up with internal policy on
785 generating cardnumbers before providing them to self registered patrons.
786 Once this is done the library can change the category to one that is
787 more appropriate (be it an adult, resident, non resident, student, etc)
788 and add a cardnumber/barcode.
789
790 .. _my-account-label:
791
792 My Account
793 -------------------------------
794
795 From the OPAC patrons can log in and access their account if you have
796 set the :ref:`opacuserlogin` preference to 'Allow'. Once
797 logged in patrons are brought to their account summary. If you would
798 like to get to your account in the OPAC, you can click on your name in
799 the top right of any page in the OPAC.
800
801 .. _resetting-your-password-label:
802
803 Resetting your password
804 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
805
806 If you have the :ref:`OpacResetPassword` set to allow
807 patrons to reset their password they can click 'Forgot your password?'
808 link found under the log in box to reset their passwords.
809
810 |image1002|
811
812 Once clicked they will be presented with a form asking for their
813 username and their email address (patrons must have an email address on
814 file to reset their password).
815
816 |image1302|
817
818 The system will then email the patron instructions for resetting their
819 password.
820
821 |image1303|
822
823 .. _my-summary-label:
824
825 My Summary
826 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
827
828 |image1003|
829
830 From the 'my summary' tab, patrons will see all of the items they have
831 checked out with the overdue items highlighted in red. If you have
832 :ref:`OpacRenewalAllowed` set to 'Allow' then your
833 patrons will be able to renew their books right from the OPAC. If you
834 have HTML entered in the :ref:`OPACMySummaryHTML`
835 preference then you will see that to the right of the 'Fines' column.
836
837 |image1004|
838
839 If your patrons would like to see the items barcodes on their list of
840 checked out items you can set up a :ref:`patron
841 attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
842 :ref:`authorized value <authorized-values-label>` of YES\_NO.
843
844 |image1005|
845
846 Then on the :ref:`patron's record set the value <editing-patrons-label>` for
847 SHOW\_BCODE to yes.
848
849 |image1006|
850
851 This will add a column to the check out summary in the OPAC that shows
852 the patrons the barcodes of the items they have checked out.
853
854 |image1007|
855
856 If you would like your patrons to leave a note on an item they have checked out
857 :ref:`allowcheckoutnotes` preference must be set to allow.
858
859 In the patron's summary of checkouts, there will be an added column 
860 to allow the patron to leave a note (for example:  missing first page, or DVD is
861 scratched).  This note once confirmed by the patron will appear to the staff
862 when this item is checked in. 
863
864 If their guarantee has allowed it via :ref:`their
865 privacy <my-privacy-label>`, when the guarantor logs in they will see a
866 tab labeled "Relatives' checkouts" on their summary tab.
867
868 |image1304|
869
870 Clicking on the 'Overdue' tab will show only the items that are overdue.
871
872 |image1008|
873
874 The 'Fines' tab will show just a total of what the patron owes. Clicking
875 on the total will take them to the 'my fines' tab where they will see a
876 complete breakdown of their fines and bills. If you don't charge fines
877 at your library you can turn the display of these tabs off by setting
878 the :ref:`OPACFinesTab` preference to 'Don't Allow.'
879
880 |image1009|
881
882 Finally, clicking on the 'Holds' tab will show the patron the status of
883 all of the items they have on hold.
884
885 |image1010|
886
887 Patrons can cancel or suspend (depending on the value of your
888 :ref:`SuspendHoldsOpac` system preference) their own
889 holds if they are not in transit or already waiting for them. When they
890 click 'Suspend' they will be presented with the option to choose a date
891 for their hold to resume.
892
893 |image1305|
894
895 They can also suspend all of their holds indefinitely or until a
896 specific date if they choose by filling in the suspend options at the
897 bottom of the page.
898
899     **Note**
900
901     If you have your
902     :ref:`AutoResumeSuspendedHolds` preference
903     set to "Don't allow" then you will not have the option to put an end
904     date on the hold suspension
905
906 .. _patron-flags-label:
907
908 Patron Flags
909 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
910
911 If you have `flagged your patron's account <#patronflags>`__ they may
912 see one of the following error messages at the top of their account.
913
914 -  Card marked as lost
915
916    |image1011|
917
918 -  Patron address in question
919
920    |image1012|
921
922    -  **Note**
923
924           this error message will not include a link to the update form
925           if you have :ref:`OPACPatronDetails` set to
926           'Don't allow'
927
928 -  Patron marked restricted
929
930    |image1013|
931
932 .. _my-fines-label:
933
934 My Fines
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
936
937 If your library charges fines the next tab on the left is 'my fines.'
938 Opening this tab will show the patron an entire history of their
939 accounting at the library.
940
941 |image1014|
942
943 If you are allowing patrons to pay their fines using PayPal with the
944 :ref:`EnablePayPalOpacPayments <enablepaypalopacpayments-&-paypalsandboxmode-label>` preference
945 there will be checkboxes to the left of each fine with an outstanding
946 amount.
947
948 |image1306|
949
950 At the bottom the patron will see the option to pay with PayPal for the
951 items they have checked.
952
953 |image1015|
954
955 After paying they will be presented with a confirmation
956
957 |image1307|
958
959 And you will see that the fine was paid using PayPal on the staff
960 side.
961
962 |image1308|
963
964 .. _my-details-label:
965
966 My Details
967 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
968
969 If you have your :ref:`OPACPatronDetails` preference
970 set to 'Allow', your patrons will see a form filled in with their
971 contacting information by clicking on the 'my personal details' tab. You
972 can control what fields patrons see and can modify via the OPAC by
973 setting the
974 :ref:`PatronSelfRegistrationBorrowerMandatoryField`
975 :ref:`PatronSelfRegistrationBorrowerUnwantedField`
976 preferences.
977
978 |image1016|
979
980 Patrons can edit their details in this form and click 'Submit Changes'
981 to have their edits sent to the library for review before their record
982 is updated. Staff will see all patrons requesting modification to their
983 record listed below the modules on the main dashboard along with
984 anything else awaiting library attention.
985
986 |image1017|
987
988 If the :ref:`OPACPatronDetails` preference is set to
989 'Don't allow' then patrons will simply see their details and a message
990 stating that they should contact the library for changes.
991
992 |image1018|
993
994 .. _my-tags-label:
995
996 My Tags
997 ~~~~~~~~~~~~~~~~~~~~~~~~~
998
999 If your library has :ref:`TagsEnabled` set to 'Allowed' then
1000 the next tab on the left will be 'my tags.' This tab will show patrons
1001 all of the tags in the system as a cloud and then all of the tags they
1002 have applied in a list format. From here patrons have the ability to
1003 remove tags that they have added if they want.
1004
1005 |image1019|
1006
1007 .. _change-my-password-label:
1008
1009 Change My Password
1010 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1011
1012 Next, if you have :ref:`OpacPasswordChange` set to
1013 'Allow' the next tab will be 'change my password,' where patrons can
1014 change their password for logging into the OPAC. Patrons will be
1015 presented with a standard form asking them to enter their old password
1016 and then their new password twice.
1017
1018 |image1020|
1019
1020 .. _my-search-history-label:
1021
1022 My Search History
1023 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1024
1025 If you have your :ref:`EnableOpacSearchHistory`
1026 preference set to 'Allow' then your patrons can access their search
1027 history via the 'my search history' tab.
1028
1029 |image1021|
1030
1031 The search history is a record of all searches run by the patron.
1032 Clicking on any of the search phrases will re-run the search for the
1033 patron. The search history can be deleted by the patron at any time by
1034 clicking the 'Delete your search history' link found at the top of this
1035 tab or by clicking the little red 'x' next to the 'Search history' link
1036 at the top right of the OPAC.
1037
1038 |image1022|
1039
1040 .. _my-reading-history-label:
1041
1042 My Reading History
1043 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1044
1045 Depending on your library's setting for
1046 :ref:`opacreadinghistory` your patrons may see the
1047 'my reading history' tab next. This will show the patron their entire
1048 reading history unless they have asked the library to not keep that
1049 information via the 'my privacy' tab which will appear if you have the
1050 :ref:`OPACPrivacy` preference set to 'Allow.'
1051
1052 |image1023|
1053
1054 If you have HTML entered in the
1055 :ref:`OPACMySummaryHTML` preference then you will see
1056 that to the right of the 'Date' column.
1057
1058 .. _my-privacy-label:
1059
1060 My Privacy
1061 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1062
1063 The 'my privacy' tab will appear if you have both the
1064 :ref:`opacreadinghistory` and the
1065 :ref:`OPACPrivacy` preferences set to 'Allow.' This tab will
1066 allow the patrons to decide how the library keeps their circulation
1067 history data.
1068
1069 |image1024|
1070
1071 The patron can choose from three options:
1072
1073 -  Forever: keep my reading history without limit. This is the option
1074    for users who want to keep track of what they are reading.
1075
1076 -  Default: keep my reading history according to local laws. This is the
1077    default option : the library will keep your reading history for the
1078    duration permitted by local laws.
1079
1080 -  Never: Delete my reading history immediately. This will delete all
1081    record of the item that was checked-out upon check-in.
1082
1083 Depending on the patron's suggestions the contents of the ':ref:`my reading
1084 history <my-reading-history-label>`' tab and the ':ref:`Circulation
1085 History <circulation-history-label>`' tab in the staff client may change.
1086
1087 Regardless of the patron's choice they can delete their reading history
1088 in bulk at any time by clicking the 'Immediate deletion' button.
1089
1090 |image1025|
1091
1092 Clicking this button will not delete items that are currently checked
1093 out, but will clear the patron's past reading history.
1094
1095     **Important**
1096
1097     In order for the patron to be able to delete their reading history
1098     you must have the :ref:`AnonymousPatron` preference
1099     set.
1100
1101 If you're allowing guarantees to grand permission to their guarantors to
1102 view their current checkouts with the
1103 :ref:`AllowPatronToSetCheckoutsVisibilityForGuarantor`
1104 preference they will see that option on this
1105 screen.
1106
1107 |image1309|
1108
1109 When the guarantor logs in they will see a tab labeled "Relatives'
1110 checkouts" on their summary tab.
1111
1112 |image1310|
1113
1114 .. _my-purchase-suggestions-label:
1115
1116 My Purchase Suggestions
1117 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1118
1119 If your library allows patrons to make purchase suggestions the next tab
1120 will show all suggestions that the patron made to the library and their
1121 statuses. To disable this tab and the suggestion functionality set the
1122 :ref:`suggestion` preference to 'Don't allow.'
1123
1124 |image1026|
1125
1126 If you have :ref:`OPACViewOthersSuggestions`
1127 set to 'Show' then patrons will be able to search suggestions from the
1128 top of this list.
1129
1130 .. _my-messaging-label:
1131
1132 My Messaging
1133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1134
1135 If your library has the
1136 :ref:`EnhancedMessagingPreferences` and the
1137 :ref:`EnhancedMessagingPreferencesOPAC`
1138 preferences set to 'Allow' then your patrons will be able to choose
1139 which messages they receive from the library (with the exception of
1140 overdue notices which the library controls).
1141
1142 |image1027|
1143
1144 If you use an outside driver for sending text messages set with the
1145 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
1146 additional column to receive these messages as SMS (or text messages)
1147 and a field for a cell (or SMS) number.
1148
1149 |image1028|
1150
1151 If you are using the Email protocol for sending text messages set with
1152 the :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
1153 additional column to receive these messages as SMS (or text messages), a
1154 field for a cell (or SMS) number, and a pull down listing :ref:`cellular
1155 providers entered in administration <sms-cellular-providers-label>`.
1156
1157 |image1029|
1158
1159 If you are using the :ref:`Itiva Talking
1160 Tech <talkingtechitivaphonenotification-label>` service you will see an
1161 additional column to receive these messages via Phone.
1162
1163 |image1311|
1164
1165 -  These notices are:
1166
1167    -  Advanced notice : A notice in advance of the patron's items being
1168       due (The patron can choose the number of days in advance)
1169
1170    -  Item checkout : A notice that lists all the of the items the
1171       patron has just checked out and/or renewed, this is an electronic
1172       form of the checkout receipt
1173
1174    -  Hold filled : A notice when you have confirmed the hold is waiting
1175       for the patron
1176
1177    -  Item due : A notice on the day and item is due back at the library
1178
1179    -  Item check-in : A notice that lists all the of the items the
1180       patron has just checked in
1181
1182 Patrons can choose to receive their notices as a digest by checking the
1183 'Digest only?' box along with the delivery method. A digest is a
1184 combination of all the messages of that type (so all items due in 3 days
1185 in one email) in to one email instead of multiple emails for each alert.
1186
1187     **Important**
1188
1189     You must choose a delivery method (SMS or Email or Phone) along with
1190     'Digest only?' if you would like to receive a digest of the
1191     messages.
1192
1193 .. _my-lists-label:
1194
1195 My Lists
1196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1197
1198 Finally, if your library has the :ref:`virtualshelves`
1199 set to 'Allow' then the last tab will by 'my lists.' From here your
1200 patrons can review public lists and create or edit their own private
1201 lists.
1202
1203 |image1030|
1204
1205 .. _ask-for-a-discharge-label:
1206
1207 Ask for a Discharge
1208 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1209
1210 If you have enabled the :ref:`useDischarge` preference then
1211 patrons will be able to request a discharge via the OPAC.
1212
1213 |image1312|
1214
1215 From here patrons can request a discharge
1216
1217 |image1031|
1218
1219 And will receive confirmation of their request.
1220
1221 |image1032|
1222
1223 .. _purchase-suggestions-label:
1224
1225 Purchase Suggestions
1226 -------------------------------------------
1227
1228 If your library has the :ref:`suggestion` preference set
1229 to 'Allow' then patrons will have the option to make purchase
1230 suggestions in several areas in the OPAC.
1231
1232 If you are allowing everyone to see the purchase suggestions made by
1233 others with the
1234 :ref:`OPACViewOthersSuggestions` preference,
1235 then there will be a link at the top of your OPAC under the search box.
1236
1237 |image1033|
1238
1239 There will be a link when the patron finds nothing for their search.
1240
1241 |image1034|
1242
1243 And there will be a link on the patron's :ref:`My Purchase
1244 Suggestions <my-purchase-suggestions-label>` tab.
1245
1246 |image1035|
1247
1248 Clicking any one of these links will open the purchase suggestion form.
1249
1250 |image1036|
1251
1252 -  From the form on the 'Title' is required by the library.
1253
1254 -  The Item type list can be edited by editing the SUGGEST\_FORMAT
1255    :ref:`authorized value <authorized-values-label>`.
1256
1257 -  If you would like the 'Reason for suggestion' menu shown in the
1258    screenshot above to appear on your suggestions list you need to add
1259    an :ref:`authorized value <authorized-values-label>` category titled
1260    'OPAC\_SUG' and include reasons as values in that list.
1261
1262 -  If you would like the patron to be able to choose which branch they
1263    are making a suggestion for you need to set the
1264    :ref:`AllowPurchaseSuggestionBranchChoice`
1265    preference to 'Allow'
1266
1267 Once the form is submitted the data will be saved to the
1268 :ref:`Acquisitions <managing-suggestions-label>` module for the librarians to manage.