Bug 20790: Fix dangling refs to removed sample cart/list emails
[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
391
392    |image972|
393
394 -  To print the contents of your list out click the 'Print List' link
395
396 .. _managing-lists-label:
397
398 Managing Lists
399 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
400
401 Once the list is saved patrons can begin adding items to it. From the
402 'my lists' tab on the patron record the patron can edit and delete the
403 lists they have created by clicking the appropriate link to the right of
404 the list name.
405
406 |image973|
407
408 To edit the list's title or sorting patrons click the 'Edit' link to the
409 right of the list description.
410
411 |image974|
412
413 When clicking 'Delete' next to a list you will be asked to confirm that
414 you want to delete the list.
415
416 |image975|
417
418 The list will not be deleted until the 'Confirm' button is clicked to
419 the right of the list you'd like to delete.
420
421 If the library is allowing you to share private lists with the
422 :ref:`OpacAllowSharingPrivateLists`
423 preference then you will see the 'Share' link on your list of lists and
424 the 'Share list' link at the top of each individual list. Clicking this
425 will ask you to enter the email address of a patron.
426
427 |image1298|
428
429 Once the email address is entered Koha will present you with a
430 confirmation message
431
432 |image976|
433
434 and will send a message to that patron.
435
436 .. _cart-label:
437
438 Cart
439 ~~~~~~~~~~~~~~~~~~~~
440
441 .. _adding-titles-to-the-cart-label:
442
443 Adding titles to the Cart
444 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
445
446 Titles can be added to the cart from the search results and/or from the
447 bibliographic record. On the search results options to add items to the
448 cart appear below each result and across the top of the results page
449
450 |image977|
451
452 Clicking the 'Add to Cart' button will add the one title to your cart.
453 To add multiple titles at once, check the box to the left of each result
454 and then choose 'Cart' from the 'Add to' pull down at the top of the
455 screen. Once titles are added to the cart you will be presented with a
456 confirmation
457
458 |image978|
459
460 From the results you will see which items are in your cart and will be
461 able to remove those items by clicking '(remove)'.
462
463 |image1299|
464
465 .. _managing-the-cart-label:
466
467 Managing the Cart
468 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
469
470 Once you have titles in your cart you can manage the contents by
471 clicking on the 'Cart' button usually found at the top of the screen.
472 Your cart will open in a new window.
473
474 |image979|
475
476 From this window you are presented with several options. Across the top
477 of the cart are several buttons.
478
479 First is the 'More details' button. Clicking this will show you
480 additional information about the titles in your cart (ISBNs, Subjects,
481 Publisher Info, Notes and more).
482
483 |image1300|
484
485 Next is the option to send the contents of your cart to an email
486 address. This is handy if you want to send the resources you found at
487 the library to your home email account to refer to later or to send to a
488 patron researching a specific topic. Clicking this link will open up a
489 new window that asks for the email address and message to send.
490
491 |image980|
492
493     **Important**
494
495     The cart can only be emailed by logged in users. This will prevent
496     your cart email function from being used for spamming.
497
498 In addition to sending your cart you can download the contents of your
499 cart in several pre-defined formats or using a :ref:`CSV
500 Profile <csv-profiles-label>` that you defined in the Tools module.
501
502 |image981|
503
504 Finally you can print out the contents of your cart by choosing the
505 'Print' link.
506
507 In addition to the various different ways to save the contents of your
508 cart, there are ways to add value to the data in your cart. By selecting
509 one or more titles from the cart you can add them to a list (click 'Add
510 to a List'), place hold(s) (click 'Place hold'), or tag them (click
511 'Tag'). All of these operations follow the same procedure as they do
512 when performing them in the OPAC.
513
514 .. _placing-holds-label:
515
516 Placing Holds
517 ----------------------------------
518
519 Patrons can place holds on items via the OPAC if they're logged in and
520 you have the :ref:`RequestOnOpac` preference set to
521 'Allow'. If the item can be placed on hold the option to place it on
522 hold will appear in several different places.
523
524 -  When viewing a list or search results page you'll see the option to
525    place hold on multiple items by checking the boxes to the left of the
526    results and clicking 'Place Hold' at the top
527
528    |image982|
529
530 -  When viewing a list or search results page you'll see the option to
531    place the item on hold below the basic information about the title
532
533    |image983|
534
535 -  When viewing an individual title you'll see the option to place a
536    hold in the box on the right side of the screen
537
538    |image984|
539
540 No matter which of the above links you click to place your hold you'll
541 be brought to the same hold screen.
542
543 |image985|
544
545 -  Check the box to the left of the items you'd like to place on hold
546
547 -  The title includes a link back to the detail page for the record
548
549 -  The priority shows where in the holds queue this hold will fall
550
551 -  If allowed by your
552    :ref:`OPACAllowUserToChooseBranch`
553    preference the patron can choose where they'd like to pick up their
554    hold
555
556 -  If you would like to see more options you can click 'Show more
557    options'
558
559    Place Hold Form with More Options
560
561    -  If you have the
562       :ref:`AllowHoldItemTypeSelection`
563       preference set to 'Allow' and the record had more than one item
564       type attached you will see an option to choose to limit the hold
565       to a specific item type
566
567       |image1301|
568
569 -  If allowed by your
570    :ref:`OPACAllowHoldDateInFuture`
571    preference, the 'Hold Starts on Date' column will show. This field
572    allows the patron to have their hold start on a future date.
573
574 -  By default holds placed in the system remain until canceled, but if
575    the patron fills in a 'Hold Not Needed After' date then the hold has
576    an expiration date.
577
578    -  **Important**
579
580           Expired holds are removed by the :ref:`Expired Holds Cron
581           Job <expired-holds-label>`, this is not an automatic process
582           and must be set up by your system administrator
583
584 -  If allowed by the :ref:`OpacHoldNotes` preference then
585    patrons can leave notes about their holds for the library by clicking
586    the 'Edit notes' button
587
588    |image986|
589
590 -  Depending on the rules you set regarding item specific holds in your
591    :ref:`circulation and fines rules <circulation-and-fine-rules-label>` the patron will be
592    allowed to choose whether to place the hold on the next available
593    copy and/or a specific copy
594
595    |image987|
596
597 After clicking the Place Hold button the patron will be brought to their
598 account page where they'll see all of the items they have on hold.
599
600 .. _enhanced-content-label:
601
602 Enhanced Content
603 -------------------------------------------
604
605 .. _opac-tagging-label:
606
607 Tagging
608 ~~~~~~~~~~~~~~~~~~~~~~~~~~
609
610 Depending on your settings for the :ref:`TagsEnabled`,
611 :ref:`TagsInputOnList` and
612 :ref:`TagsInputOnDetail` preferences you may be able
613 to add tags to bibliographic records from the search results and/or
614 bibliographic records. If you are allowing patrons to add tags from the
615 search results screen you will see an input box below each result and a
616 'Tag' option at the top of the screen.
617
618 |image988|
619
620 To add a tag to one item, type the tabs (separated by commas) in the
621 'New tag' box and click 'Add'. You will be presented with a confirmation
622 of your tags being added.
623
624 |image989|
625
626 From the results you can also tag items in bulk by clicking the
627 checkboxes on the left and then clicking the 'Tag' button at the top.
628 After clicking the button it will change into an input box for you to
629 add tags to all of the items you have selected.
630
631 |image990|
632
633 .. _comments-label:
634
635 Comments
636 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
637
638 Patrons can leave comments in the OPAC if you have the
639 :ref:`reviewson` preference set to allow this. Each
640 bibliographic record has a comments tab below the bibliographic
641 information.
642
643 |image991|
644
645 If the patron is logged in they will see a link to add a comment to the
646 item. Clicking this link will open a pop up window with a box for their
647 comments.
648
649 |image992|
650
651 Once the comment has been typed and the 'Submit' button clicked, the
652 patron will see their comment as pending and other patrons will simply
653 see that there are no comments on the item.
654
655 |image993|
656
657 Once the comment is approved the patron will see the number of comments
658 on the 'Comments' tab and their comment labeled amongst the other
659 comments. If you have set your
660 :ref:`ShowReviewerPhoto` preference to 'Show' then
661 you'll see the patron's photo pulled from the
662 `Libravatar <https://www.libravatar.org>`__ library.
663
664 |image994|
665
666 Other patrons will see the comment with the name of the patron who left
667 the comment (unless you have set the :ref:`ShowReviewer`
668 preference to not show patron names).
669
670 |image995|
671
672 If you have your :ref:`OpacShowRecentComments`
673 set to show then you'll see the approved comments on that page.
674
675 |image996|
676
677 From this page patrons can subscribe to the recent comments using RSS if
678 they would like.
679
680 .. _zotero-label:
681
682 Zotero
683 ~~~~~~~~~~~~~~~~~~~~
684
685 Zotero is a Firefox add on that allows for the saving and generating of
686 a bibliography. Learn more about and download Zotero at
687 http://zotero.org.
688
689 When on the search results in the Koha OPAC, if you have Zotero
690 installed, you will see a folder icon in the address bar to the right of
691 the URL. Clicking that folder will open up a list of titles on the page
692 for you to pick from to add to Zotero.
693
694 |image997|
695
696 Select the titles you want to add to Zotero and then click the 'OK'
697 button. This will add the title to Zotero. You can see the title by
698 opening your Zotero library.
699
700 |image998|
701
702 .. _custom-rss-feeds-label:
703
704 Custom RSS Feeds
705 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
706
707 Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for any SQL
708 query (for example a new acquisitions RSS feed). rss.pl is run on the
709 command line to produce an RSS XML document.
710
711 The output should be placed in a directory accessible to the OPAC (or
712 staff) web interface so that users can download the RSS feed.
713
714 An example of usage can be found at: misc/cronjobs/rss.pl
715 lastAcquired.conf
716
717 Normally rss.pl should be run periodically (e.g., daily) to keep the
718 feed up-to-date.
719
720 The configuration file (e.g., lastAcquired.conf) lists
721
722 -  name of the template file to use
723
724 -  path of output file
725
726 -  SQL query
727
728 rss.pl runs the SQL query, then feeds the output of the query through
729 the template to produce the output file.
730
731     **Important**
732
733     To use custom RSS feeds you need to turn on the rss.pl cron job.
734
735 .. _opac-self-registration-label:
736
737 OPAC Self Registration
738 ----------------------------------------------
739
740 If you allow it, patrons can register for their own accounts via the
741 OPAC. If you have the
742 :ref:`PatronSelfRegistration` preference set to
743 'Allow' then patrons will see a link to register below the log in box on
744 the right of the main OPAC page.
745
746 |image999|
747
748 When the patron clicks the 'Register here' link they will be brough to a
749 registration page. The options on the registration page can be conrolled
750 by editing the
751 :ref:`PatronSelfRegistrationBorrowerMandatoryField`
752 and the
753 :ref:`PatronSelfRegistrationBorrowerUnwantedField`
754 preferences.
755
756 |image1000|
757
758 Once the patron has confirmed submitted their registration they will
759 either be sent an email to confirm their account (if you have the
760 :ref:`PatronSelfRegistrationVerifyByEmail`
761 preference to require this) or presented with their new username and
762 password.
763
764 |image1001|
765
766 Patrons registered in this way will not have a cardnumber until assigned
767 one by the library, but will have access to all OPAC functionality
768 immediately. For this reason it is recommended that you:
769
770 -  set up a provisional :ref:`patron category <adding-a-patron-category-label>` for self
771    registered patrons (such as 'Self Registered) instead of using an
772    existing patron category and set that value in the
773    :ref:`PatronSelfRegistrationDefaultCategory`
774    preference
775
776 -  give this patron category minimal circulation privileges in the
777    :ref:`Circulation and Fine Rules` (such as allowing a
778    couple holds, but no check outs)
779
780 That way patrons will either have to come in to the library to verify
781 their identity before given a cardnumber and the ability to check items
782 out or the library will have to come up with internal policy on
783 generating cardnumbers before providing them to self registered patrons.
784 Once this is done the library can change the category to one that is
785 more appropriate (be it an adult, resident, non resident, student, etc)
786 and add a cardnumber/barcode.
787
788 .. _my-account-label:
789
790 My Account
791 -------------------------------
792
793 From the OPAC patrons can log in and access their account if you have
794 set the :ref:`opacuserlogin` preference to 'Allow'. Once
795 logged in patrons are brought to their account summary. If you would
796 like to get to your account in the OPAC, you can click on your name in
797 the top right of any page in the OPAC.
798
799 .. _resetting-your-password-label:
800
801 Resetting your password
802 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
803
804 If you have the :ref:`OpacResetPassword` set to allow
805 patrons to reset their password they can click 'Forgot your password?'
806 link found under the log in box to reset their passwords.
807
808 |image1002|
809
810 Once clicked they will be presented with a form asking for their
811 username and their email address (patrons must have an email address on
812 file to reset their password).
813
814 |image1302|
815
816 The system will then email the patron instructions for resetting their
817 password.
818
819 |image1303|
820
821 .. _my-summary-label:
822
823 My Summary
824 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
825
826 |image1003|
827
828 From the 'my summary' tab, patrons will see all of the items they have
829 checked out with the overdue items highlighted in red. If you have
830 :ref:`OpacRenewalAllowed` set to 'Allow' then your
831 patrons will be able to renew their books right from the OPAC. If you
832 have HTML entered in the :ref:`OPACMySummaryHTML`
833 preference then you will see that to the right of the 'Fines' column.
834
835 |image1004|
836
837 If your patrons would like to see the items barcodes on their list of
838 checked out items you can set up a :ref:`patron
839 attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
840 :ref:`authorized value <authorized-values-label>` of YES\_NO.
841
842 |image1005|
843
844 Then on the :ref:`patron's record set the value <editing-patrons-label>` for
845 SHOW\_BCODE to yes.
846
847 |image1006|
848
849 This will add a column to the check out summary in the OPAC that shows
850 the patrons the barcodes of the items they have checked out.
851
852 |image1007|
853
854 If you would like your patrons to leave a note on an item they have checked out
855 :ref:`allowcheckoutnotes` preference must be set to allow.
856
857 In the patron's summary of checkouts, there will be an added column 
858 to allow the patron to leave a note (for example:  missing first page, or DVD is
859 scratched).  This note once confirmed by the patron will appear to the staff
860 when this item is checked in. 
861
862 If their guarantee has allowed it via :ref:`their
863 privacy <my-privacy-label>`, when the guarantor logs in they will see a
864 tab labeled "Relatives' checkouts" on their summary tab.
865
866 |image1304|
867
868 Clicking on the 'Overdue' tab will show only the items that are overdue.
869
870 |image1008|
871
872 The 'Fines' tab will show just a total of what the patron owes. Clicking
873 on the total will take them to the 'my fines' tab where they will see a
874 complete breakdown of their fines and bills. If you don't charge fines
875 at your library you can turn the display of these tabs off by setting
876 the :ref:`OPACFinesTab` preference to 'Don't Allow.'
877
878 |image1009|
879
880 Finally, clicking on the 'Holds' tab will show the patron the status of
881 all of the items they have on hold.
882
883 |image1010|
884
885 Patrons can cancel or suspend (depending on the value of your
886 :ref:`SuspendHoldsOpac` system preference) their own
887 holds if they are not in transit or already waiting for them. When they
888 click 'Suspend' they will be presented with the option to choose a date
889 for their hold to resume.
890
891 |image1305|
892
893 They can also suspend all of their holds indefinitely or until a
894 specific date if they choose by filling in the suspend options at the
895 bottom of the page.
896
897     **Note**
898
899     If you have your
900     :ref:`AutoResumeSuspendedHolds` preference
901     set to "Don't allow" then you will not have the option to put an end
902     date on the hold suspension
903
904 .. _patron-flags-label:
905
906 Patron Flags
907 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
908
909 If you have `flagged your patron's account <#patronflags>`__ they may
910 see one of the following error messages at the top of their account.
911
912 -  Card marked as lost
913
914    |image1011|
915
916 -  Patron address in question
917
918    |image1012|
919
920    -  **Note**
921
922           this error message will not include a link to the update form
923           if you have :ref:`OPACPatronDetails` set to
924           'Don't allow'
925
926 -  Patron marked restricted
927
928    |image1013|
929
930 .. _my-fines-label:
931
932 My Fines
933 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
934
935 If your library charges fines the next tab on the left is 'my fines.'
936 Opening this tab will show the patron an entire history of their
937 accounting at the library.
938
939 |image1014|
940
941 If you are allowing patrons to pay their fines using PayPal with the
942 :ref:`EnablePayPalOpacPayments <enablepaypalopacpayments-&-paypalsandboxmode-label>` preference
943 there will be checkboxes to the left of each fine with an outstanding
944 amount.
945
946 |image1306|
947
948 At the bottom the patron will see the option to pay with PayPal for the
949 items they have checked.
950
951 |image1015|
952
953 After paying they will be presented with a confirmation
954
955 |image1307|
956
957 And you will see that the fine was paid using PayPal on the staff
958 side.
959
960 |image1308|
961
962 .. _my-details-label:
963
964 My Details
965 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
966
967 If you have your :ref:`OPACPatronDetails` preference
968 set to 'Allow', your patrons will see a form filled in with their
969 contacting information by clicking on the 'my personal details' tab. You
970 can control what fields patrons see and can modify via the OPAC by
971 setting the
972 :ref:`PatronSelfRegistrationBorrowerMandatoryField`
973 :ref:`PatronSelfRegistrationBorrowerUnwantedField`
974 preferences.
975
976 |image1016|
977
978 Patrons can edit their details in this form and click 'Submit Changes'
979 to have their edits sent to the library for review before their record
980 is updated. Staff will see all patrons requesting modification to their
981 record listed below the modules on the main dashboard along with
982 anything else awaiting library attention.
983
984 |image1017|
985
986 If the :ref:`OPACPatronDetails` preference is set to
987 'Don't allow' then patrons will simply see their details and a message
988 stating that they should contact the library for changes.
989
990 |image1018|
991
992 .. _my-tags-label:
993
994 My Tags
995 ~~~~~~~~~~~~~~~~~~~~~~~~~
996
997 If your library has :ref:`TagsEnabled` set to 'Allowed' then
998 the next tab on the left will be 'my tags.' This tab will show patrons
999 all of the tags in the system as a cloud and then all of the tags they
1000 have applied in a list format. From here patrons have the ability to
1001 remove tags that they have added if they want.
1002
1003 |image1019|
1004
1005 .. _change-my-password-label:
1006
1007 Change My Password
1008 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1009
1010 Next, if you have :ref:`OpacPasswordChange` set to
1011 'Allow' the next tab will be 'change my password,' where patrons can
1012 change their password for logging into the OPAC. Patrons will be
1013 presented with a standard form asking them to enter their old password
1014 and then their new password twice.
1015
1016 |image1020|
1017
1018 .. _my-search-history-label:
1019
1020 My Search History
1021 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1022
1023 If you have your :ref:`EnableOpacSearchHistory`
1024 preference set to 'Allow' then your patrons can access their search
1025 history via the 'my search history' tab.
1026
1027 |image1021|
1028
1029 The search history is a record of all searches run by the patron.
1030 Clicking on any of the search phrases will re-run the search for the
1031 patron. The search history can be deleted by the patron at any time by
1032 clicking the 'Delete your search history' link found at the top of this
1033 tab or by clicking the little red 'x' next to the 'Search history' link
1034 at the top right of the OPAC.
1035
1036 |image1022|
1037
1038 .. _my-reading-history-label:
1039
1040 My Reading History
1041 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1042
1043 Depending on your library's setting for
1044 :ref:`opacreadinghistory` your patrons may see the
1045 'my reading history' tab next. This will show the patron their entire
1046 reading history unless they have asked the library to not keep that
1047 information via the 'my privacy' tab which will appear if you have the
1048 :ref:`OPACPrivacy` preference set to 'Allow.'
1049
1050 |image1023|
1051
1052 If you have HTML entered in the
1053 :ref:`OPACMySummaryHTML` preference then you will see
1054 that to the right of the 'Date' column.
1055
1056 .. _my-privacy-label:
1057
1058 My Privacy
1059 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1060
1061 The 'my privacy' tab will appear if you have both the
1062 :ref:`opacreadinghistory` and the
1063 :ref:`OPACPrivacy` preferences set to 'Allow.' This tab will
1064 allow the patrons to decide how the library keeps their circulation
1065 history data.
1066
1067 |image1024|
1068
1069 The patron can choose from three options:
1070
1071 -  Forever: keep my reading history without limit. This is the option
1072    for users who want to keep track of what they are reading.
1073
1074 -  Default: keep my reading history according to local laws. This is the
1075    default option : the library will keep your reading history for the
1076    duration permitted by local laws.
1077
1078 -  Never: Delete my reading history immediately. This will delete all
1079    record of the item that was checked-out upon check-in.
1080
1081 Depending on the patron's suggestions the contents of the ':ref:`my reading
1082 history <my-reading-history-label>`' tab and the ':ref:`Circulation
1083 History <circulation-history-label>`' tab in the staff client may change.
1084
1085 Regardless of the patron's choice they can delete their reading history
1086 in bulk at any time by clicking the 'Immediate deletion' button.
1087
1088 |image1025|
1089
1090 Clicking this button will not delete items that are currently checked
1091 out, but will clear the patron's past reading history.
1092
1093     **Important**
1094
1095     In order for the patron to be able to delete their reading history
1096     you must have the :ref:`AnonymousPatron` preference
1097     set.
1098
1099 If you're allowing guarantees to grand permission to their guarantors to
1100 view their current checkouts with the
1101 :ref:`AllowPatronToSetCheckoutsVisibilityForGuarantor`
1102 preference they will see that option on this
1103 screen.
1104
1105 |image1309|
1106
1107 When the guarantor logs in they will see a tab labeled "Relatives'
1108 checkouts" on their summary tab.
1109
1110 |image1310|
1111
1112 .. _my-purchase-suggestions-label:
1113
1114 My Purchase Suggestions
1115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1116
1117 If your library allows patrons to make purchase suggestions the next tab
1118 will show all suggestions that the patron made to the library and their
1119 statuses. To disable this tab and the suggestion functionality set the
1120 :ref:`suggestion` preference to 'Don't allow.'
1121
1122 |image1026|
1123
1124 If you have :ref:`OPACViewOthersSuggestions`
1125 set to 'Show' then patrons will be able to search suggestions from the
1126 top of this list.
1127
1128 .. _my-messaging-label:
1129
1130 My Messaging
1131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1132
1133 If your library has the
1134 :ref:`EnhancedMessagingPreferences` and the
1135 :ref:`EnhancedMessagingPreferencesOPAC`
1136 preferences set to 'Allow' then your patrons will be able to choose
1137 which messages they receive from the library (with the exception of
1138 overdue notices which the library controls).
1139
1140 |image1027|
1141
1142 If you use an outside driver for sending text messages set with the
1143 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
1144 additional column to receive these messages as SMS (or text messages)
1145 and a field for a cell (or SMS) number.
1146
1147 |image1028|
1148
1149 If you are using the Email protocol for sending text messages set with
1150 the :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
1151 additional column to receive these messages as SMS (or text messages), a
1152 field for a cell (or SMS) number, and a pull down listing :ref:`cellular
1153 providers entered in administration <sms-cellular-providers-label>`.
1154
1155 |image1029|
1156
1157 If you are using the :ref:`Itiva Talking
1158 Tech <talkingtechitivaphonenotification-label>` service you will see an
1159 additional column to receive these messages via Phone.
1160
1161 |image1311|
1162
1163 -  These notices are:
1164
1165    -  Advanced notice : A notice in advance of the patron's items being
1166       due (The patron can choose the number of days in advance)
1167
1168    -  Item checkout : A notice that lists all the of the items the
1169       patron has just checked out and/or renewed, this is an electronic
1170       form of the checkout receipt
1171
1172    -  Hold filled : A notice when you have confirmed the hold is waiting
1173       for the patron
1174
1175    -  Item due : A notice on the day and item is due back at the library
1176
1177    -  Item check-in : A notice that lists all the of the items the
1178       patron has just checked in
1179
1180 Patrons can choose to receive their notices as a digest by checking the
1181 'Digest only?' box along with the delivery method. A digest is a
1182 combination of all the messages of that type (so all items due in 3 days
1183 in one email) in to one email instead of multiple emails for each alert.
1184
1185     **Important**
1186
1187     You must choose a delivery method (SMS or Email or Phone) along with
1188     'Digest only?' if you would like to receive a digest of the
1189     messages.
1190
1191 .. _my-lists-label:
1192
1193 My Lists
1194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1195
1196 Finally, if your library has the :ref:`virtualshelves`
1197 set to 'Allow' then the last tab will by 'my lists.' From here your
1198 patrons can review public lists and create or edit their own private
1199 lists.
1200
1201 |image1030|
1202
1203 .. _ask-for-a-discharge-label:
1204
1205 Ask for a Discharge
1206 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1207
1208 If you have enabled the :ref:`useDischarge` preference then
1209 patrons will be able to request a discharge via the OPAC.
1210
1211 |image1312|
1212
1213 From here patrons can request a discharge
1214
1215 |image1031|
1216
1217 And will receive confirmation of their request.
1218
1219 |image1032|
1220
1221 .. _purchase-suggestions-label:
1222
1223 Purchase Suggestions
1224 -------------------------------------------
1225
1226 If your library has the :ref:`suggestion` preference set
1227 to 'Allow' then patrons will have the option to make purchase
1228 suggestions in several areas in the OPAC.
1229
1230 If you are allowing everyone to see the purchase suggestions made by
1231 others with the
1232 :ref:`OPACViewOthersSuggestions` preference,
1233 then there will be a link at the top of your OPAC under the search box.
1234
1235 |image1033|
1236
1237 There will be a link when the patron finds nothing for their search.
1238
1239 |image1034|
1240
1241 And there will be a link on the patron's :ref:`My Purchase
1242 Suggestions <my-purchase-suggestions-label>` tab.
1243
1244 |image1035|
1245
1246 Clicking any one of these links will open the purchase suggestion form.
1247
1248 |image1036|
1249
1250 -  From the form on the 'Title' is required by the library.
1251
1252 -  The Item type list can be edited by editing the SUGGEST\_FORMAT
1253    :ref:`authorized value <authorized-values-label>`.
1254
1255 -  If you would like the 'Reason for suggestion' menu shown in the
1256    screenshot above to appear on your suggestions list you need to add
1257    an :ref:`authorized value <authorized-values-label>` category titled
1258    'OPAC\_SUG' and include reasons as values in that list.
1259
1260 -  If you would like the patron to be able to choose which branch they
1261    are making a suggestion for you need to set the
1262    :ref:`AllowPurchaseSuggestionBranchChoice`
1263    preference to 'Allow'
1264
1265 Once the form is submitted the data will be saved to the
1266 :ref:`Acquisitions <managing-suggestions-label>` module for the librarians to manage.