1 .. include:: images.rst
6 .. _global-system-preferences-label:
8 Global System Preferences
9 -----------------------------------------------
11 Global system preferences control the way your Koha system works in
12 general. Set these preferences before anything else in Koha.
14 - *Get there:* More > Administration > Global System Preferences
16 Global System Preferences Link and Search
19 System preferences can be searched (using any part of the preference
20 name or description) using the search box on the 'Administration' page
21 or the search box at the top of each system preferences page.
23 Preferences search at the top of System Preference page
26 When editing preferences a '(modified)' tag will appear next to items
27 you change until you click the 'Save All' button:
29 After editing TagsModeration the '(modified)' label appears
32 After saving your preferences you'll get a confirmation message telling
33 you what preferences were saved:
35 Preference save confirmation message
38 Each section of preferences can be sorted alphabetically by clicking the
39 small down arrow to the right of the word 'Preference' in the header
42 Sort option at the top right of each section of preferences
45 If the preference refers to monetary values (like
46 :ref:`maxoutstanding`) the currency displayed will be the
47 default you set in your :ref:`Currencies and Exchange Rates`
48 administration area. In the examples to
49 follow they will all read USD for U.S. Dollars.
53 For libraries systems with unique URLs for each site the system
54 preference can be overridden by editing your koha-http.conf file
55 this has to be done by a system administrator or someone with access
56 to your system files. For example if all libraries but one want to
57 have search terms highlighted in results you set the
58 OpacHighlightedWords preference to 'Highlight' then edit the
59 koha-http.conf for the library that wants this turned off by adding
60 'SetEnv OVERRIDE\_SYSPREF\_OpacHighlightedWords "0"'. After
61 restarting the web server that one library will no longer see
62 highlighted terms. Consult with your system administrator for more
65 .. _acquisitions-label:
68 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70 *Get there:* More > Administration > Global System Preferences >
73 .. _acquisitions-policy-label:
76 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
78 .. _acqcreateitem-label:
81 ''''''''''''''''''''''''''''''''''
83 Default: placing an order
85 Asks: Create an item when \_\_\_.
97 - This preference lets you decide when you'd like to create an item
98 record in Koha. If you choose to add an item record when 'placing an
99 order' then you will enter item information in as you place records
100 in your basket. If you choose to add the item when 'receiving an
101 order' you will be asked for item record information when you're
102 receiving orders in acquisitions. If you choose to add the item when
103 'cataloging a record' then item records will not be created in
104 acquisitions at all, you will need to go to the cataloging module to
107 .. _acqenablefiles-label:
110 ''''''''''''''''''''''''''''''''''''
114 Asks: \_\_\_ enable the ability to upload and attach arbitrary files to
125 - This preference controls whether or not you allow the uploading of
126 invoice files via the acquisitions module.
128 .. _acqitemsetsubfieldswhenreceiptiscancelled-label:
130 AcqItemSetSubfieldsWhenReceiptIsCancelled
131 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
133 Asks: Upon cancelling a receipt, update the item's subfields if they
134 were created when placing an order (e.g. o=5\|a="bar foo""). \_\_\_
138 - This preference is used in conjunction with the
139 :ref:`AcqItemSetSubfieldsWhenReceived`
140 preference. If you have the system set to enter default values when
141 you receive you will want to have those values revert back if reeipt
142 is cancelled. This preference allows you to do that.
144 `AcqItemSetSubfieldsWhenReceived`
145 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
147 Asks: Upon receiving items, update their subfields if they were created
148 when placing an order (e.g. o=5\|a="foo bar"). \_\_\_
152 - This preference allows you to set default values for items that you
153 receive via acquisitions. Enter the data as subfield=value and split
154 your values with a bar ( \| ). For example you can remove the Ordered
155 status on the item automatically when you receive it just by entering
156 7=0 in this preference. That will set the Not for Loan status
157 (subfield 7) to 0 which is available.
159 .. _acqviewbaskets-label:
162 ''''''''''''''''''''''''''''''''''''
164 Default: created by staff member
166 Asks: Show baskets \_\_\_
170 - created by staff member
172 - from staff member's branch
174 - in system, regardless of owner
178 - When in acquisitions this preference allows you to control whose
179 baskets you can see when looking at a vendor. The default value of
180 'created by staff member' makes it so that you only see the baskets
181 you created. Choosing to see baskets 'from staff member's branch'
182 will show you the baskets created by anyone at the branch you're
183 logged in at. Finally, you can choose to set this preference to show
184 you all baskets regardless of who created it ('in system, regardless
185 of owner). Regardless of which value you choose for this preference,
186 superlibrarians can see all baskets created in the system.
188 .. _acqwarnonduplicateinvoice-label:
190 AcqWarnOnDuplicateInvoice
191 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
195 Asks: \_\_\_ when the librarian tries to create an invoice with a
204 .. _basketconfirmations-label:
207 ''''''''''''''''''''''''''''''''''''''''''''''
209 Default: always ask for confirmation
211 Asks: When closing or reopening a basket, \_\_\_.
215 - always ask for confirmation
217 - do not ask for confirmation
221 - This preference adds the option to skip confirmations on closing and
222 reopening a basket. If you skip the confirmation, you do not create a
225 .. _claimsbcccopy-label:
228 ''''''''''''''''''''''''''''''''''
232 Asks: \_\_\_ blind copy (BCC) to logged in user when sending serial or
233 acquisitions claims notices.
243 - When filing a claim in the :ref:`Claim Late Serials` or
244 Acquisitions module this preference will allow for
245 the sending of a copy of the email to the librarian.
247 .. _currencyformat-label:
250 ''''''''''''''''''''''''''''''''''''
252 Default: 360,000.00 (US)
254 Asks: Display currencies using the following format \_\_\_
269 Asks: The default tax rate is \_\_\_
273 - This preference will allow the library to define a default Goods and
274 Services Tax rate. The default of value of 0 will disable this
279 Enter this value as a number (.06) versus a percent (6%).
281 .. _marcfieldstoorder-label:
284 ''''''''''''''''''''''''''''''''''''''''''
286 Asks: Set the mapping values for a new order line created from a MARC
287 record in a staged file.
291 - This preference includes MARC fields to check for order information
292 to use when you are trying to :ref:`Order from a staged file` in
293 acquisitions. You can use the following fields: price, quantity,
294 budget\_code, discount, sort1, sort2.
304 .. _marcitemfieldstoorder-label:
306 MarcItemFieldsToOrder
307 ''''''''''''''''''''''''''''''''''''''''''''''''''
309 Asks: Set the mapping values for new item records created from a MARC record
314 - This preference automatically generates items in Koha with populated
315 information based on a 9XX field and subfield. You can use the following
316 fields: homebranch, holdingbranch, itype, nonpublic_note, public_note, loc,
317 ccode, notforloan, uri, copyno, price, replacementprice and itemcallnumber.
318 Special fields: quantity and budget_code
329 .. _uniqueitemfields-label:
332 ''''''''''''''''''''''''''''''''''''''''
336 Asks:\_\_\_ (space-separated list of fields that should be unique for
337 items, must be valid SQL fields of
338 `items <http://schema.koha-community.org/tables/items.html>`__ table)
342 - If this preference is left blank when adding items in acquisitions
343 there will be no check for uniqueness. This means that a duplicate
344 barcode can be created in acquisitions which will cause errors later
345 when checking items in and out.
350 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
352 .. _orderpdfformat-label:
355 ''''''''''''''''''''''''''''''''''''
357 Default: pdfformat::layout2pages
359 Asks: Use \_\_\_ when printing basket groups.
361 .. _administration-label:
364 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
366 These preferences are general settings for your system.
368 *Get there:* More > Administration > Global System Preferences >
371 .. _cas-authentication-label:
374 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
376 The Central Authentication Service (CAS) is a single sign-on protocol
377 for the web. If you don't know what this is, leave these preferences set
380 .. _casauthentication-label:
383 ''''''''''''''''''''''''''''''''''''''''''
387 Asks: \_\_\_ CAS for login authentication.
392 ''''''''''''''''''''''''''
394 Default: Don't logout
396 Asks: \_\_\_ of CAS when logging out of Koha.
398 .. _casserverurl-label:
401 ''''''''''''''''''''''''''''''''
403 Asks: The CAS Authentication Server can be found at \_\_\_
405 .. _google-openid-connect-label:
407 Google OpenID Connect
408 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
410 Visit the `Google Developers
411 Console <https://console.developers.google.com/>`__ to obtain OAuth 2.0
412 credentials such as a client ID and client secret that are known to both
413 Google and your application.Developers Console
415 - Create a project, and give it some details to help you identify it
421 - Next search for the Google Identity and Access Management API
426 - Enable the Google Identity and Access Management API
428 Enable Google Identity
431 - Go to 'Credentials' and set the OAuth cosent screen values
436 - Next choose to 'Create credentials' from the 'Credentials' page
441 - Choose 'Web application' from the 'Application type' menu and fill in
447 - Set 'Authorized JavaScript origins' to your OPACBaseURL
449 - Change the 'Authorized Redirect URIs' to
450 http://YOUROPAC/cgi-bin/koha/svc/auth/googleopenidconnect
452 - You will be presented with your values for your client ID and your
453 client secret after saving
455 OAuth Client ID and Secret
458 .. _googleoauth2clientid-label:
461 ''''''''''''''''''''''''''''''''''''''''''''''''
463 Asks: Google OAuth2 Client ID \_\_\_
465 .. _googleoauth2clientsecret-label:
467 GoogleOAuth2ClientSecret
468 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
470 Asks: Google OAuth2 Client Secret \_\_\_
472 .. _googleopenidconnect-label:
475 ''''''''''''''''''''''''''''''''''''''''''''''
479 Asks \_\_\_ Google OpenID Connect login.
483 You will need to select OAuth2 when creating an app in the google
484 cloud console, and set the web origin to your\_opac\_url and the
486 your\_opac\_url/cgi-bin/koha/svc/auth/googleopenidconnect .
497 .. _googleopenidconnectdomain-label:
499 GoogleOpenIDConnectDomain
500 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
502 Asks: Google OpenID Connect Restrict to domain (or subdomain of this
507 Leave blank for all google domains
509 .. _interface-options-label:
512 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
514 These preference are related to your Koha interface
516 .. _debuglevel-label:
519 ''''''''''''''''''''''''''''
523 Asks: Show \_\_\_ debugging information in the browser when an internal
528 - lots of - will show as much information as possible
530 - no - will only show basic error messages
532 - some - will show only some of the information available
536 - This preference determines how much information will be sent to the
537 user's screen when the system encounters an error. The most detail
538 will be sent when the value level is set at 2, some detail will be
539 sent when the value is set at 1, and only a basic error message will
540 display when the value is set at 0. This setting is especially
541 important when a system is new and the administration is interested
542 in working out the bugs (errors or problems) quickly. Having detailed
543 error messages makes quick fixes more likely in problem areas.
545 .. _defaulttologgedinlibrarycircrules-label:
547 DefaultToLoggedInLibraryCircRules
548 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
550 Default: all libraries
552 Asks: When editing circulation rules show \_\_\_ the rules by default.
558 - logged in library's
562 - This preference controls the default value in the branch pull down
563 found at the top of the :ref:`Circulation and Fine
566 .. _defaulttologgedinlibrarynoticesslips-label:
568 DefaultToLoggedInLibraryNoticesSlips
569 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
571 Default: all libraries
573 Asks: When editing notices and slips show the \_\_\_ notices and slips
580 - logged in library's
584 - This preference controls the default value in the branch pull down
585 found at the top of the :ref:`Notices & Slips` tool.
587 .. _defaulttologgedinlibraryoverduetriggers-label:
589 DefaultToLoggedInLibraryOverdueTriggers
590 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
592 Default: all libraries
594 Asks: When editing overdue notice/status triggers show the \_\_\_ rules
601 - logged in library's
605 - This preference controls the default value in the branch pull down
606 found at the top of the :ref:`Overdue Notice/Status Triggers`.
611 ''''''''''''''''''''''''''
615 Asks: Separate columns in an exported report file with \_\_\_ by
634 - This preference determines how reports exported from Koha will
635 separate data. In many cases you will be able to change this option
636 when exporting if you'd like.
638 .. _kohaadminemailaddress-label:
640 KohaAdminEmailAddress
641 ''''''''''''''''''''''''''''''''''''''''''''''''''
643 This is the default 'From' address for emails unless there is one for
644 the particular branch, and is referred to when an internal error occurs.
646 Asks: Use \_\_\_ as the email address for the administrator of Koha.
650 - This preference allows one email address to be used in warning
651 messages set to the OPAC. If no email address is set for the branch
652 this address will receive messages from patrons regarding
653 modification requests, purchase suggestions, and questions or
654 information regarding overdue notices. It is recommended that a email
655 address that can be accessed by multiple staff members be used for
656 this purpose so that if one librarian is out the others can address
657 these requests. This email address can be changed when needed.
659 .. _noitemtypeimages-label:
662 ''''''''''''''''''''''''''''''''''''''''
666 Asks: \_\_\_ itemtype icons in the catalog.
676 - This preference allows the system administrator to determine if users
677 will be able to set and see an item type icon
678 the catalog on both the OPAC and the Staff Client. The images will
679 display in both the OPAC and the Staff Client/Intranet. If images of
680 item types are disabled, text labels for item types will still appear
681 in the OPAC and Staff Client.
683 .. _replytodefault-label:
686 ''''''''''''''''''''''''''''''''''''
688 Asks: Use \_\_\_ as the email address that will be set as the replyto in
693 - By default replies to notice emails will go to the `library email
694 address <#libraries-groups>`__, if you would like to specify a default
695 email address for all replies to notices you can do that here.
697 .. _returnpathdefault-label:
700 ''''''''''''''''''''''''''''''''''''''''''
702 Asks: Use \_\_\_ as the email address set as the return path, if you
703 leave this empty the KohaAdminEmailAddress will be used.
707 - The return path is the email address that bounces will be delivered
708 to. By default bounced notices will go to the `library email
709 address <#libraries-groups>`__, if you would like to specify a default
710 email address for bounces to go to then fill in this preference.
712 .. _virtualshelves-label:
715 ''''''''''''''''''''''''''''''''''''
719 Asks: \_\_\_ staff and patrons to create and view saved lists of books.
729 - This preference controls whether the lists functionality will be
730 available in the staff client and OPAC. If this is set to "Don't
731 allow" then no one will be able to save items to public or private
734 .. _login-options-label:
737 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
739 These preferences are related to logging into your Koha system
741 .. _autolocation-label:
744 ''''''''''''''''''''''''''''''''
746 Default: Don't require
748 Asks: \_\_\_ staff to log in from a computer in the IP address range
749 specified by their library (if any).
751 - Set IP address range in the library administration area
753 - *Get there:* More > Administration > Basic Parameters > :ref:`Libraries & Groups`
763 - This preference protects the system by blocking unauthorized users
764 from accessing the staff client program and settings. Authorized and
765 unauthorized users are determined by their computer's IP addresses.
766 When the preference is set to 'Require', IP authorization is in
767 effect and unauthorized IP addresses will be blocked. This means that
768 staff cannot work from home unless their IP address has been
769 authorized. When set to 'Don't require', anyone with a staff client
770 login will have access no matter which IP address they are using.
772 .. _independentbranches-label:
775 ''''''''''''''''''''''''''''''''''''''''''''''
777 Default: Don't prevent
779 Asks: \_\_\_ staff (but not superlibrarians) from modifying objects
780 (holds, items, patrons, etc.) belonging to other libraries.
790 - This preference should only be used by library systems which are
791 sharing a single Koha installation among multiple branches but are
792 considered independent organizations, meaning they do not share
793 material or patrons with other branches and do not plan to change
794 that in the future. If set to 'Prevent' it increases the security
795 between library branches by: prohibiting staff users from logging
796 into another branch from within the staff client, filtering out
797 patrons from patron searches who are not a part of the login branch
798 conducting the search, limiting the location choices to the login
799 branch when adding or modifying an item record, preventing users from
800 other branch locations from placing holds or checking out materials
801 from library branches other than their own, and preventing staff from
802 editing item records which belong to other library branches. All of
803 these security safeguards can be overridden only by the
804 superlibrarian, the highest level of privileges.
808 It is important that this value be set before going live and that it
811 .. _independentbranchespatronmodifications-label:
813 IndependentBranchesPatronModifications
814 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
818 Asks: Prevent staff (but not superlibrarians) from viewing and
819 approving/denying patron modification requests for patrons
820 belonging to other libraries. \_\_\_
828 .. _sessionrestrictionbyip-label:
830 SessionRestrictionByIP
831 ''''''''''''''''''''''''''''''''''''''''''''''''''''
835 Asks: \_\_\_ check for change in remote IP address for session security.
836 Disable only when remote IP address changes frequently.
846 - When this preference is set to 'Enable' Koha will log you out of the
847 staff client if your IP address changes as a security measure. For
848 some systems the IP address changes frequently so you'll want to set
849 this preference to 'Disable' to prevent Koha from logging you out of
850 the staff client every time that happens.
854 This is meant to help those whose IP address changes several times
855 during the day, setting this preference to 'Disable' is not
856 recommended otherwise because it is removing important security
857 features from your staff client.
859 .. _sessionstorage-label:
862 ''''''''''''''''''''''''''''''''''''
864 Default: in the MySQL database
866 Asks: Store login session information \_\_\_
872 - in the MySQL database
874 - in the PostgreSQL database
878 PostgreSQL is not yet supported
882 - This preference allows administrators to choose what format session
883 data is stored in during web sessions.
888 ''''''''''''''''''''''
892 Asks: Automatically log out users after \_\_\_ seconds of inactivity.
896 - This preference sets the length of time the Staff Client or OPAC
897 accounts can be left inactive before re-logging in is necessary. The
898 value of this preference is in seconds. At this time, the amount of
899 time before a session times out must be the same for both the Staff
902 .. _ssl-client-certificate-authentication-label:
904 SSL client certificate authentication
905 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
907 .. _allowpkiauth-label:
910 ''''''''''''''''''''''''''''''''
914 Asks: Use \_\_\_ field for SSL client certificate authentication
924 .. _search-engine-label:
927 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
929 .. _searchengine-label:
932 ''''''''''''''''''''''''''''''''
936 Asks: Use following search engine: \_\_\_
944 .. _share-anonymous-usage-statistics-label:
946 Share anonymous usage statistics
947 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
949 As an open source project Koha is used all over the world. These
950 preference will help us keep more accurate statistics on where Koha is
951 being used. If you choose to share your information, it will be
952 published on the `Hea Koha community
953 website <http://hea.koha-community.org>`__. You will need to enable the
954 :ref:`Share Usage Stats` cronjob to send this information at regular
955 intervals to the community.
957 .. _usagestats-label:
960 ''''''''''''''''''''''''''''
964 Asks: \_\_\_ anonymous Koha usage data with the Koha community.
974 - This data is stored to help track usage of Koha around the world. If
975 you choose to share your information, it will be published on the
976 `Hea Koha community website <http://hea.koha-community.org>`__. This
977 information is sent using the :ref:`Share Usage Stats` cronjob.
979 .. _usagestatscountry-label:
982 ''''''''''''''''''''''''''''''''''''''''''
984 Asks: The country where your library is located: \_\_\_
988 - This data is stored to help track usage of Koha around the world. If
989 you choose to share your information, it will be published on the
990 `Hea Koha community website <http://hea.koha-community.org>`__. This
991 information is sent using the :ref:`Share Usage Stats` cronjob.
995 This preference depends on the `UsageStats <#usagestats>`__
996 preference. Set that to 'Share' to share your information.
998 .. _usagestatsgeolocation-label:
1000 UsageStatsGeolocation
1001 ''''''''''''''''''''''''''''''''''''''''''''''''''
1005 Asks: Geolocation of the main library: \_\_\_ Note that this value has no effect
1006 if the :ref:`UsageStats` systemp preference is set to "Don't share"
1008 .. _usagestatslibrariesinfo-label:
1010 UsageStatsLibrariesInfo
1011 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
1013 Default: Do not Share
1015 Asks: \_\_\_ libraries information (name, url, country) Note that this value
1016 has no effect if the :ref:`UsageStats` system preference is set to
1025 .. _usagestatslibraryname-label:
1027 UsageStatsLibraryName
1028 ''''''''''''''''''''''''''''''''''''''''''''''''''
1030 Asks: The library name \_\_\_ will be shown on the `Hea Koha community
1031 website <http://hea.koha-community.org>`__.
1035 - This data is stored to help track usage of Koha around the world. If
1036 you choose to share your information, it will be published on the
1037 `Hea Koha community website <http://hea.koha-community.org>`__. This
1038 information is sent using the :ref:`Share Usage Stats` cron job.
1042 This preference depends on the `UsageStats <#usagestats>`__
1043 preference. Set that to 'Share' to share your information. If this
1044 field is empty data will be sent anonymously if you choose 'Share'
1045 for the `UsageStats <#usagestats>`__ preference.
1047 .. _usagestatslibrarytype-label:
1049 UsageStatsLibraryType
1050 ''''''''''''''''''''''''''''''''''''''''''''''''''
1054 Asks: The library type \_\_\_ will be shown on the `Hea Koha community
1055 website <http://hea.koha-community.org>`__.
1069 - religious organization
1075 - society or association
1081 - This data is stored to help track usage of Koha around the world. If
1082 you choose to share your information, it will be published on the
1083 `Hea Koha community website <http://hea.koha-community.org>`__. This
1084 information is sent using the :ref:`Share Usage Stats` cronjob.
1088 This preference depends on the `UsageStats <#usagestats>`__
1089 preference. Set that to 'Share' to share your information.
1091 .. _usagestatslibraryurl-label:
1093 UsageStatsLibraryUrl
1094 ''''''''''''''''''''''''''''''''''''''''''''''''
1096 Asks: The library URL \_\_\_ will be shown on the `Hea Koha community
1097 website <http://hea.koha-community.org>`__.
1101 - This data is stored to help track usage of Koha around the world. If
1102 you choose to share your information, it will be published on the
1103 `Hea Koha community website <http://hea.koha-community.org>`__. This
1104 information is sent using the :ref:`Share Usage Stats` cronjob.
1108 This preference depends on the `UsageStats <#usagestats>`__
1109 preference. Set that to 'Share' to share your information.
1111 .. _authorities-label:
1114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1116 *Get there:* More > Administration > Global System Preferences >
1122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1124 .. _authdisplayhierarchy-label:
1126 AuthDisplayHierarchy
1127 ''''''''''''''''''''''''''''''''''''''''''''''''
1129 Default: Don't display
1131 Asks: \_\_\_ broader term/narrower term hierarchies when viewing
1138 AuthDisplayHierarchy
1145 - If your authority records includes 5xx fields with linked references
1146 to broader and/or narrower see also references this preference will
1147 turn on a display of those authorities at the top of the record.
1149 .. _authoritymergelimit-label:
1152 ''''''''''''''''''''''''''''''''''''''''''''''
1156 Asks: When modifying an authority record, do not update attached biblio
1157 records if the number exceeds \_\_\_ records. (Above this limit, the merge_authority
1158 cron job will merge them.)
1160 .. _authoritymergemode-label:
1163 ''''''''''''''''''''''''''''''''''''''''''''
1167 Asks: When updating biblio records from an attached authority record ("merging"),
1168 handle subfields of relevant biblio record fields in \_\_\_ mode. In strict mode
1169 subfields that are not found in the authority record, are deleted. Loose mode
1170 will keep them. Loose mode is the historical behavior and still the default.
1178 .. _autocreateauthorities-label:
1180 AutoCreateAuthorities
1181 ''''''''''''''''''''''''''''''''''''''''''''''''''
1183 Default: do not generate
1185 Asks: When editing records, \_\_\_ authority records that are missing.
1195 `BiblioAddsAuthorities <#biblioaddsauthorities>`__ must be set to
1196 "allow" for this to have any effect
1200 - When this and `BiblioAddsAuthorities <#biblioaddsauthorities>`__ are
1201 both turned on, automatically create authority records for headings
1202 that don't have any authority link when cataloging. When
1203 BiblioAddsAuthorities is on and AutoCreateAuthorities is turned off,
1204 do not automatically generate authority records, but allow the user
1205 to enter headings that don't match an existing authority. When
1206 BiblioAddsAuthorities is off, this has no effect.
1208 .. _biblioaddsauthorities-label:
1210 BiblioAddsAuthorities
1211 ''''''''''''''''''''''''''''''''''''''''''''''''''
1215 Asks: When editing records, \_\_\_ them to automatically create new
1216 authority records if needed, rather than having to reference existing
1223 - This setting allows you to type values in the fields controlled by
1224 authorities and then adds a new authority if one does not exist
1228 - This setting will lock the authority controlled fields, forcing
1229 you to search for an authority versus allowing you to type the
1230 information in yourself.
1232 .. _marcauthoritycontrolfield008-label:
1234 MARCAuthorityControlField008
1235 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1237 Default: \|\| aca\|\|aabn \| a\|a d
1239 Asks: Use the following text for the contents of MARC21 authority
1240 control field 008 position 06-39 (fixed length data elements).
1244 Do not include the date (position 00-05) in this preference, Koha
1245 will calculate automatically and put that in before the values in
1250 - This preference controls the default value in the 008 field on
1251 Authority records. It does not effect bibliographic records.
1253 .. _unimarcauthorityfield100-label:
1255 UNIMARCAuthorityField100
1256 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1258 Default: afrey50 ba0
1260 Asks: Use the following text for the contents of UNIMARC authority field
1261 100 position (fixed length data elements).
1265 Do not include the date (position 00-07) in this preference, Koha
1266 will calculate automatically and put that in before the values in
1271 - This preference controls the default value in the 100 field on
1272 Authority records cataloged in UNIMARC. It does not effect
1273 bibliographic records.
1275 .. _useauthoritiesfortracings-label:
1277 UseAuthoritiesForTracings
1278 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1282 Asks: \_\_\_ authority record numbers instead of text strings for
1283 searches from subject tracings.
1289 - Search links look for subject/author keywords (example:
1290 opac-search.pl?q=su:Business%20networks)
1294 - Search links look for an authority record (example:
1295 opac-search.pl?q=an:354)
1299 - For libraries that have authority files, they may want to make it so
1300 that when a link to an authorized subject or author is clicked on the
1301 OPAC or staff client it takes the searcher only to a list of results
1302 with that authority record. Most libraries do not have complete
1303 authority files and so setting this preference to 'Don't use' will
1304 allow searchers to click on links to authors and subject headings and
1305 perform a keyword search against those fields, finding all possible
1306 relevant results instead.
1311 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1313 These preferences will control how Koha links bibliographic records to
1314 authority records. All bibliographic records added to Koha after these
1315 preferences are set will link automatically to authority records, for
1316 records added before these preferences are set there is a script
1317 (misc/link\_bibs\_to\_authorities.pl) that your system administrator can
1318 run to link records together.
1320 .. _catalogmodulerelink-label:
1323 ''''''''''''''''''''''''''''''''''''''''''''''
1327 Asks: \_\_\_ automatically relink headings that have previously been
1328 linked when saving records in the cataloging module.
1338 - Longtime users of Koha don't expect the authority and bib records to
1339 link consistently. This preference makes it possible to disable
1340 authority relinking in the cataloging module only (i.e. relinking is
1341 still possible if link\_bibs\_to\_authorities.pl is run). Note that
1342 though the default behavior matches the previous behavior of Koha
1343 (retaining links to outdated authority records), it does not match
1344 the intended behavior (updating biblio/authority link after
1345 bibliographic record is edited). Libraries that want the intended
1346 behavior of authority control rather than the way Koha used to handle
1347 linking should set CatalogModuleRelink to 'Do'. Once setting this to
1348 'Do' the following preferences can also be set.
1350 .. _linkerkeepstale-label:
1353 ''''''''''''''''''''''''''''''''''''''
1357 Asks: \_\_\_ keep existing links to authority records for headings where
1358 the linker is unable to find a match.
1368 - When set to 'Do', the linker will never remove a link to an authority
1369 record, though, depending on the value of
1370 :ref:`LinkerRelink`, it may change the link.
1372 .. _linkermodule-label:
1375 ''''''''''''''''''''''''''''''''
1379 Asks: Use the \_\_\_ linker module for matching headings to authority
1386 - Retains Koha's previous behavior of only creating links when there
1387 is an exact match to one and only one authority record; if the
1388 :ref:`LinkerOptions` preference is set to
1389 'broader\_headings', it will try to link headings to authority
1390 records for broader headings by removing subfields from the end of
1395 - Creates a link to the first authority record that matches a given
1396 heading, even if there is more than one authority record that
1401 - Creates a link to the last authority record that matches a given
1402 heading, even if there is more than one record that matches
1406 - This preference tells Koha which match to use when searching for
1407 authority matches when saving a record.
1409 .. _linkeroptions-label:
1412 ''''''''''''''''''''''''''''''''''
1414 Asks: Set the following options for the authority linker \_\_\_
1418 This feature is experimental and shouldn't be used in a production
1419 environment until further expanded upon.
1423 - This is a pipe separated (\|) list of options. At the moment, the
1424 only option available is "broader\_headings." With this option set to
1425 "broader\_headings", the linker will try to match the following
1430 =600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.
1432 First: Camins-Esakov, Jared--Coin collections--Catalogs--Early works
1435 Next: Camins-Esakov, Jared--Coin collections--Catalogs
1437 Next: Camins-Esakov, Jared--Coin collections
1439 Next: Camins-Esakov, Jared (matches! if a previous attempt had
1440 matched, it would not have tried this)
1442 .. _linkerrelink-label:
1445 ''''''''''''''''''''''''''''''''
1449 Asks: \_\_\_ relink headings that have previously been linked to
1460 - When set to 'Do', the linker will confirm the links for headings that
1461 have previously been linked to an authority record when it runs,
1462 correcting any incorrect links it may find. When set to 'Do not', any
1463 heading with an existing link will be ignored, even if the existing
1464 link is invalid or incorrect.
1466 .. _cataloging-label:
1469 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1471 *Get there:* More > Administration > Global System Preferences >
1477 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1479 .. _acquisitiondetails-label:
1482 ''''''''''''''''''''''''''''''''''''''''''''
1486 Asks: \_\_\_ acquisition details on the biblio detail page.
1496 - This preference controls whether a tab will show on the detail page
1497 in the staff client that includes detailed acquisitions information
1498 for the title. This tab will include links to order information
1499 stored in the acquisitions module.
1501 .. _authorityseparator-label:
1504 ''''''''''''''''''''''''''''''''''''''
1508 Asks: Separate multiple displayed authors, series or subjects with
1511 .. _hide\_marc-label:
1514 '''''''''''''''''''''''''''
1518 Asks: \_\_\_ MARC tag numbers, subfield codes and indicators in MARC
1523 - Display -- shows the tag numbers on the cataloging interface
1525 MARC editor with tags showing
1528 - Don't display -- shows just descriptive text when cataloging
1530 MARC editor without tags showing
1533 .. _intranetbibliodefaultview-label:
1535 IntranetBiblioDefaultView
1536 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1540 Asks: By default, display biblio records in \_\_\_
1544 - ISBD form -- displays records in the staff client in the old card
1547 - See :ref:`ISBD` preference for more information
1549 - Labelled MARC form -- displays records in the staff client in MARC
1550 with text labels to explain the different fields
1552 - MARC form -- displays records in the staff client in MARC
1554 - normal form -- visual display in the staff client (for the average
1559 - This setting determines the bibliographic record display when
1560 searching the catalog on the staff client. This setting does not
1561 affect the display in the OPAC which is changed using the
1562 :ref:`BiblioDefaultView` preference under the OPAC
1563 preference tab. This setting changes the look of the record when
1564 first displayed. The MARC and ISBD views can still be seen by
1565 clicking in the sidebar.
1570 ''''''''''''''''''''
1572 Default: :ref:`MARC21 Default Appendix <marc-default-label>` or :ref:`UNIMARC Default
1573 Appendix <unimarc-default-label>`
1575 Asks: Use the following as the ISBD template:
1579 - This determines how the ISBD information will display in the staff
1580 client. Elements in the list can be reordered to produce a different
1581 ISBD view. ISBD, the International Standard Bibliographic
1582 Description, was first introduced by IFLA (International Federation
1583 of Library Associations) in 1969 in order to provide guidelines for
1584 descriptive cataloging. The purpose of ISBD is to aid the
1585 international exchange of bibliographic records for a variety of
1588 .. _labelmarcview-label:
1591 ''''''''''''''''''''''''''''''''''
1595 Asks: \_\_\_ collapse repeated tags of the same type into one tag entry.
1599 - Do -- will combine all identical tag numbers under one heading in the
1600 MARC view in the OPAC and Staff Client
1602 MARC View in the Staff Client with LabelMARCView set to Do
1605 - Don't -- will list all of the tags individually in the MARC view in
1606 the OPAC and Staff Client
1608 MARC View in the Staff Client with LabelMARCView set to Don't
1611 .. _mergereportfields-label:
1614 ''''''''''''''''''''''''''''''''''''''''''
1616 Asks: \_\_\_ fields to display for deleted records after merge
1620 - When merging records together you can receive a report of the merge
1621 process once it's done, this preference lets you set the default
1622 values for this report.
1624 Example: '001,245ab,600' displays:
1628 - subfields a and b of fields 245
1630 - all subfields of fields 600
1632 .. _notesblacklist-label:
1635 ''''''''''''''''''''''''''''''''''''
1637 Asks: Don't show these \_\_\_ note fields in title notes separator (OPAC
1638 record details) and in the description separator (Staff client record
1643 - This preference lets you define which of your note fields are hidden
1644 from the title notes (OPAC) and descriptions (Staff) tabs. Enter the
1645 values as a comma separated list. For example to hide the local note
1646 and the bibliography note in MARC21 enter 504, 590.
1648 .. _opacsuppression,-opacsuppressionbyiprange,-opacsuppressionredirect,-and-opacsuppressionmessage-label:
1650 OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and OpacSuppressionMessage
1651 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1653 OpacSuppression Default: Don't hide
1655 Asks: \_\_\_ items marked as suppressed from OPAC search results.
1656 Restrict the suppression to IP addressesoutside of the IP range \_\_\_
1657 (Leave blank if not used. Define a range like 192.168..) Redirect the opac detail
1658 page for suppressed records to \_\_\_ Display the following message on
1659 the redirect page for suppressed biblios \_\_\_.
1661 OpacSuppression Values:
1665 - Will show records in OPAC search results if they are marked
1670 - Will not show records in OPAC search results if they're marked as
1673 OpacSuppressionRedirect Values:
1675 - an explanatory page ('This record is blocked').
1677 - the 404 error page ('Not found').
1681 - These preferences control hiding of bibliographic records from
1682 display in the OPAC. Each bibliographic record you want to hide from
1683 the OPAC simply needs to have the value "1" in the field mapped with
1684 Suppress index (942$n field in MARC21, no official field in UNIMARC).
1685 The indexer then hides it from display in OPAC but will still display
1686 it in the Staff Client. If you want to further control suppression
1687 you can set an IP address range to still show suppressed items to.
1688 Define a range like 192.168.. If you don't want to limit suppression
1689 in this way, leave the IP field blank. You can also decide what the
1690 patrons will see in the OPAC when a title is suppressed by setting
1691 the OpacSuppressionRedirect and OpacSuppressionMessage preferences.
1692 You can either show the patron a 404 page if they try to see a
1693 suppressed record or you can create a custom page by entering the
1694 HTML in the OpacSuppressionMessage part of this preference.
1698 An :ref:`authorized value <authorized-values-label>` for the MARC21 942$n
1699 field (or the equivalent UNIMARC field) should be set to
1700 eliminate errors. One example would be to create an authorized
1701 value titled SUPPRESS with a value of 0 for don't suppress and 1
1706 If this preference is set to 'hide' and you have the 942n field set
1707 to 1, it will hide the entire bib record - not just an individual
1712 Suppressed records will show a note in the staff client indicating
1713 that they are suppressed from view in the OPAC.Suppressed in Staff
1715 This note can be styled by using the
1716 :ref:`IntranetUserCSS` preference to stand out more
1717 if you'd like.Style suppression note
1719 .. _separateholdings-&-separateholdingsbranch-label:
1721 SeparateHoldings & SeparateHoldingsBranch
1722 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1724 SeparateHoldings default: Don't separate
1726 SeparateHoldingsBranch default: home library
1728 Asks: \_\_\_ items display into two tabs, where the first tab contains
1729 items whose \_\_\_ is the logged in user's library. The second tab will
1730 contain all other items.
1732 SeparateHoldings values:
1738 SeparateHoldingsBranch values:
1746 - This preference lets you decide if you would like to have the holding
1747 information on the bibliographic detail page in the staff client
1748 split in to multiple tabs. The default is to show all holdings on one
1751 Separate holdings tabs
1754 .. _urllinktext-label:
1757 ''''''''''''''''''''''''''''''
1759 Default: Online Resource
1761 Asks: Show \_\_\_ as the text of links embedded in MARC records.
1765 - If the 856 field does not have a subfield 3 or y defined, the OPAC
1766 will say 'Click here to access online.' If you would like the field
1767 to say something else enter that in this field.
1769 .. _usecontrolnumber-label:
1772 ''''''''''''''''''''''''''''''''''''''''
1776 Asks: \_\_\_ record control number ($w subfields) and control number
1777 (001) for linking of bibliographic records.
1783 - When clicking on links to titles that appear next to 'Continues'
1784 and 'Continued by' in the detail display Koha will perform a title
1789 - When clicking on links to titles that appear next to 'Continues'
1790 and 'Continued by' in the detail display Koha will perform a
1791 control number (MARC field 001) search
1795 Unless you are going in and manually changing 773$w to match your
1796 rigorously-defined bibliographic relationships, you should set this
1797 preference to "Don't use" and instead set
1798 :ref:`EasyAnalyticalRecords` to "Display"
1802 - If you have a serial called "Journal of Interesting Things" which has
1803 a separate record from when it was called "Transactions of the
1804 Interesting Stuff Society," you could add linking fields to indicate
1805 the relationship between the two records. UseControlNumber allows you
1806 to use your local accession numbers for those links. In MARC21, the
1807 relevant sections of the two records might look like this:
1812 =110 2_$aInteresting Stuff Society.
1813 =245 10$aTransactions of the Interesting Stuff Society.
1814 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1817 =110 2_$aInteresting Stuff Society.
1818 =245 10$aJournal of Interesting Things.
1819 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345
1821 With UseControlNumber set to 'Use', the 78x links will use the
1822 Control Numbers is subfield $w, instead of doing a title search on
1823 "Journal of Interesting Things" and "Transactions of the Interesting
1824 Stuff Society" respectively.
1826 .. _exporting-label:
1829 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1831 .. _bibtexexportadditionalfields-label:
1833 BibtexExportAdditionalFields
1834 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1836 Asks: Include following fields when exporting BibTeX
1840 - Use one line per tag in the format BT\_TAG: TAG$SUBFIELD ( e.g. lccn:
1843 - To specify multiple marc tags/subfields as targets for a repeating
1844 BibTex tag, use the following format: BT\_TAG: [TAG2$SUBFIELD1,
1845 TAG2$SUBFIELD2] ( e.g. notes: [501$a, 505$g] )
1847 - All values of repeating tags and subfields will be printed with the
1850 - Use '@' ( with quotes ) as the BT\_TAG to replace the bibtex record
1851 type with a field value of your choosing.
1853 .. _risexportadditionalfields-label:
1855 RisExportAdditionalFields
1856 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1858 Asks: Include following fields when exporting RIS
1862 - Use one line per tag in the format RIS\_TAG: TAG$SUBFIELD ( e.g. LC:
1865 - To specificy multiple marc tags/subfields as targets for a repeating
1866 RIS tag, use the following format: RIS\_TAG: [TAG2$SUBFIELD1,
1867 TAG2$SUBFIELD2] ( e.g. NT: [501$a, 505$g] )
1869 - All values of repeating tags and subfields will be printed with the
1872 - Use of TY ( record type ) as a key will *replace* the default TY with
1873 the field value of your choosing.
1875 .. _importing-label:
1878 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1880 .. _aggressivematchonisbn-label:
1882 AggressiveMatchOnISBN
1883 ''''''''''''''''''''''''''''''''''''''''''''''''''
1887 Asks: When matching on ISBN with the record import tool, \_\_\_ attempt
1888 to match aggressively by trying all variations of the ISBNs in the
1889 imported record as a phrase in the ISBN fields of already cataloged
1900 - This preference allows you to choose to alter the ISBN matching rule
1901 used when staging records for import to be more aggressive. This
1902 means that all text will be stripped from the ISBN field so that a
1903 pure number match is possible. If this preference is set to "Don't"
1904 then Koha will find a match only if the ISBN fields are identical.
1908 Note that this preference has no effect if
1909 :ref:`UseQueryParser` is on.
1911 .. _aggressivematchonissn-label:
1913 AggressiveMatchOnISSN
1914 ''''''''''''''''''''''''''''''''''''''''''''''''''
1918 Asks: When matching on ISSN with the record import tool, \_\_\_ attempt
1919 to match aggressively by trying all variations of the ISSNs in the imported
1920 record as a phrase in the ISSN fields of already cataloged records. Note that
1921 this preference has no effect if :ref:`UseQueryParser` is on.
1923 .. _interface-label:
1926 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1928 .. _advancedmarceditor-label:
1931 ''''''''''''''''''''''''''''''''''''''''''''
1933 Default: Don't display
1935 Asks: \_\_\_ descriptions of fields and subfields in the MARC editor.
1939 - This preference determines whether or not MARC field names will be
1940 present when editing or creating MARC records.
1946 MARC editor with text labels
1951 MARC editor without text labels
1954 .. _defaultclassificationsource-label:
1956 DefaultClassificationSource
1957 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
1959 Default: Dewey Decimal System
1961 Asks: Use \_\_\_ as the default classification source.
1965 - ANSCR (Sound Recordings)
1967 - Dewey Decimal Classification
1969 - Library of Congress Classification
1971 - Other/Generic Classification Scheme
1973 - SuDoc Classification (U.S. GPO)
1975 - Universal Decimal Classification
1979 Adding another classification under Administration > Classification Sources
1980 will make it show up in this list as well.
1982 .. _easyanalyticalrecords-label:
1984 EasyAnalyticalRecords
1985 ''''''''''''''''''''''''''''''''''''''''''''''''''
1987 Default: Don't Display
1989 Asks: \_\_\_ easy ways to create analytical record relationships
1999 If you decide to use this feature you'll want to make sure that your
2000 :ref:`UseControlNumber` preference is set to "Don't
2001 use" or else the "Show analytics" links in the staff client and the
2002 OPAC will be broken.
2006 - An analytic entry in a catalog is one that describes a part of a
2007 larger work that is also described in the catalog. In bibliographic
2008 cataloging, analytic entries may be made for chapters in books or
2009 special issues of articles in periodicals. In archival cataloging,
2010 analytic entries may be made for series or items within a collection.
2011 This feature in Koha allows for an easy way of linking analytic
2012 entries to the host records, and this system preference adds several
2013 new menu options to the staff cataloging detail pages to allow that
2016 .. _record-structure-label:
2019 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2021 .. _alternateholdingsfield-&-alternateholdingsseparator-label:
2023 AlternateHoldingsField & AlternateHoldingsSeparator
2024 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2026 Asks: Display MARC subfield \_\_\_ as holdings information for records
2027 that do not have items, with the subfields separated by \_\_\_.
2031 - Sometimes libraries migrate to Koha with their holding info in the
2032 852 field (OCLC holdings information field) and choose not to
2033 transfer that information into the 952 (Koha holdings information
2034 field) because they don't plan on circulating those items. For those
2035 libraries or other libraries that have data in the 852 fields of
2036 their records that they want to display, these preferences let you
2037 choose to display holdings info from a field other than the 952
2038 field. The AlternateHoldingsField preference can contain multiple
2039 subfields to look in; for instance 852abhi would look in 852
2040 subfields a, b, h, and i.
2042 - With AlternateHoldingsField set to 852abhi and
2043 AlternateHoldingsSeparator set to a space the holdings would look
2046 Alternate Holdings Display
2049 .. _autobarcode-label:
2052 ''''''''''''''''''''''''''''''
2054 Default: generated in the form <branchcode>yymm0001
2056 Asks: Barcodes are \_\_\_
2060 - generated in the form <branchcode>yymm0001
2062 - generated in the form <year>-0001, <year>-0002
2064 - generated in the form 1, 2, 3
2066 - incremental EAN-13 barcodes
2068 - not generated automatically
2072 - This setting is for libraries wishing to generate barcodes from
2073 within Koha (as opposed to scanning in pre-printed barcodes or
2074 manually assigning them). The default behavior makes it so that when
2075 you click in the barcode field (952$p in MARC21) it will populate
2076 with the automatic barcode you have chosen. If you would rather it
2077 only enter an automatic barcode when you click on the plugin (the ...
2078 to the right of the field) you can change the plugin used for that
2079 field in the framework. Set the plugin for 952$p (if using MARC21 or
2080 equivalent field mapped to items.barcode in your local MARC format)
2081 for your frameworks to barcode\_manual.pl instead of barcode.pl.
2082 Learn more about editing frameworks under the :ref:`MARC Bibliographic
2083 Frameworks <marc-bibliographic-frameworks-label>` section of this manual.
2085 .. _defaultlanguagefield008-label:
2087 DefaultLanguageField008
2088 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2090 Default: Empty defaults to eng
2092 Asks: Fill in the default language for field 008 Range 35-37 of MARC21
2097 - This preference will allow you to set the language for your MARC21
2098 008 field by default. If this is left empty it will default to
2099 English (eng). See the `MARC Code List for
2100 Languages <http://www.loc.gov/marc/languages/language_code.html>`__
2101 for additional values for this preference.
2105 This preference won't have any effect if your records are in
2108 .. _item-level\_itypes-label:
2111 '''''''''''''''''''''''''''''''''''''''''''
2113 Default: specific item
2115 Asks: Use the item type of the \_\_\_ as the authoritative item type
2116 (for determining circulation and fines rules, etc).
2126 - This preference determines whether the item type Koha uses for
2127 issuing rules will be an attribute of the bibliographic record or the
2128 item record. Most libraries refer to the item record for item types.
2129 It also determines if the item type icon appears on the OPAC search
2130 results. If you have the preference set to 'biblio record' then Koha
2131 displays the item type icon on the search results to the left of the
2134 Item Type Icons to the Left of Result Information
2137 .. _itemcallnumber-label:
2140 ''''''''''''''''''''''''''''''''''''
2144 Asks: Map the MARC subfield to an item's callnumber.
2148 This can contain multiple subfields to look in; for instance 082ab
2149 would look in 082 subfields a and b.
2153 - This setting determines which MARC field will be used to determine
2154 the call number that will be entered into item records automatically
2155 (952$o). The value is set by providing the MARC field code (050, 082,
2156 090, 852 are all common in MARC21) and the subfield codes without the
2157 delimiters ($a, $b would be ab).
2161 - Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the item record:
2164 .. _marcflavour-label:
2167 ''''''''''''''''''''''''''''''
2171 Asks: Interpret and store MARC records in the \_\_\_ format.
2177 - The standard style for the US, Canada, Australia, New Zealand,
2178 United Kingdom, Germany and other countries
2182 - The standard style used in France, Italy, Portugal, Russia, and
2187 - The standard style for Norway
2191 - This preference defines global MARC style (MARC21, UNIMARC or
2192 NORMARC) used for encoding.
2196 Changing the value of this preference will not convert your records
2197 from one MARC style to an other.
2199 .. _marcorgcode-label:
2202 ''''''''''''''''''''''''''''''
2206 Asks: Fill in the MARC organization code \_\_\_ by default in new MARC21
2207 records (leave blank to disable).
2211 - The MARC Organization Code is used to identify libraries with
2212 holdings of titles and more.
2214 Learn more and find your library's MARC21 code on the `MARC Code list
2216 Organizations <http://www.loc.gov/marc/organizations/orgshome.html>`__
2217 or in Canada on the `Canadian Symbols
2218 Directory <http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1>`__.
2222 This preference won't have any effect if your records are in
2225 .. _newitemsdefaultlocation-label:
2227 NewItemsDefaultLocation
2228 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2230 Asks: When items are created, give them the temporary location of \_\_\_
2231 (should be a location code, or blank to disable).
2233 .. _prefillitem-label:
2236 ''''''''''''''''''''''''''''''
2238 Default: the new item is not prefilled with last created item values.
2240 Asks: When a new item is added \_\_\_
2244 - the new item is not prefilled with last created item values.
2246 - the new item is prefilled with last created item values.
2250 - This preference controls the behavior used when adding new items.
2251 Using the options here you can choose to have your next new item
2252 prefill with the values used in the last item was added to save time
2253 typing values or to have the item form appear completely blank. Using
2254 :ref:`SubfieldsToUseWhenPrefill` you can
2255 control specifically which fields are prefilled.
2257 .. _subfieldstoallowforrestrictedbatchmod-label:
2259 SubfieldsToAllowForRestrictedBatchmod
2260 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2262 Asks: Define a list of subfields for which editing is authorized when
2263 `items\_batchmod\_restricted <#items_batchmod_restricted>`__ permission
2264 is enabled, separated by spaces. \_\_\_
2268 - UNIMARC: "995$f 995$h 995$j"
2270 - MARC21: "952$a 952$b 952$c"
2274 - This preference lets you define what fields can be edited via the
2275 :ref:`batch item modification tool <batch-item-modification-label>` if the
2276 items\_batchmod\_restricted permission is enabled.
2280 The FA framework is excluded from the permission. If the pref is
2281 empty, no fields are restricted.
2283 .. _subfieldstoallowforrestrictedediting-label:
2285 SubfieldsToAllowForRestrictedEditing
2286 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2288 Asks: Define a list of subfields for which editing is authorized when
2289 edit\_items\_restricted permission is enabled, separated by spaces.
2294 - UNIMARC: "995$f 995$h 995$j"
2296 - MARC21: "952$a 952$b 952$c"
2300 - This preference lets you define what fields can be edited via
2302 `edit\_items\_restricted <#edit_items_restricted>`__ permission is
2307 The Fast Add (FA) framework is excluded from the permission. If
2308 the pref is empty, no fields are restricted.
2310 .. _subfieldstousewhenprefill-label:
2312 SubfieldsToUseWhenPrefill
2313 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2315 Asks: Define a list of subfields to use when prefilling items \_\_\_
2319 Separate values with a space.
2323 - When the :ref:`PrefillItem` preference is set to prefill
2324 item values with those from the last added item, this preference can
2325 control which fields are prefilled (and which are not). Enter a space
2326 separated list of fields that you would like to prefill when adding a
2329 .. _unimarcfield100language-label:
2331 UNIMARCField100Language
2332 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2336 Asks: Use the language (ISO 690-2) \_\_\_ as default language in the
2337 UNIMARC field 100 when creating a new record or in the field plugin.
2339 .. _z3950normalizeauthor-&-z3950authorauthfields-label:
2341 z3950NormalizeAuthor & z3950AuthorAuthFields
2342 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2344 Defaults: Don't copy & 701,702,700
2346 Asks: \_\_\_ authors from the UNIMARC \_\_\_ tags (separated by commas)
2347 to the correct author tags when importing a record using Z39.50.
2349 Description for z3950NormalizeAuthor:
2351 - This preference allows for 'Personal Name Authorities' to replace
2352 authors as the bibliographic authority. This preference should only
2353 be considered by libraries using UNIMARC.
2355 Values for z3950NormalizeAuthor:
2361 Description for z3950AuthorAuthFields:
2363 - This preference defines which MARC fields will be used for 'Personal
2364 Name Authorities' to replace authors as the bibliographic
2365 authorities. This preference only applies to those using UNIMARC
2366 encoding. The MARC fields selected here will only be used if
2367 'z3950NormalizeAuthor' is set to "Copy". The default field are 700,
2370 .. _spine-labels-label:
2373 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2375 .. _spinelabelautoprint-label:
2378 ''''''''''''''''''''''''''''''''''''''''''''''
2382 Asks: When using the quick spine label printer, \_\_\_ automatically pop
2391 .. _spinelabelformat-label:
2394 ''''''''''''''''''''''''''''''''''''''''
2396 Default: <itemcallnumber><copynumber>
2398 Asks: Include the following fields on a quick-printed spine label:
2399 (Enter in columns from the biblio, biblioitems or items tables,
2400 surrounded by < and >.)
2402 .. _spinelabelshowprintonbibdetails-label:
2404 SpineLabelShowPrintOnBibDetails
2405 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2407 Default: Don't display
2409 Asks: \_\_\_ buttons on the bib details page to print item spine labels.
2415 'Print Label' link appears on bibliographic record in the staff
2421 .. _circulation-label:
2424 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2426 *Get there:* More > Administration > Global System Preferences >
2432 .. _article-requests-label:
2435 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2437 .. _articlerequests-label:
2440 ''''''''''''''''''''''''''''''''''''''
2442 Default: Don't enable
2444 Asks: \_\_\_ patrons to place article requests.
2454 - This preference controls whether or not article requests are allowed to be placed by patrons in the OPAC.
2456 .. _articlerequestsmandatoryfields-label:
2458 ArticleRequestsMandatoryFields
2459 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2461 Default: None selected
2463 Asks: For records that are record level or item level requestable, make the following fields mandatory \_\_\_
2485 - This preference controls what fields must be filled in before an article request can be placed
2486 for either a record level or item level request. Choosing [Select all] indicates that all fields
2487 listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
2488 request can be placed.
2490 .. _articlerequestsmandatoryfieldsitemsonly-label:
2492 ArticleRequestsMandatoryFieldsItemsOnly
2493 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2495 Default: None selected
2497 Asks: For records that are only item level requestable, make the following fields mandatory \_\_\_
2519 - This preference controls what fields must be filled in before an article request can be placed
2520 for an item level request only. Choosing [Select all] indicates that all fields
2521 listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
2522 request can be placed.
2524 .. _articlerequestsmandatoryfieldsrecordonly-label:
2526 ArticleRequestsMandatoryFieldsRecordOnly
2527 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2529 Default: None selected
2531 Asks: For records that are only record level requestable, make the following fields mandatory \_\_\_
2553 - This preference controls what fields must be filled in before an article request can be placed
2554 for a record level request only. Choosing [Select all] indicates that all fields
2555 listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
2556 request can be placed.
2559 .. _batch-checkout-label:
2562 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2564 .. _batchcheckouts-label:
2567 ''''''''''''''''''''''''''''''''''''
2569 Default: Don't allow
2571 Asks: \_\_\_ batch checkouts
2579 .. _batchcheckoutsvalidcategories-label:
2581 BatchCheckoutsValidCategories
2582 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2584 Asks: Patron categories allowed to checkout in a batch \_\_\_ (list of
2585 patron categories separated with a pipe '\|')
2587 .. _checkin-policy-label:
2590 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2592 .. _blockreturnofwithdrawnitems-label:
2594 BlockReturnOfWithdrawnItems
2595 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2599 Asks: \_\_\_ returning of items that have been withdrawn.
2609 - This preference controls whether and item with a withdrawn status
2610 (952$0 in MARC21) can be checked in or not.
2612 .. _calculatefinesonreturn-label:
2614 CalculateFinesOnReturn
2615 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2619 Asks: \_\_\_ calculate and update overdue charges when an item is
2630 - If this preference is set to "Do" and the :ref:`fines cron
2631 job <fines-label>` is off then Koha will calculate fines only
2632 when items are returned. If you have the fines cron job on and this
2633 preference set to "Do" then this preference will calculate fines
2634 based on the cron (usually run nightly) and then again when you check
2635 the item in. This option is best for those who are doing hourly
2636 loans. If this preference is set to "Don't" then fines will only be
2637 accrued if the fines cron job is running.
2641 If you are doing hourly loans then you should have this set to 'Do'.
2643 .. _cumulativerestrictionperiods-label:
2645 CumulativeRestrictionPeriods
2646 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2648 Default: Don't cumulate
2650 Asks: \_\_\_ the restriction periods.
2658 .. _updatenotforloanstatusoncheckin-label:
2660 UpdateNotForLoanStatusOnCheckin
2661 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2663 Asks: This is a list of value pairs. When an item is checked in, if the
2664 not for loan value on the left matches the items not for loan value it
2665 will be updated to the right-hand value. E.g. '-1: 0' will cause an item
2666 that was set to 'Ordered' to now be available for loan. Each pair of
2667 values should be on a separate line.
2669 .. _checkout-policy-label:
2672 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2674 .. _agerestrictionmarker-label:
2676 AgeRestrictionMarker
2677 ''''''''''''''''''''''''''''''''''''''''''''''''
2679 Asks: Restrict patrons with the following target audience values from
2680 checking out inappropriate materials: \_\_\_
2684 - This preference defines certain keywords that will trigger Koha to
2685 restrict checkout based on age. These restrictions can be overridden
2686 by the :ref:`AgeRestrictionOverride`
2687 preference. Enter in this field a series of keywords separated by bar
2688 (\|) with no spaces. For example PG\|R\|E\|EC\|Age\| will look for PG
2689 followed by an age number, R folllowed by an age number, Age followed
2690 by an age number, and so on. These values can appear in any MARC
2691 field, but Library of Congress recommends the 521$a (Target Audience
2692 Note). Whatever field you decide to use you must map the word
2693 agerestriction in the biblioitems table to that field in the :ref:`Koha to
2694 MARC Mapping <koha-to-marc-mapping-label>`. When cataloging you can enter
2695 values like PG 13 or E 10 in the 521$a and Koha will then notify
2696 circulation librarians that the material may not be recommended for
2697 the patron based on their age.
2701 You must map the word agerestriction in the biblioitems table to
2702 the MARC field where this information will appear via the :ref:`Koha
2703 to MARC Mapping <koha-to-marc-mapping-label>` administration area.
2705 .. _agerestrictionoverride-label:
2707 AgeRestrictionOverride
2708 ''''''''''''''''''''''''''''''''''''''''''''''''''''
2710 Default: Don't allow
2712 Asks: \_\_\_ staff to check out an item with age restriction.
2718 Allow age restriction override
2723 Don't allow age restriction override
2728 - When the :ref:`AgeRestrictionMarker` preference
2729 is set, Koha will try to warn circulation librarians before checking
2730 out an item that might have an age restriction listed in the MARC
2731 record. This preference asks if you would like the staff to be able
2732 to still check out these items to patrons under the age limit.
2734 .. _allfinesneedoverride-label:
2736 AllFinesNeedOverride
2737 ''''''''''''''''''''''''''''''''''''''''''''''''
2741 Asks: \_\_\_ staff to manually override all fines, even fines less than
2742 :ref:`noissuescharge`.
2752 - This preference let's you decide if you want to always be warned that
2753 the patron has fines when checking out. If you have it set to
2754 'Require' then no matter how much money the patron owes a message
2755 will pop up warning you that the patron owes money.
2757 .. _allowfineoverride-label:
2760 ''''''''''''''''''''''''''''''''''''''''''
2762 Default: Don't allow
2764 Asks: \_\_\_ staff to manually override and check out items to patrons
2765 who have more than :ref:`noissuescharge` in fines.
2775 - This preference lets you decide if you staff can check out to patrons
2776 who owe more money than you usually let them carry on their account.
2777 If set to 'Allow' staff will be warned that the patrons owes money,
2778 but it won't stop the staff from checking out to the patron.
2780 .. _allowitemsonholdcheckout-label:
2782 AllowItemsOnHoldCheckout
2783 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2785 Default: Don't allow
2787 Asks: \_\_\_ checkouts of items reserved to someone else. If allowed do
2788 not generate RESERVE\_WAITING and RESERVED warning. This allows self
2789 checkouts for those items.
2799 This system preference relates only to SIP based self checkout, not
2800 Koha's web based self checkout.
2804 - When this preference is set to 'Allow' patrons will be able to use
2805 your external self check machine to check out a book to themselves
2806 even if it's on hold for someone else. If you would like Koha to
2807 prevent people from checking out books that are on hold for someone
2808 else set this preference to "Don't allow."
2810 .. _allowitemsonholdcheckoutsco-label:
2812 AllowItemsOnHoldCheckoutSCO
2813 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2815 Default: Don't allow
2817 Asks: \_\_\_ checkouts of items reserved to someone else in the SCO module.
2818 If allowed do not generate RESERVE_WAITING and RESERVED warning. This
2819 allows self checkouts for those items.
2829 This system preference relates only to Koha's web based self checkout.
2833 - When this preference is set to 'Allow' patrons will be able to use
2834 Koha's web based self checkout to check out a book to themselves
2835 even if it's on hold for someone else. If you would like Koha to
2836 prevent people from checking out books that are on hold for someone
2837 else set this preference to "Don't allow".
2839 .. _allowmultipleissuesonabiblio-label:
2841 AllowMultipleIssuesOnABiblio
2842 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2846 Asks: \_\_\_ patrons to check out multiple items from the same record.
2856 - If this preference is set to 'Allow' then patrons will be able to
2857 check out multiple copies of the same title at the same time. If it's
2858 set to "Don't allow" then patrons will only be allowed to check out
2859 one item attached to a record at a time. Regardless of the option
2860 chosen in this preference records with subscriptions attached will
2861 allow multiple check outs.
2865 This will only effect records without a subscription attached.
2867 .. _allownotforloanoverride-label:
2869 AllowNotForLoanOverride
2870 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
2874 Asks: \_\_\_ staff to override and check out items that are marked as
2885 - This parameter is a binary setting which controls the ability of
2886 staff (patrons will always be prevented from checking these items
2887 out) to check out items that are marked as "not for loan". Setting it
2888 to "Allow" would allow such items to be checked out, setting it to
2889 "Don't allow" would prevent this. This setting determines whether
2890 items meant to stay in the library, such as reference materials, and
2891 other library resources can be checked out by patrons.
2893 .. _allowrenewallimitoverride-label:
2895 AllowRenewalLimitOverride
2896 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
2900 Asks: \_\_\_ staff to manually override the renewal limit and renew a
2901 checkout when it would go over the renewal limit.
2911 - This preference is a binary setting which controls the ability of
2912 staff to override the limits placed on the number of times an item
2913 can be renewed. Setting it to "Allow" would allow such limits to be
2914 overridden, setting it to "Don't allow" would prevent this. This is a
2915 preference in which if it is set to "allow" it would allow the
2916 library staff to use their judgment for overriding the renew limit
2917 for special cases, setting it to "Don't allow" prevents an
2918 opportunity for abuse by the library staff.
2920 .. _allowreturntobranch-label:
2923 ''''''''''''''''''''''''''''''''''''''''''''''
2925 Default: to any library
2927 Asks: Allow materials to be returned to \_\_\_
2931 - either the library the item is from or the library it was checked out
2934 - only the library the item is from.
2936 - only the library the item was checked out from.
2942 - This preference lets the library system decide how they will accept
2943 returns. Some systems allow for items to be returned to any library
2944 in the system (the default value of this preference) others want to
2945 limit item returns to only specific branches. This preference will
2946 allow you to limit item returns (checkins) to the branch(es) set in
2949 .. _allowtoomanyoverride-label:
2951 AllowTooManyOverride
2952 ''''''''''''''''''''''''''''''''''''''''''''''''
2956 Asks: \_\_\_ staff to override and check out items when the patron has
2957 reached the maximum number of allowed checkouts.
2963 Allow too many checkouts override
2968 Don't allow too many checkouts override
2973 - If this preference is set to "Allow" then staff all will be presented
2974 with an option to checkout more items to a patron than are normally
2975 allowed in the :ref:`Circulation and Fine Rules`. If
2976 this preference is set to "Don't allow" then no staff member will be
2977 able to check out more than the circulation limit.
2979 .. _automaticitemreturn-label:
2982 ''''''''''''''''''''''''''''''''''''''''''''''
2986 Asks: \_\_\_ automatically transfer items to their home branch when they
2997 - This preference is a binary setting which determines whether an item
2998 is returned to its home branch automatically or not. If set to
2999 "Don't", the staff member checking an item in at a location other
3000 than the item's home branch will be asked whether the item will
3001 remain at the non-home branch (in which case the new location will be
3002 marked as a holding location) or returned. Setting it to "Do" will
3003 ensure that items checked in at a branch other than their home branch
3004 will be sent to that home branch.
3006 .. _autoremoveoverduesrestrictions-label:
3008 AutoRemoveOverduesRestrictions
3009 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3013 Asks: \_\_\_ allow OVERDUES restrictions triggered by sent notices to be
3014 cleared automatically when all overdue items are returned by a patron.
3024 - Using the :ref:`Overdue Notice/Status Triggers` you
3025 can restrict patrons after they receive an overdue notice. This
3026 preference lets you define whether Koha will automatically remove
3027 that restriction once the overdue items in question are returned or
3030 .. _circcontrol-label:
3033 ''''''''''''''''''''''''''''''
3035 Default: the library the item is from
3037 Asks: Use the checkout and fines rules of \_\_\_
3041 - the library the item is from
3043 - The :ref:`circulation and fines policies <circulation-and-fine-rules-label>` will be
3044 determined by the item's library where
3045 :ref:`HomeOrHoldingBranch` chooses if item's
3046 home library is used or holding library is used.
3048 - the library the patron is from
3050 - The :ref:`circulation and fines policies <circulation-and-fine-rules-label>` will be
3051 determined the patron's home library
3053 - the library you are logged in at
3055 - The :ref:`circulation and fines policies <circulation-and-fine-rules-label>` will be
3056 determined by the library that checked the item out to the patron
3058 .. _consideronsitecheckoutsasnormalcheckouts-label:
3060 ConsiderOnSiteCheckoutsAsNormalCheckouts
3061 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3065 Asks: \_\_\_ on-site checkouts as normal checkouts. If enabled, the
3066 number of checkouts allowed will be normal checkouts + on-site
3067 checkouts. If disabled, both values will be checked separately.
3077 - This preference allows you to decide if checkouts that are
3078 :ref:`OnSiteCheckouts` are counted toward the total
3079 checkouts a patron can have. You can also set your :ref:`circulation and
3080 fine rules <circulation-and-fine-rules-label>` to allow only a certain number of
3081 normal and OnSite checkouts.
3083 .. _defaultlongoverduechargevalue-label:
3085 DefaultLongOverdueChargeValue
3086 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3088 Asks: Charge a lost item to the borrower's account when the LOST value
3089 of the item changes to \_\_\_
3093 - Leave this field empty if you don't want to charge the user for lost
3094 items. If you want the user to be charged enter the `LOST authorized
3095 value <#lost>`__ you are using in the
3096 :ref:`DefaultLongOverdueLostValue <defaultlongoverduelostvalue-&-defaultlongoverduedays-label>`
3097 preference. This preference is used when the :ref:`longoverdue cron
3098 job <long-overdues-label>` is called without the --charge parameter.
3100 .. _defaultlongoverduelostvalue-&-defaultlongoverduedays-label:
3102 DefaultLongOverdueLostValue & DefaultLongOverdueDays
3103 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3105 Asks: By default, set the LOST value of an item to \_\_\_ when the item
3106 has been overdue for more than \_\_\_ days.
3110 - These preferences are used when the :ref:`longoverdue cron
3111 job <long-overdues-label>` is called without the --lost parameter. It
3112 allows users to set the values of the :ref:`longoverdue
3113 cron <long-overdues-label>` without having to edit the crontab.
3114 Setting the values to 1 and 30 for example will mark the item with
3115 the `LOST authorized value <#lost>`__ of 1 after the item is 30 days
3118 .. _holdsinnoissuescharge-label:
3120 HoldsInNoissuesCharge
3121 ''''''''''''''''''''''''''''''''''''''''''''''''''
3123 Default: Don't include
3125 Asks: \_\_\_ hold charges when summing up charges for noissuescharge.
3133 .. _homeorholdingbranch-label:
3136 ''''''''''''''''''''''''''''''''''''''''''''''
3138 Default: the library the item was checked out from
3140 Asks: Use the checkout and fines rules of \_\_\_
3144 - the library the item is from
3146 - This is equivalent to 'home library'
3148 - the library the item was checked out from
3150 - This is equivalent to 'holding library'
3154 - This preference does several things.
3156 - If :ref:`CircControl` is set to 'the library the item
3157 is from' then the :ref:`circulation and fines
3158 policies <circulation-and-fine-rules-label>` will be determined by the item's
3159 library where HomeOrHoldingBranch chooses if item's home library
3160 is used or holding library is used.
3162 - If :ref:`IndependentBranches` is set to
3163 'Prevent' then the value of this preference is used in figuring
3164 out if the item can be checked out. If the item's home library
3165 does not match the logged in library, the item cannot be checked
3166 out unless you are a :ref:`superlibrarian <patron-permissions-defined-label>`.
3170 It is not recommend that this setting be changed after initial setup
3171 of Koha because it will change the behavior of items already checked
3174 .. _inprocessingtoshelvingcart-label:
3176 InProcessingToShelvingCart
3177 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3181 Asks: \_\_\_ items that have the location PROC to the location CART when
3182 they are checked in.
3192 - This preference is used to manage automatically changing item
3193 locations from processing (PROC) to the book cart (CART). A :ref:`cron
3194 job <in-processing/book-cart-label>` needs to be set to run at specified intervals
3195 to age items from CART to the permanent shelving location. (For
3196 example, an hourly cron entry of cart\_to\_shelf.pl --hours 3 where
3197 --hours is the amount of time an item should spend on the cart before
3198 aging to its permanent location.) More information can be found in
3199 the :ref:`related chapter <in-processing-/-book-cart-locations-label>` in this manual.
3203 If the :ref:`ReturnToShelvingCart` system
3204 preference is turned on, any newly checked-in item is also
3205 automatically put into the shelving cart, to be covered by the
3210 Checkins with confirmed holds will not go into the shelving
3211 cart. If items on the shelving cart are checked out, the cart
3212 location will be cleared.
3214 .. _issuelostitem-label:
3217 ''''''''''''''''''''''''''''''''''
3219 Default: display a message
3221 Asks: When issuing an item that has been marked as lost, \_\_\_.
3227 Lost message when checking out
3232 - This option will just check the item out without notifying you
3233 that the item was marked lost.
3235 - require confirmation
3237 Confirm checkout of lost item
3242 - This preference lets you define how library staff are notified that
3243 an item with a lost status is being checked out. This will help staff
3244 mark items as 'available' if you choose to 'display a message' or
3245 'require confirmation.' If you choose to 'do nothing,' there will be
3246 no notification that the item being checked out is marked as 'lost.'
3248 .. _issuinginprocess-label:
3251 ''''''''''''''''''''''''''''''''''''''''
3253 Default: Don't prevent
3255 Asks: \_\_\_ patrons from checking out an item whose rental charge would
3256 take them over the limit.
3266 - This preference determines if a patron can check items out if there
3267 is an overdue fine on the account and any of the materials the patron
3268 wishes to check out will potentially tip the account balance over the
3269 maximum fines policy the library has in place.
3271 Example: Your library has a $5 limit set for 'fines' (ie, after
3272 incurring $5 in fines, a patron can no longer check out items). A patron
3273 comes to the desk with 5 items to check out (4 books and a video) The
3274 patron has $4 in charges already on their account. One of the videos has
3275 a rental charge of $1, therefore making the total fines on the patron's
3276 account suddenly $5 (the limit).
3278 .. _maninvinnoissuescharge-label:
3280 ManInvInNoissuesCharge
3281 ''''''''''''''''''''''''''''''''''''''''''''''''''''
3285 Asks: \_\_\_ MANUAL\_INV charges when summing up charges for
3296 - This preference lets you decide if charges entered as manual invoices
3297 are included when calculating the
3298 :ref:`noissuescharge`. If this is set to include then
3299 Koha will include all manual invoices when deciding if the patron
3300 owes too much money to check anything else out of the library. If
3301 it's set to Don't include then Koha will ignore all manual invoice
3302 charges when figuring out if the patron owes too much money to
3303 checkout additional materials.
3305 .. _maxoutstanding-label:
3308 ''''''''''''''''''''''''''''''''''''
3312 Asks: Prevent patrons from making holds on the OPAC if they owe more
3313 than \_\_\_ USD in fines.
3315 .. _noissuescharge-label:
3318 ''''''''''''''''''''''''''''''''''''
3322 Asks: Prevent patrons from checking out books if they have more than
3323 \_\_\_ USD in fines.
3327 - This preference is the maximum amount of money owed to the library
3328 before the user is banned from borrowing more items. Using the
3329 :ref:`ManInvInNoissuesCharge` and
3330 :ref:`RentalsInNoissuesCharge` preferences
3331 you can control which types of charges are considered in this total.
3332 This also coincides with :ref:`maxoutstanding` that
3333 limits patrons from placing holds when the maximum amount is owed to
3336 .. _noissueschargeguarantees-label:
3338 NoIssuesChargeGuarantees
3339 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3341 Asks: Prevent a patron from checking out if the patron has guarantees
3342 owing in total more than \_\_\_ USD in fines.
3346 - Allows a library to prevent patrons from checking out items if his or
3347 her guarantees owe too much in fines.
3349 .. _norenewalbeforeprecision-label:
3351 NoRenewalBeforePrecision
3352 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3356 Asks: Calculate "No renewal before" based on \_\_\_.
3366 Only relevant for loans calculated in days, hourly loans are not
3371 - This preference allows you to control how the 'No renewal before"
3372 option in the :ref:`Circulation and fine rules <circulation-and-fine-rules-label>`
3373 administration area.
3375 .. _noticebcc-label:
3378 ''''''''''''''''''''''''''''''''''''''''
3380 Asks: Send all notices as a BCC to this email address \_\_\_
3382 This preference makes it so that a librarian can get a copy of every
3383 notice sent out to patrons.
3387 If you'd like more than one person to receive the blind copy you can
3388 simply enter in multiple email addresses separated by commas.
3390 .. _onsitecheckouts-label:
3393 ''''''''''''''''''''''''''''''''''''''
3397 Asks: \_\_\_ the on-site checkouts feature.
3403 - EnableOnSiteCheckouts
3407 - This preference lets you check out items that are 'not for loan' to
3408 patrons. A checkbox is added to the checkout screen when this
3409 preference is set to 'Enable' labeled 'On-site checkout'. This allows
3410 you to track who's using items that are normally not for loan or are
3411 in a closed stack setting.
3413 .. _onsitecheckoutsforce-label:
3415 OnSiteCheckoutsForce
3416 ''''''''''''''''''''''''''''''''''''''''''''''''
3420 Asks: \_\_\_ the on-site for all cases (Even if a user is debarred,
3429 Force checkouts on restricted patrons
3434 - This preference lets the staff override any restrictions a patron
3435 might have and check out items for use within the library. The
3436 :ref:`OnSiteCheckouts` preference must first be set
3437 to 'Enable' for this preference to be considered.
3439 .. _opacfinenorenewalsblockautorenew-label:
3441 OPACFineNoRenewalsBlockAutoRenew
3442 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3446 Asks: If a patron owes more than the value of :ref:`OPACFineNoRenewals`,
3447 \_\_\_ his/her auto renewals.
3455 .. _overduenoticecalendar-label:
3457 OverdueNoticeCalendar
3458 ''''''''''''''''''''''''''''''''''''''''''''''''''
3460 Default: Ignore calendar
3462 Asks: \_\_\_ when working out the period for overdue notices
3468 - Notices do not take holidays into account, so they will be sent
3469 even if holidays have meant the item is not actually overdue yet
3473 - Notices take holidays into account, so they will not be sent if
3474 holidays mean the item is not actually overdue yet
3476 .. _overduesblockcirc-label:
3479 ''''''''''''''''''''''''''''''''''''''''''
3481 Default: Ask for confirmation
3483 Asks: \_\_\_ when checking out to a borrower that has overdues
3488 - Ask for confirmation
3490 - Will not let you check an item out to patrons with overdues until
3491 a librarian confirms that it is okay
3495 - Block all patrons with overdue items from being able to check out
3499 - Allow all patrons with overdue items to continue to check out
3501 .. _overduesblockrenewing-label:
3503 OverduesBlockRenewing
3504 ''''''''''''''''''''''''''''''''''''''''''''''''''
3506 Default: allow renewing
3508 Asks: When a patron's checked out item is overdue, \_\_\_
3514 - block renewing for all the patron's items
3516 - block renewing for only this item
3518 .. _printnoticesmaxlines-label:
3520 PrintNoticesMaxLines
3521 ''''''''''''''''''''''''''''''''''''''''''''''''
3523 Asks: Include up to \_\_\_ item lines in a printed overdue notice.
3527 If the number of items is greater than this number, the notice will
3528 end with a warning asking the borrower to check their online account
3529 for a full list of overdue items.
3533 Set to 0 to include all overdue items in the notice, no matter how
3538 This preference only refers to the print notices, not those sent via
3541 .. _renewalperiodbase-label:
3544 ''''''''''''''''''''''''''''''''''''''''''
3546 Default: the old due date of the checkout
3548 Asks: When renewing checkouts, base the new due date on \_\_\_
3552 - the old due date of the checkout
3556 .. _renewalsendnotice-label:
3559 ''''''''''''''''''''''''''''''''''''''''''
3563 Asks: \_\_\_\_ a renewal notice according to patron checkout alert
3574 - If a patron has chosen to receive a check out notice in their
3575 messaging preferences and this preference is set to 'Send' then those
3576 patrons will also receive a notice when they renew materials. You
3577 will want to set up a :ref:`new notice <adding-notices-&-slips-label>` with the code of
3578 RENEWAL (if you don't already have it) with custom text for renewing
3583 This preference requires that you have
3584 :ref:`EnhancedMessagingPreferences`
3587 .. _rentalfeescheckoutconfirmation-label:
3589 RentalFeesCheckoutConfirmation
3590 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3594 Asks: When checking out an item with rental fees, \_\_\_ for
3599 - askRentalFeesCheckoutConfirmation
3605 - If you are charging rental fees for items this preference will make
3606 it so that you can show (or not show) a confirmation before checking
3607 out an item that will incur a rental charge.
3609 .. _rentalsinnoissuescharge-label:
3611 RentalsInNoissuesCharge
3612 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3616 Asks: \_\_\_ rental charges when summing up charges for noissuescharge.
3626 - This preference lets you decide if rental charges are included when
3627 calculating the :ref:`noissuescharge`. If this is set
3628 to include then Koha will include all rental charges when deciding if
3629 the patron owes too much money to check anything else out of the
3630 library. If it's set to Don't include then Koha will ignore all
3631 rental charges when figuring out if the patron owes too much money to
3632 checkout additional materials.
3634 .. _restrictionblockrenewing-label:
3636 RestrictionBlockRenewing
3637 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3641 Asks: If patron is restricted, \_\_\_ renewing of items.
3649 .. _returnbeforeexpiry-label:
3652 ''''''''''''''''''''''''''''''''''''''''''''
3654 Default: Don't require
3656 Asks: \_\_\_ patrons to return books before their accounts expire (by
3657 restricting due dates to before the patron's expiration date).
3667 - This is preference may prevent a patron from having items checked out
3668 after their library card has expired. If this is set to "Require",
3669 then a due date of any checked out item can not be set for a date
3670 which falls after the patron's card expiration. If the setting is
3671 left "Don't require" then item check out dates may exceed the
3672 expiration date for the patron's library card.
3674 .. _returntoshelvingcart-label:
3676 ReturnToShelvingCart
3677 ''''''''''''''''''''''''''''''''''''''''''''''''
3681 Asks: \_\_\_ all items to the location CART when they are checked in.
3691 - More information can be found in the :ref:`related
3692 chapter <in-processing-/-book-cart-locations-label>` in this manual.
3694 .. _staffsearchresultsdisplaybranch-label:
3696 StaffSearchResultsDisplayBranch
3697 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3699 Default: the library the item is held by
3701 Asks: For search results in the staff client, display the branch of
3706 - the library the item is from
3708 - the library the items is held by
3710 .. _switchonsitecheckouts-label:
3712 SwitchOnSiteCheckouts
3713 ''''''''''''''''''''''''''''''''''''''''''''''''''
3715 Default: Don't switch
3717 Asks: \_\_\_ on-site checkouts to normal checkouts when checked out.
3725 .. _transfersmaxdayswarning-label:
3727 TransfersMaxDaysWarning
3728 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3732 Asks: Show a warning on the "Transfers to Receive" screen if the
3733 transfer has not been received \_\_\_ days after it is sent.
3737 - The TransferMaxDaysWarning preference is set at a default number of
3738 days. This preference allows for a warning to appear after a set
3739 amount of time if an item being transferred between library branches
3740 has not been received. The warning will appear in the :ref:`Transfers to
3741 Receive <transfers-to-receive-label>` report.
3743 .. _usebranchtransferlimits-&-branchtransferlimitstype-label:
3745 UseBranchTransferLimits & BranchTransferLimitsType
3746 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3748 Defaults: Don't enforce & collection code
3750 Asks: \_\_\_ branch transfer limits based on \_\_\_
3752 UseBranchTransferLimits Values:
3758 BranchTransferLimitsType Values:
3764 BranchTransferLimitsType Description:
3766 - This parameter is a binary setting which determines whether items are
3767 transferred according to item type or collection code. This value
3768 determines how the library manager is able to restrict what items can
3769 be transferred between the branches.
3771 .. _usedaysmode-label:
3774 ''''''''''''''''''''''''''''''
3776 Default: Don't include
3778 Asks: Calculate the due date using \_\_\_.
3782 - circulation rules only.
3784 - the calendar to push the due date to the next open day.
3786 - the calendar to skip all days the library is closed.
3790 - This preference controls how scheduled library closures affect the
3791 due date of a material. The 'the calendar to skip all days the
3792 library is closed' setting allows for a scheduled closure not to
3793 count as a day in the loan period, the 'circulation rules only'
3794 setting would not consider the scheduled closure at all, and 'the
3795 calendar to push the due date to the next open day' would only effect
3796 the due date if the day the item is due would fall specifically on
3801 - The library has put December 24th and 25th in as closures on the
3802 calendar. A book checked out by a patron has a due date of December
3803 25th according to the circulation and fine rules. If this preference
3804 is set to 'circulation rules only' then the item will remain due on
3805 the 25th. If the preference is set to 'the calendar to push the due
3806 date to the next open day' then the due date will be December 26th.
3807 If the preference is set to 'the calendar to skip all days the
3808 library is closed' then the due date will be pushed to the 27th of
3809 December to accommodate for the two closed days.
3811 The calendar is defined on a branch by branch basis. To learn more about
3812 the calendar, check out the ':ref:`Calendar & Holidays <calendar-label>`'
3813 section of this manual.
3815 .. _usetransportcostmatrix-label:
3817 UseTransportCostMatrix
3818 ''''''''''''''''''''''''''''''''''''''''''''''''''''
3822 Asks: \_\_\_ Transport Cost Matrix for calculating optimal holds filling
3833 - If the system is configured to use the :ref:`Transport cost
3834 matrix <transport-cost-matrix-label>` for filling holds, then when
3835 attempting to fill a hold, the system will search for the lowest cost
3836 branch, and attempt to fill the hold with an item from that branch
3837 first. Branches of equal cost will be selected from randomly. The
3838 branch or branches of the next highest cost shall be selected from
3839 only if all the branches in the previous group are unable to fill the
3842 The system will use the item's current holding branch when
3843 determining whether the item can fulfill a hold using the Transport
3846 .. _course-reserves-label:
3849 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3851 .. _usecoursereserves-label:
3854 ''''''''''''''''''''''''''''''''''''''''''
3858 Asks: \_\_\_ course reserves
3868 - The `Course Reserves <#coursereserves>`__ module in Koha allows you
3869 to temporarily move items to 'reserve' and assign different
3870 circulation rules to these items while they are being used for a
3873 .. _fines-policy-label:
3876 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3878 .. _finescalendar-label:
3881 ''''''''''''''''''''''''''''''''''
3883 Default: not including the days the library is closed
3885 Asks: Calculate fines based on days overdue \_\_\_
3891 - not including the days the library is closed
3895 - This preference will determine whether or not fines will be accrued
3896 during instances when the library is closed. Examples include
3897 holidays, library in-service days, etc. Choosing "not including the
3898 days the library is closed" setting will enable Koha to access its
3899 :ref:`Calendar` module and be considerate of dates when
3900 the library is closed. To make use of this setting the administrator
3901 must first access Koha's calendar and mark certain days as "holidays"
3904 The calendar is defined on a branch by branch basis. To learn more about
3905 the calendar, check out the ':ref:`Calendar & Holidays <calendar-label>`'
3906 section of this manual.
3908 .. _finesincludegraceperiod-label:
3910 FinesIncludeGracePeriod
3911 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
3915 Asks: \_\_\_ the grace period when calculating the fine for an overdue
3926 - This preference lets you control how Koha calculates fines when there
3927 is a grace period. If you choose to include the grace period when
3928 calculating fines then Koha will charge for the days in the grace
3929 period should the item be overdue more than those days. If you choose
3930 not to include the grace period then Koha will only charge for the
3931 days overdue after the grace period.
3933 .. _finesmode-label:
3936 ''''''''''''''''''''''''''
3938 Default: Calculate (but only for mailing to the admin)
3944 - Calculate (but only for mailing to the admin)
3946 - Calculate and charge
3952 Requires that you have the fines cron job running
3953 (misc/cronjobs/fines.pl)
3955 .. _holdfeemode-label:
3958 ''''''''''''''''''''''''''''''
3960 Default: only if all items are checked out and the record has at least one hold already.
3962 Asks: Charge a hold fee \_\_\_
3966 - any time a hold is collected.
3968 - any time a hold is placed.
3970 - only if all items are checked out and the record has at least one hold already.
3972 .. _refundlostonreturncontrol-label:
3974 RefundLostOnReturnControl
3975 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3977 Default: check-in library.
3979 Asks: If a lost item is returned, apply the refunding rules defined
3986 - item holding branch.
3990 .. _whenlostchargereplacementfee-label:
3992 WhenLostChargeReplacementFee
3993 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
3997 Asks: \_\_\_ the replacement price when a patron loses an item.
4007 - This preference lets you tell Koha what to do with an item is marked
4008 lost. If you want Koha can 'Charge' the patron the replacement fee
4009 listed on the item they lost or it can do nothing in reference to the
4010 patron and just mark the item lost in the catalog.
4012 .. _whenlostforgivefine-label:
4015 ''''''''''''''''''''''''''''''''''''''''''''''
4017 Default: Don't forgive
4019 Asks: \_\_\_ the fines on an item when it is lost.
4029 - This preference allows the library to decide if fines are charged in
4030 addition to the replacement fee when an item is marked as lost. If
4031 this preference is set to 'Forgive' then the patron won't be charged
4032 fines in addition to the replacement fee.
4034 .. _holds-policy-label:
4037 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4039 .. _allowholddateinfuture-label:
4041 AllowHoldDateInFuture
4042 ''''''''''''''''''''''''''''''''''''''''''''''''''
4046 Asks: \_\_\_ hold requests to be placed that do not enter the waiting
4047 list until a certain future date.
4055 .. _allowholditemtypeselection-label:
4057 AllowHoldItemTypeSelection
4058 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4060 Default: Don't allow
4062 Asks: \_\_\_ hold fulfillment to be limited by itemtype.
4070 .. _allowholdpolicyoverride-label:
4072 AllowHoldPolicyOverride
4073 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4077 Asks: \_\_\_ staff to override hold policies when placing holds.
4087 - This preference is a binary setting which controls whether or not the
4088 library staff can override the circulation and fines rules as they
4089 pertain to the placement of holds. Setting this value to "Don't
4090 allow" will prevent anyone from overriding, setting it to "Allow"
4091 will allow it. This setting is important because it determines how
4092 strict the libraries rules for placing holds are. If this is set to
4093 "Allow", exceptions can be made for patrons who are otherwise
4094 normally in good standing with the library, but there is opportunity
4095 for the staff to abuse this function. If it is set to "Don't allow",
4096 no abuse of the system is possible, but it makes the system entirely
4097 inflexible in respect to holds.
4099 .. _allowholdsondamageditems-label:
4101 AllowHoldsOnDamagedItems
4102 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4106 Asks: \_\_\_ hold requests to be placed on damaged items.
4116 - This parameter is a binary setting which controls whether or not hold
4117 requests can be placed on items that are marked as "damaged" (items
4118 are marked as damaged by editing subfield 4 on the item record).
4119 Setting this value to "Don't allow" will prevent anyone from placing
4120 a hold on such items, setting it to "Allow" will allow it. This
4121 preference is important because it determines whether or not a patron
4122 can place a request for an item that might be in the process of being
4123 repaired or not in good condition. The library may wish to set this
4124 to "Don't allow" if they were concerned about their patrons not
4125 receiving the item in a timely manner or at all (if it is determined
4126 that the item is beyond repair). Setting it to "Allow" would allow a
4127 patron to place a hold on an item and therefore receive it as soon as
4128 it becomes available.
4130 .. _allowholdsonpatronspossessions-label:
4132 AllowHoldsOnPatronsPossessions
4133 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4137 Asks: \_\_\_\_ a patron to place a hold on a record where the patron
4138 already has one or more items attached to that record checked out.
4148 - By setting to "Don't allow," you can prevent patrons from placing
4149 holds on items they already have out, thus preventing them from
4150 blocking anyone else from getting an item.
4152 .. _allowrenewalifotheritemsavailable-label:
4154 AllowRenewalIfOtherItemsAvailable
4155 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4157 Default: Don't allow
4159 Asks: \_\_\_ a patron to renew an item with unfilled holds if other
4160 available items can fill that hold.
4168 .. _autoresumesuspendedholds-label:
4170 AutoResumeSuspendedHolds
4171 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4175 Asks: \_\_\_ suspended holds to be automatically resumed by a set date.
4185 - If this preference is set to 'Allow' then all suspended holds will be
4186 able to have a date at after which they automatically become
4187 unsuspended. If you have this preference set to 'Allow' you will also
4188 need the :ref:`Unsuspend Holds` cron job running.
4192 The holds will become unsuspended the date after that entered by the
4195 .. _canreservefromotherbranches-label:
4197 canreservefromotherbranches
4198 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4202 Asks: \_\_\_ a user from one library to place a hold on an item from
4207 - This preference is a binary setting which determines whether patrons
4208 can place holds on items from other branches. If the preference is
4209 set to "Allow" patrons can place such holds, if it is set to "Don't
4210 allow" they cannot. This is an important setting because it
4211 determines if users can use Koha to request items from another
4212 branch. If the library is sharing an installation of Koha with other
4213 independent libraries which do not wish to allow interlibrary
4214 borrowing it is recommended that this parameter be set to "Don't
4221 - Don't allow (with :ref:`independent branches <independentbranches-label>`)
4223 .. _confirmfutureholds-label:
4226 ''''''''''''''''''''''''''''''''''''''''''''
4230 Asks: Confirm future hold requests (starting no later than \_\_\_ days
4231 from now) at checkin time.
4235 - When confirming a hold at checkin time, the number of days in this
4236 preference is taken into account when deciding which holds to show
4237 alerts for. This preference does not interfere with renewing,
4238 checking out or transferring a book.
4242 This number of days will be used too in calculating the default end
4243 date for the Holds to pull-report. But it does not interfere with
4244 issuing, renewing or transferring books.
4248 This preference is only looked at if you're allowing hold dates in
4249 the future with :ref:`AllowHoldDateInFuture`
4250 or :ref:`OPACAllowHoldDateInFuture`
4252 .. _decreaseloanhighholds,-decreaseloanhighholdsduration,-decreaseloanhighholdsvalue,-decreaseloanhighholdscontrol,-and-decreaseloanhighholdsignorestatuses-label:
4254 decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue, decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses
4255 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4257 Asks: \_\_\_ the reduction of loan period \_\_\_ to days for items with
4258 more than \_\_\_ holds \_\_\_ . Ignore items with the following statuses
4259 when counting items \_\_\_
4261 decreaseLoanHighHolds default: Don't enable
4263 decreaseLoanHighHoldsControl default: on the record
4265 decreaseLoanHighHolds values:
4269 decreaseLoanHighHoldsControl values:
4271 - over the number of holdable items on the records
4275 decreaseLoanHighHoldsIgnoreStatuses values:
4289 - These preferences let you change the loan length for items that have
4290 many holds on them. This will not effect items that are already
4291 checked out, but items that are checked out after the
4292 decreaseLoanHighHoldsValue is met will only be checked out for the
4293 number of days entered in the decreaseLoanHighHoldsDuration
4299 .. _displaymultiplacehold-label:
4301 DisplayMultiPlaceHold
4302 ''''''''''''''''''''''''''''''''''''''''''''''''''
4304 Default: Don't enable
4306 Asks: \_\_\_ the ability to place holds on multiple biblio from the
4315 .. _emaillibrarianwhenholdisplaced-label:
4317 emailLibrarianWhenHoldIsPlaced
4318 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4320 Default: Don't enable
4322 Asks: \_\_\_ sending an email to the Koha administrator email address
4323 whenever a hold request is placed.
4333 - This preference enables Koha to email the library staff whenever a
4334 patron requests an item to be held. While this function will
4335 immediately alert the librarian to the patron's need, it is extremely
4336 impractical in most library settings. In most libraries the hold
4337 lists are monitored and maintained from a separate interface. That
4338 said, many libraries that allow on shelf holds prefer to have this
4339 preference turned on so that they are alerted to pull an item from
4344 In order for this email to send you must have a
4345 :ref:`notice <notices-&-slips-label>` template with the code of HOLDPLACED
4349 This notice will only be sent if the :ref:`process\_message\_queue.pl
4350 cronjob <message-queue-label>` being run periodically to send the
4353 .. _excludeholidaysfrommaxpickupdelay-label:
4355 ExcludeHolidaysFromMaxPickUpDelay
4356 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4358 Default: Don't allow
4360 Asks: \_\_\_ Closed days to be taken into account in reserves max pickup delay.
4368 .. _expirereservesmaxpickupdelay-label:
4370 ExpireReservesMaxPickUpDelay
4371 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4373 Default: Don't allow
4375 Asks: \_\_\_ holds to expire automatically if they have not been picked
4376 by within the time period specified in
4377 :ref:`ReservesMaxPickUpDelay`
4387 - If set to 'allow' this will cancel holds that have been waiting for
4388 longer than the number of days specified in the
4389 :ref:`ReservesMaxPickUpDelay` system
4390 preference. Holds will only be cancelled if the :ref:`Expire Holds cron
4391 job <expired-holds-label>` is runnning.
4393 .. _expirereservesmaxpickupdelaycharge-label:
4395 ExpireReservesMaxPickUpDelayCharge
4396 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4401 :ref:`ExpireReservesMaxPickUpDelay`, charge
4402 a borrower who allows his or her waiting hold to expire a fee of \_\_\_
4407 - If you are expiring holds that have been waiting too long you can use
4408 this preference to charge the patron for not picking up their hold.
4409 If you don't charge patrons for items that aren't picked up you can
4410 leave this set to the default which is 0. Holds will only be
4411 cancelled and charged if the :ref:`Expire Holds cron
4412 job <expired-holds-label>` is running.
4414 .. _expirereservesonholidays-label:
4416 ExpireReservesOnHolidays
4417 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4421 Asks: \_\_\_ expired holds to be cancelled on days the library is
4430 .. _localholdspriority,-localholdsprioritypatroncontrol,-localholdspriorityitemcontrol-label:
4432 LocalHoldsPriority, LocalHoldsPriorityPatronControl, LocalHoldsPriorityItemControl
4433 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4435 Asks: \_\_\_ priority for filling holds to patrons whose \_\_\_ matches
4438 LocalHoldsPriority Values:
4444 LocalHoldsPriorityPatronControl Values:
4450 LocalHoldsPriorityItemControl Values:
4458 - This feature will allow libraries to specify that, when an item is
4459 returned, a local hold may be given priority for fulfillment even
4460 though it is of lower priority in the list of unfilled holds.
4462 .. _maxreserves-label:
4465 ''''''''''''''''''''''''''''''
4469 Asks: Patrons can only have \_\_\_ holds at once.
4471 .. _opacallowholddateinfuture-label:
4473 OPACAllowHoldDateInFuture
4474 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4478 Asks: \_\_\_ patrons to place holds that don't enter the waiting list
4479 until a certain future date.
4485 - :ref:`AllowHoldDateInFuture` must also be
4486 enabled for this to work
4490 .. _opacallowusertochoosebranch-label:
4492 OPACAllowUserToChooseBranch
4493 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4497 Asks: \_\_\_ a user to choose the branch to pick up a hold from.
4507 - Changing this preference will not prevent staff from being able to
4508 transfer titles from one branch to another to fill a hold, it will
4509 only prevent patrons from saying they plan on picking a book up at a
4510 branch other than their home branch.
4512 .. _opacholdsifavailableatpickup-label:
4514 OPACHoldsIfAvailableAtPickup
4515 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4519 Asks: \_\_\_ to pickup holds at libraries where the item is available.
4527 .. _opacholdsifavailableatpickupexceptions-label:
4529 OPACHoldsIfAvailableAtPickupExceptions
4530 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4534 Asks: Patron categories not affected by :ref:`OPACHoldsIfAvailableAtPickup`
4535 \_\_\_ (list of patron categories separated with a pipe '|')
4537 .. _reservescontrolbranch-label:
4539 ReservesControlBranch
4540 ''''''''''''''''''''''''''''''''''''''''''''''''''
4542 Default: item's home library
4544 Asks: Check the \_\_\_ to see if the patron can place a hold on the
4549 - item's home library.
4551 - patron's home library.
4553 .. _reservesmaxpickupdelay-label:
4555 ReservesMaxPickUpDelay
4556 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4560 Asks: Mark a hold as problematic if it has been waiting for more than
4565 - This preference (based on calendar days, not the :ref:`Koha holiday
4566 calendar <calendar-label>`) puts an expiration date on an item a
4567 patron has on hold. After this expiration date the staff will have
4568 the option to release the unclaimed hold which then may be returned
4569 to the library shelf or issued to the next patron on the item's hold
4570 list. Items that are 'expired' by this preference are moved to the
4571 'Holds Over' tab on the ':ref:`Holds Awaiting Pickup <holds-awaiting-pickup-label>`'
4574 .. _reservesneedreturns-label:
4577 ''''''''''''''''''''''''''''''''''''''''''''''
4579 Default: Don't automatically
4581 Asks: \_\_\_ mark holds as found and waiting when a hold is placed
4582 specifically on them and they are already checked in.
4588 - Don't automatically
4592 - This preference refers to 'item specific' holds where the item is
4593 currently on the library shelf. This preference allows a library to
4594 decide whether an 'item specific' hold is marked as "Waiting" at the
4595 time the hold is placed or if the item will be marked as "Waiting"
4596 after the item is checked in. This preference will tell the patron
4597 that their item is 'Waiting' for them at their library and ready for
4600 .. _staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label:
4602 StaticHoldsQueueWeight, HoldsQueueSkipClosed & RandomizeHoldsQueueWeight
4603 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4605 StaticHoldsQueueWeight Default: 0
4607 HoldsQueueSkipClosed Default: open or closed
4609 RandomizeHoldsQueueWeight Default: in that order
4611 Asks: Satisfy holds using items from the libraries \_\_\_ (as
4612 branchcodes, separated by commas; if empty, uses all libraries) when
4613 they are \_\_\_ \_\_\_.
4615 HoldsQueueSkipClosed Values:
4621 RandomizeHoldsQueueWeight Values:
4625 - If StaticHoldsQueueWeight is left at the default Koha will
4626 randomize all libraries, otherwise it will randomize the libraries
4631 - If StaticHoldsQueueWeight is left at the default then this will
4632 use all of your branches in alphabetical order, otherwise it will
4633 use the branches in the order that you entered them in the
4634 StaticHoldsQueueWeight preference.
4638 - These preferences control how the :ref:`Holds Queue
4639 report <holds-queue-label>` is generated using :ref:`a cron
4640 job <holds-queue-label>`.
4642 If you do not want all of your libraries to participate in the
4643 on-shelf holds fulfillment process, you should list the the libraries
4644 that \*do\* participate in the process here by inputting all the
4645 participating library's branchcodes, separated by commas ( e.g.
4646 "MPL,CPL,SPL,BML" etc. ).
4648 By default, the holds queue will be generated such that the system
4649 will first attempt to hold fulfillment using items already at the
4650 pickup library if possible. If there are no items available at the
4651 pickup library to fill a hold, build\_holds\_queue.pl will then use
4652 the list of libraries defined in StaticHoldsQueueWeight. If
4653 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
4654 script will assign fulfillment requests in the order the branches are
4655 placed in the StaticHoldsQueueWeight system preference.
4657 For example, if your system has three libraries, of varying sizes (
4658 small, medium and large ) and you want the burden of holds
4659 fulfillment to be on larger libraries before smaller libraries, you
4660 would want StaticHoldsQueueWeight to look something like
4663 If you want the burden of holds fulfillment to be spread out equally
4664 throughout your library system, simply enable
4665 RandomizeHoldsQueueWeight. When this system preference is enabled,
4666 the order in which libraries will be requested to fulfill an on-shelf
4667 hold will be randomized each time the list is regenerated.
4669 Leaving StaticHoldsQueueWeight empty is contraindicated at this time.
4670 Doing so will cause the build\_holds\_queue script to ignore
4671 RandomizeHoldsQueueWeight, causing the script to request hold
4672 fulfillment not randomly, but by alphabetical order.
4676 The :ref:`Transport Cost Matrix <transport-cost-matrix-label>` takes
4677 precedence in controlling where holds are filled from, if the matrix
4678 is not used then Koha checks the StaticHoldsQueueWeight. To use the
4679 Transport Cost Matrix simply set your
4680 :ref:`UseTransportCostMatrix` preference to
4683 .. _suspendholdsintranet-label:
4685 SuspendHoldsIntranet
4686 ''''''''''''''''''''''''''''''''''''''''''''''''
4690 Asks: \_\_\_ holds to be suspended from the intranet.
4700 - The holds suspension feature can be turned on and off in the staff
4701 client by altering this system preference. If this is set to 'allow'
4702 you will want to set the
4703 :ref:`AutoResumeSuspendedHolds` system
4706 .. _suspendholdsopac-label:
4709 ''''''''''''''''''''''''''''''''''''''''
4713 Asks: \_\_\_ holds to be suspended from the OPAC.
4723 - The holds suspension feature can be turned on and off in the OPAC by
4724 altering this system preference. If this is set to 'allow' you will
4726 :ref:`AutoResumeSuspendedHolds` system
4729 .. _transferwhencancelallwaitingholds-label:
4731 TransferWhenCancelAllWaitingHolds
4732 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4734 Default: Don't transfer
4736 Asks: \_\_\_ items when cancelling all waiting holds.
4746 - When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no
4747 branch transfer records are created. Koha will not allow the holds to
4748 be transferred, because that would orphan the items at the library
4749 where the holds were awaiting pickup, without any further instruction
4750 to staff as to what items are at the library or where they need to
4751 go. When that system preference set to "Transfer", branch transfers
4752 are created, so the holds may be cancelled.
4754 .. _housebound-module-label:
4757 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4759 .. _houseboundmodule-label:
4762 ''''''''''''''''''''''''''''''''''''''''
4766 Asks: \_\_\_ housebound module
4776 - This preference enables or disables the Housebound module which
4777 handles management of circulation to Housebound readers.
4779 .. _housebound-interface-label:
4782 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4784 .. _allowallmessagedeletion-label:
4786 AllowAllMessageDeletion
4787 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4789 Default: Don't allow
4791 Asks: \_\_\_ staff to delete messages added from other libraries.
4799 .. _allowcheckoutnotes-label:
4802 ''''''''''''''''''''''''''''''''''''''''''''
4804 Default: Don't allow
4806 Asks: \_\_\_ patrons to submit notes about checked out items.
4814 .. _allowofflinecirculation-label:
4816 AllowOfflineCirculation
4817 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
4819 Default: Do not enable
4821 Asks: \_\_\_ offline circulation on regular circulation computers.
4831 - Setting this preference to 'Enable' allows you to use the Koha
4832 interface for :ref:`offline circulation <offline-circulation-utilities-label>`. This system
4833 preference does not affect the :ref:`Firefox
4834 plugin <firefox-plugin-label>` or the :ref:`desktop
4835 application <offline-circ-tool-for-windows-label>`, any of these three options can
4836 be used for offline circulation without effecting the other.
4838 .. _circautocompl-label:
4841 ''''''''''''''''''''''''''''''''''
4845 Asks: \_\_\_ to automatically fill in the member when entering a patron
4846 search on the circulation screen.
4850 - This preference is a binary setting which determines whether
4851 auto-completion of fields is enabled or disabled for the circulation
4852 input field. Setting it to "Try" would enable a staff member to begin
4853 typing a name or other value into the field and have a menu pop up
4854 with suggestions for completing it. Setting it to "Don't try" would
4855 disable this feature. This preference can make staff members' jobs
4856 easier or it could potentially slow down the page loading process.
4864 When CircAutocompl is turned on search results will appear below the
4868 .. _circautoprintquickslip-label:
4870 CircAutoPrintQuickSlip
4871 ''''''''''''''''''''''''''''''''''''''''''''''''''''
4873 Default: open a print quick slip window
4875 Asks: When an empty barcode field is submitted in circulation \_\_\_
4881 - open a print quick slip window
4883 - open a print slip window
4887 - If this preference is set to open a quick slip
4888 (:ref:`ISSUEQSLIP <existing-notices-&-slips-label>`) or open a slip
4889 (:ref:`ISSUESLIP <existing-notices-&-slips-label>`) for printing it will eliminate the
4890 need for the librarian to click the print button to generate a
4891 checkout receipt for the patron they're checking out to. If the
4892 preference is set to clear the screen then "checking out" an empty
4893 barcode will clear the screen of the patron you were last working
4896 .. _circsidebar-label:
4899 ''''''''''''''''''''''''''''''
4903 Asks: \_\_\_ the navigation sidebar on all Circulation pages.
4911 .. _displayclearscreenbutton-label:
4913 DisplayClearScreenButton
4914 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4918 Asks: \_\_\_ a button to clear the current patron from the screen on the
4925 No X in the top right
4930 X in the top right will clear the screen
4933 .. _exportcirchistory-label:
4936 ''''''''''''''''''''''''''''''''''''''''''
4940 Asks: \_\_\_ the export patron checkout history options.
4948 .. _exportremovefields-label:
4951 ''''''''''''''''''''''''''''''''''''''''''''
4953 Asks: The following fields should be excluded from the patron checkout
4954 history CSV or iso2709 export \_\_\_
4958 - This space separated list of fields (e.g. 100a 245b) will
4959 automatically be excluded when exporting the patron's current
4965 .. _filterbeforeoverduereport-label:
4967 FilterBeforeOverdueReport
4968 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
4970 Default: Don't require
4972 Asks: \_\_\_ staff to choose which checkouts to show before running the
4977 - Koha's overdue report shows you all of the overdue items in your
4978 library system. If you have a large library system you'll want to set
4979 this preference to 'Require' to force those running the report to
4980 first limit the data generated to a branch, date range, patron
4981 category or other such filter. Requiring that the report be filtered
4982 before it's run prevents your staff from running a system heavy
4983 report and slowing down other operations in the system.
4985 Overdue Report Filters
4994 .. _finenotifyatcheckin-label:
4997 ''''''''''''''''''''''''''''''''''''''''''''''
4999 Default: Don't notify
5001 Asks: \_\_\_ librarians of overdue fines on the items they are checking
5012 - With this preference set to 'Notify' all books that have overdue
5013 fines owed on them will pop up a warning when checking them in. This
5014 warning will need to acknowledged before you can continue checking
5015 items in. With this preference set to 'Don't notify,' you will still
5016 see fines owed on the patron record, you just won't have an
5017 additional notification at check in.
5019 Fine notification at checkin
5022 .. _holdstopullstartdate-label:
5024 HoldsToPullStartDate
5025 ''''''''''''''''''''''''''''''''''''''''''''''''
5029 Asks: Set the default start date for the Holds to pull list to \_\_\_
5034 - The :ref:`Holds to Pull <holds-to-pull-label>` report in circulation defaults to
5035 filtering holds placed 2 days ago. This preference allows you to set
5036 this default filter to any number of days.
5038 .. _itembarcodefallbacksearch-label:
5040 itemBarcodeFallbackSearch
5041 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5043 Default: Don't enable
5045 Asks: \_\_\_ the automatic use of a keyword catalog search if the phrase
5046 entered as a barcode on the checkout page does not turn up any results
5047 during an item barcode search.
5060 - Sometimes libraries want to checkout using something other than the
5061 barcode. Enabling this preference will do a keyword search of Koha to
5062 find the item you're trying to check out. You can use the call
5063 number, barcode, part of the title or anything you'd enter in the
5064 keyword search when this preference is enabled and Koha will ask you
5065 which item you're trying to check out.
5069 While you're not searching by barcode a barcode is required on every
5070 title you check out. Only titles with barcodes will appear in the
5073 .. _itembarcodeinputfilter-label:
5075 itemBarcodeInputFilter
5076 ''''''''''''''''''''''''''''''''''''''''''''''''''''
5078 Default: Don't filter
5080 Asks: \_\_\_ scanned item barcodes.
5084 - Convert from CueCat format
5086 - Convert from Libsuite8 form
5090 - EAN-13 or zero-padded UPC-A from
5092 - Remove spaces from
5094 - Remove the first number from T-prefix style
5096 - This format is common among those libraries migrating from Follett
5099 .. _noticecss-label:
5102 ''''''''''''''''''''''''''
5104 Asks: Include the stylesheet at \_\_\_ on Notices.
5108 This should be a complete URL, starting with http://
5112 - If you would like to style your notices with a consistent set of
5113 fonts and colors you can use this preference to point Koha to a
5114 stylesheet specifically for your notices.
5116 .. _numreturneditemstoshow-label:
5118 numReturnedItemsToShow
5119 ''''''''''''''''''''''''''''''''''''''''''''''''''''
5123 Asks : Show the \_\_\_ last returned items on the checkin screen.
5125 .. _previousissuesdefaultsortorder-label:
5127 previousIssuesDefaultSortOrder
5128 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5130 Default: earliest to latest
5132 Asks: Sort previous checkouts on the circulation page from \_\_\_ due
5137 - earliest to latest
5139 - latest to earliest
5141 .. _recordlocaluseonreturn-label:
5143 RecordLocalUseOnReturn
5144 ''''''''''''''''''''''''''''''''''''''''''''''''''''
5146 Default: Don't record
5148 Asks: \_\_\_ local use when an unissued item is checked in.
5158 - When this preference is set to "Don't record" you can record local
5159 use of items by checking items out to the statistical patron. With
5160 this preference set to "Record" you can record local use by checking
5161 out to the statistical patron and/or by checking in a book that is
5162 not currently checked out.
5164 .. _showallcheckins-label:
5167 ''''''''''''''''''''''''''''''''''''''
5169 Default: Do not show
5171 Asks: \_\_\_ all items in the "Checked-in items" list, even items that
5172 were not checked out.
5182 - When items that are not currently checked out are checked in they
5183 don't show on the list of checked in items. This preference allows
5184 you to choose how you'd like the log of checked in items displays.
5186 .. _specifyduedate-label:
5189 ''''''''''''''''''''''''''''''''''''
5193 Asks: \_\_\_ staff to specify a due date for a checkout.
5195 Due dates are calculated using your circulation and fines rules, but
5196 staff can override that if you allow them to specify a due date at
5201 - This preference allows for circulation staff to change a due date
5202 from the automatic due date to another calendar date. This option
5203 would be used for circumstances in which the due date may need to be
5204 decreased or extended in a specific circumstance. The "Allow" setting
5205 would allow for this option to be utilized by staff, the "Don't
5206 allow" setting would bar staff from changing the due date on
5213 Specify Due Date Box Shows
5218 Specify Due Date Box Doesn't Show
5221 .. _specifyreturndate-label:
5224 ''''''''''''''''''''''''''''''''''''''''''
5226 Default: Don't allow
5228 Asks: \_\_\_ staff to specify a return date for a check in.
5232 - AllowAllow return date edits
5234 - Don't allowDon't allow return date edits
5238 - This preference lets you decide if staff can specify an arbitrary
5239 return date when checking in items. If an arbitrary return date is
5240 specified then fines are recalculated accordingly.
5242 .. _todaysissuesdefaultsortorder-label:
5244 todaysIssuesDefaultSortOrder
5245 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5247 Default: latest to earliest
5249 Asks: Sort today's checkouts on the circulation page from \_\_\_ due
5254 - earliest to latest
5256 - latest to earliest
5258 .. _updatetotalissuesoncirc-label:
5260 UpdateTotalIssuesOnCirc
5261 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
5265 Asks: \_\_\_ update a bibliographic record's total issues count whenever
5274 This increases server load significantly; if performance is a
5275 concern, use the :ref:`cron job <track-total-checkouts-label>` to update the
5276 total issues count instead.
5282 - Koha can track the number of times and item is checked out and store
5283 that on the item record in the database. This information is not
5284 stored by default. Setting this preference to 'Do' will tell Koha to
5285 track that info everytime the item is checked out in real time.
5286 Otherwise you could use the :ref:`cron job <track-total-checkouts-label>` to have
5287 Koha update that field nightly.
5289 .. _waitingnotifyatcheckin-label:
5291 WaitingNotifyAtCheckin
5292 ''''''''''''''''''''''''''''''''''''''''''''''''''''
5294 Default: Don't notify
5296 Asks: \_\_\_ librarians of waiting holds for the patron whose items they
5305 Notification that a hold is waiting
5310 - When checking in books you can choose whether or not to have a notice
5311 pop up if the patron who returned the book has a hold waiting for
5312 pick up. If you choose 'Notify' for WaitingNotifyAtCheckin then every
5313 time a hold is found for the patron who had the book out last a
5314 message will appear on your check in screen.
5316 .. _self-checkout-label:
5319 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5321 .. _allowselfcheckreturns-label:
5323 AllowSelfCheckReturns
5324 ''''''''''''''''''''''''''''''''''''''''''''''''''
5326 Default: Don't allow
5328 Asks: \_\_\_ patrons to return items through web-based self checkout
5339 - This preference is used to determine if you want patrons to be
5340 allowed to return items through your self check machines. By default
5341 Koha's self check interface is simply for checking items out.
5343 .. _autoselfcheckallowed,-autoselfcheckid-&-autoselfcheckpass-label:
5345 AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass
5346 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5350 Most libraries will want to leave this set to 'Don't allow.' This
5351 preference turns off the requirement to log into the self checkout
5352 machine with a staff username and password by storing the username
5353 and password for automatic login.
5355 AutoSelfCheckAllowed Default: Don't allow
5357 Asks: \_\_\_ the web-based self checkout system to automatically login
5358 with this staff login \_\_\_ and this password \_\_\_ .
5360 AutoSelfCheckAllowed Values:
5366 AutoSelfCheckID Value:
5368 - The username of a staff patron with 'circulate'
5369 :ref:`permissions <patron-permissions-label>`.
5371 AutoSelfCheckPass Value:
5373 - The password of a staff patron with 'circulate'
5374 :ref:`permissions <patron-permissions-label>`.
5376 .. _scousercss-label:
5379 ''''''''''''''''''''''''''''
5381 Asks: Include the following CSS on all pages in the web-based self
5386 - The CSS entered in this preference will be used on all of your Koha
5387 self checkout screens.
5389 .. _scouserjs-label:
5392 ''''''''''''''''''''''''''
5394 Asks: Include the following JavaScript on all pages in the web-based
5399 - The JavaScript entered in this preference will effect all of your
5400 Koha self checkout screens.
5402 .. _selfcheckhelpmessage-label:
5404 SelfCheckHelpMessage
5405 ''''''''''''''''''''''''''''''''''''''''''''''''
5407 Asks: Include the following HTML in the Help page of the web-based self
5412 - Clicking the 'Help' link in the top right of the self checkout
5413 interface opens up a three step process for using the self check
5414 interface. Adding HTML to this system preference will print that
5415 additional help text above what's already included.
5417 .. _selfcheckoutbylogin-label:
5420 ''''''''''''''''''''''''''''''''''''''''''''''
5424 Asks: Have patrons login into the web-based self checkout system with
5431 Self Checkout Patron Card Number
5434 - Username and password
5436 Shelf checkout by login
5441 - This preference lets you decide how your patrons will log in to the
5442 self checkout machine. Barcode is the patron's card number and their
5443 username and password is set using the opac/staff username and
5444 password fields on the patron record.
5446 .. _selfcheckreceiptprompt-label:
5448 SelfCheckReceiptPrompt
5449 ''''''''''''''''''''''''''''''''''''''''''''''''''''
5453 Asks: \_\_\_ the print receipt popup dialog when self checkout is
5464 - This preference controls whether a prompt shows up on the web based
5465 self check out when the patron clicks the 'Finish' button.
5467 .. _selfchecktimeout-label:
5470 ''''''''''''''''''''''''''''''''''''''''
5474 Asks: Time out the current patron's web-based self checkout system login
5475 after \_\_\_ seconds.
5479 - After the machine is idle for the time entered in this preference the
5480 self check out system will log out the current patron and return to
5481 the starting screen.
5483 .. _showpatronimageinwebbasedselfcheck-label:
5485 ShowPatronImageInWebBasedSelfCheck
5486 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5490 Asks: \_\_\_ the patron's picture (if one has been added) when they use
5491 the web-based self checkout.
5499 .. _webbasedselfcheck-label:
5502 ''''''''''''''''''''''''''''''''''''''''''
5504 Default: Don't enable
5506 Asks: \_\_\_ the web-based self checkout system.
5514 Enabling this preference will allow access to the :ref:`self
5515 checkout <self-checkout-label>` module in Koha.
5517 .. _enhanced-content-label:
5520 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5522 *Get there:* More > Administration > Global System Preferences >
5527 Always read the terms of service associated with external data
5528 sources to be sure that you are using the products within the
5533 You cannot have more than one service for cover images (including
5534 local cover images) set up. If you set up more than one you will get
5535 multiple cover images. Instead choose only one source for cover
5541 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5543 .. _frbrizeeditions-label:
5546 ''''''''''''''''''''''''''''''''''''''
5550 Asks: \_\_\_ other editions of an item on the staff client
5558 Editions tab in staff client
5563 - Using the rules set forth in the Functional Requirements for
5564 Bibliographic records, this option, when enabled, pulls all editions
5565 of the same title available in your collection regardless of material
5566 type. Items will appear under an 'Editions' tab on the detail page
5567 for the title in question.. According to *Libraries Unlimited's
5568 Online Dictionary for Library and Information Science*
5569 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
5570 records of similar materials. FRBRization brings together entities
5571 (sets of Works, Expressions, or Manifestations), rather than just
5572 sets of Items. It can aid patrons in selecting related items,
5573 expressions, and manifestations that will serve their needs. When it
5574 is set to "Show", the OPAC will query one or more ISBN web services
5575 for associated ISBNs and display an Editions tab on the details
5576 pages. Once this preference is enabled, the library must select one
5577 of the ISBN options (:ref:`ThingISBN` and/or
5578 :ref:`XISBN`). This option is only for the Staff Client; the
5579 :ref:`OPACFRBRizeEditions` option must be enabled
5580 to have the Editions tab appear on the OPAC.
5584 Requires that you turn on one or more of the ISBN services
5585 (:ref:`ThingISBN` and/or :ref:`XISBN`)
5587 .. _opacfrbrizeeditions-label:
5590 ''''''''''''''''''''''''''''''''''''''''''''''
5594 Asks: \_\_\_ other editions of an item on the OPAC.
5598 - Using the rules set forth in the Functional Requirements for
5599 Bibliographic records, this option, when enabled, pulls all editions
5600 of the same title available in your collection regardless of material
5601 type. Items will appear under an 'Editions' tab on the detail page
5602 for the title in question.. According to *Libraries Unlimited's
5603 Online Dictionary for Library and Information Science*
5604 (http://lu.com/odlis/), FRBRizing the catalog involves collating MARC
5605 records of similar materials. FRBRization brings together entities
5606 (sets of Works, Expressions, or Manifestations), rather than just
5607 sets of Items. It can aid patrons in selecting related items,
5608 expressions, and manifestations that will serve their needs. When it
5609 is set to "Show", the OPAC will query one or more ISBN web services
5610 for associated ISBNs and display an Editions tab on the details
5611 pages. Once this preference is enabled, the library must select one
5612 of the ISBN options (:ref:`ThingISBN` and/or
5613 :ref:`XISBN`). This option is only for the OPAC; the
5614 :ref:`FRBRizeEditions` option must be turned "On" to
5615 have the Editions tab appear on the Staff Client.
5623 Editions tab in the OPAC
5626 This preference pulls all editions of the same title available in your
5627 collection regardless of material type. Items will appear under an
5628 'Editions' tab on the detail page for the title in question.
5632 Requires that you turn on one or more of the ISBN services
5633 (:ref:`ThingISBN` and/or :ref:`XISBN`)
5638 ^^^^^^^^^^^^^^^^^^^^^^^^^
5640 .. _amazonassoctag-label:
5643 ''''''''''''''''''''''''''''''''''''
5645 Asks: Put the associate tag \_\_\_ on links to Amazon.
5649 This can net your library referral fees if a patron decides to buy
5650 an item after clicking through to Amazon from your site.
5654 - An Amazon Associates Tag allows a library to earn a percentage of all
5655 purchases made on Amazon when a patron accesses Amazon's site via
5656 links on the library's website. More information about the Amazon
5657 Associates program is available at Amazon's Affiliate Program's
5658 website, https://affiliate-program.amazon.com/. Before a tag can be
5659 obtained, however, the library must first apply for an Amazon Web
5660 Services (AWS) account. Applications are free of charge and can be
5661 made at http://aws.amazon.com. Once an AWS account has been
5662 established, the library can then obtain the Amazon Associates Tag.
5664 Sign up at: https://affiliate-program.amazon.com/
5666 .. _amazoncoverimages-label:
5669 ''''''''''''''''''''''''''''''''''''''''''
5673 Asks: \_\_\_ cover images from Amazon on search results and item detail
5674 pages on the staff interface.
5684 - This preference makes it possible to either allow or prevent Amazon
5685 cover images from being displayed in the Staff Client. Cover images
5686 are retrieved by Amazon, which pulls the content based on the first
5687 ISBN number in the item's MARC record. Amazon offers this service
5688 free of charge. If the value for this preference is set to "Show",
5689 the cover images will appear in the Staff Client, and if it is set to
5690 "Don't show", the images will not appear. Finally, if you're using
5691 Amazon cover images, all other cover image services must be disabled.
5692 If they are not disabled, they will prevent AmazonCoverImages from
5693 functioning properly.
5695 .. _amazonlocale-label:
5698 ''''''''''''''''''''''''''''''''
5702 Asks: Use Amazon data from its \_\_\_ website.
5718 .. _opacamazoncoverimages-label:
5720 OPACAmazonCoverImages
5721 ''''''''''''''''''''''''''''''''''''''''''''''''''
5725 Asks: \_\_\_ cover images from Amazon on search results and item detail
5736 - This preference makes it possible to either allow or prevent Amazon
5737 cover images from being displayed in the OPAC. Cover images are
5738 retrieved by Amazon, which pulls the content based on the first ISBN
5739 number in the item's MARC record. Amazon offers this service free of
5740 charge. If the value for this preference is set to "Show", the cover
5741 images will appear in the OPAC, and if it is set to "Don't show", the
5742 images will not appear. Finally, if you're using Amazon cover images,
5743 all other cover image services must be disabled. If they are not
5744 disabled, they will prevent AmazonCoverImages from functioning
5747 .. _babelthã¨que-label:
5750 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5752 .. _babeltheque-label:
5755 ''''''''''''''''''''''''''''''
5759 Asks: \_\_\_ include information (such as reviews and citations) from
5760 Babelthèque in item detail pages on the OPAC.
5764 - This preference makes it possible to display a Babeltheque tab in the
5765 OPAC, allowing patrons to access tags, reviews, and additional title
5766 information provided by Babeltheque. The information which
5767 Babeltheque supplies is drawn from the French language-based
5768 `Babelio.com <http://www.babelio.com/>`__, a French service similar
5769 to LibraryThing for Libraries. More information about Babeltheque is
5770 available through its website,
5771 `http://www.babeltheque.com <http://www.babeltheque.com/>`__.
5772 Libraries that wish to allow access to this information must first
5773 register for the service at http://www.babeltheque.com. Please note
5774 that this information is only provided in French.
5780 Data from Babelthèque on the bib record
5785 .. _babeltheque\_url\_js-label:
5787 Babeltheque\_url\_js
5788 ''''''''''''''''''''''''''''''''''''''''''''''
5790 Asks: \_\_\_ Defined the url for the Babeltheque javascript file (eg.
5791 http://www.babeltheque.com/bw\_XX.js)
5793 .. _babeltheque\_url\_update-label:
5795 Babeltheque\_url\_update
5796 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
5798 Asks: \_\_\_ Defined the url for the Babeltheque update periodically
5799 (eq. http://www.babeltheque.com/.../file.csv.bz2).
5801 .. _baker-&-taylor-label:
5804 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5808 This is a pay service, you must contact Baker & Taylor to subscribe
5809 to this service before setting these options.
5811 .. _bakertaylorbookstoreurl-label:
5813 BakerTaylorBookstoreURL
5814 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
5816 Asks: Baker and Taylor "My Library Bookstore" links should be accessed
5817 at https:// \_\_\_ isbn
5821 - Some libraries generate additional funding for the library by selling
5822 books and other materials that are purchased from or have been
5823 previously leased from Baker & Taylor. These materials can be
5824 accessed via a link on the library's website. This service is often
5825 referred to as "My Library Bookstore." In order to participate in
5826 this program, the library must first register and pay for the service
5827 with Baker & Taylor. Additional information about this and other
5828 services provided by Baker & Taylor is available at the Baker &
5829 Taylor website, http://www.btol.com. The BakerTaylorBookstoreURL
5830 preference establishes the URL in order to link to the library's
5831 Baker & Taylor-backed online bookstore, if such a bookstore has been
5832 established. The default for this field is left blank; if no value is
5833 entered, the links to My Library Bookstore will remain inactive. If
5834 enabling this preference, enter the library's Hostname and Parent
5835 Number in the appropriate location within the URL. The "key" value
5836 (key=) should be appended to the URL, and https:// should be
5839 This should be filled in with something like
5840 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=
5844 Leave it blank to disable these links.
5848 Be sure to get this information from Baker & Taylor when
5851 .. _bakertaylorenabled-label:
5854 ''''''''''''''''''''''''''''''''''''''''''''
5858 Asks: \_\_\_ Baker and Taylor links and cover images to the OPAC and
5859 staff client. This requires that you have entered in a username and
5860 password (which can be seen in image links).
5870 - This preference makes it possible to display Baker & Taylor content
5871 (book reviews, descriptions, cover images, etc.) in both the Staff
5872 Client and the OPAC. Libraries that wish to display Baker & Taylor
5873 content must first register and pay for this service with Baker &
5874 Taylor (http://www.btol.com). If Baker & Taylor content is enabled be
5875 sure to turn off other cover and review services to prevent
5880 To use this you will need to also set the :ref:`BakerTaylorUsername &
5881 BakerTaylorPassword <bakertaylorusername-&-bakertaylorpassword-label>` system preferences
5883 .. _bakertaylorusername-&-bakertaylorpassword-label:
5885 BakerTaylorUsername & BakerTaylorPassword
5886 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
5888 Asks: Access Baker and Taylor using username \_\_\_ and password \_\_\_
5892 - This setting in only applicable if the library has a paid
5893 subscription to the external Content Café service from Baker &
5894 Taylor. Use the box provided to enter in the library's Content Café
5895 username and password. Also, ensure that the
5896 :ref:`BakerTaylorBookstoreURL` and
5897 :ref:`BakerTaylorEnabled` settings are properly
5898 set. The Content Café service is a feed of enhanced content such as
5899 cover art, professional reviews, and summaries that is displayed
5900 along with Staff Client/OPAC search results. For more information on
5901 this service please see the Baker & Taylor website:
5906 Be sure to get this information from Baker & Taylor when
5909 .. _coce-cover-images-cache-label:
5911 Coce Cover images cache
5912 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5914 Coce is a remote image URL cache. With this option, cover images are not
5915 fetched directly from Amazon, Google, and so on. Their URLs are
5916 requested via a web service to Coce which manages a cache of URLs.
5923 Default: Don't enable
5925 Asks: \_\_\_ a Coce image cache service.
5935 - Coce has many benefits when it comes to choosing and displaying cover
5938 - If a book cover is not available from a provider, but is available
5939 from another one, Koha will be able to display a book cover, which
5942 - Since URLs are cached, it isn't necessary for each book cover to
5943 request, again and again, the provider, and several of them if
5946 - Amazon book covers are retrieved with Amazon Product Advertising
5947 API, which means that more covers are retrieved (ISBN13).
5951 Coce does not come bundled with Koha. Your Koha install will not
5952 already have a Coce server set up. Before enabling this
5953 functionality you will want to be sure to have a Coce server set
5954 up. Instructions on installing and setting up Coce can be found
5955 on the official github page at https://github.com/fredericd/coce.
5960 ''''''''''''''''''''''''
5962 Asks: Coce server URL \_\_\_
5966 - This will be the full URL (starting with http://) to your Coce
5969 .. _coceproviders-label:
5972 ''''''''''''''''''''''''''''''''''
5974 Asks: Use the following providers to fetch the covers \_\_\_
5980 - Amazon Web Services
5988 - The providers chosen here will be used to gather cover images for
5989 display in your Koha catalog.
5994 ^^^^^^^^^^^^^^^^^^^^^^^^^
5996 .. _googlejackets-label:
5999 ''''''''''''''''''''''''''''''''''
6003 Asks: \_\_\_ cover images from Google Books to search results and item
6004 detail pages on the OPAC.
6014 - This setting controls the display of applicable cover art from the
6015 free Google Books database, via the Google Books API. Please note
6016 that to use this feature, all other cover services should be turned
6019 .. _html5-media-label:
6022 ^^^^^^^^^^^^^^^^^^^^^^^^
6024 .. _html5mediaenabled-label:
6027 ''''''''''''''''''''''''''''''''''''''''''
6031 Asks: Show a tab with a HTML5 media player for files catalogued in field
6036 - in OPAC and staff client
6040 HTML5 Media in the OPAC
6043 - in the staff client
6045 HTML5 Media in the staff client
6052 - If you have media elements in the 856 of your MARC record this
6053 preference can run/show those media files in a separate tab using
6056 .. _html5mediaextensions-label:
6058 HTML5MediaExtensions
6059 ''''''''''''''''''''''''''''''''''''''''''''''''
6061 Default: webm\|ogg\|ogv\|oga\|vtt
6063 Asks: Media file extensions \_\_\_
6067 - Enter in file extensions separated with bar (\|)
6069 .. _html5mediayoutube-label:
6072 ''''''''''''''''''''''''''''''''''''''''''
6074 Default: Don't embed
6078 To turn this on first enable
6079 :ref:`HTML5MediaEnabled`
6081 Asks: \_\_\_ YouTube links as videos.
6091 - This preference will allow MARC21 856$u that points to YouTube to
6092 appear as a playable video on the pages defined in
6093 :ref:`HTML5MediaEnabled`.
6095 .. _idreamlibraries-label:
6098 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6100 `IDreamBooks.com <http://idreambooks.com/>`__ aggregates book reviews by
6101 critics to help you discover the very best of what's coming out each
6102 week. These preferences let you integrated content from
6103 `IDreamBooks.com <http://IDreamBooks.com>`__ in to your Koha OPAC.
6107 This is a new website and has limited content, so you may only see
6108 these features on new popular titles until the database grows some
6111 .. _idreambooksreadometer-label:
6113 IDreamBooksReadometer
6114 ''''''''''''''''''''''''''''''''''''''''''''''''''
6118 Asks: \_\_\_ a "Readometer" that summarizes the reviews gathered by
6119 IDreamBooks.com to the OPAC details page.
6125 Readometer on the details page
6130 .. _idreambooksresults-label:
6133 ''''''''''''''''''''''''''''''''''''''''''''
6137 Asks: \_\_\_ the rating from IDreamBooks.com to OPAC search results.
6143 iDreamBooks rating on search results
6148 .. _idreambooksreviews-label:
6151 ''''''''''''''''''''''''''''''''''''''''''''
6155 Asks: \_\_\_ a tab on the OPAC details with book reviews from critics
6156 aggregated by IDreamBooks.com.
6162 Reviews tab on the detail page
6167 .. _librarything-label:
6170 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6172 LibraryThing for Libraries is a pay service. You must first contact
6173 LibraryThing directly for pricing and subscription information. Learn
6174 more at http://www.librarything.com/forlibraries. Also, for further
6175 configuration instructions please see the LibraryThing Wiki:
6176 http://www.librarything.com/wiki/index.php/Koha
6178 .. _librarythingforlibrariesenabled-label:
6180 LibraryThingForLibrariesEnabled
6181 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6185 Asks: \_\_\_ reviews, similar items, and tags from Library Thing for
6186 Libraries on item detail pages on the OPAC.
6196 - This setting is only applicable if the library has a paid
6197 subscription to the external LibraryThing for Libraries service. This
6198 service can provide patrons with the display of expanded information
6199 on catalog items such as book recommendations. It also can offer
6200 advanced features like tagged browsing, patron written reviews, and a
6201 virtual library display accessed from the details tab.
6205 If this is set to 'show' you will need to enter a value in the
6206 ':ref:`LibraryThingForLibrariesID`'
6209 .. _librarythingforlibrariesid-label:
6211 LibraryThingForLibrariesID
6212 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6214 Asks: Access Library Thing for Libraries using the customer ID \_\_\_
6218 - This setting is only applicable if the library has a paid
6219 subscription to the external LibraryThing for Libraries service. Use
6220 the box provided to enter in the library's LibraryThing for Libraries
6221 ID as provided to the library by LibraryThing. The ID number is a
6222 series of numbers in the form ###-#########, and can be found on the
6223 library's account page at LibraryThing for Libraries. This service
6224 can provide patrons with the display of expanded information on
6225 catalog items such as book recommendations and cover art. It also can
6226 offer advanced features like tagged browsing, patron written reviews,
6227 and a virtual library display accessed from the details tab.
6229 .. _librarythingforlibrariestabbedview-label:
6231 LibraryThingForLibrariesTabbedView
6232 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6234 Default: in line with bibliographic information
6236 Asks: Show Library Thing for Libraries content \_\_\_
6240 - in line with bibliographic information
6246 - This setting is only applicable if the library has a paid
6247 subscription to the external LibraryThing for Libraries service. This
6248 service can provide patrons with the display of expanded information
6249 on catalog items such as book recommendations and cover art. It also
6250 can offer advanced features like tagged browsing, patron written
6251 reviews, and a virtual library display accessed from the details tab.
6253 .. _thingisbn-label:
6256 ''''''''''''''''''''''''''
6260 Asks: \_\_\_ the ThingISBN service to show other editions of a title
6270 - Set to 'Use' to display an "Editions" tab on the item's detail page.
6271 Editions are listed, complete with cover art (if you have one of the
6272 cover services enabled) and bibliographic information. The feed comes
6273 from LibraryThing's ThingISBN web service. This is a free service to
6274 non-commercial sites with fewer than 1,000 requests per day.
6278 Requires :ref:`FRBRizeEditions` and/or
6279 :ref:`OPACFRBRizeEditions` set to 'show'
6283 This is separate from Library Thing for Libraries and does not have
6284 a cost associated with it.
6286 .. _local-cover-images-label:
6289 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6291 .. _allowmultiplecovers-label:
6294 ''''''''''''''''''''''''''''''''''''''''''''''
6296 Default: Don't allow
6298 Asks: \_\_\_ multiple images to be attached to each bibliographic
6309 - If this preference is set to 'Allow' then you can upload multiple
6310 images that will appear in the images tab on the bib record in the
6311 OPAC and the staff client. This preference requires that either one
6312 or both :ref:`LocalCoverImages` and
6313 :ref:`OPACLocalCoverImages` are set to
6316 Multiple cover images
6319 .. _localcoverimages-label:
6322 ''''''''''''''''''''''''''''''''''''''''
6324 Default: Don't display
6326 Asks: \_\_\_ local cover images on intranet search and details pages.
6336 - Setting this preference to 'Display' allows you to upload your own
6337 cover images to bib records and display them on the detail page in
6338 the staff client. At this time the cover will only show under the
6339 'Images' tab on the holdings table on the detail display, not next to
6340 the title at the top left or on the search results.
6342 .. _opaclocalcoverimages-label:
6344 OPACLocalCoverImages
6345 ''''''''''''''''''''''''''''''''''''''''''''''''
6347 Default: Don't display
6349 Asks: \_\_\_ local cover images on OPAC search and details pages.
6359 - Setting this preference to 'Display' allows you to upload your own
6360 cover images to bib records and display them on the detail page and
6361 search results in the OPAC.
6363 .. _novelist-select-label:
6366 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6368 Novelist Select is not a free service. Contact your Ebsco representative
6369 to get your log in information to embed this content in the OPAC.
6373 Novelist Select does not include cover images for the search results
6374 and bibliographic detail pages. You can choose any other cover image
6375 service for this content or you can contract with Ebsco to get
6376 access to the :ref:`Baker & Taylor Content Cafe <baker-&-taylor-label>` for
6379 .. _novelistselectenabled-label:
6381 NovelistSelectEnabled
6382 ''''''''''''''''''''''''''''''''''''''''''''''''''
6386 Asks: \_\_\_ Novelist Select content to the OPAC.
6396 Enabling this requires that you have entered in a user profile and
6397 password in the :ref:`NovelistSelectProfile &
6398 NovelistSelectPassword <novelistselectprofile-&-novelistselectpassword-label>` preferences
6402 - Novelist Select from Ebsco is a subscription service that can provide
6403 additional content in the OPAC.
6405 .. _novelistselectprofile-&-novelistselectpassword-label:
6407 NovelistSelectProfile & NovelistSelectPassword
6408 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6410 Asks: Access Novelist Select using user profile \_\_\_ and password
6415 This information will be visible if someone views the source code on
6420 - Novelist Select from Ebsco is a subscription service that can provide
6421 additional content in the OPAC.
6423 .. _novelistselectstaffenabled-label:
6425 NovelistSelectStaffEnabled
6426 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6430 Asks: \_\_\_ Novelist Select content to the Staff client (requires that
6431 you have entered in a user profile and password, which can be seen in
6440 .. _novelistselectstaffview-label:
6442 NovelistSelectStaffView
6443 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
6447 Asks: Display Novelist Select staff content \_\_\_.
6451 - above the holdings table
6453 - below the holdings table
6457 .. _novelistselectview-label:
6460 ''''''''''''''''''''''''''''''''''''''''''''
6462 Default: in an OPAC tab
6464 Asks: Display Novelist Select content \_\_\_
6468 - Novelist Select provides a lot of content, for that reason you have
6469 four choices of where to display this content. The default view is in
6470 a tab in the holdings table.
6472 Novelist Select in a tab
6475 The content is the same if you choose to show it above the holdings
6476 table or below it. If shown in the right column of the page it's the
6477 same content, but displays a bit differently since space is limited.
6479 Novelist Select on the side
6484 - above the holdings table
6486 - below the holdings table
6490 - under the Save Record dropdown on the right
6495 ^^^^^^^^^^^^^^^^^^^^^
6497 .. _oclcaffiliateid-label:
6500 ''''''''''''''''''''''''''''''''''''''
6502 Asks: Use the OCLC affiliate ID \_\_\_ to access the xISBN service.
6506 - This setting is only applicable if the library has an OCLC Affiliate
6507 ID. This allows WorldCat searching in the OPAC via the XISBN
6508 programming interface. Simply enter the library's OCLC Affiliate ID
6509 in the box provided. Please note that using this data is only
6510 necessary if :ref:`FRBRizeEditions` and/or
6511 :ref:`OPACFRBRizeEditions` and :ref:`XISBN`
6512 settings are enabled. For more information on this service please
6513 visit the OCLC website:
6514 http://www.worldcat.org/affiliate/default.jsp.
6518 Unless you have signed up for an ID with OCLC, you are limited to
6519 1000 requests per day. Available at:
6520 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
6529 Asks: \_\_\_ the OCLC xISBN service to show other editions of a title
6533 - Set to 'Use' to display an "Editions" tab on the item's detail page.
6534 Editions are listed, complete with cover art and bibliographic
6535 information. The feed comes from OCLC's xISBN web service. The feed
6536 limit for non-commercial sites is 1000 requests per day.
6546 Requires :ref:`FRBRizeEditions` and/or
6547 :ref:`OPACFRBRizeEditions` set to 'show'
6549 .. _xisbndailylimit-label:
6552 ''''''''''''''''''''''''''''''''''''''
6556 Asks: Only use the xISBN service \_\_\_ times a day.
6560 Unless you have signed up for an ID with OCLC, you are limited to
6561 1000 requests per day. Available at:
6562 http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
6564 .. _open-library-label:
6567 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6569 .. _openlibrarycovers-label:
6572 ''''''''''''''''''''''''''''''''''''''''''
6576 Asks: \_\_\_ cover images from Open Library to search results and item
6577 detail pages on the OPAC.
6587 - This setting controls the display of applicable cover art from the
6588 free Open Library database, via the Open Library API. Please note
6589 that to use this feature, all other cover services should be turned
6592 .. _openlibrarysearch-label:
6595 ''''''''''''''''''''''''''''''''''''''''''
6599 Asks: \_\_\_ search results from Open Library on the OPAC.
6605 - ShowOpen Library results
6607 .. _overdrive-label:
6610 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6612 OverDrive is an pay service. You must first contact OverDrive directly
6613 for pricing and subscription information. Enabling this service will
6614 integrate Overdrive results in to your OPAC searches. You will have to
6615 apply for these 3 pieces of information through an application as an API
6616 developer. Overdrive API applications are evaluated once a week so you
6617 may not be able to use this feature immediately after signing up. To
6618 learn more please contact your OverDrive representative.
6623 .. _overdrivecirculation-label:
6625 OverDriveCirculation
6626 ''''''''''''''''''''''''''''''''''''''''''''''''
6628 Default: Don't enable
6630 Asks: \_\_\_ users to access their OverDrive circulation history, and circulate
6631 items. If you enable access, you must register auth return url of
6632 http(s)://my.opac.hostname/cgi-bin/koha/external/overdrive/auth.pl with OverDrive.
6640 .. _overdriveclientkey-and-overdriveclientsecret-label:
6642 OverDriveClientKey and OverDriveClientSecret
6643 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6645 Asks: Include OverDrive availability information with the client key
6646 \_\_ and client secret \_\_\_
6650 - OverDrive customers can get this information by visiting the
6651 `OverDrive Developer
6652 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
6653 following the instructions found there to apply as an API developer.
6654 Once this data and the :ref:`OverDriveLibraryID`
6655 are populated you will see OverDrive results on your OPAC searches.
6657 .. _overdrivelibraryid-label:
6660 ''''''''''''''''''''''''''''''''''''''''''''
6662 Asks: Show items from the OverDrive catalog of library # \_\_\_
6666 - OverDrive customers can get this information by visiting the
6667 `OverDrive Developer
6668 Portal <https://developer.overdrive.com/docs/getting-started>`__ and
6669 following the instructions found there to apply as an API developer.
6670 Once this data and the :ref:`OverDriveClientKey and
6671 OverDriveClientSecret <overdriveclientkey-and-overdriveclientsecret-label>` are populated you will
6672 see OverDrive results on your OPAC searches.
6677 ^^^^^^^^^^^^^^^^^^^^^^^^^^
6679 .. _usekohaplugins-label:
6682 ''''''''''''''''''''''''''''''''''''
6684 Default: Don't enable
6686 Asks: \_\_\_ the ability to use Koha Plugins.
6696 The plugin system must also be enabled in the Koha configuration
6697 file to be fully enabled. Learn more in the `Plugins
6698 chapter <#pluginsystem>`__.
6700 .. _syndetics-label:
6703 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6705 Syndetics is a pay service. You must first contact Syndetics directly
6706 for pricing and subscription information.
6708 .. _syndeticsauthornotes-label:
6710 SyndeticsAuthorNotes
6711 ''''''''''''''''''''''''''''''''''''''''''''''''
6715 Asks: \_\_\_ notes about the author of a title from Syndetics on item
6716 detail pages on the OPAC.
6726 - When this option is set to "Show", Syndetics provides notes and short
6727 author biographies for more that 300,000 authors, in both fiction and
6728 nonfiction. With this option enabled the library can display
6729 Syndetics Author Notes on the OPAC. According to the Syndetics
6730 Solutions website (http://www.bowker.com/syndetics/), Author Notes
6731 include lists of contributors for many multi-author texts and
6732 compilations. The :ref:`SyndeticsClientCode` must
6733 be entered and the :ref:`SyndeticsEnabled` option
6734 must be activated before this service can be used.
6736 .. _syndeticsawards-label:
6739 ''''''''''''''''''''''''''''''''''''''
6743 Asks: \_\_\_ information from Syndetics about the awards a title has won
6744 on item detail pages on the OPAC.
6754 - When this option is set to "Show", Syndetics provides its clients
6755 with a list of awards that any title has won. With this service
6756 enabled the library can display those awards for each book on its
6757 website. For each book or item that comes up during a user search,
6758 the list of awards for that title will be displayed. When a user
6759 clicks on a given award, information about that award is presented
6760 along with a list of the other titles that have won that award. If
6761 the user clicks on any title in the list, they will see holdings
6762 information about that title in their region. This option is a paid
6763 subscription service. The
6764 :ref:`SyndeticsClientCode` must be entered and
6765 the :ref:`SyndeticsEnabled` option must be activated
6766 before this service can be used.
6768 .. _syndeticsclientcode-label:
6771 ''''''''''''''''''''''''''''''''''''''''''''''
6773 Asks: Use the client code \_\_\_ to access Syndetics.
6777 - Once the library signs up for Syndetics' services, Syndetics will
6778 provide the library with an access code. (Visit the Syndetics
6779 homepage at http://www.bowker.com/syndetics/ for more information.)
6780 This is the code that must be entered to access Syndetics'
6781 subscription services. Syndetics is a paid subscription service. This
6782 value must be entered before
6783 :ref:`SyndeticsEditions` can be enabled. If the
6784 code is lost, corrupted, or forgotten, a new one can be obtained from
6785 http://www.bowker.com/syndetics/.
6789 You will need to get your client code directly from Syndetics.
6791 .. _syndeticscoverimages-&-syndeticscoverimagesize-label:
6793 SyndeticsCoverImages & SyndeticsCoverImageSize
6794 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
6796 SyndeticsCoverImages Default: Don't show
6798 SyndeticsCoverImageSize Default: medium
6800 Asks: \_\_\_ cover images from Syndetics on search results and item
6801 detail pages on the OPAC in a \_\_\_ size.
6805 - When enabled, SyndeticsCoverImages, allows libraries to display
6806 Syndetics' collection of full-color cover images for books, videos,
6807 DVDs and CDs on their OPAC. For each book or item that comes up
6808 during a user search, the cover image for that title will be
6809 displayed. Since these cover images come in three sizes, the optimum
6810 size must be selected using the SyndeticsCoverImageSize preference
6811 after SyndeticsCoverImages are enabled. Syndetics cover images come
6812 in two sizes: mid-size (187 x 187 pixels), and large (400 x 400
6813 pixels). Syndetics is a paid subscription service. The
6814 :ref:`SyndeticsClientCode` must be entered and
6815 the :ref:`SyndeticsEnabled` option must be activated
6816 before this service can be used. Other cover image preferences should
6817 also be disabled to avoid interference.
6819 SyndeticsCoverImages Values:
6825 SyndeticsCoverImageSize Values:
6831 .. _syndeticseditions-label:
6834 ''''''''''''''''''''''''''''''''''''''''''
6838 Asks: \_\_\_ information about other editions of a title from Syndetics
6839 on item detail pages on the OPAC
6843 - When enabled this option shows information on other editions of a
6844 title from Syndetics on the item detail pages of the OPAC. Syndetics
6845 is a paid subscription service. The
6846 :ref:`SyndeticsClientCode` must be entered and
6847 the :ref:`SyndeticsEnabled` option must be activated
6848 before this service can be used.
6858 Requires :ref:`OPACFRBRizeEditions` set to
6861 .. _syndeticsenabled-label:
6864 ''''''''''''''''''''''''''''''''''''''''
6868 Asks: \_\_\_ content from Syndetics.
6878 - When this option is enabled any of the Syndetics options can be used.
6882 Requires that you enter your
6883 :ref:`SyndeticsClientCode` before this content
6886 .. _syndeticsexcerpt-label:
6889 ''''''''''''''''''''''''''''''''''''''''
6893 Asks: \_\_\_ excerpts from of a title from Syndetics on item detail
6904 - This preference allows Syndetics to display excerpts given to them
6905 from selected publishers. The excerpts are available from prominently
6906 reviewed new titles, both fiction and non-fiction. The excerpts
6907 include poems, essays, recipes, forwards and prefaces. Automatic
6908 links provided by the ISBNs within local MARC records are required to
6909 integrate Syndetics secured, high-speed Internet servers to the
6910 library OPACs. For more information see
6911 (http://www.bowker.com/syndetics/).
6913 .. _syndeticsreviews-label:
6916 ''''''''''''''''''''''''''''''''''''''''
6920 Asks: \_\_\_ reviews of a title from Syndetics on item detail pages on
6931 - Syndetics Reviews is an accumulation of book reviews available from a
6932 variety of journals and serials. The reviews page displays colored
6933 images of reviewed books dust jackets, partnered with the names of
6934 the journal or serial providing the review. Clicking on an icon opens
6935 a window revealing the book title, author's name, book cover icon and
6936 the critic's opinion of the book. Automatic links provided by the
6937 ISBNs within local MARC records are required to integrate Syndetics
6938 secured, high-speed Internet servers to the library OPACs. For more
6939 information see (http://www.bowker.com/syndetics/).
6941 .. _syndeticsseries-label:
6944 ''''''''''''''''''''''''''''''''''''''
6948 Asks: \_\_\_ information on other books in a title's series from
6949 Syndetics on item detail pages on the OPAC.
6959 - Each fiction title within a series is linked to the complete series
6960 record. The record displays each title in reading order and also
6961 displays the publication order, if different. Alternate series titles
6962 are also displayed. Automatic links provided by the ISBNs within
6963 local MARC records are required to integrate Syndetics secured, high-
6964 speed Internet servers to the library OPACs. For more information see
6965 (http://www.bowker.com/syndetics/).
6967 .. _syndeticssummary-label:
6970 ''''''''''''''''''''''''''''''''''''''''
6974 Asks: \_\_\_ a summary of a title from Syndetics on item detail pages on
6985 - Providing more than 5.6 million summaries and annotations derived
6986 from book jackets, edited publisher copy, or independently written
6987 annotations from Book News, Inc. Covering fiction and non-fiction,
6988 this summaries option provides annotations on both trade and
6989 scholarly titles. For more information see
6990 (http://www.bowker.com/syndetics/).
6992 .. _syndeticstoc-label:
6995 ''''''''''''''''''''''''''''''''
6999 Asks: \_\_\_ the table of contents of a title from Syndetics on item
7000 detail pages on the OPAC.
7010 - This preference allows staff and patrons to review the Table of
7011 Contents from a wide variety of publications from popular self-help
7012 books to conference proceedings. Specific Information access is the
7013 main purpose for this option, allowing patrons guidance to their
7014 preferred section of the book. Special arrangements with selected
7015 book services is used to obtain the table of contents for new
7016 publications each year. Automatic links provided by the ISBNs within
7017 local MARC records are required to integrate Syndetics secured,
7018 high-speed Internet servers to the library OPACs. For more
7019 information see (http://www.bowker.com/syndetics/).
7024 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
7026 .. _tagsenabled-label:
7029 ''''''''''''''''''''''''''''''
7033 Asks: \_\_\_ patrons and staff to put tags on items.
7043 - Set to 'Allow' enable tagging. A tag is metadata, a word added to
7044 identify an item. Tags allow patrons to classify materials on their
7045 own. TagsEnabled is the main switch that permits the tagging
7046 features. TagsEnable must be set to 'Allow' to allow for other
7049 .. _tagsexternaldictionary-label:
7051 TagsExternalDictionary
7052 ''''''''''''''''''''''''''''''''''''''''''''''''''''
7054 Asks: Allow tags in the dictionary of the ispell executable \_\_\_ on
7055 the server to be approved without moderation.
7059 - The dictionary includes a list of accepted and rejected tags. The
7060 accepted list includes all the tags that have been pre-allowed. The
7061 rejected list includes tags that are not allowed. This preference
7062 identifies the "accepted" dictionary used. Ispell is an open source
7063 dictionary which can be used as a list of accepted terms. Since the
7064 dictionary allows for accurately spelled obscenities, the libraries
7065 policy may dictate that modifications are made to the Ispell
7066 dictionary if this preference is use. For more information about
7067 Ispell http://www.gnu.org/software/ispell/ispell.html. Enter the path
7068 on your server to a local ispell executable, used to set
7069 $Lingua::Ispell::path.
7071 .. _tagsinputondetail-label:
7074 ''''''''''''''''''''''''''''''''''''''''''
7078 Asks: \_\_\_ patrons to input tags on item detail pages on the OPAC.
7089 .. _tagsinputonlist-label:
7092 ''''''''''''''''''''''''''''''''''''''
7096 Asks: \_\_\_ patrons to input tags on search results on the OPAC.
7102 Tags on Search Results
7107 .. _tagsmoderation-label:
7110 ''''''''''''''''''''''''''''''''''''
7112 Default: Don't require
7114 Asks: \_\_\_ that tags submitted by patrons be reviewed by a staff
7115 member before being shown.
7125 - When set to 'Require,' all tags to be first filtered by the tag
7126 moderator. Only approved tags will be visible to patrons. When set to
7127 'Don't require' tags will bypass the tag moderator and patrons' tags
7128 to be immediately visible. When this preference is enabled the
7129 moderator, a staff member, would approve the tag in the Staff Client.
7130 The moderator will have the option to approve or reject each pending
7133 When moderation is required all tags go through the tag moderation tool
7134 before becoming visible.
7136 - *Get there:* More > Tools > :ref:`Tags <tag-moderation-label>`
7138 .. _tagsshowondetail-label:
7141 ''''''''''''''''''''''''''''''''''''''''
7145 Asks: Show \_\_\_ tags on item detail pages on the OPAC.
7149 Set the value to 0 (zero) to turn this feature off.
7151 .. _tagsshowonlist-label:
7154 ''''''''''''''''''''''''''''''''''''
7158 Asks: Show \_\_\_ tags on search results on the OPAC.
7162 Set the value to 0 (zero) to turn this feature off.
7164 .. _i18n/l10n-label:
7167 ~~~~~~~~~~~~~~~~~~~~~~~~~~
7169 These preferences control your Internationalization and Localization
7172 *Get there:* More > Administration > Global System Preferences >
7175 .. _addressformat-label:
7178 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7180 Default: US style ([Street number], [Address] - [City], [Zip/Postal
7183 Asks: Format postal addresses using \_\_\_
7187 - German style ([Address] [Street number] - [Zip/Postal Code] [City] -
7190 - French style ([Street number] [Address] - [ZIP/Postal Code] [City] -
7193 - US style ([Street number], [Address] - [City], [Zip/Postal Code],
7198 - This preference will let you control how Koha displays patron
7199 addresses given the information entered in the various fields on
7205 ^^^^^^^^^^^^^^^^^^^^^^^^
7207 Default: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
7209 Asks: Use the alphabet \_\_\_ for lists of browsable letters. This
7210 should be a space separated list of uppercase letters.
7214 - This preference allows you define your own alphabet for browsing
7217 Alphabet browse on patron module
7220 .. _calendarfirstdayofweek-label:
7222 CalendarFirstDayOfWeek
7223 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7227 Asks: Use \_\_\_ as the first day of week in the calendar.
7247 - Using this preference you can control what day shows as the first day
7248 of the week in the calendar pop ups throughout Koha and on the
7249 Calendar tool. If you change this preference and don't see a change
7250 in your browser try clearing your cache since it makes changes to the
7251 Javascript on these pages.
7253 .. _dateformat-label:
7256 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7260 Asks: Format dates like \_\_\_
7274 - This preference controls how the date is displayed. The options are
7275 the United States method, mm/dd/yyyy (04/24/2010), the metric method,
7276 dd/mm/yyyy (24/04/2010) or ISO, which is the International Standard
7277 of Organization, yyyy/mm/dd (2010/04/24). The International Standard
7278 of Organization would primarily be used by libraries with locations
7279 in multiple nations that may use different date formats, to have a
7280 single display type, or if the library would be in a region that does
7281 not use the United States or metric method. More information
7282 regarding the ISO date format can be found at
7283 http://www.iso.org/iso/iso_catalogue.htm.
7288 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7292 Asks: Enable the following languages on the staff interface
7298 To install additional languages please refer to
7299 http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client
7301 .. _opaclanguages-label:
7304 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7308 Asks: Enable the following languages on the OPAC
7316 To install additional languages you need to run
7317 misc/translation/install-code.pl. For example, to install French you
7318 would run the following command install-code.pl fr-FR to make the
7319 templates, once they exist and are in the right place then they will
7320 show up as an option in this preference.
7322 .. _opaclanguagesdisplay-label:
7324 opaclanguagesdisplay
7325 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7327 Default: Don't allow
7329 Asks: \_\_\_ patrons to select their language on the OPAC.
7335 - Patrons can choose their language from a list at the bottom of the
7338 Language selector in OPAC
7343 - The public catalog will not give an option to choose a language
7347 - Using the :ref:`OpacLangSelectorMode` preference
7348 you can decide where these language options will appear in the public
7351 .. _timeformat-label:
7354 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7356 Default: 24 hour format
7358 Asks: Format times in \_\_\_
7362 - 12 hour format (eg 02:18PM)
7364 - 24 hour format (eg 14:18)
7366 .. _translatenotices-label:
7369 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7371 Default: Don't allow
7373 Asks: \_\_\_ notices to be translated. If set, notices will be translatable from
7374 the "Notices and Slips" interface. The language used to send a notice to a patron
7375 will be the one defined for the patron.
7386 ~~~~~~~~~~~~~~~~~~~~~
7388 *Get there:* More > Administration > Global System Preferences > Labs
7390 The preferences in this section are for experimental features that need
7391 additional testing and debugging.
7393 .. _enableadvancedcatalogingeditor-label:
7395 EnableAdvancedCatalogingEditor
7396 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7398 Default: Don't enable
7400 Asks: \_\_\_ the advanced cataloging editor.
7404 - This preference will allow you to choose between a basic editor and a
7405 advanced editor for cataloging.
7409 This feature is currently experimental, and may have bugs that cause
7410 corruption of records. It also does not include any support for
7411 UNIMARC or NORMARC fixed fields. Please help us test it and report
7412 any bugs, but do so at your own risk.
7414 .. _local-use-label:
7417 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
7419 These preferences are defined locally.
7421 *Get there:* More > Administration > Global System Preferences > Local
7426 Sometimes preferences which are either new or outdated will appear
7427 in this tab, if you didn't add any preferences to this tab then it's
7428 best to ignore preferences listed here.
7430 .. _intradidyoumean-label:
7433 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7437 Asks: Did you mean? configuration for the Intranet. Do not change, as this is
7438 controlled by /cgi-bin/koha/admin/didyoumean.pl.
7440 .. _opacdidyoumean-label:
7443 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7447 Asks: Did you mean? configuration for the OPAC. Do not change, as this is
7448 controlled by /cgi-bin/koha/admin/didyoumean.pl.
7450 .. _printcirculationships-label:
7452 printcirculationships
7453 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7457 Asks: If ON, enable printing circulation receipts
7465 .. _usagestatsid-label:
7468 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7472 Asks: This preference is part of Koha but it should not be deleted or
7475 .. _usagestatslastupdatetime-label:
7477 UsageStatsLastUpdateTime
7478 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7482 Asks: This preference is part of Koha but it should not be deleted or
7485 .. _usagestatspublicid-label:
7488 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7492 Asks: Public ID for Hea website
7497 ^^^^^^^^^^^^^^^^^^^^^^
7499 Default: automatically generated
7501 Asks: The Koha database version. WARNING: Do not change this value
7502 manually. It is maintained by the webinstaller
7509 Logs keep track of transaction on the system. You can decide which
7510 actions you want to log and which you don't using these preferences.
7511 Logs can then be viewed in the :ref:`Log Viewer` under Tools.
7513 *Get there:* More > Administration > Global System Preferences > Logs
7515 .. _debugging-label:
7518 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7520 .. _dumptemplatevarsintranet-label:
7522 DumpTemplateVarsIntranet
7523 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7527 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
7528 source for the staff intranet.
7536 .. _dumptemplatevarsopac-label:
7538 DumpTemplateVarsOpac
7539 ''''''''''''''''''''''''''''''''''''''''''''''''
7543 Asks: \_\_\_ dump all Template Toolkit variable to a comment in the html
7544 source for the OPAC.
7555 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
7557 .. _authoritieslog-label:
7560 ''''''''''''''''''''''''''''''''''''
7564 Asks: \_\_\_ changes to authority records.
7572 .. _borrowerslog-label:
7575 ''''''''''''''''''''''''''''''''
7579 Asks: \_\_\_ changes to patron records.
7587 .. _cataloguinglog-label:
7590 ''''''''''''''''''''''''''''''''''''
7594 Asks: \_\_\_ any changes to bibliographic or item records.
7604 Since this occurs whenever a book is cataloged, edited, or checked
7605 in or out it can be very resource intensive - slowing down your
7608 .. _cronjoblog-label:
7611 ''''''''''''''''''''''''''''
7615 Asks: \_\_\_ information from cron jobs.
7626 ''''''''''''''''''''''''
7630 Asks: \_\_\_ when overdue fines are charged or automatically forgiven.
7641 ''''''''''''''''''''''''
7645 Asks: \_\_\_ any actions on holds (create, cancel, suspend, resume, etc.).
7656 ''''''''''''''''''''''''
7660 Asks: \_\_\_ when items are checked out.
7668 .. _letterlog-label:
7671 ''''''''''''''''''''''''''
7675 Asks: \_\_\_ when an automatic claim notice is sent.
7685 This log tracks all notices that go to patrons including the overdue
7688 .. _renewallog-label:
7691 ''''''''''''''''''''''''''''
7695 Asks: \_\_\_ when items are renewed.
7703 .. _reportslog-label:
7706 ''''''''''''''''''''''''''''
7710 Asks: \_\_\_ when reports are added, deleted or changed.
7718 .. _returnlog-label:
7721 ''''''''''''''''''''''''''
7725 Asks: \_\_\_ when items are returned.
7733 .. _subscriptionlog-label:
7736 ''''''''''''''''''''''''''''''''''''''
7740 Asks: \_\_\_ when serials are added, deleted or changed.
7751 ~~~~~~~~~~~~~~~~~~~~~
7753 *Get there:* More > Administration > Global System Preferences > OPAC
7755 .. _advanced-search-options-label:
7757 Advanced Search Options
7758 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7760 .. _opacadvsearchmoreoptions-label:
7762 OpacAdvSearchMoreOptions
7763 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7767 Asks: Show search options for the expanded view \_\_\_
7777 - Location and availability
7787 - The settings in this preference will determine which search fields
7788 will show when the patron is using the 'More options' mode on the
7789 advanced search page.
7791 .. _opacadvsearchoptions-label:
7793 OpacAdvSearchOptions
7794 ''''''''''''''''''''''''''''''''''''''''''''''''
7796 Default: Item types, Language, Location and availability, Publication
7799 Asks: Show search options \_\_\_
7809 - Location and availability
7819 - The settings in this preference will determine which search fields
7820 will show when the patron is using the 'Fewer options' mode on the
7821 advanced search page.
7823 .. _appearance-label:
7826 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7828 These preferences control how things appear in the OPAC.
7830 .. _authorisedvalueimages-label:
7832 AuthorisedValueImages
7833 ''''''''''''''''''''''''''''''''''''''''''''''''''
7837 Asks: \_\_\_ images for authorized values (such as lost statuses and
7838 locations) in search results and item detail pages on the OPAC.
7846 *Get there:* More > Administration > :ref:`Authorized
7847 Values <authorized-values-label>`
7849 .. _bibliodefaultview-label:
7852 ''''''''''''''''''''''''''''''''''''''''''
7854 Default: in simple form
7856 Asks: By default, show bib records \_\_\_
7860 - as specified in the ISBD template.
7862 - See :ref:`ISBD` preference for more information
7866 - in their MARC format.
7870 - This preference determines the level of bibliographic detail that the
7871 patron will see on the OPAC detail page. The simple form displays the
7872 graphical interface; MARC format displays the MARC21 cataloging view;
7873 ISBD displays the ISBD (International Standard Bibliographic
7874 Description, AACR2) view.
7876 .. _coinsinopacresults-label:
7879 ''''''''''''''''''''''''''''''''''''''''''''
7883 Asks: \_\_\_ COinS / OpenURL / Z39.88 in OPAC search results.
7889 - If you choose not to include COinS on the search results, it will
7890 still be loaded on the individual bibliographic records.
7894 - Enabling this feature will slow OPAC search response times.
7898 - COinS stands for ContextObjects in Spans. COinS is a method to embed
7899 bibliographic metadata in the HTML code of web pages. This allows
7900 bibliographic software to publish machine-readable bibliographic
7901 items and client reference management software (such as Zotero) to
7902 retrieve bibliographic metadata. The metadata can also be sent to an
7903 OpenURL resolver. This allows, for instance, searching for a copy of
7904 a book in one's own library.
7906 .. _displayopaciconsxslt-label:
7908 DisplayOPACiconsXSLT
7909 ''''''''''''''''''''''''''''''''''''''''''''''''
7913 Asks: On pages displayed with XSLT stylesheets on the OPAC, \_\_\_ icons
7914 for itemtype and authorized values.
7918 :ref:`OPACXSLTResultsDisplay` and/or
7919 :ref:`OPACXSLTDetailsDisplay` must be set to
7920 use an XSLT stylesheet for this to show (default or custom)
7928 DisplayOPACiconsXSLT
7933 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
7936 .. _googleindictransliteration-label:
7938 GoogleIndicTransliteration
7939 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7943 Asks: \_\_\_ GoogleIndicTransliteration on the OPAC.
7951 .. _hidelostitems-label:
7954 ''''''''''''''''''''''''''''''''''
7958 Asks: \_\_\_ lost items on search and detail pages.
7962 - Items that are marked lost by the library can either be shown or not
7963 shown on the OPAC. By setting the value to "Don't show," the lost
7964 item is not shown on the OPAC. By setting the value "Show," the lost
7965 item is shown on the OPAC for patrons to view with a status of
7974 Lost item showing in the OPAC
7977 .. _highlightownitemsonopac-&-highlightownitemsonopacwhich-label:
7979 HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich
7980 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7982 HighlightOwnItemsOnOPAC Default: Don't emphasize
7984 HighlightOwnItemsOnOPACWhich Default: patron's home library
7986 Asks: \_\_\_ results from the \_\_\_ by moving the results to the front
7987 and increasing the size or highlighting the rows for those results.
7989 HighlightOwnItemsOnOPAC Values:
7995 HighlightOwnItemsOnOPACWhich Values:
7997 - OPAC's branch based via the URL
7999 - The library is chosen based on the Apache environment variable
8000 BRANCHCODE. For example, this could be added to the OPAC section
8001 of koha-httpd.conf: SetEnv BRANCHCODE "CPL"
8003 - patron's home library
8005 - The items emphasized will be those of the same library as the
8006 patron's library. If no one is logged into the OPAC, no items will
8011 This preference will only effect sites that are not using an XSLT
8012 stylesheet. XSLT stylesheets are defined in the
8013 :ref:`OPACXSLTResultsDisplay` and
8014 :ref:`OPACXSLTDetailsDisplay` preferences.
8016 .. _libraryname-label:
8019 ''''''''''''''''''''''''''''''
8021 Asks: Show \_\_\_ as the name of the library on the OPAC.
8025 This value will appear in the title bar of the browser
8029 Edit ':ref:`opacheader`' if you'd like to add a library
8030 name above your search box on the OPAC
8032 Browser title and address bar
8035 .. _nologininstructions-label:
8038 ''''''''''''''''''''''''''''''''''''''''''''''
8040 Asks: Show the following HTML on the OPAC login form when a patron is
8045 - This preference allows you to override the default text seen on the
8046 log in page in the Koha OPAC. The default HTML is:
8050 <h5>Don't have a password yet?</h5>
8051 <p> If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
8052 <h5>Don't have a library card?</h5>
8053 <p> If you don't have a library card, stop by your local library to sign up.</p>
8055 Any HTML in this box will replace the above text below the log in
8056 box.No login instructions
8058 .. _opacadditionalstylesheet-label:
8060 OpacAdditionalStylesheet
8061 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8063 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
8064 settings from the default stylesheet.
8068 - The preference can look for stylesheets in the template directory for
8069 your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css.
8070 If you upload a custom file, opac-mystyles.css to this directory, you
8071 can specify it by entering opac-mystyles.css in your
8072 opaccolorstylesheet system preference. This adds your custom
8073 stylesheet as a linked stylesheet alongside the OPAC's default CSS
8074 files. This method is preferable because linked stylesheets are
8075 cached by the user's browser, meaning upon repeat visits to your site
8076 the user's browser will not have to re-download the stylesheet,
8077 instead using the copy in the browser's cache.
8079 - If you would rather, you can upload your CSS to another server and
8080 enter the full URL pointing to it's location remember to begin the
8085 Leave this field blank to disable it
8089 This file will add a linked CSS, not replace the existing default
8092 .. _opacaddmastheadlibrarypulldown-label:
8094 OpacAddMastheadLibraryPulldown
8095 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8099 Asks: \_\_\_ a library select pulldown menu on the OPAC masthead.
8105 Library select box on Koha OPAC
8110 No library select box on Koha OPAC
8113 .. _opacbaseurl-label:
8116 ''''''''''''''''''''''''''''''
8118 Asks: The OPAC is located at \_\_\_
8122 - This preference is looking for the URL of your public catalog (OPAC)
8123 with the http:// in front of it (enter http://www.mycatalog.com
8124 instead of www.mycatalog.com). Once it is filled in Koha will use it
8125 to generate permanent links in your RSS feeds, for your social
8126 network share buttons and in your staff client when generating links
8127 to bib records in the OPAC.
8131 Do not include a trailing slash in the URL this will break links
8132 created using this URL. (example: http://www.google.com not
8133 http://www.google.com/)
8137 This must be filled in with the URL of your public catalog for RSS,
8138 unAPI, and search plugins to work.
8142 This must be filled in with the URL of your public catalog to show
8143 'OPAC View' links from bib records in the staff client:
8145 With OPACBaseURL set, links to the OPAC will appear on each individual
8146 bib record in the staff client
8149 .. _opaccredits-label:
8152 ''''''''''''''''''''''''''''''
8154 Asks: Include the following HTML in the footer of all pages in the OPAC:
8158 Click the 'Click to edit; link to enter HTML to appear at the bottom
8159 of every page in the OPAC
8161 HTML version of a footer for your OPAC
8164 A sample of what can appear in your OPAC credits/footer
8169 - This setting is for credits that will appear at the bottom of your
8170 OPAC pages. Credits traditionally encompass copyright information,
8171 last date updated, hyperlinks or other information represented in an
8172 HTML format. This is static information and any updates must be
8175 Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
8177 .. _opaccustomsearch-label:
8180 ''''''''''''''''''''''''''''''''''''''''
8182 Asks: Replace the search box at the top of OPAC pages with the following
8187 - This preference allows you to replace the default search box at the
8188 top of the OPAC : Default search box
8190 with any HTML you would like :Edited search box area
8192 .. _opacdisplay856uasimage-label:
8194 OPACDisplay856uAsImage
8195 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8197 Default: Neither details or results page
8199 Asks: Display the URI in the 856u field as an image on: \_\_\_
8203 - Both results and details pages
8213 :ref:`OPACXSLTDetailsDisplay` needs to
8214 have a value in it for this preference to work.
8216 Showing the 856u as an image
8219 - Neither details or results page
8229 - In addition to this option being set, the corresponding XSLT option
8230 must be turned on. Also, the corresponding 856q field must have a
8231 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
8232 starting with "image/"), or the generic indicator "img" entered in
8233 the field. When all of the requirements are met, an image file will
8234 be displayed instead of the standard link text. Clicking on the image
8235 will open it in the same way as clicking on the link text. When you
8236 click on the image it should open to full size, in the current window
8237 or in a new window depending on the value in the system pref
8238 :ref:`OPACURLOpenInNewWindow`.
8240 Sample 856 in MARC Record
8243 .. _opacexportoptions-label:
8246 ''''''''''''''''''''''''''''''''''''''''''
8248 Default: Default OpacExportOptions options
8250 Asks: List export options that should be available from OPAC detail page
8255 - In the OPAC on the right of each bib record there is a menu that
8256 allows for saving the record in various formats. This patch will
8257 allow you to define which options are in the pull down menu.
8258 Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML
8259 (marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC
8260 (utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9-
8261 fields and subfields (marcstd), MODS (mods), and RIS (ris).
8263 .. _opacfallback-label:
8266 ''''''''''''''''''''''''''''''''
8270 Asks: Use the \_\_\_ theme as the fallback theme on the OPAC.
8274 - This preference has no use right now, as Koha has only one theme, but
8275 if your library has a custom theme it will show here as an option.
8276 The purpose of this preference is to provide a way to choose to what
8277 theme to fallback on when you have a partial theme in place.
8279 .. _opacfavicon-label:
8282 ''''''''''''''''''''''''''''''
8284 Asks: Use the image at \_\_\_ for the OPAC's favicon.
8288 This should be a complete URL, starting with http://
8292 Turn your logo into a favicon with the `Favicon
8293 Generator <http://antifavicon.com/>`__.
8297 - The favicon is the little icon that appears next to the URL in the
8298 address bar in most browsers. The default value for this field (if
8299 left blank) is the small 'K' in the Koha logo.
8301 Default Koha Favicon
8304 .. _opacheader-label:
8307 ''''''''''''''''''''''''''''
8309 Asks: Include the following HTML in the header of all pages in the OPAC
8311 Sample HTML to be displayed at the top of my OPAC
8316 This value will appear above the main content of your page
8318 OPAC display of the value from 'opacheader'
8323 Edit ':ref:`LibraryName`' if you'd like to edit the
8324 contents of the <title> tag
8326 Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
8328 .. _opachighlightedwords-&-nothighlightedwords-label:
8330 OpacHighlightedWords & NotHighlightedWords
8331 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8333 OpacHighlightedWords Default: Don't highlight
8335 NotHighlightedWords Default: and\|or\|not
8337 Asks: \_\_\_ words the patron searched for in their search results and
8338 detail pages; To prevent certain words from ever being highlighted,
8339 enter a list of stopwords here \_\_\_ (separate columns with \|)
8341 OpacHighlightedWords Values:
8347 .. _opacholdingsdefaultsortfield-label:
8349 OPACHoldingsDefaultSortField
8350 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8352 Default: First column of the table
8354 Asks: \_\_\_ is the default sort field for the holdings table
8358 - First column of the table
8364 .. _opackohaurl-label:
8367 ''''''''''''''''''''''''''''''
8379 - When this preference is set to 'Show' text will appear in the bottom
8380 right of the OPAC footer stating 'Powered by Koha' and linking to the
8381 official Koha website.
8386 .. _opaclangselectormode-label:
8388 OpacLangSelectorMode
8389 ''''''''''''''''''''''''''''''''''''''''''''''''
8391 Default: only footer
8393 Asks: Display language selector on \_\_\_.
8397 - both top and footer
8405 - If you have the :ref:`opaclanguagesdisplay`
8406 preference set to display language options in the public catlaog,
8407 then this preference will allow you to control where the language
8408 selector shows. You can choose to show it only on the top or bottom
8411 .. _opaclayoutstylesheet-label:
8413 opaclayoutstylesheet
8414 ''''''''''''''''''''''''''''''''''''''''''''''''
8418 Asks: Use the CSS stylesheet /css/ \_\_\_ on all pages in the OPAC,
8419 instead of the default
8423 - This setting's function is to point to the \*.css file used to define
8424 the OPAC layout. A \*.css file is a cascading stylesheet which is
8425 used in conjunction with HTML to set how the HTML page is formatted
8426 and will look on the OPAC. There are two stylesheets that come with
8427 the system; opac.css and opac2.css. A custom stylesheet may also be
8428 used. The stylesheets listed in the opaclayoutstylesheet preference
8429 are held on the Koha server.
8433 Leave this field blank to disable it and let Koha use the default
8438 Using a custom value in this preference causes Koha to completely
8439 ignore the default layout stylesheet.
8441 .. _opaclocationbranchtodisplay-label:
8443 OpacLocationBranchToDisplay
8444 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8446 Default: holding library
8448 Asks: Display the \_\_\_ for items on the OPAC record details page.
8454 - home and holding library
8460 - Defines whether to display the holding library, the home library, or
8461 both for the opac details page.
8463 .. _opaclocationbranchtodisplayshelving-label:
8465 OpacLocationBranchToDisplayShelving
8466 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8468 Default: holding library
8470 Asks: Display the shelving location under the \_\_\_ for items on the
8471 OPAC record details page.
8477 - home and holding library
8483 - Defines where the shelving location should be displayed, under the
8484 home library, the holding library, or both.
8486 .. _opacmaintenance-label:
8489 ''''''''''''''''''''''''''''''''''''''
8493 Asks: \_\_\_ a warning that the OPAC is under maintenance, instead of
8498 this shows the same warning as when the database needs to be
8499 upgraded, but unconditionally.
8503 - This preference allows the system administrator to turn off the OPAC
8504 during maintenance and display a message to users. When this
8505 preference is switched to "Show" the OPAC is not usable. The text of
8506 this message is not editable at this time.
8514 - When this preference is set to show the maintenance message the
8515 ability to search the OPAC is disabled and a message appears. The
8516 default message can be altered by using the
8517 :ref:`OpacMaintenanceNotice` preference.
8519 OPAC Maintenance Message
8522 .. _opacmaintenancenotice-label:
8524 OpacMaintenanceNotice
8525 ''''''''''''''''''''''''''''''''''''''''''''''''''
8527 Asks: Show the following HTML when OpacMaintenance is enabled
8531 - This preference will allow you to set the text the OPAC displays when
8532 the :ref:`OpacMaintenance` preference is set to
8535 .. _opacmainuserblock-label:
8538 ''''''''''''''''''''''''''''''''''''''''''
8540 Default: Welcome to Koha... <hr>
8542 Asks: Show the following HTML in its own column on the main page of the
8547 - HTML entered in this field will appear in the center of the main page
8550 Sample OpacMainUserBlock appears below the search bar
8553 Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
8555 .. _opacmaxitemstodisplay-label:
8557 OpacMaxItemsToDisplay
8558 ''''''''''''''''''''''''''''''''''''''''''''''''''
8562 Asks: Display up to \_\_\_ items on the biblio detail page
8566 - This preference will help with slow load times on the bibliographic
8567 detail pages by limiting the number of items to display by default.
8568 If the biblio has more items than this, a link is displayed instead
8569 that allows the user to choose to display all items.
8571 .. _opacmysummaryhtml-label:
8574 ''''''''''''''''''''''''''''''''''''''''''
8576 Asks: Include a "Links" column on the "my summary" tab when a user is
8577 logged in to the OPAC, with the following HTML (leave blank to disable).
8581 - In this preference you can enter HTML that will appear on the
8582 'Checked Out' tab on the 'My Summary' section when logged in to the
8583 OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
8584 will be replaced with information from the displayed record. This can
8585 be used to enter in 'share' links for social networks or generate
8586 searches against other library catalogs.
8588 Example of 'Links' column with a value in the OPACMySummaryHTML
8596 <p><a href="http://www.facebook.com/sharer.php?u=http://YOUROPAC.ORG/cgi-bin/koha/opac-detail.pl?biblionumber={BIBLIONUMBER}">Share on Facebook</a>
8597 <br />TITLE: {TITLE}
8598 <br />AUTHOR: {AUTHOR}
8600 <br />BIBLIONUMBER: {BIBLIONUMBER}</p>
8602 .. _opacmysummarynote-label:
8605 ''''''''''''''''''''''''''''''''''''''''''
8607 Asks: Note to display on the patron summary page.
8611 - This preference will display text above the patron's summary and
8612 below the welcome message when the patron logs in to the OPAC and
8613 view their 'my summary' tab.OPACMySummaryNote in the OPAC
8618 ''''''''''''''''''''''
8620 Default: Important links here.
8622 Asks: Show the following HTML on the left hand column of the main page
8623 and patron account on the OPAC (generally navigation links)
8625 Sample navigation links
8628 Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
8630 .. _opacnavbottom-label:
8633 ''''''''''''''''''''''''''''''''''
8635 Asks: Show the following HTML on the left hand column of the main page
8636 and patron account on the OPAC, after :ref:`OpacNav`, and before
8637 patron account links if available:
8639 Description: When a patron is logged in to their account they see a
8640 series of tabs to access their account information.
8641 :ref:`OpacNav` appears above this list of tabs and OpacNavBottom
8642 will appear below them. When not on the patron account pages the HTML in
8643 OpacNavBottom will just appear right below :ref:`OpacNav`.
8645 OpacNav and OpacNavBottom on Patron Account
8648 .. _opacnavright-label:
8651 ''''''''''''''''''''''''''''''''
8653 Asks: Show the following HTML in the right hand column of the main page
8654 under the main login form.
8656 Description: HTML entered in this preference will appear on the right
8657 hand side of the OPAC under the log in form. If the log in form is not
8658 visible this content will move up on the right column.
8663 .. _opacnoresultsfound-label:
8666 ''''''''''''''''''''''''''''''''''''''''''''
8670 Asks: Display this HTML when no results are found for a search in the
8673 This HTML will display below the existing notice that no results were
8674 found for your search.
8676 HTML in OPACNoResultsFound will appear below lines that look like this
8681 You can insert placeholders {QUERY\_KW} that will be replaced with
8682 the keywords of the query.
8684 .. _opacpublic-label:
8687 ''''''''''''''''''''''''''''
8691 Asks: \_\_\_ Koha OPAC as public. Private OPAC requires authentication
8692 before accessing the OPAC.
8702 - This preference determines if your OPAC is accessible and searchable
8703 by anyone or only by members of the library. If set to 'Don't enable'
8704 only members who are logged into the OPAC can search. Most libraries
8705 will leave this setting at its default of 'Enable' to allow their
8706 OPAC to be searched by anyone and only require login for access to
8707 personalized content.
8709 .. _opacresultslibrary-label:
8712 ''''''''''''''''''''''''''''''''''''''''''''
8714 Default: home library
8716 Asks: For search results in the OPAC, show the item's \_\_\_. Please
8717 note that this feature is currently available for MARC21 and UNIMARC.
8725 .. _opacresultssidebar-label:
8728 ''''''''''''''''''''''''''''''''''''''''''''
8730 Asks: Include the following HTML under the facets in OPAC search results
8734 - The HTML entered in this preference will appear on the search results
8735 pages below the list of facets on the left side of the screen.
8737 .. _opacsearchfortitlein-label:
8739 OPACSearchForTitleIn
8740 ''''''''''''''''''''''''''''''''''''''''''''''''
8742 Default: <li><a href="http://worldcat.org/search?q={TITLE}"
8743 target="\_blank">Other Libraries (WorldCat)</a></li> <li><a
8744 href="http://www.scholar.google.com/scholar?q={TITLE}"
8745 target="\_blank">Other Databases (Google Scholar)</a></li> <li><a
8746 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
8747 target="\_blank">Online Stores (Bookfinder.com)</a></li>
8749 Asks: Include a "More Searches" box on the detail pages of items on the
8750 OPAC, with the following HTML (leave blank to disable)
8754 The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN},
8755 {ISSN} and {AUTHOR} will be replaced with information from the
8758 .. _opacseparateholdings-&-opacseparateholdingsbranch-label:
8760 OpacSeparateHoldings & OpacSeparateHoldingsBranch
8761 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8763 OpacSeparateHoldings default: Don't separate
8765 OpacSeparateHoldingsBranch default: home library
8767 Asks: \_\_\_ items display into two tabs, where the first tab contains
8768 items whose \_\_\_ is the logged in user's library. The second tab will
8769 contain all other items.
8771 OpacSeparateHoldings values:
8777 OpacSeparateHoldingsBranch values:
8785 - This preference lets you decide if you would like to have the holding
8786 information on the bibliographic detail page in the OPAC split in to
8787 multiple tabs. The default is to show all holdings on one tab.
8789 Separate holdings tabs
8792 .. _opacshowbarcode-label:
8795 ''''''''''''''''''''''''''''''''''''''
8799 Asks: \_\_\_ the item's barcode on the holdings tab.
8805 Barcode not shown in the OPAC
8810 Barcode shown in the OPAC
8815 - This preference allows you to control whether patrons can see items'
8816 barcodes in the OPAC.
8818 .. _opacshowcheckoutname-label:
8820 OPACShowCheckoutName
8821 ''''''''''''''''''''''''''''''''''''''''''''''''
8825 Asks: \_\_\_ the name of the patron that has an item checked out on item
8826 detail pages on the OPAC.
8836 - This preference allows all patrons to see who has the item checked
8837 out if it is checked out. In small corporate libraries (where the
8838 OPAC is behind a firewall and not publicly available) this can be
8839 helpful so coworkers can just contact the patron with the book
8840 themselves. In larger public and academic libraries setting this to
8841 'Show' would pose serious privacy issues.
8843 .. _opacshowholdqueuedetails-label:
8845 OPACShowHoldQueueDetails
8846 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8848 Default: Don't show any hold details
8850 Asks: \_\_\_ to patrons in the OPAC.
8854 - Don't show any hold details
8858 The holdings table on the bibliographic record will show the number
8862 - Show holds and priority level
8864 - Show priority level
8866 Patron record in the OPAC shows where in line the patron waits for
8870 - :ref:`opacuserlogin` needs to be set to 'allow'
8872 .. _opacshowrecentcomments-label:
8874 OpacShowRecentComments
8875 ''''''''''''''''''''''''''''''''''''''''''''''''''''
8879 Asks: \_\_\_ a link to recent comments in the OPAC masthead.
8889 - If you have chosen to allow comments in your OPAC by setting
8890 :ref:`reviewson` to 'Allow' you can include a link to the
8891 recent comments under the search box at the top of your OPAC with
8894 Recent Comments link on OPAC
8897 .. _opacshowunusedauthorities-label:
8899 OPACShowUnusedAuthorities
8900 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
8904 Asks: \_\_\_ unused authorities in the OPAC authority browser.
8914 Requires that the :ref:`OpacAuthorities`
8915 preference is set to 'Allow'
8919 - When patrons search your authority file via the OPAC they will see
8920 all authorities in your system even if you don't have them linked to
8921 any bibliographic records. This preference lets you determine what
8922 the default behavior is when searching authorities via the OPAC. If
8923 you choose 'Do not show' it will only show patrons authority records
8924 that are linked to bib records in the search results. Otherwise the
8925 system will show all authority records even if they aren't linked to
8928 .. _opacstarratings-label:
8931 ''''''''''''''''''''''''''''''''''''''
8935 Asks: Show star-ratings on \_\_\_ pages.
8943 Star Ratings on the Details Page
8946 - results and details
8948 OPAC Star Ratings on the Search Results
8953 - Star ratings are a way for your patrons to leave ratings without
8954 having to leave a full review. Patrons who are not logged in will
8955 only be able to see the stars, once logged in patrons can click on
8956 the stars on the details page to leave their own rating. Clicking on
8957 the stars on the search results will not submit a rating.
8959 .. _opacsuggestionmanagedby-label:
8961 OpacSuggestionManagedBy
8962 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
8966 Asks: \_\_\_ the name of the staff member who managed a suggestion in
8977 - If you're :ref:`allowing patrons to make purchase
8978 suggestions <suggestion-label>` then they will see the 'my
8979 suggestions' tab when logged in. This tab shows the patron the
8980 librarian who approved or rejected the purchase suggestion. This
8981 preference controls if the patron sees the librarian's name or not.
8983 .. _opacthemes-label:
8986 ''''''''''''''''''''''''''''
8990 Asks: Use the \_\_\_ theme on the OPAC.
8998 This theme is completely responsive
9000 .. _opacurlopeninnewwindow-label:
9002 OPACURLOpenInNewWindow
9003 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9007 Asks: When patrons click on a link to another website from your OPAC
9008 (like Amazon or OCLC), \_\_\_ open the website in a new window.
9018 - This preference determines if URLs in the OPAC will open in a new
9019 window or not. When clicking on a link in the OPAC, a patron does not
9020 need to worry about navigating away from their search results.
9022 .. _opacusercss-label:
9025 ''''''''''''''''''''''''''''''
9027 Asks: Include the following CSS on all pages in the OPAC
9031 - OPACUserCSS allows the administrator to enter styles that will
9032 overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet'
9033 or 'opacstylesheet'. Styles may be entered for any of the selectors
9034 found in the default style sheet. The default stylesheet will likely
9036 http://your\_koha\_address/opac-tmpl/bootstrap/css/opac.css. Unlike
9037 :ref:`OpacAdditionalStylesheet` and
9038 :ref:`opaclayoutstylesheet` this preference will
9039 embed the CSS directly on your OPAC pages.
9041 .. _opacuserjs-label:
9044 ''''''''''''''''''''''''''''
9046 Asks: Include the following JavaScript on all pages in the OPAC
9048 OPAC login box before OPACUserJS edit
9051 JavaScript in OPACUserJS to change the OPAC login box
9054 New OPAC login box after editing OPACUserJS
9059 - This preference allows the administrator to enter JavaScript or
9060 JQuery that will be embedded across all pages of the OPAC.
9061 Administrators may use this preference to customize some of the
9062 interactive sections of Koha, customizing the text for the login
9063 prompts, for example. Sample JQuery scripts used by Koha libraries
9064 can be found on the wiki:
9065 http://wiki.koha-community.org/wiki/JQuery_Library.
9067 .. _opacxsltdetailsdisplay-label:
9069 OPACXSLTDetailsDisplay
9070 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9074 Asks: Display OPAC details using XSLT stylesheet at \_\_\_
9078 - leave empty to not use the XSLT stylesheet
9080 - In previous versions of Koha this was the setting that read
9083 - enter "default" for the default one
9085 - put a path to define a XSLT file
9087 - ex: /path/to/koha/and/your/stylesheet.xsl
9089 - If in a multi-language system you can enter {langcode} in the path
9090 to tell Koha to look in the right language folder
9093 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl
9095 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
9097 - put an URL for an external specific stylesheet
9099 - ex: http://mykohaopac.org/stylesheet.xsl
9103 - XSLT stylesheets allow for the customization of the details shows on
9104 the screen when viewing a bib record. This preference will allow you
9105 either use the default look that comes with Koha or design your own
9108 .. _opacxsltlistsdisplay-label:
9110 OPACXSLTListsDisplay
9111 ''''''''''''''''''''''''''''''''''''''''''''''''
9115 Asks: Display lists in the OPAC using XSLT stylesheet at \_\_\_
9119 - leave empty to not use the XSLT stylesheet
9121 - In previous versions of Koha this was the setting that read
9124 - enter "default" for the default one
9126 - put a path to define a XSLT file
9128 - ex: /path/to/koha/and/your/stylesheet.xsl
9130 - If in a multi-language system you can enter {langcode} in the path
9131 to tell Koha to look in the right language folder
9134 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
9136 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
9138 - put an URL for an external specific stylesheet
9140 - ex: http://mykohaopac.org/stylesheet.xsl
9144 - XSLT stylesheets allow for the customization of the details shows on
9145 the screen when viewing lists. This preference will
9146 allow you either use the default look that comes with Koha or design
9147 your own stylesheet.
9149 .. _opacxsltresultsdisplay-label:
9151 OPACXSLTResultsDisplay
9152 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9156 Asks: Display OPAC results using XSLT stylesheet at \_\_\_
9160 - leave empty to not use the XSLT stylesheet
9162 - In previous versions of Koha this was the setting that read
9165 - enter "default" for the default one
9167 - put a path to define a XSLT file
9169 - ex: /path/to/koha/and/your/stylesheet.xsl
9171 - If in a multi-language system you can enter {langcode} in the path
9172 to tell Koha to look in the right language folder
9175 /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
9177 - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
9179 - put an URL for an external specific stylesheet
9181 - ex: http://mykohaopac.org/stylesheet.xsl
9185 - XSLT stylesheets allow for the customization of the details shows on
9186 the screen when viewing the search results. This preference will
9187 allow you either use the default look that comes with Koha or design
9188 your own stylesheet.
9193 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9195 .. _numsearchrssresults-label:
9198 ''''''''''''''''''''''''''''''''''''''''''''''
9202 Asks: Display \_\_\_ search results in the RSS feed.
9206 - By default the RSS feed that is automatically generated for every
9207 search results page will list 50 items. This can sometimes be too
9208 much for some RSS feed readers and for some people this isn't enough.
9209 This preference allows you to adjust this number to show the best
9210 number of results for your patrons.
9212 .. _opacacquisitiondetails-label:
9214 OPACAcquisitionDetails
9215 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9217 Default: Don't display
9219 Asks: \_\_\_ the acquisition details on OPAC detail pages.
9223 - DisplayAcquisitions details in the OPAC
9229 - This preference shows the patrons how many items are on order in the
9230 Holdings tab if you have the :ref:`AcqCreateItem` set
9231 to 'cataloging the record'
9233 .. _opacauthorities-label:
9236 ''''''''''''''''''''''''''''''''''''''
9240 Asks: \_\_\_ patrons to search your authority records.
9244 - This preference displays the link on the OPAC for the authority
9245 search. By setting the preference to "Allow" patrons can use this
9246 search link of the OPAC.
9252 - A link labeled 'Authority search' will appear at the top of your
9253 OPAC under the search box
9255 'Browse by Subject' link under search box on OPAC
9260 .. _opacbookbag-label:
9263 ''''''''''''''''''''''''''''''
9267 Asks: \_\_\_ patrons to store items in a temporary "Cart" on the OPAC.
9277 - This preference allows the user to temporarily save a list of items
9278 found on the catalog. By using the Book Bag, or Cart, the user can
9279 print out or email a list of items found. The user does not need to
9280 be logged in. This list is temporary and will be emptied, or cleared,
9281 at the end of the session.
9283 .. _opacbrowser-label:
9286 ''''''''''''''''''''''''''''''
9290 This preference only applies to installations using UNIMARC at this time.
9292 Default: Don't allow
9294 Asks: \_\_\_ patrons to browse subject authorities on OPAC
9304 run the :ref:`Authorities Browser Cron Job <authorities-browser-label>` to
9305 create the browser list
9307 .. _opacbrowseresults-label:
9310 ''''''''''''''''''''''''''''''''''''''''''
9314 Asks: \_\_\_ browsing and paging search results from the OPAC detail
9323 Browsing and Paging Search Results
9328 - This preference will control the option to return to your results
9329 and/or browse them from the detail page in the OPAC.
9331 .. _opaccloud-label:
9334 ''''''''''''''''''''''''''
9338 This preference only applies to French systems at this time.
9342 Asks: \_\_\_ a subject cloud on OPAC
9352 run the :ref:`Authorities Browser Cron Job <authorities-browser-label>` to
9353 create the browser list
9355 .. _opacfinestab-label:
9358 ''''''''''''''''''''''''''''''''
9362 Asks: \_\_\_ patrons to access the Fines tab on the My Account page on
9369 - :ref:`opacuserlogin` needs to be set to 'allow'
9373 .. _opacholdnotes-label:
9376 ''''''''''''''''''''''''''''''''''
9378 Default: Do not allow
9380 Asks: \_\_\_ users to add a note when placing a hold.
9386 Holds notes in the OPAC
9394 ''''''''''''''''''''''''
9396 Default: :ref:`MARC21 Default Appendix <marc-label>`
9398 Asks: Use the following as the OPAC ISBD template:
9402 - This determines how the ISBD information will display in the OPAC.
9403 Elements in the list can be reordered to produce a different ISBD
9404 view. ISBD, the International Standard Bibliographic Description, was
9405 first introduced by IFLA (International Federation of Library
9406 Associations) in 1969 in order to provide guidelines for descriptive
9407 cataloging. The purpose of ISBD is to aid the international exchange
9408 of bibliographic records for a variety of materials.
9410 .. _opacitemlocation-label:
9413 ''''''''''''''''''''''''''''''''''''''''
9415 Default: call number only
9417 Asks: Show \_\_\_\_ for items on the OPAC search results.
9429 - This setting allows users of the OPAC results XSLT stylesheet to
9430 choose to display collection code or location in addition to call
9433 .. _opacnewslibraryselect-label:
9435 OpacNewsLibrarySelect
9436 ''''''''''''''''''''''''''''''''''''''''''''''''''
9438 Default: Don't display
9440 Asks: \_\_\_ a branch selection list for news items in the OPAC.
9448 .. _opacpasswordchange-label:
9451 ''''''''''''''''''''''''''''''''''''''''''''
9455 Asks: \_\_\_ patrons to change their own password on the OPAC.
9461 - :ref:`opacuserlogin` needs to be set to 'allow'
9467 Enabling this will break LDAP authentication.
9469 .. _opacpatrondetails-label:
9472 ''''''''''''''''''''''''''''''''''''''''''
9476 Asks: \_\_\_ patrons to notify the library of changes to their contact
9477 information from the OPAC.
9483 - :ref:`opacuserlogin` needs to be set to 'allow'
9489 - If patrons are allowed to notify the library of changes to their
9490 account then staff will need to approve the changes via the staff
9491 client. Notification of patron account requests will appear on the
9492 dashaboard below the list of modules with other pending actions.
9494 Patrons requesting modifications
9497 Once you click the notification you will be presented with the
9498 changes the patron would like to make to their account and from there
9499 you can choose how to proceed.
9501 Patrons modifications
9506 You can control what fields patrons see and can modify via the
9508 :ref:`PatronSelfRegistrationBorrowerMandatoryField`
9509 :ref:`PatronSelfRegistrationBorrowerUnwantedField`
9512 .. _opacpatronimages-label:
9515 ''''''''''''''''''''''''''''''''''''''
9519 Asks: \_\_\_ patron images on the patron information page in the OPAC.
9529 - If :ref:`patronimages` is set to allow the upload of
9530 patron images via the staff client, then setting this preference to
9531 'show' will show the patron what image you have on file for them when
9532 they view their personal information on their account in the OPAC.
9534 .. _opacpopupauthorssearch-label:
9536 OPACPopupAuthorsSearch
9537 ''''''''''''''''''''''''''''''''''''''''''''''''''''
9539 Default: Don't display
9541 Asks: \_\_\_ the list of authors/subjects in a popup for a combined
9542 search on OPAC detail pages.
9548 Subject search pop up
9552 This will only display the pop up if you are not using an XSLT
9553 stylesheet. Review your
9554 :ref:`OPACXSLTDetailsDisplay` to find
9555 out what stylesheet you're using.
9559 - Authors and subjects will display as search links instead of pop
9564 - If this preference is set to 'Display' then clicking a subject or
9565 author from the details page in the OPAC will present the searcher
9566 with a pop up box. From this box you can check off any of the
9567 subjects or authors listed and search them all at once by clicking
9568 'Search' at the bottom of the pop up. The default behavior is for
9569 Koha to search just the clicked author or subject.
9571 .. _opacresetpassword-label:
9574 ''''''''''''''''''''''''''''''''''''''''''
9576 Default: not allowed
9578 Asks: Library users are \_\_\_ to recover their password via e-mail in
9583 - allowedForgot your password link
9589 - This preference controls whether you present users of the public
9590 catalog with a 'Forgot your password' link or not. Learn more in the
9591 :ref:`OPAC section <resetting-your-password-label>` of this manual.
9593 .. _opactopissue-label:
9596 ''''''''''''''''''''''''''''''''
9598 Default: Don't allow
9600 Asks: \_\_\_ patrons to access a list of the most checked out items on
9607 - A link to 'Most Popular' will appear at the top of your OPAC
9609 'Most Popular' link under the search box
9616 - This preference allows the administrator to choose to show the "Most
9617 Popular" link at the top of the OPAC under the search box. The "Most
9618 Popular" page shows the top circulated items in the library, as
9619 determined by the number of times a title has been circulated. This
9620 allows users to see what titles are popular in their community. It is
9621 recommended that you leave this preference set to 'Don't allow' until
9622 you have been live on Koha for a couple of months, otherwise the data
9623 that it shows will not be an accurate portrayal of what's popular in
9626 Sample top issues page
9629 .. _opacuserlogin-label:
9632 ''''''''''''''''''''''''''''''''''
9636 Asks: \_\_\_ patrons to log in to their accounts on the OPAC.
9644 - The OPAC will still be searchable if patrons can't log in, this
9645 just disables the patron account access via the OPAC
9647 .. _quoteoftheday-label:
9650 ''''''''''''''''''''''''''''''''''
9654 Asks: \_\_\_ Quote of the Day display on OPAC home page
9664 - This feature will allow you to enter a series of quotes that will
9665 then show on the OPAC homepage in random order. To add/edit quotes,
9666 visit the :ref:`Quote of the Day Editor <quote-of-the-day-(qotd)-editor-label>` under Tools.
9668 .. _requestonopac-label:
9671 ''''''''''''''''''''''''''''''''''
9675 Asks: \_\_\_ patrons to place holds on items from the OPAC.
9681 - :ref:`opacuserlogin` needs to be set to 'allow'
9685 .. _reviewson-label:
9688 ''''''''''''''''''''''''''
9692 Asks: \_\_\_ patrons to make comments on items on the OPAC.
9698 - Patrons comments/reviews all require moderation before they appear
9701 - :ref:`opacuserlogin` needs to be set to 'Allow'
9707 - This button allows the patrons to submit comments on books they have
9708 read via the OPAC. If this preference is set to "Allow" reviews are
9709 first sent to the staff client for staff approval before the review
9710 is displayed in the OPAC. The staff member who reviews and approves
9711 comments may find the pending comments on the
9712 :ref:`Comments` tool. The staff member can then choose to
9713 approve or delete the comments.
9715 .. _showreviewer-label:
9718 ''''''''''''''''''''''''''''''''
9722 Asks: Show \_\_\_ of commenter with comments in OPAC.
9728 - first name and last initial
9740 - If you would like to protect your patron's privacy in the OPAC you
9741 can choose to hide their names or parts of their names from any of
9742 the comments they leave on bib records in your system.
9743 :ref:`reviewson` needs to be set to 'Allow' for this to
9744 preference to come in to play
9746 .. _showreviewerphoto-label:
9749 ''''''''''''''''''''''''''''''''''''''''''
9753 Asks: \_\_\_ reviewer's photo beside comments in OPAC.
9761 - :ref:`reviewson` needs to be set to 'Allow' and
9762 :ref:`ShowReviewer` needs to be set to 'Show' for
9763 this to preference to come in to play
9765 ShowReviewerPhoto set to 'Show'
9770 - This system preference allows libraries to show avatars next to
9771 patron's comments in the OPAC. These avatars are pulled from the
9772 `Libravatar <https://www.libravatar.org>`__ library, an open source
9773 powered product that allows Internet users to choose a small icon to
9774 display next to their name on various different websites. The library
9775 has no control over the images the patron chooses to display.
9777 .. _socialnetworks-label:
9780 ''''''''''''''''''''''''''''''''''''
9784 Asks: \_\_\_ social network links in opac detail pages
9797 - This preference will enable a line of social network share buttons
9798 below the right hand column on the detail pages of records in the
9803 In order for these share buttons to work when clicked you must have
9804 filled in your :ref:`OPACBaseURL` preference.
9806 .. _suggestion-label:
9809 '''''''''''''''''''''''''''''''''
9813 Asks: \_\_\_ patrons to make purchase suggestions on the OPAC.
9819 - :ref:`opacuserlogin` needs to be set to 'allow'
9820 unless :ref:`AnonSuggestions` is set to 'allow'
9827 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9829 These preferences will allow you control the tools you use to accept
9830 online payments from your patrons via the OPAC.
9832 .. _enablepaypalopacpayments-&-paypalsandboxmode-label:
9834 EnablePayPalOpacPayments & PayPalSandboxMode
9835 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9837 EnablePayPalOpacPayments Default: Don't all
9839 PayPalSandboxMode Default: Sandbox
9841 Asks: \_\_\_ patrons to make payments from the OPAC via PayPal in \_\_\_
9844 EnablePayPalOpacPayments values:
9850 PayPalSandboxMode values:
9854 - Visit https://developer.paypal.com/ to get information for
9855 accepting payments in production
9859 - Visit https://developer.paypal.com/developer/accounts/ to get
9860 information for your sandbox account
9864 - This preference will allow you to accept credit card payments via the
9865 OPAC for fines via PayPal. You will need to set up your PayPal
9866 account and it is recommended that you run tests before using this in
9871 PayPayl's terms of service state that you cannot charge your patrons
9872 for the processing fees and so this plugin will not add additional
9873 fees to the charges.
9875 .. _paypalchargedescription-label:
9877 PayPalChargeDescription
9878 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
9880 Default: Koha fee payment
9882 Asks: The patron should see the charge description as \_\_\_
9886 - This preference controls what the patron will see on their PayPal
9887 account/Bank account for this charge.
9889 .. _paypalpwd-label:
9892 ''''''''''''''''''''''''''
9894 Asks: The password for the PayPal account to receive payments is \_\_\_
9896 .. _paypalsignature-label:
9899 ''''''''''''''''''''''''''''''''''''''
9901 Asks: The signature for the PayPal account to receive payments is \_\_\_
9903 .. _paypaluser-label:
9906 ''''''''''''''''''''''''''''
9908 Asks: The email address to receive PayPal payments is \_\_\_
9913 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9915 .. _allowpurchasesuggestionbranchchoice-label:
9917 AllowPurchaseSuggestionBranchChoice
9918 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9920 Default: Don't allow
9922 Asks: \_\_\_ patrons to select branch when making a purchase suggestion
9932 - If your library system lets patrons make purchase suggestions for a
9933 specific branch you can set this preference to 'Allow' to add a
9934 branch selection option to the purchase suggestion form.
9936 .. _blockexpiredpatronopacactions-label:
9938 BlockExpiredPatronOpacActions
9939 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9941 Default: Don't block
9943 Asks: \_\_\_ expired patrons from OPAC actions such as placing a hold or
9954 - This preference lets you set a default value for how Koha handles
9955 permissions for patrons who are expired. This preference can be
9956 overwritten by the setting on :ref:`individual patron
9957 categories <patron-categories-label>`.
9959 .. _maxopensuggestions-label:
9962 ''''''''''''''''''''''''''''''''''''''''''''
9966 Asks: Limit patrons to \_\_\_ open suggestions. Leave empty for no limit.
9970 This setting does not affect anonymous suggestions.
9972 .. _opacallowpubliclistcreation-label:
9974 OpacAllowPublicListCreation
9975 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
9979 Asks: \_\_\_ opac users to create public lists.
9989 - Public lists are visible to anyone who visits your OPAC. With this
9990 preference you can control whether or now patrons are allowed to
9991 create these public lists. If this is set to "Don't allow" then only
9992 staff will be able to create public lists.
9996 This preference will only be taken in to account if you have
9997 :ref:`virtualshelves` set to 'Allow'
9999 .. _opacallowsharingprivatelists-label:
10001 OpacAllowSharingPrivateLists
10002 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10004 Default: Don't allow
10006 Asks: \_\_\_ opac users to share private lists with other patrons.
10016 - This feature will add the option for patrons to share their lists
10017 with other patrons. When this is set to 'Allow' patrons will see a
10018 share link at the top of their list. When they click that link it
10019 will ask for the email of the patron they would like to share with.
10020 Koha will then email the patron an invitation to see the list.
10022 .. _opacfinenorenewals-label:
10025 ''''''''''''''''''''''''''''''''''''''''''''
10029 Asks: Only allow patrons to renew their own books on the OPAC if they
10030 have less than \_\_\_ USD in fines
10034 Leave this field blank to disable
10038 To allow renewals in the OPAC, :ref:`opacuserlogin`
10039 needs to be set to 'allow'
10041 .. _opachiddenitems-label:
10044 ''''''''''''''''''''''''''''''''''''''
10046 Asks: Allows to define custom rules for hiding specific items at opac.
10050 See docs/opac/OpacHiddenItems.txt in your Koha install directory for
10055 - In this field you can enter criteria for items you would like to hide
10056 from display in the OPAC. This field takes any combination of item
10057 fields (from the items table in the Koha database) for blocking. For
10058 example a value of:
10063 location: [STAFF, ISO]
10065 Will block items with an itype code of 07 or 10 as well as items that
10066 have a shelving location of STAFF or ISO.
10068 In items my items.itype 07 is defined in Item Types Administration as
10069 Staff Assigned My items.itype 10 in Item Types is Archival Copy The
10070 locations STAFF and ISO are in Authorized Values for category=LOC
10071 STAFF means it's assigned to the staff reading room and ISO means it
10072 is in the isolation room.
10074 .. _opacrenewalallowed-label:
10077 ''''''''''''''''''''''''''''''''''''''''''''
10079 Default: Don't allow
10081 Asks: \_\_\_ patrons to renew their own books on the OPAC.
10087 - :ref:`opacuserlogin` needs to be set to 'allow'
10091 - Staff will still be able to renew items for patrons via the staff
10096 - This preference allows the administration to choose if patrons can
10097 renew their checked out materials via their checked out history in
10098 the OPAC. It allows patrons to renew their materials without having
10099 to contact the library or having to return to the library.
10101 .. _opacrenewalbranch-label:
10104 ''''''''''''''''''''''''''''''''''''''''''
10106 Default: the branch the item was checked out from
10108 Asks: Use \_\_\_ as branchcode to store in the statistics table
10116 - the item's home branch
10118 - the patron's home branch
10120 - the branch the item was checked out from
10124 - This value is used in the statistics table to help with reporting.
10125 The statistics table in Koha keeps track of all checkouts and
10126 renewals, this preference defines which branch is entered in to the
10127 table when a patron renews an item for themselves via the OPAC.
10129 .. _opacsuggestionmandatoryfields-label:
10131 OPACSuggestionMandatoryFields
10132 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10136 Asks: Fields that should be mandatory for patron purchase suggestions:
10137 \_\_\_ Note: if none of the above options are selected, 'Title' field
10138 would be mandatory anyway, by default.
10148 - Copyright or publication date
10150 - ISBN, ISSN or other standard number
10154 - Library or branch
10160 - Publication place
10166 .. _opacviewotherssuggestions-label:
10168 OPACViewOthersSuggestions
10169 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10171 Default: Don't show
10173 Asks: \_\_\_ purchase suggestions from other patrons on the OPAC.
10181 - :ref:`opacuserlogin` needs to be set to 'allow'
10183 .. _searchmylibraryfirst-label:
10185 SearchMyLibraryFirst
10186 ''''''''''''''''''''''''''''''''''''''''''''''''
10188 Default: Don't limit
10190 Asks: \_\_\_ patrons' searches to the library they are registered at.
10196 - Searching the OPAC will show results from all libraries
10198 - If you're a one branch system, choose 'Don't limit'
10202 - Patrons will still be able to search other libraries via the
10203 Advanced search page - but will be limited to searches for their
10204 library only from the basic search box
10206 - :ref:`opacuserlogin` needs to be set to 'allow'
10211 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10213 .. _allowpatrontosetcheckoutsvisibilityforguarantor-label:
10215 AllowPatronToSetCheckoutsVisibilityForGuarantor
10216 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10218 Default: Don't allow
10220 Asks: \_\_\_ patrons to choose their own privacy settings for showing
10221 the patron's checkouts to the patron's guarantor".
10231 - By default staff can see checkouts to family members via the staff
10232 client. This preference will allow guarantees (children) to grant
10233 permission to guarantors (guardians) to view their current checkouts
10234 via the public catalog. This preference requires that you allow
10235 patrons to se their own privacy with the
10236 :ref:`OPACPrivacy` preference.
10238 .. _anonsuggestions-label:
10241 ''''''''''''''''''''''''''''''''''''''
10243 Default: Don't allow
10245 Asks: \_\_\_ patrons that aren't logged in to make purchase suggestions.
10249 If set to 'Allow', suggestions are connected to the
10250 :ref:`AnonymousPatron`
10258 .. _anonymouspatron-label:
10261 ''''''''''''''''''''''''''''''''''''''
10265 Asks: Use borrowernumber \_\_\_ as the Anonymous Patron (for anonymous
10266 suggestions and reading history)
10270 Before setting this preference :ref:`create a patron <add-a-new-patron-label>`
10271 to be used for all anonymous suggestions and/or reading history
10272 items. This patron can be any type and should be named something to
10273 make it clear to you that they're anonymous (ex. Anonymous Patron).
10277 Remember to use the borrowernumber note the patron's cardnumber for
10278 this value. The borrowernumber can be found on the patron record
10279 under 'Library use' on the right.Borrowernumber
10281 .. _enableopacsearchhistory-label:
10283 EnableOpacSearchHistory
10284 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10288 Asks: \_\_\_ patron search history in the OPAC.
10296 .. _opacprivacy-label:
10299 ''''''''''''''''''''''''''''''
10301 Default: Don't allow
10303 Asks: \_\_\_ patrons to choose their own privacy settings for their
10308 This requires :ref:`opacreadinghistory` set to
10309 'Allow' and :ref:`AnonymousPatron` to be set to your
10310 anonymous patron's borrowernumber.
10320 - The default privacy setting for each patron category can be set in
10321 the :ref:`Patrons Categories <patron-categories-label>` area. If you set this
10322 preference to 'allow' then patrons can change that for themselves via
10327 If patron has chosen to have their reading history anonymized and
10328 you have :ref:`StoreLastBorrower` set to "Don't
10329 store" then as soon as the item is checked in the last borrower will
10332 .. _opacreadinghistory-label:
10335 ''''''''''''''''''''''''''''''''''''''''''''
10339 Asks: \_\_\_ patrons to see what books they have checked out in the
10344 Enabling this will make it so that patrons can view their
10345 circulation history in the OPAC unless you have
10346 :ref:`OPACPrivacy` set to 'Allow.'
10350 This data is stored in the system regardless of your choice, unless
10351 your patrons have chosen to never have their reading history kept.
10353 .. _storelastborrower-label:
10356 ''''''''''''''''''''''''''''''''''''''''''
10358 Default: Don't store
10360 Asks: \_\_\_ the last patron to return an item.
10370 - This preference allows you to store the last patron to borrow an item
10371 even if the patron has chosen to have their reading history
10376 This setting is independent of
10377 :ref:`opacreadinghistory` and/or
10378 :ref:`AnonymousPatron`.
10380 .. _trackclicks-label:
10383 ''''''''''''''''''''''''''''''
10385 Default: Don't track
10387 Asks: \_\_\_ links that patrons click on.
10395 - Track anonymously
10399 - By setting this preference to one of the track options you will allow
10400 Koha to track every link clicked in Koha. This data will be stored in
10401 a database table so that you can run reports against that data. If
10402 you choose to 'Track' clicks then Koha will record both the link
10403 clicked and the logged in user who clicked the link. If you choose to
10404 'Track anonymously' then the borrowernumber will not be recorded, but
10405 the rest of the data will.
10409 Remember to update your local privacy policies and link to them
10410 from the OPAC to notify your users that you are tracking their
10413 .. _restricted-page-label:
10416 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10418 Using the following preference you can create a page within your Koha
10419 system that is accessible by only specific IP addresses. This can be
10420 used to house links to databases that can only be accessed from with the
10421 library or other licensed content.
10423 .. _restrictedpagecontent-label:
10425 RestrictedPageContent
10426 ''''''''''''''''''''''''''''''''''''''''''''''''''
10428 Asks: HTML content of your restricted page.
10430 .. _restrictedpagelocalips-label:
10432 RestrictedPageLocalIPs
10433 ''''''''''''''''''''''''''''''''''''''''''''''''''''
10435 Asks: Access from IP addresses beginning with \_\_\_ do not need to be
10440 - You can enter individual IPS as a comma separated list (ex:
10441 '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
10444 .. _restrictedpagetitle-label:
10446 RestrictedPageTitle
10447 ''''''''''''''''''''''''''''''''''''''''''''''
10449 Asks: Use \_\_\_ as title of your restricted page
10453 - This title will appear in the breadcrumb and on the top of the
10456 .. _self-registration-label:
10459 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10461 .. _patronselfmodificationborrowerunwantedfield-label:
10463 PatronSelfModificationBorrowerUnwantedField
10464 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10468 Asks: The following `database
10469 columns <http://schema.koha-community.org/tables/borrowers.html>`__ will
10470 not appear on the patron self-modification screen: \_\_\_
10474 - This preference allows you to define what fields patrons can edit if
10475 you're allowing them to update their personal information via the
10476 public catalog with the :ref:`OPACPatronDetails`
10481 Separate columns with \|
10483 .. _patronselfregistration-label:
10485 PatronSelfRegistration
10486 ''''''''''''''''''''''''''''''''''''''''''''''''''''
10488 Default: Don't allow
10490 Asks: \_\_\_ library patrons to register an account via the OPAC.
10500 - Setting this preference to 'Allow' will provide a link on the OPAC to
10501 register for a new account. Using the other :ref:`Self
10502 Registration <self-registration-label>` system preferences you
10503 can control how this preference will function.
10505 Register link in the OPAC
10510 Patrons registering via the OPAC will not need to be approved by a
10511 librarian. For this reason it is recommended that you set up a
10512 provisional :ref:`patron category <patron-categories-label>` with no :ref:`circulation
10513 rights <circulation-and-fine-rules-label>`. That way patrons will have to come in to
10514 the library to verify their identity before given circulation rights
10515 at the library. Once the patron confirms their identity the library
10516 staff can change the category to one with permissions to check items
10517 out and place holds.
10519 .. _patronselfregistrationadditionalinstructions-label:
10521 PatronSelfRegistrationAdditionalInstructions
10522 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10524 Asks: Display the following additional instructions for patrons who self
10525 register via the OPAC ( HTML is allowed ):
10529 - This preference takes any HTML you'd like to display on the page the
10530 patron sees after successfully registering for their library card.
10532 .. _patronselfregistrationborrowermandatoryfield-label:
10534 PatronSelfRegistrationBorrowerMandatoryField
10535 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10537 Default: surname\|firstname
10539 Asks: The following database columns must be filled in on the patron
10540 entry screen: \_\_\_
10544 - This preference allows you to define what fields patrons must fill in
10545 on their self registration form. If any of the required fields are
10546 blank Koha will not let the patron register.
10550 Separate columns with \|
10554 For help with field names, ask your system administrator or `view
10556 structure <http://schema.koha-community.org/tables/borrowers.html>`__
10557 associated with the borrowers table.
10561 If you're going to require that patrons verify their accounts via
10563 :ref:`PatronSelfRegistrationVerifyByEmail`
10564 preference the email field will automatically be marked as required.
10566 .. _patronselfregistrationborrowerunwantedfield-label:
10568 PatronSelfRegistrationBorrowerUnwantedField
10569 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10573 Asks: The following database columns will not appear on the patron entry
10578 - Using this preference you can hide fields from the patron registration
10579 and update form in the OPAC.
10583 Separate columns with \|
10587 For help with field names, ask your system administrator or `view
10589 structure <http://schema.koha-community.org/tables/borrowers.html>`__
10590 associated with the borrowers table.
10592 .. _patronselfregistrationdefaultcategory-label:
10594 PatronSelfRegistrationDefaultCategory
10595 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10597 Asks: Use the patron category code \_\_\_ as the default patron category
10598 for patrons registered via the OPAC.
10602 - Enter in the patron category code for the category that all new
10603 patrons registered via the OPAC will be put in to.
10607 Patrons registering via the OPAC will not need to be approved by a
10608 librarian. For this reason it is recommended that you set up a
10609 provisional :ref:`patron category <patron-categories-label>` with no :ref:`circulation
10610 rights <circulation-and-fine-rules-label>`. That way patrons will have to come in to
10611 the library to verify their identity before given circulation rights
10612 at the library. Once the patron confirms their identiy the library
10613 staff can change the category to one with permissions to check items
10614 out and place holds.
10618 If you leave this blank or enter in an invalid code your patrons
10619 will still be able to register but will not be given a username.
10620 There will be no errors on the page to explain this, so be sure to
10621 enter a valid patron category code.
10623 .. _patronselfregistrationemailmustbeunique-label:
10625 PatronSelfRegistrationEmailMustBeUnique
10626 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10628 Default: Do not consider
10630 Asks: \_\_\_ patron's email (borrowers.email) as unique on self registering.
10631 An email won't be accepted if it already exists in the database.
10639 .. _patronselfregistrationexpiretemporaryaccountsdelay-label:
10641 PatronSelfRegistrationExpireTemporaryAccountsDelay
10642 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10646 Asks: Delete patrons registered via the OPAC, but not yet verified after
10651 - This preference links to the :ref:`delete\_expired\_opac\_registrations.pl
10652 cron job <unverified-registrations-label>`. If that cron is set to
10653 run nightly it will clean up any registrations that have not been
10654 verified via email in the number of days entered on this preference.
10655 This is dependent on
10656 :ref:`PatronSelfRegistrationVerifyByEmail`
10659 .. _patronselfregistrationlibrarylist-label:
10661 PatronSelfRegistrationLibraryList
10662 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10666 Asks: Enable the self registration for the following libraries: \_\_\_
10667 (separate branchcode with |). If empty, all libraries will be listed.
10669 .. _patronselfregistrationprefillform-label:
10671 PatronSelfRegistrationPrefillForm
10672 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10674 Default: Display and prefill
10676 Asks: \_\_\_ password and login form after a patron has self registered.
10680 - Do not display and prefill
10682 - Display and prefill
10684 .. _patronselfregistrationverifybyemail-label:
10686 PatronSelfRegistrationVerifyByEmail
10687 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10689 Default: Don't require
10691 Asks: \_\_\_ that a self-registering patron verify his or herself via
10702 - If you require patrons to verify their accounts via email they will
10703 not be able to log in to the OPAC until they acknowledge the email
10704 sent by Koha. If you don't require this then patrons will be able to
10705 log in as soon as they fill in the registration form. You can set the
10706 :ref:`PatronSelfRegistrationExpireTemporaryAccountsDelay`
10707 preference to delete the un-verified self registrations after a
10708 certain number of days.
10712 If you're going to require that patrons verify their accounts via
10713 email then the email field will automatically be marked as required.
10715 .. _shelf-browser-label:
10718 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10720 .. _opacshelfbrowser-label:
10723 ''''''''''''''''''''''''''''''''''''''''
10727 Asks: \_\_\_ a shelf browser on item details pages, allowing patrons to
10728 see what's near that item on the shelf.
10741 - This preference allows patrons to view what is located on the shelf
10742 near the item they looked up. The shelf browser option appears on the
10743 details page to the right of each items' call number. Clicking the
10744 'Browse Shelf' link allows for a virtual shelf browsing experience
10745 via the OPAC and lets patrons see other books that may relate to
10746 their search and items that sit on the shelf near the item they are
10751 This uses up a fairly large amount of resources on your server, and
10752 should be avoided if your collection has a large number of items.
10754 .. _shelfbrowserusesccode-label:
10756 ShelfBrowserUsesCcode
10757 ''''''''''''''''''''''''''''''''''''''''''''''''''
10761 Asks: \_\_\_ the item collection code when finding items for the shelf
10772 - If your library uses collection codes then you might want the shelf
10773 browser to take into consideration what collection the books belong
10774 to when populating the virtual shelf browser.
10776 .. _shelfbrowseruseshomebranch-label:
10778 ShelfBrowserUsesHomeBranch
10779 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10783 Asks: \_\_\_ the item home branch when finding items for the shelf
10794 - If you have a multiple branch system you may want to make sure that
10795 Koha takes into consideration what branch owns the books when
10796 populating the virtual shelf browser for accuracy.
10798 .. _shelfbrowseruseslocation-label:
10800 ShelfBrowserUsesLocation
10801 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10805 Asks: \_\_\_ the item location when finding items for the shelf browser.
10815 - If your library uses shelving locations then you might want the shelf
10816 browser to take into consideration what shelving location the books
10817 belong to when populating the virtual shelf browser.
10822 ~~~~~~~~~~~~~~~~~~~~~~~~~~
10824 *Get there:* More > Administration > Global System Preferences > Patrons
10829 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10831 .. _allowstafftosetcheckoutsvisibilityforguarantor-label:
10833 AllowStaffToSetCheckoutsVisibilityForGuarantor
10834 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10836 Default: Don't allow
10838 Asks: \_\_\_ staff to set the ability for a patron's checkouts to be
10839 viewed by linked patrons in the OPAC.
10847 .. _autoemailopacuser-label:
10850 ''''''''''''''''''''''''''''''''''''''''''
10852 Default: Don't send
10854 Asks: \_\_\_ an email to newly created patrons with their account
10859 - AutoEmailOpacUser allows library users to be notified by email of
10860 their account details when a new account is opened at the email
10861 address specified in the
10862 :ref:`AutoEmailPrimaryAddress` preference.
10863 The email contains the username and password given to or chosen by
10864 the patron when signing up for their account and can be customized by
10865 editing the `ACCTDETAILS <#ACCTDETAILS>`__ notice.
10873 .. _autoemailprimaryaddress-label:
10875 AutoEmailPrimaryAddress
10876 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
10880 Asks: Use \_\_\_ patron email address for sending out emails.
10894 - If you choose 'first valid' as the value for AutoEmailPrimaryAddress
10895 the system will check the email fields in this order: home, work,
10896 then alternate. Otherwise the system will use the email address you
10899 .. _automembernum-label:
10902 ''''''''''''''''''''''''''''''''''
10906 Asks: \_\_\_ default the card number field on the patron addition screen
10907 to the next available card number
10913 - If the largest currently used card number is 26345000012941, then
10914 this field will default to 26345000012942 for the next patron
10920 - This preference determines if the patron's barcode is automatically
10921 calculated. This prevents the person setting up the library card
10922 account from having to assign a number to the new card. If set to
10923 'Do' the system will calculate a new patron barcode by adding 1 to
10924 the maximum barcode already present in the database.
10926 .. _borrowermandatoryfield-label:
10928 BorrowerMandatoryField
10929 ''''''''''''''''''''''''''''''''''''''''''''''''''''
10931 Default: surname\|cardnumber\|barcode
10933 Asks: The following database columns must be filled in on the patron
10934 entry screen: \_\_\_
10938 - This preference enables the system administrator to choose which
10939 fields your library would like required for patron accounts. Enter
10940 field names separated by \| (bar). This ensures that basic
10941 information is included in each patron record. If a patron leaves one
10942 of the required fields blank an error message will issue and the
10943 account will not be created.
10947 Separate columns with \|
10951 For help with field names, ask your system administrator or `view
10953 structure <http://schema.koha-community.org/tables/borrowers.html>`__
10954 associated with the borrowers table.
10956 .. _borrowerrelationship-label:
10958 borrowerRelationship
10959 ''''''''''''''''''''''''''''''''''''''''''''''''
10961 Default: father\|mother
10963 Asks: Guarantors can be the following of those they guarantee \_\_\_
10967 - This preference enables the system administrator to define valid
10968 relationships between a guarantor (usually a parent) & a guarantee
10969 (usually a child). Defining values for this field does not make the
10970 guarantor field required when adding a guarantee type patron. This
10971 preference creates a drop down list identifying the relationship of
10972 the guarantor to the guarantee. To disable the ability to add
10973 children types in Koha you can leave this field blank.
10977 Input multiple choices separated by \|
10979 .. _borrowerrenewalperiodbase-label:
10981 BorrowerRenewalPeriodBase
10982 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10984 Default: current date
10986 Asks: When renewing borrowers, base the new expiry date on \_\_\_
10992 - current membership expiry date.
10996 - This preference controls what the patron's new expiration date will
10997 be when you renew their card. Using the 'current date' will add the
10998 subscription period to today's date when calculating the new
10999 expiration date. Using 'current membership expiry date' will add the
11000 subscription period to the old expiration date for the patron when
11001 renewing their account.
11003 .. _borrowerstitles-label:
11006 ''''''''''''''''''''''''''''''''''''''
11008 Default: Mr\|Mrs\|Miss\|Ms
11010 Asks: Borrowers can have the following titles \_\_\_
11014 - This preference allows the staff to choose the titles that can be
11015 assigned to patrons. The choices present as a drop down list when
11016 creating a patron record.
11020 Input multiple choices separated by \|
11022 .. _borrowerunwantedfield-label:
11024 BorrowerUnwantedField
11025 ''''''''''''''''''''''''''''''''''''''''''''''''''
11027 Asks: The following database columns will not appear on the patron entry
11032 - This preference enables the system administrator to choose which
11033 fields your library doesn't need to see on the patron entry form.
11034 Enter field names separated by \| (bar).
11038 Separate columns with \|
11042 For help with field names, ask your system administrator or `view
11044 structure <http://schema.koha-community.org/tables/borrowers.html>`__
11045 associated with the borrowers table.
11047 .. _cardnumberlength-label:
11050 ''''''''''''''''''''''''''''''''''''''''
11052 Asks: Card numbers for patrons must be \_\_\_ characters long.
11056 - The length can be a single number to specify an exact length, a range
11057 separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum
11058 (i.e., ',Max'). If 'cardnumber' is included in the
11059 :ref:`BorrowerMandatoryField` list, the
11060 minimum length, if not specified here, defaults to one.
11062 .. _checkdigit-label:
11065 ''''''''''''''''''''''''''''
11069 Asks: \_\_\_ check and construct borrower card numbers in the Katipo
11080 This overrides :ref:`autoMemberNum` if on.
11082 .. _checkprevcheckout-label:
11085 ''''''''''''''''''''''''''''''''''''''''''
11089 Asks: \_\_\_ check borrower checkout history to see if the current item has been checked out before.
11097 - Unless overridden, do
11099 - Unless overridden, do not
11103 When the value of this system preference is set to 'do', Koha will look at the
11104 patron's circulation history to see if they have checked this item out before.
11105 An alert will show up on the screen indicating that patron has indeed checked
11106 this item out. Staff will be prompted to allow the checkout to occur.
11107 If the vaulue is set to 'don't', Koha will not check the patron's circulation
11108 history. When the value is set to 'Unless overridden, do', this will check the
11109 patron's circulation history even if there are fines, fees, and/or holds on the
11110 patron's account. Lastly, if the value is set to 'Unless overridden, don't',
11111 Koha will not check circulation history regardless of fines, fees, and/or holds.
11115 This system preference will not work for patrons that have chosen to anonymize
11116 their reading history.
11118 .. _defaultpatronsearchfields-label:
11120 DefaultPatronSearchFields
11121 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11123 Default: surname,firstname,othernames,cardnumber,userid
11125 Asks: \_\_\_ Comma separated list defining the default fields to be used during a patron search
11127 **Important** possible values can be found in the borrowers table of Koha's schema
11128 located at http://schema.koha-community.org/
11130 .. _enableborrowerfiles-label:
11132 EnableBorrowerFiles
11133 ''''''''''''''''''''''''''''''''''''''''''''''
11137 Asks: \_\_\_ enable the ability to upload and attach arbitrary files to
11148 - When enabled this will add a 'Files' tab to the left of the patron
11149 detail page where you can view and upload files to the patron record.
11151 .. _enhancedmessagingpreferences-label:
11153 EnhancedMessagingPreferences
11154 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11158 Asks: \_\_\_ staff to manage which notices patrons will receive and when
11159 they will receive them.
11169 This only applies to certain kinds of notices, overdue notices will
11170 be sent based on the library's rules, not the patron's choice.
11174 To manage if patrons have also access to these settings, use
11175 :ref:`EnhancedMessagingPreferencesOPAC`.
11179 - These messages are in addition to the overdue notices that the
11180 library sends. The difference between these notices and overdues is
11181 that the patron can opt-in and out of these. Setting this preference
11182 to 'Allow' will allow staff to choose for patrons to receive any one
11183 of the following messages:
11185 - Item Checkout : A notice that lists all the of the items the
11186 patron has just checked out and/or renewed, this is an electronic
11187 form of the checkout receipt
11189 - Item Due : A notice on the day and item is due back at the library
11191 - Hold Filled : A notice when you have confirmed the hold is waiting
11194 - Item Checkin : A notice that lists all the of the items the patron
11195 has just checked in
11197 - Advanced Notice : A notice in advance of the patron's items being
11198 due (Staff can choose the number of days in advance)
11200 .. _enhancedmessagingpreferencesopac-label:
11202 EnhancedMessagingPreferencesOPAC
11203 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11207 Asks: \_\_\_ patron messaging setting on the OPAC
11217 :ref:`EnhancedMessagingPreferences`
11218 must be enabled for messaging options to show in the OPAC
11222 - These messages are in addition to the overdue notices that the
11223 library sends. The difference between these notices and overdues is
11224 that the patron can opt-in and out of these. Setting this preference
11225 to 'Allow' will allow patrons to choose to receive any one of the
11226 following messages:
11228 - Item Checkout : A notice that lists all the of the items the
11229 patron has just checked out and/or renewed, this is an electronic
11230 form of the checkout receipt
11232 - Item Due : A notice on the day and item is due back at the library
11234 - Hold Filled : A notice when you have confirmed the hold is waiting
11237 - Item Checkin : A notice that lists all the of the items the patron
11238 has just checked in
11240 - Advanced Notice : A notice in advance of the patron's items being
11241 due (The patron can choose the number of days in advance)
11243 .. _extendedpatronattributes-label:
11245 ExtendedPatronAttributes
11246 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11250 Asks: \_\_\_ searching, editing and display of custom attributes on
11259 - Define attributes in Koha administration
11261 - Get there: More > Administration > :ref:`Patron Attribute
11262 Types <patron-attribute-types-label>`
11266 - Patron attributes are library-defined custom fields that can be
11267 applied to patron records.
11271 Use custom attributes for fields that the default patron record does
11272 not support such as driver's license number or student ID number.
11274 .. _feeonchangepatroncategory-label:
11276 FeeOnChangePatronCategory
11277 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11281 Asks: \_\_\_ charge a fee when a patron changes to a category with an
11290 .. _intranetreadinghistory-label:
11292 intranetreadinghistory
11293 ''''''''''''''''''''''''''''''''''''''''''''''''''''
11297 Asks: \_\_\_ staff to access a patron's checkout history.
11301 If you have the :ref:`OPACPrivacy` preference set to
11302 'Allow' and the patron has decided to not have their history kept
11303 staff will only see currently checked out items.
11313 Reading history is still stored, regardless of staff being allowed
11314 access or not unless the patron has chosen to have their history
11315 anonymized via their :ref:`privacy page <my-privacy-label>`.
11320 ''''''''''''''''''''''
11324 Asks: The late fine for all checkouts will only go up to \_\_\_ USD.
11328 - This preference controls the default cap on fines accrued by the
11329 patron. Leaving this preference blank means that there is no cap on
11330 the amount of fines a patron can accrue. If you'd like, single item
11331 caps can be specified in the :ref:`circulation rules
11332 matrix <circulation-and-fine-rules-label>`.
11334 .. _membershipexpirydaysnotice-label:
11336 MembershipExpiryDaysNotice
11337 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11339 Asks: Send an account expiration notice when a patron's card will expire
11344 - If you would like to notify patrons that their accounts are about to
11345 expire then you can enter a number of days before expiration in this
11346 preference. The notice text can be customized in the :ref:`Notices &
11347 Slips <notices-&-slips-label>` tool.
11351 You will need to enable the :ref:`membership expiry cron
11352 job <notify-patrons-of-expiration-label>` for this notice to send.
11354 .. _minpasswordlength-label:
11357 ''''''''''''''''''''''''''''''''''''''''''
11361 Asks: Login passwords for staff and patrons must be at least \_\_\_
11366 This applies to both the staff login and the patron OPAC login.
11368 .. _notifyborrowerdeparture-label:
11370 NotifyBorrowerDeparture
11371 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
11375 Asks: Show a notice that a patron is about to expire \_\_\_ days
11380 - When the patron attempts to check out materials, a warning will
11381 appear in the check out window of the Staff Client telling the
11382 librarian that the patrons account is about to expire.
11386 This notice will appear on the patron's record in the staff client.
11388 .. _patronimages-label:
11391 ''''''''''''''''''''''''''''''''
11395 Asks: \_\_\_ images to be uploaded and shown for patrons on the staff
11406 - If this preference is set to 'Allow' the staff will be able to upload
11407 images of patrons either :ref:`one by one <add-patron-images-label>` or :ref:`in
11408 bulk <upload-patron-images-label>`. Patrons images will show on the detail
11409 page to the left of the patron information. They can also show in the
11410 OPAC if you set the :ref:`OPACpatronimages` preference
11411 or in the self check out module if you set the
11412 :ref:`ShowPatronImageInWebBasedSelfCheck`
11415 .. _patronquickaddfields-label:
11417 PatronQuickAddFields
11418 ''''''''''''''''''''''''''''''''''''''''''''''''
11422 Asks: \_\_\_ (separate columns with |) add these fields to the patron
11423 quick add form when entering a new patron. Displays only mandatory fields
11424 and fields specified here. If applicable, the guarantor form will be shown
11425 as well, individual fields in that form will be ignored.
11427 .. _patronsperpage-label:
11430 ''''''''''''''''''''''''''''''''''''
11434 Asks: By default, show \_\_\_ results per page in the staff client.
11438 - This preference will let you define how many patrons to show on
11439 patron search results pages.
11441 .. _smssenddriver,-smssendusername,-and-smssendpassword-label:
11443 SMSSendDriver, SMSSendUsername, and SMSSendPassword
11444 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11446 Asks: Use the SMS::Send:: \_\_\_ driver to send SMS messages. Define a
11447 username/login \_\_\_ and a password \_\_\_.
11451 Please refer to your national laws concerning the sending of bulk
11452 SMS messages before enabling this feature.
11456 - There are two options for using SMS in Koha. You can use the Email
11457 protocol for free by entering 'Email' as the SMSSendDriver or you can
11458 pay for a SMS driver. Some examples of values for the driver are:
11460 - SMS::Send::Us::Ipipi
11462 - SMS::Send::US::TMobile
11464 - SMS::Send::US::Verizon
11466 - SMS::Send::IN::Unicel
11468 Additional values can be found here:
11469 http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
11473 Only drivers available as Perl modules will work in this
11474 preference, so make sure a Perl module is available before
11475 choosing an SMS service.
11477 Once a driver is entered in the preference an option will appear in
11478 the staff client and the OPAC on the patron messaging form to choose
11479 to receive messages as SMS
11481 SMSSendDriver Options
11487 :ref:`EnhancedMessagingPreferences` for
11490 .. _statisticsfields-label:
11493 ''''''''''''''''''''''''''''''''''''''''
11495 Default: location\|itype\|ccode
11497 Asks: Show the following fields from the items database table as columns
11498 on the statistics tab on the patron record: \_\_\_
11500 Statistics on Patron Record
11505 Enter the values separated by bars (\|)
11509 - This preference lets you set which fields will show on the patron
11510 record on the Statistics tab.
11512 .. _talkingtechitivaphonenotification-label:
11514 TalkingTechItivaPhoneNotification
11515 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11519 Asks: \_\_\_ patron phone notifications using Talking Tech i-tiva
11520 (overdues, predues and holds notices currently supported).
11530 - To learn more about setting up this third party product view the
11531 `Talking Tech Appendix <#talkingtechappendix>`__.
11535 Requires that you have
11536 :ref:`EnhancedMessagingPreferences` set
11539 .. _tracklastpatronactivity-label:
11541 TrackLastPatronActivity
11542 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
11546 Asks: \_\_\_ track last patron activity. Everytime a patron will connect,
11547 the borrowers.lastseen will be updated with the current time.
11555 .. _uppercasesurnames-label:
11558 ''''''''''''''''''''''''''''''''''''''''''
11562 Asks: \_\_\_ store and display surnames (last names) in upper case.
11570 .. _usedischarge-label:
11573 ''''''''''''''''''''''''''''''''
11575 Default: Don't allow
11577 Asks: \_\_\_ librarians to discharge borrowers and borrowers to request
11588 - A discharge is a certificate that says the patron has no current
11589 checkouts, no holds and owe no money.
11593 In France a "quitus" ("discharge") is needed if you want to
11594 register for an account in a library or a university).
11598 Academic libraries often require that you have a clear record at
11599 the library before you can graduate.
11601 .. _norwegian-patron-database-label:
11603 Norwegian patron database
11604 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11606 .. _failedloginattempts-label:
11608 FailedLoginAttempts
11609 ''''''''''''''''''''''''''''''''''''''''''''''
11613 Asks: Block a patron's account if it reaches \_\_\_ failed login attempts.
11615 .. _norwegianpatrondbenable-&-norwegianpatrondbendpoint-label:
11617 NorwegianPatronDBEnable & NorwegianPatronDBEndpoint
11618 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11620 NorwegianPatronDBEnable Default: Disable
11622 Asks: \_\_\_ the ability to communicate with the Norwegian national
11623 patron database via the \_\_\_ endpoint.
11631 .. _norwegianpatrondbsearchnlafterlocalhit-label:
11633 NorwegianPatronDBSearchNLAfterLocalHit
11634 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11638 Asks: \_\_\_ search the Norwegian national patron database after a local
11639 search result was found.
11647 .. _norwegianpatrondbusername-&-norwegianpatrondbpassword-label:
11649 NorwegianPatronDBUsername & NorwegianPatronDBPassword
11650 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11652 Asks: Communicate with the Norwegian national patron database using the
11653 username \_\_\_ and the password \_\_\_.
11657 - You can get these from "Base Bibliotek", which is maintained by the
11658 Norwegian National Library.
11660 .. _searching-label:
11663 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11665 *Get there:* More > Administration > Global System Preferences >
11668 .. _features-label:
11671 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11673 .. _enablesearchhistory-label:
11675 EnableSearchHistory
11676 ''''''''''''''''''''''''''''''''''''''''''''''
11678 Default: Don't keep
11680 Asks: \_\_\_ patron search history in the staff client.
11686 - KeepEnableSearchHistory
11690 - This preference controls whether the staff client keeps search
11691 history for logged in users. Search history will be accessible under
11692 the link to your account in the top right of the staff client.
11694 .. _includeseefrominsearches-label:
11696 IncludeSeeFromInSearches
11697 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11699 Default: Don't include
11701 Asks: \_\_\_ *see from* (non-preferred form) headings in bibliographic
11712 - When this preference is set to include the search engine indexer will
11713 insert *see from* headings from authority records into bibliographic
11714 records when indexing, so that a search on an obsolete term will turn
11715 up relevant records. For example when you search for cookery (the old
11716 term) you get titles with the heading of cooking (the new term).
11720 You will need to reindex your bibliographic database when changing
11723 .. _opacgroupresults-label:
11726 ''''''''''''''''''''''''''''''''''''''''
11730 Asks: \_\_\_ PazPar2 to group similar results on the OPAC.
11740 This requires that `PazPar2 <http://www.indexdata.com/pazpar2>`__ is
11741 set up and running.
11743 .. _queryautotruncate-label:
11746 ''''''''''''''''''''''''''''''''''''''''''
11748 Default: automatically
11750 Asks: Perform wildcard searching (where, for example, Har would match
11751 Harry and harp) \_\_\_ (The \* character would be used like so: Har\* or
11758 - only if \* is added
11762 - This setting allows for searches to be automatically truncated or for
11763 additional characters to be added to the end of a search string. When
11764 set to "automatically" the search string automatically ends with a
11765 wildcard function. For example, a search for the word "invent" with
11766 auto truncation enabled will also retrieve results for inventor,
11767 invention, inventory, etc. If you don't want this to happen
11768 automatically you can still be perform wildcard searches manually by
11769 adding an asterisk (\*). Typing "invent\*" even with auto truncation
11770 disabled will retrieve the same inventor, invention, inventory
11771 results. Auto truncation bypasses the necessity to type long search
11772 strings in their entirety.
11774 .. _queryfuzzy-label:
11777 ''''''''''''''''''''''''''''
11781 Asks: \_\_\_ to match similarly spelled words in a search (for example,
11782 a search for flang would also match flange and fang)
11792 - This preference enables "fuzzy" searching, in which the search engine
11793 returns results that are similar to, but not exactly matching, the
11794 word or words entered by the user. This preference enables the search
11795 function to compensate for slightly misspelled names or phrases.
11799 Requires that :ref:`UseICU` set to 'Not using'
11801 .. _querystemming-label:
11804 ''''''''''''''''''''''''''''''''''
11808 Asks: \_\_\_ to match words of the same base in a search
11816 - A search for enabling would also match enable and enabled
11820 - This preference enables word stemming. Stemming allows the search
11821 function to return multiple versions of the same word, as well as
11822 related terms (i.e., both fish and fishing would be returned).
11824 .. _queryweightfields-label:
11827 ''''''''''''''''''''''''''''''''''''''''''
11831 Asks: \_\_\_ ranking of search results by relevance
11839 .. _tracecompletesubfields-label:
11841 TraceCompleteSubfields
11842 ''''''''''''''''''''''''''''''''''''''''''''''''''''
11846 Asks: \_\_\_ subject tracings in the OPAC and Staff Client to search
11847 only for complete-subfield matches.
11853 - Searches for subject keywords (example:
11854 opac-search.pl?q=su:World%20Wide%20Web)
11858 - Searches for complete subject fields (example:
11859 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)
11863 - When TraceCompleteSubfields is set to "force," clicking on links in
11864 non-authority controlled subject tracings will only find other
11865 records where the entire subfields match. Leaving it at "don't force"
11866 does a keyword search of the subject indexes.
11870 This preference assumes that you're using XSLT stylesheets as set in
11871 the :ref:`OPACXSLTDetailsDisplay` preference.
11873 .. _tracesubjectsubdivisions-label:
11875 TraceSubjectSubdivisions
11876 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11880 Asks: \_\_\_ subdivisions for searches generated by clicking on subject
11887 - Searches for subject keywords (example:
11888 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)
11892 - Searches for complete subject fields (example:
11893 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))
11897 - When TraceSubjectSubdivisions is set to "Include," if you click on a
11898 subject with subdivisions (subfields other than 'a') they will be
11899 searched along with the subject heading (subfield 'a'). To have only
11900 the subject heading (subfield 'a') searched, set this preference to
11905 This preference assumes that you're using XSLT stylesheets as set in
11906 the :ref:`OPACXSLTDetailsDisplay` preference.
11911 ''''''''''''''''''''
11915 Asks: \_\_\_ ICU Zebra indexing.
11925 - ICU is a set of code libraries providing Unicode and Globalization
11926 support for software applications. What this means is ICU Zebra
11927 indexing is only necessary if you use non-roman characters in your
11928 cataloging. If using ICU Zebra indexing you will want to not use
11933 This setting will not affect Zebra indexing, it should only be used
11934 to tell Koha that you have activated ICU indexing if you have
11935 actually done so, since there is no way for Koha to figure this out
11940 Talk to your system administrator when changing this preference to
11941 make sure that your system is set up properly for this to work.
11943 .. _usequeryparser-label:
11946 ''''''''''''''''''''''''''''''''''''
11948 Default: Do not try
11950 Asks: \_\_\_ to use the QueryParser module for parsing queries.
11954 Enabling this will have no impact if you do not have QueryParser
11955 installed, and everything will continue to work as usual.
11965 - This preference enables an experimental new query parser which opens
11966 the door for a more expressive and more-effective search syntax.
11968 .. _results-display-label:
11971 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11973 .. _defaultsortfield-&-defaultsortorder-label:
11975 defaultSortField & defaultSortOrder
11976 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
11978 defaultSortField Default: author
11980 defaultSortOrder Default: ascending
11982 Asks: By default, sort search results in the staff client by \_\_\_,
11987 - These preferences set the default sort field and sort order for
11988 searches on the staff side. Regardless of your choice, the other sort
11989 options are still available in the drop down list on the advanced
11992 defaultSortField Values:
12000 - date of publication
12006 - total number of checkouts
12008 defaultSortOrder Values:
12018 .. _displayfacetcount-label:
12021 ''''''''''''''''''''''''''''''''''''''''''
12023 Default: Don't show
12025 Asks: \_\_\_ facet counts.
12029 - This preference lets you decide if you show how many times a facet is
12030 used in your search results in the OPAC and the staff client. The
12031 relevance of these numbers highly depends on the value of the
12032 :ref:`maxRecordsForFacets` preference. Showing
12033 these numbers can potentially effect the performance of your
12034 searching, so test your system with different values for this
12035 preference to see what works best.
12043 Number of times each Facet is found in results
12046 .. _displaylibraryfacets-label:
12048 DisplayLibraryFacets
12049 ''''''''''''''''''''''''''''''''''''''''''''''''
12051 Default: holding library
12053 Asks: Show facets for \_\_\_
12057 - both home and holding library
12065 - This preferenc controls the libraries facet that displays on search
12066 results in the staff and opac. The value selected here will determine
12067 which library(s) show in the facets when a search is run.
12069 .. _facetlabeltruncationlength-label:
12071 FacetLabelTruncationLength
12072 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12076 Asks: Truncate facets length to \_\_\_ characters, in OPAC/staff
12081 - In the OPAC and the staff client your facets are cut off at 20
12082 characters by default. Depending on your layout this may be too many
12083 or two few letters, this preference lets you decide what number is
12084 best for your library's design.
12086 .. _facetmaxcount-label:
12089 ''''''''''''''''''''''''''''''''''
12093 Asks: Show up \_\_\_ to facets for each category.
12097 - This preference allows you to control how many possible limits show
12098 under each heading (Author, Series, Topics, etc) on the facets in the
12101 .. _maxitemsinsearchresults-label:
12103 maxItemsInSearchResults
12104 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
12108 Asks: Show up to \_\_\_ items per biblio in the search results
12112 - This preference will let you set how many results display by default
12113 when a search is run on the Staff Client.
12115 .. _maxrecordsforfacets-label:
12117 maxRecordsForFacets
12118 ''''''''''''''''''''''''''''''''''''''''''''''
12122 Asks: Build facets based on \_\_\_ records from the search results.
12126 - By default Koha only bases facets on the first page of results
12127 (usually 20 results). This preference lets you tell Koha to based the
12128 facet descriptions and numbers on any number of search results
12129 returned. The higher this number the longer it will take for your
12130 search results to return, so test with various different values to
12131 find the best balance for your library.
12133 .. _maxsearchresultsitemsperrecordstatuscheck-label:
12135 MaxSearchResultsItemsPerRecordStatusCheck
12136 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12140 Asks: For records with many items, only check the availability status
12141 for the first \_\_\_ items.
12145 - Availability statuses may show incorrectly in search results if a
12146 record has more items than the limit set. Statuses will display
12147 correctly in the record details. Leave empty for no limit.
12149 .. _numsearchresults-label:
12152 ''''''''''''''''''''''''''''''''''''''''
12156 Asks: By default, show \_\_\_ results per page in the staff client.
12158 .. _opacdefaultsortfield-and-opacdefaultsortorder-label:
12160 OPACdefaultSortField & OPACdefaultSortOrder
12161 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12163 OPACdefaultSortField Default: relevance
12165 OPACdefaultSortOrder Default: ascending
12167 Asks: By default, sort search results in the OPAC by \_\_\_, \_\_\_
12171 - These preferences set the default sort field and sort order for
12172 searches on the OPAC. Regardless of your choice, the other sort
12173 options are still available in the drop down list on the advanced
12176 OPACdefaultSortField Values:
12184 - date of publication
12190 - total number of checkouts
12192 OPACdefaultSortOrder Values:
12202 .. _opacitemsresultsdisplay-label:
12204 OPACItemsResultsDisplay
12205 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
12207 Default: Don't show
12209 Asks: \_\_\_ an item's branch, location and call number in OPAC search
12220 - This setting selects the information about an item that will display
12221 in the search results page of the OPAC. The results can display the
12222 status of an item and/or full details including branch, location, and
12223 call number. While the 'Show' option allows for more information to
12224 be displayed on the search results page, the information can be
12225 overwhelming for large collections with multiple branches.
12227 .. _opacnumsearchresults-label:
12229 OPACnumSearchResults
12230 ''''''''''''''''''''''''''''''''''''''''''''''''
12234 Asks: By default, show \_\_\_ results per page in the OPAC.
12236 .. _searchwithisbnvariations-label:
12238 SearchWithISBNVariations
12239 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12241 Default: don't search
12243 Asks: When searching on the ISBN index, \_\_\_ on all variations of the
12254 - With this preference set to search you'll be able to search for ISBNs
12255 even if there are dashes or spaces in the field. So if you search for
12256 9781843345855 but the ISBN was cataloged as 978-1843345855 you'll
12257 still be able to find it if this preference is set to 'search'.
12261 This preference has no effect if
12262 :ref:`UseQueryParser` is on
12264 .. _unimarcauthorsfacetsseparator-label:
12266 UNIMARCAuthorsFacetsSeparator
12267 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12271 Asks: Use the following text as separator for UNIMARC authors facets \_\_\_
12273 .. _search-form-label:
12276 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12278 .. _advancedsearchlanguages-label:
12280 AdvancedSearchLanguages
12281 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
12283 Asks: Limit the languages listed in the advanced search drop-down to the
12284 \_\_\_ ISO 639-2 language codes (separate values with \| or ,).
12288 - This preference will allow you to decide what languages show in the
12289 pull down menu on the advanced search page in the OPAC and the staff
12290 client. If this preference is left blank, all languages will show. To
12291 limit the languages that are shown enter their `ISO 639-2 language
12292 codes <http://www.loc.gov/standards/iso639-2/php/code_list.php>`__
12293 separated by comma ( , ) or bar ( \| ). For example to limit listing
12294 to French and Italian, enter ita\|fre.
12296 .. _advancedsearchtypes-label:
12298 AdvancedSearchTypes
12299 ''''''''''''''''''''''''''''''''''''''''''''''
12303 Asks: Show tabs in OPAC and staff-side advanced search for limiting
12304 searches on the \_\_\_ fields (separate values with \|).
12308 - On the advanced search page you can choose to allow filters on one or
12309 all of the following: Item types (itemtypes), Collection Codes
12310 (ccode) and Shelving Location (loc). If you would like to be able to
12311 limit searches on item type and shelving location for example you
12312 would enter itemtypes\|loc in the preference input box. The order of
12313 these fields will determine the order of the tabs in the OPAC and
12314 staff client advanced search screens. Values within the search type
12315 are OR'ed together, while each different search type is AND'ed
12316 together in the query limits. The current stored values are supported
12317 without any required modification.Each set of advanced search fields
12318 are displayed in tabs in both the OPAC and staff client. The first
12319 value in the AdvancedSearchTypes syspref is the selected tab; if no
12320 values are present, "itemtypes" is used. For non-itemtype values, the
12321 value in AdvancedSearchTypes must match the Authorised Value name,
12322 and must be indexed with 'mc-' prefixing that name.
12324 Searching by Item Type and Shelving Location
12327 .. _expandedsearchoption-label:
12329 expandedSearchOption
12330 ''''''''''''''''''''''''''''''''''''''''''''''''
12332 Default: don't show
12334 Asks: By default, \_\_\_ "More options" on the OPAC and staff advanced
12343 .. _intranetnumberspreferphrase-label:
12345 IntranetNumbersPreferPhrase
12346 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12350 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
12351 standard number staff client searches
12361 - When searching by call number and standard number (biblionumber) in
12362 Koha Staff Client you can choose to force the search to be a phrase
12363 search by setting this preference to 'use.' This will allow for more
12364 accurate results over doing a general keyword field search.
12366 .. _loadsearchhistorytothefirstloggeduser-label:
12368 LoadSearchHistoryToTheFirstLoggedUser
12369 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12373 Asks: Load the unlogged history to the next user. \_\_\_ history to the next client.
12381 .. _opacnumberspreferphrase-label:
12383 OPACNumbersPreferPhrase
12384 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
12388 Asks: By default, \_\_\_ the operator "phr" in the callnumber and
12389 standard number OPAC searches
12399 - When searching by call number and standard number (biblionumber) in
12400 the Koha OPAC you can choose to force the search to be a phrase
12401 search by setting this preference to 'use.' This will allow for more
12402 accurate results over doing a general keyword field search.
12407 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
12409 *Get there:* More > Administration > Global System Preferences > Serials
12411 .. _makepreviousserialavailable-label:
12413 makePreviousSerialAvailable
12414 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12416 Default: Do not make
12418 Asks: \_\_\_ previous serial automatically available when receiving a
12419 new serial issue. The previous issue can also be set to another item
12420 type when receiving a new one. Please note that the :ref:`item-level\_itypes <item-level\_itypes-label>`
12421 syspref must be set to specific item.
12429 .. _opacserialdefaulttab-label:
12431 opacSerialDefaultTab
12432 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12434 Default: Subscriptions tab
12436 Asks: Show \_\_\_ as default tab for serials in OPAC.
12442 - Serial Collection tab
12446 Please note that the Serial Collection tab is currently available
12447 only for systems using the UNIMARC standard.
12449 Serial Collection tab
12452 - Subscriptions tab
12457 .. _opacserialissuedisplaycount-label:
12459 OPACSerialIssueDisplayCount
12460 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12464 Asks: Show the \_\_\_ previous issues of a serial on the OPAC.
12468 - This preference allows the administrator to select the number of
12469 recent issues for each serial which appear in the OPAC when the
12470 serial is accessed. This is just the default value, patrons can
12471 always click to see a full list of serials.
12473 .. _renewserialaddssuggestion-label:
12475 RenewSerialAddsSuggestion
12476 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12480 Asks: \_\_\_ a suggestion for a biblio when its attached serial is
12491 - If set to "Add", this preference will automatically add a serial to
12492 the Acquisitions Purchase Suggestions menu when clicking the 'renew'
12493 option. If you don't use the Acquisitions module to manage serials
12494 purchases it's best to leave this set as 'Don't add.'
12496 .. _routinglistaddreserves-label:
12498 RoutingListAddReserves
12499 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12503 Asks: \_\_\_ received serials on hold if they are on a routing list.
12511 .. _routinglistnote-label:
12514 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12516 Asks: Include following note on all routing lists
12520 - Text entered in this box will appear below the routing list
12523 .. _routingserials-label:
12526 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12530 Asks: \_\_\_ received serials to the routing list.
12534 - This preference determines if serials routing lists are enabled or
12535 disabled for the library. When set to "Add", serials routing is
12536 enabled and a serial can be directed through a list of people by
12537 identifying who should receive it next. The list of people can be
12538 established for each serial to be passed using the Serials module.
12539 This preference can be used to ensure each person who needs to see a
12540 serial when it arrives at the library will get it. Learn more in the
12541 :ref:`routing list <create-a-routing-list-label>` section of this manual.
12549 .. _staffserialissuedisplaycount-label:
12551 StaffSerialIssueDisplayCount
12552 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12556 Asks: Show the \_\_\_ previous issues of a serial on the staff client.
12560 - This preference allows the administrator to select the number of
12561 recent issues for each serial which appear in the Staff Client when
12562 the serial is accessed. This is just the default value, staff members
12563 can always click to see a full list of serials.
12565 .. _subscriptionduplicatedroppedinput-label:
12567 SubscriptionDuplicateDroppedInput
12568 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12570 Asks: List of fields which must not be rewritten when a subscription is
12571 duplicated (Separated by pipe \|) \_\_\_
12575 - When duplicating a subscription sometimes you don't want all of the
12576 fields duplicated, using this preference you can list the fields that
12577 you don't want to be duplicated. These field names come from the
12578 subscription table in the Koha database. Learn what fields are in
12579 that table on the `Koha DB
12580 Schema <http://schema.koha-community.org/tables/subscription.html>`__
12583 .. _subscriptionhistory-label:
12585 SubscriptionHistory
12586 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12588 Default: full history
12590 Asks: When showing the subscription information for a bibliographic
12591 record, preselect \_\_\_ view of serial issues.
12607 - This preference determines what information appears in the OPAC when
12608 the user clicks the More Details option. The 'brief' option displays
12609 a one-line summary of the volume and issue numbers of all issues of
12610 that serial held by the library. The 'full' option displays a more
12611 detailed breakdown of issues per year, including information such as
12612 the issue date and the status of each issue.
12614 .. _staff-client-label:
12617 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12619 *Get there:* More > Administration > Global System Preferences > Staff
12622 .. _appearance-label:
12625 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12627 .. _display856uasimage-label:
12630 ''''''''''''''''''''''''''''''''''''''''''''
12632 Default: Neither details or results page
12634 Asks: Display the URI in the 856u field as an image on: \_\_\_
12638 - Both results and details pages
12642 Not implemented yet
12648 :ref:`XSLTDetailsDisplay` needs to be on
12649 for this preference to work.
12651 Showing the 856u as an image
12654 - Neither details or results page
12656 - Results page only
12660 Not yet implemented
12664 - In addition to this option being set, the corresponding XSLT option
12665 must be turned on. Also, the corresponding 856q field must have a
12666 valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
12667 starting with "image/"), or the generic indicator "img" entered in
12668 the field. When all of the requirements are met, an image file will
12669 be displayed instead of the standard link text. Clicking on the image
12670 will open it in the same way as clicking on the link text. When you
12671 click on the image it should open to full size, in the current window
12672 or in a new window depending on the value in the system pref
12673 :ref:`OPACURLOpenInNewWindow`.
12678 .. _displayiconsxslt-label:
12681 ''''''''''''''''''''''''''''''''''''''''
12685 Asks: \_\_\_ the format, audience, and material type icons in XSLT
12686 MARC21 results and detail pages in the staff client.
12690 :ref:`XSLTResultsDisplay` and/or
12691 :ref:`XSLTDetailsDisplay` must be set to use an
12692 XSLT stylesheet (default or custom) for these icons to show.
12705 See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
12708 .. _intranet\_includes-label:
12711 '''''''''''''''''''''''''''''''''''''''''''
12715 Asks: Use include files from the \_\_\_ directory in the template
12716 directory, instead of includes/. (Leave blank to disable)
12718 .. _intranetcirculationhomehtml-label:
12720 IntranetCirculationHomeHTML
12721 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12723 Asks: Show the following HTML in its own div on the bottom of the home
12724 page of the circulation module: IntranetCirculationHomeHTML
12726 .. _intranetcolorstylesheet-label:
12728 intranetcolorstylesheet
12729 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
12731 Asks: Include the additional CSS stylesheet \_\_\_ to override specified
12732 settings from the default stylesheet
12736 - This preference is used to set the background color and style of the
12737 Staff Client. The value is a .css file. The system administrator
12738 should determine which file is appropriate. Enter just a filename, a
12739 full local path or a complete URL starting with http:// (if the file
12740 lives on a remote server). Please note that if you just enter a
12741 filename, the file should be in the css subdirectory for each active
12742 theme and language within the Koha templates directory. A full local
12743 path is expected to start from your HTTP document root.
12747 Leave this field blank to disable.
12749 .. _intranetfavicon-label:
12752 ''''''''''''''''''''''''''''''''''''''
12754 Asks: Use the image at \_\_\_ for the Staff Client's favicon.
12758 This should be a complete URL, starting with http://
12762 Turn your logo into a favicon with the `Favicon
12763 Generator <http://antifavicon.com/>`__.
12767 - The favicon is the little icon that appears next to the URL in the
12768 address bar in most browsers. The default value for this field (if
12769 left blank) is the small 'K' in the Koha logo.
12771 Default Koha Favicon
12774 .. _intranetmainuserblock-label:
12776 IntranetmainUserblock
12777 ''''''''''''''''''''''''''''''''''''''''''''''''''
12779 Asks: Show the following HTML in its own column on the main page of the
12782 Sample HTML for IntranetmainUserblock
12785 Message from IntranetmainUserblock as it appears on the Staff Client
12789 .. _intranetnav-label:
12792 ''''''''''''''''''''''''''''''
12794 Asks: Show the following HTML in the More menu at the top of each page
12795 on the staff client (should be a list of links or blank)
12797 .. _intranetreportshomehtml-label:
12799 IntranetReportsHomeHTML
12800 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
12802 Asks: Show the following HTML in its own div on the bottom of the home
12803 page of the reports module: HTML on Reports page
12805 .. _intranetslipprinterjs-label:
12807 IntranetSlipPrinterJS
12808 ''''''''''''''''''''''''''''''''''''''''''''''''''
12810 Asks: Use the following JavaScript for printing slips.
12814 - The most logical use of this preference is in conjunction with the
12815 `jsPrintSetup <http://jsprintsetup.mozdev.org/>`__ Firefox add-on.
12816 Learn more about this preference and the add-on setup on the Koha
12818 http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently.
12820 .. _intranetstylesheet-label:
12823 ''''''''''''''''''''''''''''''''''''''''''''
12825 Asks: Use the CSS stylesheet \_\_\_ on all pages in the staff interface,
12826 instead of the default css (used when leaving this field blank).
12830 - The Intranetstylesheet preference is a layout and design feature for
12831 the intranet or staff client. This preference allows a library to
12832 customize the appearance of the Staff Client. Enter just a filename,
12833 a full local path or a complete URL starting with http:// (if the
12834 file lives on a remote server). Please note that if you just enter a
12835 filename, the file should be in the css subdirectory for each active
12836 theme and language within the Koha templates directory. A full local
12837 path is expected to start from your HTTP document root.
12839 .. _intranetusercss-label:
12842 ''''''''''''''''''''''''''''''''''''''
12844 Asks: Include the following CSS on all pages in the staff client
12846 .. _intranetuserjs-label:
12849 ''''''''''''''''''''''''''''''''''''
12851 Asks: Include the following JavaScript on all pages in the staff
12856 - This preference allows the administrator to enter JavaScript or
12857 JQuery that will be embedded across all pages of the Staff Client.
12858 Administrators may use this preference to customize some of the
12859 interactive sections of Koha, customizing the text for the login
12860 prompts, for example. Sample JQuery scripts used by Koha libraries
12861 can be found on the wiki:
12862 http://wiki.koha-community.org/wiki/JQuery_Library.
12867 ''''''''''''''''''''''
12869 Asks: Include the stylesheet at \_\_\_ on Issue and Reserve Slips.
12873 This should be a complete URL, starting with http://
12877 - If you would like to style your receipts or slips with a consistent
12878 set of fonts and colors you can use this preference to point Koha to
12879 a stylesheet specifically for your slips.
12881 .. _staffclientbaseurl-label:
12884 ''''''''''''''''''''''''''''''''''''''''''''
12886 Asks: The staff client is located at http:// \_\_\_
12888 .. _template-label:
12891 ''''''''''''''''''''''''
12895 Asks: Use the \_\_\_ theme on the staff interface.
12903 Do not include a trailing slash in the URL this will break links
12904 created using this URL. (example: www.google.com not
12907 .. _xsltdetailsdisplay-label:
12910 ''''''''''''''''''''''''''''''''''''''''''''
12914 Asks: Display details in the staff client using XSLT stylesheet at
12919 - leave empty to not use the XSLT stylesheet
12921 - In previous versions of Koha this was the setting that read
12924 Detail display without XSLT stylesheets
12927 - enter "default" for the default one
12929 Detail display using XSLT stylesheets
12932 - put a path to define a XSLT file
12934 - ex: /path/to/koha/and/your/stylesheet.xsl
12936 - If in a multi-language system you can enter {langcode} in the path
12937 to tell Koha to look in the right language folder
12940 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
12942 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
12944 - put an URL for an external specific stylesheet
12946 - ex: http://mykoha.org/stylesheet.xsl
12950 - XSLT stylesheets allow for the customization of the details shown on
12951 the screen when viewing a bib record. This preference will allow you
12952 either use the default look that comes with Koha or design your own
12955 .. _xsltlistsdisplay-label:
12958 ''''''''''''''''''''''''''''''''''''''''
12962 Asks: Display lists in the staff client using XSLT stylesheet at
12967 - leave empty to not use the XSLT stylesheet
12969 - In previous versions of Koha this was the setting that read
12972 - enter "default" for the default one
12974 - put a path to define a XSLT file
12976 - ex: /path/to/koha/and/your/stylesheet.xsl
12978 - If in a multi-language system you can enter {langcode} in the path
12979 to tell Koha to look in the right language folder
12982 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
12984 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
12986 - put an URL for an external specific stylesheet
12988 - ex: http://mykoha.org/stylesheet.xsl
12992 - XSLT stylesheets allow for the customization of the details shown on
12993 the screen when viewing a list. This preference will allow you
12994 either use the default look that comes with Koha or design your own
12997 .. _xsltresultsdisplay-label:
13000 ''''''''''''''''''''''''''''''''''''''''''''
13004 Asks: Display results in the staff client using XSLT stylesheet at
13009 - leave empty to not use the XSLT stylesheet
13011 - In previous versions of Koha this was the setting that read
13014 - enter "default" for the default one
13016 - put a path to define a XSLT file
13018 - ex: /path/to/koha/and/your/stylesheet.xsl
13020 - If in a multi-language system you can enter {langcode} in the path
13021 to tell Koha to look in the right language folder
13024 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl
13026 - ex. http://mykoha.org/{langcode}/stylesheet.xsl
13028 - put an URL for an external specific stylesheet
13030 - ex: http://mykoha.org/stylesheet.xsl
13034 - XSLT stylesheets allow for the customization of the details shown on
13035 the screen when viewing the search results. This preference will
13036 allow you either use the default look that comes with Koha or design
13037 your own stylesheet.
13042 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13044 .. _audioalerts-label:
13047 ''''''''''''''''''''''''''''''
13049 Default: Don't enable
13051 Asks: \_\_\_ audio alerts for events defined in the audio alerts section
13062 This feature is not supported by all browsers. Requires an HTML5
13065 .. _hidepatronname-label:
13068 ''''''''''''''''''''''''''''''''''''
13072 Asks: \_\_\_ the names of patrons that have items checked out or on hold
13073 on detail pages or the "Place Hold" screen.
13081 .. _intranetbookbag-label:
13084 ''''''''''''''''''''''''''''''''''''''
13088 Asks: \_\_\_ the cart option in the staff client.
13096 .. _intranetcatalogsearchpulldown-label:
13098 IntranetCatalogSearchPulldown
13099 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
13101 Default: Don't show
13103 Asks: \_\_\_ a search field pulldown for 'Search the catalog' boxes.
13111 .. _staffdetailitemselection-label:
13113 StaffDetailItemSelection
13114 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
13118 Asks: \_\_\_ item selection in record detail page.
13128 - This preference lets you choose to show (or not show) checkboxes to
13129 the left of every item in the holdings tab on the detail display of a
13130 record in the staff client. Showing these checkboxes allows the staff
13131 members to select multiple items to edit or delete at once.
13133 Items with the checkboxes enabled
13136 .. _usewysiwyginsystempreferences-label:
13138 UseWYSIWYGinSystemPreferences
13139 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
13141 Default: Don't show
13143 Asks: \_\_\_ WYSIWYG editor when editing certain HTML system
13150 - ShowWYSIWYG Editor in Sys Prefs
13154 - This preference allows you to chang system preferences with HTML in
13155 them to WYSIWYG editors instead of plain text boxes.
13157 .. _viewisbd-label:
13160 ''''''''''''''''''''''''
13164 Asks: \_\_\_ staff to view records in ISBD form on the staff client.
13172 .. _viewlabeledmarc-label:
13175 ''''''''''''''''''''''''''''''''''''''
13179 Asks: \_\_\_ staff to view records in labeled MARC form on the staff
13188 .. _viewmarc-label:
13191 ''''''''''''''''''''''''
13195 Asks: \_\_\_ staff to view records in plain MARC form on the staff
13207 ~~~~~~~~~~~~~~~~~~~~~~~
13209 *Get there:* More > Administration > Global System Preferences > Tools
13211 .. _batch-item-label:
13214 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13216 These preferences are in reference to the :ref:`Batch Item
13217 Modification <batch-item-modification-label>` tool.
13219 .. _maxitemsforbatchdel-label:
13221 MaxItemsForBatchDel
13222 ''''''''''''''''''''''''''''''''''''''''
13226 Asks: Display up to \_\_\_ items in a single deletion batch.
13230 - In the :ref:`batch item delete tool <batch-item-deletion-label>` this will
13231 prevent the display of more than the items you entered in this
13232 preference, but you will be able to delete more than the number you
13235 .. _maxitemsforbatchmod-label:
13237 MaxItemsForBatchMod
13238 ''''''''''''''''''''''''''''''''''''''''
13242 Asks: Process up to \_\_\_ items in a single modification batch.
13246 - In the :ref:`batch item modification
13247 tool <batch-item-modification-label>` this preference will prevent the editing
13248 of more than the number entered here.
13253 ^^^^^^^^^^^^^^^^^^^^^^^^^
13255 .. _newsauthordisplay-label:
13258 ''''''''''''''''''''''''''''''''''''''''''
13260 Default: not at all
13262 Asks: Show the author for news items: \_\_\_
13266 - Both OPAC and staff client
13272 - Staff client only
13274 .. _patron-cards-label:
13277 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13279 These preferences are in reference to the :ref:`Patron Card
13280 Creator <patron-card-creator-label>` tool.
13282 .. _imagelimit-label:
13285 ''''''''''''''''''''''''''''
13287 Asks: Limit the number of creator images stored in the database to
13293 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13295 These preferences are in reference to the Reports module.
13297 .. _numsavedreports-label:
13300 ''''''''''''''''''''''''''''''''''''''
13304 Asks: By default, show \_\_\_ reports on the Saved Reports page.
13309 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13311 .. _uploadpurgetemporaryfilesdays-label:
13313 UploadPurgeTemporaryFilesDays
13314 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
13318 Asks: Automatically delete temporary uploads older than \_\_\_ days in
13319 cleanup_database cron job.
13321 .. _web-services-label:
13324 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13326 *Get there:* More > Administration > Global System Preferences > Web
13332 ^^^^^^^^^^^^^^^^^^^^^^^^
13334 .. _ils-di-pref-label:
13337 ''''''''''''''''''''
13341 Asks: \_\_\_ ILS-DI services for OPAC users
13349 .. _ils-di:authorizedips-label:
13351 ILS-DI:AuthorizedIPs
13352 ''''''''''''''''''''''''''''''''''''''''''''''''
13354 Asks: \_\_\_ allowed IPs to use the ILS-DI services
13356 .. _idref-pref-label:
13359 ^^^^^^^^^^^^^^^^^^^^^^^
13368 Asks: \_\_\_ the IdRef webservice from the opac detail page. IdRef
13369 allows to request authorities from the Sudoc database.
13379 - IdRef is a French service for Sudoc autorities. Using the `Sudoc
13380 database <http://www.sudoc.abes.fr/>`__, it allows to request /
13381 modify / add authorities. If a record comes from the Sudoc (so 009 is
13382 filled with an integer), at the OPAC you will see "Author: Idref" if
13383 a 7..$3 (unimarc author) if filled with a ppn. On clicking on the
13384 Idref link, a popup will display. IdRef link
13386 The Idref webservice is requested and all records (by roles) for this
13387 author will be displayedSudoc
13389 There is 1 line / record and 2 links at the end. 1 will request Koha
13390 (cgi-bin/koha/opac-search.pl?q=ident:003381862), the other one will
13391 redirect to the sudoc page (http://www.sudoc.fr/003381862).
13395 Please note that this feature is available only for libraries
13400 The French Sudoc database should not be confused with the US
13401 Superintendent of Documents (SuDocs) Classification Scheme.
13406 ^^^^^^^^^^^^^^^^^^^^^^^
13408 .. _oai-pmh-pref-label:
13411 ''''''''''''''''''''''
13415 Asks: \_\_\_ Koha's OAI-PMH server.
13425 - Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl
13426 to see your file. For the Open Archives Initiative-Protocol for
13427 Metadata Harvesting (OAI-PMH) there are two groups of 'participants':
13428 Data Providers and Service Providers. Data Providers (open archives,
13429 repositories) provide free access to metadata, and may, but do not
13430 necessarily, offer free access to full texts or other resources.
13431 OAI-PMH provides an easy to implement, low barrier solution for Data
13432 Providers. Service Providers use the OAI interfaces of the Data
13433 Providers to harvest and store metadata. Note that this means that
13434 there are no live search requests to the Data Providers; rather,
13435 services are based on the harvested data via OAI-PMH. Koha at present
13436 can only act as a Data Provider. It can not harvest from other
13437 repositories. The biggest stumbling block to having Koha harvest from
13438 other repositories is that MARC is the only metadata format that Koha
13439 indexes natively. Visit
13440 http://www.oaforum.org/tutorial/english/page3.htm for diagrams of how
13443 Learn more about OAI-PMH at: http://www.openarchives.org/pmh/
13445 .. _oai-pmh:archiveid-label:
13448 '''''''''''''''''''''''''''''''''''''''''
13450 Default: KOHA-OAI-TEST
13452 Asks: Identify records at this site with the prefix \_\_\_ :
13454 .. _oai-pmh:autoupdatesets-label:
13456 OAI-PMH:AutoUpdateSets
13457 '''''''''''''''''''''''''''''''''''''''''''''''''''
13461 Asks: \_\_\_ automatic update of OAI-PMH sets when a bibliographic
13462 record is created or updated.
13470 .. _oai-pmh:conffile-label:
13473 '''''''''''''''''''''''''''''''''''''''
13475 If this preference is left empty, Koha's OAI Server operates in normal
13476 mode, otherwise it operates in extended mode. In extended mode, it's
13477 possible to parameter other formats than marcxml or Dublin Core.
13478 OAI-PMH:ConfFile specify a YAML configuration file which list available
13479 metadata formats and XSL file used to create them from marcxml records.
13481 For more information, see the :ref:`sample conf file <sample-oai-conf-file-label>` in
13484 .. _oai-pmh:deletedrecord-label:
13486 OAI-PMH:DeletedRecord
13487 '''''''''''''''''''''''''''''''''''''''''''''''''
13489 Default: will never be emptied or truncated (persistent)
13491 Asks: Koha's deletedbiblio table \_\_\_
13495 - will never have any data in it (no)
13497 - will never be emptied or truncated (persistent)
13499 - might be emptied or truncated at some point (transient)
13501 .. _oai-pmh:maxcount-label:
13504 '''''''''''''''''''''''''''''''''''''''
13508 Asks: Only return \_\_\_ records at a time in response to a ListRecords
13509 or ListIdentifiers query.
13513 - This is the maximum number of records that would be returned based on
13514 ListRecord or ListIdentifier queries from harvesters. ListRecords
13515 harvest the entire records while the ListIdentifier is an abbreviated
13516 form of ListRecords, retrieving only headers rather than records.
13518 .. _reporting-label:
13521 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13523 .. _svcmaxreportrows-label:
13526 ''''''''''''''''''''''''''''''''''''''''
13530 Asks: Only return \_\_\_ rows of a report requested via the reports web
13535 - This value will be used to limit the number of results returned by
13536 `public reports <#publicreport>`__.
13538 .. _basic-parameters-label:
13541 -----------------------------------
13543 *Get there:* More > Administration
13547 Configure all 'parameters' in the order they appear.
13549 .. _libraries-&-groups-label:
13552 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13554 When setting up your Koha system you will want to add information for
13555 every library that will be sharing your system. This data is used in
13556 several areas of Koha.
13558 - *Get there:* More > Administration > Basic Parameters > Libraries and
13561 When visiting this page you are presented with a list of the libraries
13562 and groups that have already been added to the system.
13570 .. _adding-a-library-label:
13573 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13575 To add a new library:
13577 - Click 'New Library'
13579 - The top of the form asks for some basics about the library
13584 - The library code should not contain any spaces and be 10 or fewer
13585 characters. This code will be used as a unique identifier in the
13588 - The name will be displayed on the OPAC wherever the library name
13589 displays to the public and should be a name that makes sense to
13592 - If you have :ref:`groups <adding-a-group-label>` set up you can choose
13593 what group this library belongs to after entering in the code and
13596 - Next you can enter basic contact info about the branch
13598 Library Contact Info
13601 - The address and contact fields can be used to make notices custom
13604 - The email address field is not required, but it should be filled
13605 for every library in your system
13609 Be sure to enter a library email address to make sure that
13610 notices are sent to and from the right address
13612 - If you'd like you can enter a different 'Reply-To' email address.
13613 This is the email address that all replies will go to.
13617 If you do not fill in this value Koha will use the address
13618 in the :ref:`ReplytoDefault` preference
13620 - If you'd like you can also enter a different 'Return-Path' email
13621 address. This is the email address that all bounced messages will
13626 If you do not fill in this value Koha will use the address
13627 in the :ref:`ReturnpathDefault`
13630 - If the URL field is populated then the library name will be linked
13631 in the holdings table on the OPAC
13633 Linked Library Name
13636 - The OPAC Info box is for you to put information about the library
13637 that will appear in the OPAC when the branch name is moused over
13638 in the holdings table
13643 - IP Address does not have be filled in unless you plan on limiting
13644 access to your staff client to a specific IP Address
13648 An IP address is required if you have enabled
13649 :ref:`AutoLocation`
13651 - Finally, if you have any notes you can put them here. These will
13652 not show in the OPAC
13656 Of the fields listed, only 'Library code' and 'Name' are required
13658 .. _editing/deleting-a-library-label:
13660 Editing/Deleting a Library
13661 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13663 You will be unable to delete any library that has patrons or items
13666 Staff will be presented with a warning when trying to delete a library
13670 Each library will have an 'Edit' link to the right of it. Click this
13671 link to edit/alter details associated with the library in question.
13675 You will be unable to edit the 'Library code'
13677 .. _adding-a-group-label:
13680 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13682 To add a Search Domain or Library Property Group click the 'New Group'
13683 button at the top of the screen
13688 Give the group a 'Category type; of 'searchdomain' and if you would like
13689 the group to show up in the library pull down at the top of the OPAC
13691 :ref:`OpacAddMastheadLibraryPulldown` set
13692 to 'Add') and on the advanced search page you can check the 'Show in
13693 search pulldown' box.
13695 Of the fields on the group form, 'Category code', 'Name', and 'Category
13696 type' are the only required fields
13698 .. _search-domain-groups-label:
13700 Search Domain Groups
13701 ''''''''''''''''''''''''''''''''''''''''''''''
13703 Search Domain Groups allow you to search a group of libraries at the
13704 same time instead of searching just one library or all libraries.
13706 Search Domain Groups
13709 To see Search Domain Groups in action visit the staff client advanced
13710 search page in your Koha system:
13712 Library group search on staff client
13715 .. _library-property-groups-label:
13717 Library Property Groups
13718 ''''''''''''''''''''''''''''''''''''''''''''''''
13720 You can assign specific categories to your libraries by adding groups
13723 Library Property Groups
13726 Properties are then applied to libraries via the add or edit library
13729 Groups on the Add/Modify library form
13732 .. _item-types-label:
13735 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13737 Koha allows you to organize your collection by item types and collection
13740 - *Get there:* More > Administration > Basic Parameters > Item Types
13742 Item types typically refer to the material type (book, cd, dvd, etc),
13743 but can be used in any way that works for your library.
13748 .. _adding-item-types-label:
13751 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13753 To add a new item type, simply click the 'New Item Type' button at the
13754 top of the Item Types page.
13759 - In the 'Item Type' field, enter a short code for your item type
13761 - The description is the plain text definition of the item type (for
13762 those with multiple languages installed you can translate the item
13763 type description in to all of those languages using the 'Translate in
13764 to other languages' link)
13766 - Item types and can grouped together for searching at the same time.
13767 For example you can put DVDs and Bluray in to a group called Movie
13768 and then they can be searched together. These groups are defined in
13769 the ITEMTYPECAT authorized value.
13771 - You can choose to have an image associated with your item type
13773 - You can choose from a series of image collections
13775 - You can link to a remote image
13777 - Or you can just have no image associated with the item type
13781 To have your item type images appear in the OPAC you need to
13782 set :ref:`noItemTypeImages` to 'Show'
13784 - *Get there:*\ More > Administration > Global System Preferences
13785 > :ref:`Admin <administration-label>`
13787 - For items that you are suppressing from the OPAC you can hide their
13788 item type from being searched in the OPAC
13790 - For items that do not circulate, check the 'Not for loan' options
13792 - Items marked 'Not for loan' will appear in the catalog, but cannot
13793 be checked out to patrons
13795 - For items that you charge a rental fee for, enter the total fee you
13796 charge in the 'Rental charge' field
13800 Do not enter symbols in this field, only numbers and decimal
13801 points (ex. $5.00 should be entered as 5 or 5.00)
13803 - This will charge the patron on checkout
13805 - If you would like a message or alert to appear when items of this
13806 type are checked in you can enter that in the 'Checkin message' box
13808 Checkin message setup
13811 - The Checkin message type can be a Message or an Alert. The only
13812 difference between these two is the styling. By default a Message
13818 and an Alert is yellow.
13823 - Some SIP devices need you to use a SIP-specific media type instead of
13824 Koha's item type (usually lockers and sorters need this media type),
13825 if you use a device like this you'll want to enter the SIP media
13828 - When finished, click 'Save Changes'
13832 All fields, with the exception of the 'Item Type' will be
13833 editable from the Item Types list
13835 - Your new item type will now appear on the list
13840 .. _editing-item-types-label:
13843 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13845 Each item type has an Edit button beside it. To edit an item simply
13846 click the 'Edit' link.
13850 You will not be able to edit the code you assigned as the 'Item
13851 Type' but you will be able to edit the description for the item.
13853 .. _deleting-item-types-label:
13855 Deleting Item Types
13856 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13858 Each item has a Delete button beside it. To delete an item, simply click
13863 You will not be able to delete item types that are being used by
13864 items within your system.
13866 Warning when you try to delete an item that is in use
13869 .. _authorized-values-label:
13872 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13874 Authorized values can be used in several areas of Koha. One reason you
13875 would add an authorized value category would be to control the values
13876 that can be entered into MARC fields by catalogers.
13878 - *Get there:* More > Administration > Basic Parameters > Authorized
13881 .. _existing-values-label:
13884 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13886 Koha installs with pre-defined values that your library is likely to
13887 use, for instance 'Lost'.
13891 - Used for acquisitions statistical purposes
13895 - Used for acquisitions statistical purposes
13899 - Values for custom patron messages that appear on the circulation
13900 screen and the OPAC. The value in the Description field should be
13901 the message text and is limited to 200 characters.
13908 - Values that can be entered to fill in the patron's sort 1 field
13912 - Values that can be entered to fill in the patron's sort 2 field
13916 - Is the shelving cart location, used by
13917 :ref:`InProcessingToShelvingCart` and
13918 :ref:`ReturnToShelvingCart`
13922 - Collection codes (appears when cataloging and working with items)
13926 - Descriptions for items marked as damaged (appears when cataloging
13927 and working with items)
13931 - Departments are required by and will be used in the `Course
13932 Reserves <#coursereserves>`__ module
13936 - General Holdings: Acquisition Status Designator :: This data
13937 element specifies acquisition status for the unit at the time of
13938 the holdings report.
13942 - General Holdings: Completeness Designator
13946 - Physical Form Designators
13950 - General Holdings: Retention Designator :: This data element
13951 specifies the retention policy for the unit at the time of the
13956 - General Holdings: Type of Unit Designator
13960 - Shelving location (usually appears when adding or editing an item)
13964 - Descriptions for the items marked as lost (appears when adding or
13969 Values given to lost statuses should be numeric and not
13970 alphabetical in order for statuses to appear properly
13974 - Values for manual invoicing types
13978 The value set as the Authorized Value for the MANUAL\_INV
13979 authorized value category will appear as the Description and
13980 the Authorized Value Description will be used as the amount.
13981 Enter monetary amounts in the description without currency
13986 - Reasons why a title is not for loan
13990 Values given to lost statuses should be numeric and not
13991 alphabetical in order for statuses to appear properly
13995 Negative number values will still allow holds (use for on
13996 order statuses for example) where as positive numbers will not
13997 allow holds or checkouts
13999 - ORDER\_CANCELLATION\_REASON
14001 - Reasons why an order might have been cancelled
14005 - The location to be used for
14006 :ref:`NewItemsDefaultLocation` (change
14007 description as desired), also the location expected by
14008 :ref:`InProcessingToShelvingCart`.
14012 - A way to sort and filter your reports, the default values in this
14013 category include the Koha modules (Accounts, Acquitisions,
14014 Catalog, Circulation, Patrons)
14021 - Can be used to further sort and filter your reports. This category
14022 is empty by default. Values here need to include the authorized
14023 value code from REPORT\_GROUP in the Description (OPAC) field to
14024 link the subgroup to the appropriate group.
14031 - Restricted status of an item
14035 - Road types to be used in patron addresses
14039 - Used when :ref:`creating <adding-item-types-label>` or
14040 :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
14041 media type for devices like lockers and sorters.
14045 - List of patron suggestion reject or accept reasons (appears when
14046 managing suggestions)
14050 - Description of a withdrawn item (appears when adding or editing an
14055 - A generic authorized value field that can be used anywhere you
14056 need a simple yes/no pull down menu.
14058 .. _add-new-authorized-value-category-label:
14060 Add new Authorized Value Category
14061 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14063 In addition to the existing categories that come by default with Koha,
14064 librarians can add their own authorized value categories to control data
14065 that is entered into the system. To add a new category:
14067 - Click 'New Category'
14069 New Authorized Category form
14072 - Limit your Category to 10 characters (something short to make it
14073 clear what the category is for)
14077 Category cannot have spaces or special characters other than
14078 underscores and hyphens in it.
14080 - When adding a new category you're asked to create at least one
14083 - Enter a code for your Authorized Value into the 'Authorized value'
14088 Authorized value is limited to 80 characters and cannot
14089 have spaces or special characters other than underscores
14092 - Use the Description field for the actual value that will be
14093 displayed. If you want something different to show in the OPAC,
14094 enter a 'Description (OPAC)'
14096 - If you would like to limit this authorized value category to only
14097 specific libraries you can choose them from the 'Branches
14098 limitation' menu. To have it show for all libraries just choose
14099 'All branches' at the top of the list.
14102 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
14103 and/or :ref:`AuthorisedValueImages` set to
14104 show images for authorized values you can choose the image under
14109 - Your new category and value will appear on the list of Authorized
14112 Custom Authorized Value on list of values
14115 .. _add-new-authorized-value-label:
14117 Add new Authorized Value
14118 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14120 New authorized values can be added to any existing or new category. To
14123 - Click 'New authorized value for ...'
14125 New Authorized Value form
14128 - Enter a code for your Authorized Value into the 'Authorized value'
14133 Authorized value is limited to 80 characters and cannot have
14134 spaces or special characters other than underscores and
14137 - Use the Description field for the actual value that will be
14138 displayed. If you want something different to show in the OPAC, enter
14139 a 'Description (OPAC)'
14141 - If you would like to limit this authorized value category to only
14142 specific libraries you can choose them from the 'Branches limitation'
14143 menu. To have it show for all libraries just choose 'All branches' at
14144 the top of the list.
14147 `StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
14148 :ref:`AuthorisedValueImages` set to show images
14149 for authorized values you can choose the image under 'Choose an icon'
14153 - The new value will appear in the list along with existing values
14155 List of authorized values in MARC504 category
14158 .. _patrons-&-circulation-label:
14160 Patrons & Circulation
14161 -------------------------------------
14163 Settings for controlling circulation and patron information.
14165 .. _patron-categories-label:
14168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14170 Patron categories allow you to organize your patrons into different
14171 roles, age groups, and patron types.
14173 - *Get there:* More > Administration > Patrons & Circulation > Patron
14176 Patron category list
14179 Patrons are assigned to one of six main categories:
14183 - Most common patron type, usually used for a general 'Patron'
14188 - Children patrons can have a guardian to be attached to them.
14192 - Librarians (and library workers) should be assigned the staff
14193 category so that you can :ref:`set their
14194 permissions <patron-permissions-label>` and give them access to the
14199 - Organizational patrons are organizations. Organizations can be
14200 used as guarantors for Professional patrons.
14204 - Professional patrons can be linked to Organizational patrons
14208 - This patron type is used strictly for statistical purposes, such
14209 as in house use of items.
14211 .. _adding-a-patron-category-label:
14213 Adding a patron category
14214 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14216 To add a new patron category click 'New Category' at the top of the page
14218 New patron category form
14221 - The 'Category Code' is an identifier for your new code.
14225 The category code is limited to 10 characters (numbers and
14230 This field is required in order to save your patron category.
14231 If left blank you will be presented with an error.
14233 Missing fields error
14236 - Enter a plain text version of the category in the 'Description'
14241 This field is required in order to save your patron category.
14242 If left blank you will be presented with an error.
14244 Missing fields error
14247 - Enrollment period (in months) should be filled in if you have a
14248 limited enrollment period for your patrons (eg. Student cards expire
14249 after 9 months or until a specific date)
14253 You cannot enter both a month limit and a date until. Choose
14254 to enter either one or the other.
14258 This field is required in order to save your patron category.
14259 If left blank you will be presented with an error.
14261 Missing fields error
14264 - Some patron categories can have a minimum age (in years) requirement
14265 associated with them, enter this age in the 'Age required'
14269 This value will only be checked if
14270 :ref:`BorrowerMandatoryField` defines
14271 the dateofbirth as a required field on the patron record
14273 - Patron categories can also have a maximum age (in years) associated
14274 with them (such as children), enter this age in the 'Upperage limit'
14278 This value will only be checked if
14279 :ref:`BorrowerMandatoryField` defines
14280 the dateofbirth as a required field on the patron record
14282 - If you charge a membership fee for your patrons (such as those who
14283 live in another region) you can enter that in the 'Enrollment fee'
14288 Only enter numbers and decimals in this field
14292 Depending on your value for the
14293 :ref:`FeeOnChangePatronCategory`
14294 preference this fee will be charged on patron renewal as well
14295 as when they are first enrolled.
14297 - If you want your patron to receive overdue notices, set the 'Overdue
14298 notice required' to 'Yes'
14300 - You can decide on a patron category basis if lost items are shown in
14301 the staff client by making a choice from the 'Lost items in staff
14304 Choose a value for 'Hide Lost Items'
14309 Note that this is only applicable in the staff client, so
14310 changing this value on patron categories who do not have
14311 access to the staff client won't make any difference
14313 - If you charge patrons for placing holds on items, enter the fee
14314 amount in the 'Hold fee' field.
14318 Only enter numbers and decimals in this field
14320 - In the 'Category type' field choose one of the six main parent
14323 Six main patron categories
14328 This field is required in order to save your patron category.
14329 If left blank you will be presented with an error.
14331 Missing fields error
14334 - The Branch Limitations let you limit this patron category to only
14335 some branches in your library system. Select 'All branches' if you
14336 would like any library to be able to use this category.
14338 - You can decide if this patron category is blocked from performing
14339 actions in the OPAC if their card is expired using the next option.
14340 By default it will follow the rule set in the
14341 :ref:`BlockExpiredPatronOpacActions`
14342 preferenceBlock expired patrons
14344 - Next you can choose the default privacy settings for this patron
14345 category. This setting can be edited by the patron via the OPAC if
14346 you allow it with the :ref:`OPACPrivacy` system
14347 preference.Default privacy
14349 - Finally you can assign advanced messaging preferences by default to a
14354 Requires that you have
14355 :ref:`EnhancedMessagingPreferences`
14358 - These defaults will be applied to new patrons that are added to
14359 the system. They will not edit the preferences of the existing
14360 patrons. Also, these can be changed for individual patrons, this
14361 setting is just a default to make it easier to set up messages for
14362 an entire category.
14366 After setting the default for the patron category you can
14367 force those changes to all existing patrons by running the
14368 *borrowers-force-messaging-defaults* script found in the
14369 *misc/maintenance* folder. Ask your system administrator
14370 for assistance with this script.
14372 .. _circulation-and-fine-rules-label:
14374 Circulation and Fine Rules
14375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14377 These rules define how your items are circulated, how/when fines are
14378 calculated and how holds are handled.
14380 - *Get there:* More > Administration > Patrons & Circulation >
14381 Circulation and fines rules
14383 The rules are applied from most specific to less specific, using the
14384 first found in this order:
14386 - same library, same patron type, same item type
14388 - same library, same patron type, all item type
14390 - same library, all patron types, same item type
14392 - same library, all patron types, all item types
14394 - default (all libraries), same patron type, same item type
14396 - default (all libraries), same patron type, all item types
14398 - default (all libraries), all patron types, same item type
14400 - default (all libraries), all patron types, all item types
14402 The :ref:`CircControl` and
14403 :ref:`HomeOrHoldingBranch` also come in to play when
14404 figuring out which circulation rule to follow.
14406 - If CircControl is set to "the library you are logged in at" circ
14407 rules will be selected based on the library you are logged in at
14409 - If CircControl is set to "the library the patron is from" circ rules
14410 will be selected based on the patron's library
14412 - If CircControl is set to "the library the item is from" circ rules
14413 will be selected based on the item's library where
14414 HomeOrHoldingBranch chooses if item's home library is used or holding
14417 - If :ref:`IndependentBranches` is set to 'Prevent'
14418 then the value of HomeOrHoldingBranch is used in figuring out if the
14419 item can be checked out. If the item's home library does not match
14420 the logged in library, the item cannot be checked out unless you are
14421 a :ref:`superlibrarian <patron-permissions-defined-label>`.
14425 If you are a single library system choose your branch name before
14426 creating rules (sometimes having only rules for the 'all libraries'
14427 option can cause issues with holds)
14431 At the very least you will need to set a default circulation rule.
14432 This rule should be set for all item types, all libraries and all
14433 patron categories. That will catch all instances that do not match a
14434 specific rule. When checking out if you do not have a rule for all
14435 libraries, all item types and all patron types then you may see
14436 patrons getting blocked from placing holds. You will also want a
14437 rule for your specific library set for all item types and all patron
14438 types to avoid this holds issue. Koha needs to know what rule to
14441 .. _default-circulation-rules-label:
14443 Default Circulation Rules
14444 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14446 Using the issuing rules matrix you can define rules that depend on
14447 patron/item type combos. To set your rules, choose a library from the
14448 pull down (or 'all libraries' if you want to apply these rules to all
14451 Libraries to apply the rules to
14454 From the matrix you can choose any combination of patron categories and
14455 item types to apply the rules to
14457 Setting issuing rules for your libraries
14460 - First choose which patron category you'd like the rule to be applied
14461 to. If you leave this to 'All' it will apply to all patron categories
14463 - Choose the 'Item type' you would like this rule to apply to. If you
14464 leave this to 'All' it will apply to all item types
14466 - Limit the number of items a patron can have checked out at the same
14467 time by entering a number in the 'Current checkouts allowed' field
14469 - If you're allowing :ref:`OnSiteCheckouts` then you
14470 may also want to set a limit on the number of items patron's can have
14475 This setting also depends on the
14476 :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
14479 - Define the period of time an item can be checked out to a patron by
14480 entering the number of units (days or hours) in the 'Loan period'
14483 - Choose which unit of time, Days or Hours, that the loan period and
14484 fines will be calculated in in the 'Unit' column
14486 - You can also define a hard due date for a specific patron category
14487 and item type. A hard due date ignores your usual circulation rules
14488 and makes it so that all items of the type defined are due on, before
14489 or after the date you specify.
14491 - 'Fine amount' should have the amount you would like to charge for
14496 Enter only numbers and decimal points (no currency symbols).
14498 - Enter the 'Fine charging interval' in the unit you set (ex. charge
14499 fines every 1 day, or every 2 hours)
14501 - 'When to charge' is most handy in libraries that have a fine charging
14502 interval of more than 1 day.
14506 - Given a grace period of 2 days and a fine interval of 7 days,
14507 the first fine will appear 7 days after the due date, it will
14508 always take one fine interval (7 days), before the first fine
14511 - Start of interval
14513 - Given a grace period of 2 days and a fine interval of 7 days,
14514 the first fine will appear 2 days after the due date and the
14515 second fine 7 days after the due date.
14517 - The 'Fine grace period' is the period of time an item can be overdue
14518 before you start charging fines.
14522 This can only be set for the Day unit, not in Hours
14524 - The 'Overdue fines cap' is the maximum fine for this patron and item
14529 If this field is left blank then Koha will not put a limit on
14530 the fines this item will accrue. A maximum fine amount can be
14531 set using the :ref:`MaxFine` system preference.
14533 - If you would like to prevent overcharging patrons for a lost items,
14534 you can check the box under 'Cap fine at replacement price.' This
14535 will prevent the patron's fines from going above the replacement
14540 If the 'Overdue fines cap' is also set, the fine will be the
14541 lesser of the two, if both apply to the given overdue
14544 - If your library 'fines' patrons by suspending their account you can
14545 enter the number of days their fine should be suspended in the
14546 'Suspension in days' field
14550 This can only be set for the Day unit, not in Hours
14552 - You can also define the maximum number of days a patron will be
14553 suspended in the 'Max suspension duration' setting
14555 - Next decide if the patron can renew this item type and if so, enter
14556 how many times they can renew it in the 'Renewals allowed' box
14558 - If you're allowing renewals you can control how long the renewal loan
14559 period will be (in the units you have chosen) in the 'Renewal period'
14562 - If you're allowing renewals you can control how soon before the due
14563 date patrons can renew their materials with the 'No renewals before'
14566 - Items can be renewed at any time if this value is left blank.
14567 Otherwise items can only be renewed if the item is due after the
14568 number in units (days/hours) entered in this box.
14570 - To control this value on a more granular level please set the
14571 :ref:`NoRenewalBeforePrecision`
14574 - You can enable automatic renewals for certain items/patrons if you'd
14575 like. This will renew automatically following your circulation rules
14576 unless there is a hold on the item
14580 You will need to enable the :ref:`automatic renewal cron
14581 job <automatic-renewal-label>` for this to work.
14585 This feature needs to have the "no renewal before" column
14586 filled in or it will auto renew everyday after the due date
14588 - If the patron can place holds on this item type, enter the total
14589 numbers of items (of this type) that can be put on hold in the 'Holds
14592 - Next you can decide if this patron/item combo are allowed to place
14593 holds on items that are on the shelf (or available in the library) or
14594 not. If you choose 'no' then items can only be placed on hold if
14597 - You can also decide if patrons are allowed to place item specific
14598 holds on the item type in question. The options are:
14600 - Allow: Will allow patrons the option to choose next available or
14603 - Don't allow: Will only allow patrons to choose next available
14605 - Force: Will only allow patrons to choose an specific item
14607 - Finally, if you charge a `rental fee <#rentalcharge>`__ for the item
14608 type and want to give a specific patron type a discount on that fee,
14609 enter the percentage discount (without the % symbol) in the 'Rental
14612 When finished, click 'Add' to save your changes. To modify a rule,
14613 simply click the 'Edit' link to the right of the fule and edit the
14614 values that appear filled in at the bottom of the form.
14616 Edit circ and fine rule
14619 If you would like to delete your rule, click the 'Delete' link to the
14622 To save time you can clone rules from one library to another by choosing
14623 the clone option above the rules matrix.
14625 Circulation & Fine Rules Clone Tool
14628 After choosing to clone you will be presented with a confirmation
14631 Circulation & Fine Rules Successfully Cloned Message
14634 .. _default-checkouts-and-hold-policy-label:
14636 Default Checkouts and Hold Policy
14637 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14639 You can set a default maximum number of checkouts and hold policy that
14640 will be used if none is defined below for a particular item type or
14641 category. This is the fall back rule for defaults.
14643 Default Checkouts and Hold Policy
14646 From this menu you can set a default to apply to all item types and
14647 patrons in the library if no other option is set in the forms below.
14649 - In 'Total current checkouts allowed' enter the total number of items
14650 patrons can have checked out at one time
14652 - In 'Total current on-site checkouts allowed' enter the total number
14653 of items patrons can have checked out on site at a time
14654 (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
14656 - Control where patrons can place holds from using the 'Hold Policy'
14659 - From Any Library: Patrons from any library may put this item on
14660 hold. (default if none is defined)
14662 - From Home Library: Only patrons from the item's home library may
14663 put this book on hold.
14665 - No Holds Allowed: No patron may put this book on hold.
14667 - Control if there is a limit to filling a hold based on the item's
14672 - item's home library
14674 - item's holding library
14678 The patron's home library should not affect whether a patron
14679 can place the hold, instead the hold will only be fillable
14680 when an item matching the pickup location becomes available.
14682 - Control where the item returns to once it is checked in
14684 - Item returns home
14686 - Item returns to issuing branch
14690 - When an item floats it stays where it was checked in and does
14691 not ever return 'home'
14693 - Once your policy is set, you can unset it by clicking the 'Unset'
14694 link to the right of the rule
14696 .. _checkouts-per-patron-label:
14698 Checkouts Per Patron
14699 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14701 For this library, you can specify the maximum number of loans that a
14702 patron of a given category can make, regardless of the item type.
14704 Set default checkouts per patron category
14709 If the total amount loanable for a given patron category is left
14710 blank, no limit applies, except possibly for a limit you define for
14711 a specific item type.
14713 For example, if you have a rule in the matrix that says Board patrons
14714 are allowed 10 books and 5 DVDs but you want to make it so that Board
14715 patrons only have a total of 12 things checked out at once. If you enter
14716 12 here and the patron has 10 books out already they will only be
14717 allowed 2 DVDs to equal the 12 total they're allowed.
14719 .. _item-hold-policies-label:
14722 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14724 For this library, you can edit hold and return policies for a given item
14725 type, regardless of the patron's category.
14727 Hold policies per item type
14730 The various Hold Policies have the following effects:
14732 - From Any Library: Patrons from any library may put this item on hold.
14733 (default if none is defined)
14735 - From Home Library: Only patrons from the item's home library may put
14738 - No Holds Allowed: No patron may put this book on hold.
14742 Note that if the system preference
14743 :ref:`AllowHoldPolicyOverride` set to
14744 'allow', these policies can be overridden by your circulation staff.
14748 These policies are based on the patron's home branch, not the branch
14749 that the reserving staff member is from.
14751 Control if there is a limit to filling a hold based on the item's
14756 - item's home library
14758 - item's holding library
14762 The patron's home library should not affect whether a patron can
14763 place the hold, instead the hold will only be fillable when an
14764 item matching the pickup location becomes available.
14766 The various Return Policies have the following effects:
14768 - Item returns home: The item will prompt the librarian to transfer the
14769 item to its home library
14773 If the :ref:`AutomaticItemReturn`
14774 preference is set to automatically transfer the items home,
14775 then a prompt will not appear
14777 - Item returns to issuing branch: The item will prompt the librarian to
14778 transfer the item back to the library where it was checked out
14782 If the :ref:`AutomaticItemReturn`
14783 preference is set to automatically transfer the items home,
14784 then a prompt will not appear
14786 - Item floats: The item will not be transferred from the branch it was
14787 checked in at, instead it will remain there until transferred
14788 manually or checked in at another branch
14790 For example you might allow holds at your libraries but not what New
14791 items or DVDs to be placed on hold by other branches so you can set the
14792 'Hold policy' to 'From home library' so that those items can only be
14793 placed on hold if the items' owning library and the patron's home
14794 library are the same. You can also block holds completely on specific
14795 item types from this form. This is also how you can set up floating item
14796 types and types that remain with their home library.
14798 .. _patron-attribute-types-label:
14800 Patron Attribute Types
14801 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14803 Patron attributes can be used to define custom fields to associate with
14804 your patron records. In order to enable the use of custom fields you
14805 need to set the :ref:`ExtendedPatronAttributes`
14808 - *Get there:* More > Administration > Patrons & Circulation > Patron
14811 A common use for this field would be for a student ID number or a
14812 Driver's license number.
14814 List of Patron Attributes
14817 .. _adding-patron-attributes-label:
14819 Adding Patron Attributes
14820 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14822 To add a new Patron Attribute Type, click the 'New Patron Attribute
14823 Type' button at the top of the page
14825 Add Patron Attribute Type form
14828 - In the 'Patron attribute type code', enter a short code to identify
14833 This field is limited to 10 characters (numbers and letters
14838 This setting cannot be changed after an attribute is defined
14840 - In the 'Description' field, enter a longer (plain text) explanation
14841 of what this field will contain
14843 - Check the box next to 'Repeatable' to let a patron record have
14844 multiple values of this attribute.
14848 This setting cannot be changed after an attribute is defined
14850 - If 'Unique identifier' is checked, the attribute will be a unique
14851 identifier which means, if a value is given to a patron record, the
14852 same value cannot be given to a different record.
14854 - Unique attributes can be used as match points on the :ref:`patron
14855 import tool <patron-import-label>`
14859 This setting cannot be changed after an attribute is defined
14861 - Check 'Allow password' to make it possible to associate a password
14862 with this attribute.
14864 - Check 'Display in OPAC' to display this attribute on a patron's
14865 details page in the OPAC.
14867 - Check 'Searchable' to make this attribute searchable in the staff
14870 - Check 'Display in check-out' to make this attribute visible in the
14871 patron's short detail display on the left of the checkout screen and
14874 Show attribute in patron detail on the left
14877 - Authorized value category; if one is selected, the patron record
14878 input page will only allow values to be chosen from the authorized
14881 - You will first need to add an authorized value list for it to
14882 appear in this menu
14884 - *Get there:*\ More > Administration > Basic Parameters >
14885 :ref:`Authorized Values`
14889 an authorized value list is not enforced during batch patron
14892 - If you would like this attribute to only be used by specific branches
14893 you can choose those branches from the 'Branches limitation' list.
14894 Choose 'All branches' to show it for all libraries.
14898 Note that items with locations already set on them will not be
14899 altered. The branch limitation only limits the choosing of an
14900 authorized value based on the home branch of the current staff
14901 login. All authorized values for item records (LOC, LOST,
14902 CCODE, etc) will show in the OPAC for all patrons.
14904 - If you'd like to only show this attribute on patrons of one type
14905 choose that patron type from the 'Category' pull down
14907 - If you have a lot of attributes it might be handy to group them so
14908 that you can easily find them for editing. If you create an
14909 :ref:`Authorized Value <authorized-values-label>` for PA\_CLASS it will show
14910 in the 'Class' pull down and you can then change your attributes page
14911 to have sections of attributes
14913 Patron Attributes Sorted
14916 - Click Save to save your new attribute
14918 Once added your attribute will appear on the list of attributes and also
14919 on the patron record add/edit form
14921 Patron Attributes list on the Patron add/edit form
14924 If you have set up classes for organizing attributes they will appear
14925 that way on the add/edit patron form
14930 .. _editing/deleting-patron-attributes-label:
14932 Editing/Deleting Patron Attributes
14933 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14935 Each patron attribute has an edit and a delete link beside it on the
14936 list of attributes.
14938 Some fields in the attribute will not be editable once created:
14940 - Patron attribute type code
14944 - Unique identifier
14946 You will be unable to delete an attribute if it's in use.
14948 Warning when trying to delete an attribute that is in use
14951 .. _library-transfer-limits-label:
14953 Library Transfer Limits
14954 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14956 Limit the ability to transfer items between libraries based on the
14957 library sending, the library receiving, and the collection code
14960 - *Get there:* More > Administration > Patrons & Circulation > Library
14963 These rules only go into effect if the preference
14964 :ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
14967 Before you begin you will want to choose which library you are setting
14970 Choose the library you're setting limits for
14973 Transfer limits are set based on the collections codes you have applied
14974 via the :ref:`Authorized Value <authorized-values-label>` administration area.
14976 Collection Code values assigned in the Authorized Value area
14979 Collection codes will appear as tabs above the checkboxes:
14981 Collection Code tabs
14984 Check the boxes for the libraries that you accept checkins from for the
14985 item type you have selected at the top (in the example below - FIC)
14987 Example transfer limits set up
14990 In the above example, Centerville library will allow patrons to return
14991 items from all libraries except Liberty and Franklin to their branch.
14993 .. _transport-cost-matrix-label:
14995 Transport cost matrix
14996 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14998 The Transport cost matrix lets a library system define relative costs to
14999 transport books to one another. In order for the system to use this
15000 matrix you must first set the
15001 :ref:`UseTransportCostMatrix` preference to
15006 The Transport cost matrix takes precedence in controlling where
15007 holds are filled from, if the matrix is not used then Koha checks
15008 the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
15010 Costs are decimal values between some arbitrary maximum value (e.g. 1 or
15011 100) and 0 which is the minimum (no) cost. For example, you could just
15012 use the distance between each library in miles as your 'cost', if that
15013 would accurately reflect the cost of transferring them. Perhaps post
15014 offices would be a better measure. Libraries sharing a post office would
15015 have a cost of 1, adjacent post offices would have a cost of 2, etc.
15017 To enter transport costs simply click in the cell you would like to
15018 alter, uncheck the 'Disable' box and enter your 'cost'
15020 Transport cost matrix
15023 After entering in your cost, hit 'Enter' on your keyboard or click the
15024 'Save' button at the bottom of the matrix to save your changes.
15028 A NULL value will make no difference where the From and To libraries
15029 are the same library. However, as a best practice, you should put a
15030 0 in there. For all other To/From combinations, a NULL value will
15031 cause that relationship to act as if it has been disabled. So, in
15032 summary, don't leave any of the values empty. It's best to always
15033 put a number in there ( even if you choose to disable that given
15036 .. _item-circulation-alerts-label:
15038 Item Circulation Alerts
15039 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15041 Libraries can decide if they want to have patrons automatically notified
15042 of circulation events (check ins and check outs).
15044 - *Get there:* More > Administration > Patrons & Circulation > Item
15047 These preferences are set based on patron types and item types.
15051 These preference can be overridden by changes in the individual
15052 patron's messaging preferences.
15054 To set up circulation alerts:
15056 - Choose your library from the pull down at the top of the screen
15058 Libraries to set Circulation Alerts
15061 - To set preferences for all libraries, keep the menu set to
15064 - By default all item types and all patrons are notified of check ins
15065 and check outs. To change this, click on the item/patron type combo
15066 that you would like to stop notices for.
15068 Circulation Alert Matrix
15071 - In the above example, Juveniles and Kids will not receive check
15074 .. _cities-and-towns-label:
15077 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15079 To standardize patron input you can define cities or towns within your
15080 region so that when new patrons are added librarians simply have to
15081 select the town from a list instead of having to type the town and zip
15082 (or postal) code information.
15084 - *Get there:* More > Administration > Patrons & Circulation > Cities
15087 .. _adding-a-city-label:
15090 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15092 To add a new city, click the 'New City' button at the top of the page
15093 and enter the city name, state, zip/postal code and country.
15095 New city entry form
15098 One you click Submit, your city will be saved and will be listed on the
15099 Cities and Towns page
15104 Cities can be edited or deleted at any time.
15106 .. _viewing-cities-on-patron-add-form-label:
15108 Viewing Cities on Patron Add Form
15109 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15111 If you have defined local cities using the New city form, then when
15112 adding or editing a patron record you will see those cities in a pull
15113 down menu to make city selection easy.
15115 Cities pull down on the patron record
15118 This will allow for easy entry of local cities into the patron record
15119 without risking the potential for typos or mistaken zip/postal codes.
15121 .. _catalog-administration-label:
15123 Catalog Administration
15124 --------------------------------------
15126 Set these controls before you start cataloging on your Koha system.
15128 - *Get there:* More > Administration > Catalog
15130 .. _marc-bibliographic-frameworks-label:
15132 MARC Bibliographic Frameworks
15133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15135 Think of Frameworks as templates for creating new bibliographic records.
15136 Koha comes with some predefined frameworks that can be edited or
15137 deleted, and librarians can create their own frameworks for content
15138 specific to their libraries.
15140 - *Get there:* More > Administration > Catalog > MARC Bibliographic
15148 Do not delete or edit the Default Framework since this will cause
15149 problems with your cataloging records - always create a new template
15150 based on the Default Framework, or alter the other Frameworks.
15152 After clicking the 'MARC structure' link to the right of each framework
15153 you can decide how many fields you want to see on one screen by using
15154 the pagination options at the top of the table.
15159 .. _add-new-framework-label:
15162 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15164 To add a new framework
15166 - Click 'New Framework'
15171 - Enter a code of 4 or fewer characters
15173 - Use the Description field to enter a more detailed definition of
15178 - Once your Framework is added click 'MARC structure' to the right of
15179 it on the list of Frameworks
15181 Choose basis for new Framework
15184 - You will be asked to choose a Framework to base your new Framework
15185 off of, this will make it easier than starting from scratch
15187 - Once your Framework appears on the screen you can edit or delete each
15188 field by following the instructions for :ref:`editing
15189 subfields <edit-framework-subfields-label>`
15191 .. _edit-existing-frameworks-label:
15193 Edit Existing Frameworks
15194 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15196 Clicking 'Edit' to the right of a Framework will only allow you to edit
15197 the Description for the Framework:
15202 To make edits to the fields associated with the Framework you must first
15203 click 'MARC Structure' and then follow the instructions for :ref:`editing
15204 subfields <edit-framework-subfields-label>`
15206 .. _add-subfields-to-frameworks-label:
15208 Add subfields to Frameworks
15209 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15211 To add a field to a Framework click the 'New Tag' button at the top of
15212 the Framework definition
15217 This will open up a blank form for entering MARC field data
15219 Add a new tag to framework
15222 Enter the information about your new tag:
15224 - The 'Tag' is the MARC field number
15226 - The 'Label for lib' is the text that will appear in the staff client
15227 when in the cataloging module
15229 - The 'Label for OPAC' is the text that will appear in the OPAC when
15230 viewing the MARC version of the record
15232 - If this field can be repeated, check the 'Repeatable' box
15234 - If this field is mandatory, check the 'Mandatory' box
15236 - If you want this field to be a pull down with limited possible
15237 answers, choose which 'Authorized value' list you want to use
15239 When you're finished, click 'Save Changes' and you will be presented
15240 with your new field
15242 New tag and link to subfields
15245 To the right of the new field is a link to 'Subfields,' you will need to
15246 add subfields before this tag will appear in your MARC editor. The
15247 process of entering the settings for the new subfield is the same as
15248 those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
15249 section of this manual.
15251 .. _edit-framework-subfields-label:
15253 Edit Framework Subfields
15254 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15256 Frameworks are made up of MARC fields and subfields. To make edits to
15257 most Frameworks you must edit the fields and subfields. Clicking 'Edit'
15258 to the right of each subfield will allow you to make changes to the text
15259 associated with the field
15264 - Each field has a tag (which is the MARC tag) that is uneditable
15266 - The 'Label for lib' is what will show in the staff client if you
15267 have :ref:`advancedMARCeditor` set to display
15270 - The 'Label for OPAC' is what will show on the MARC view in the
15273 - If you check 'Repeatable' then the field will have a plus sign
15274 next to it allowing you to add multiples of that tag
15276 - If you check 'Mandatory' the record will not be allowed to save
15277 unless you have a value assigned to this tag
15279 - 'Authorized value' is where you define an :ref:`authorized
15280 value <authorized-values-label>` that your catalogers can choose from
15281 a pull down to fill this field in
15283 To edit the subfields associated with the tag, click 'Subfields' to the
15284 right of the tag on the 'MARC Structure' listing
15286 - From the list of subfields you can click 'Delete' to the right of
15287 each to delete the subfields
15289 - To edit the subfields click 'Edit Subfields'
15291 - For each subfield you can set the following Basic constraint values
15293 Editing the 504 Subfield
15296 - Text for librarian
15298 - what appears before the subfield in the librarian interface
15302 - what appears before the field in the OPAC.
15304 - If left empty, the text for librarian is used instead
15308 - the field will have a plus sign next to it allowing you to add
15309 multiples of that tag
15313 - the record will not be allowed to save unless you have a value
15314 assigned to this tag
15318 - defines the tab where the subfield is shown. All subfields of a
15319 given field must be in the same tab or ignored. Ignore means
15320 that the subfield is not managed.
15322 - For each subfield you can set the following Advanced constraint
15325 Advanced constraints
15330 - defines what you want to appear in the field by default, this
15331 will be editable, but it saves time if you use the same note
15332 over and over or the same value in a field often.
15336 If you would like a field to fill in with today's date you
15337 can use the YYYY MM DD syntax in the 'Default value'. For
15338 example: a default of "Year:YYYY Month:MM Day:DD" (without
15339 quotes) will print as "Year:2015 Month:11 Day:30"
15343 - allows you to select from where this subfield is
15344 visible/hidden, simply check the boxes where you would like the
15345 field to show and uncheck the boxes where you would like it
15348 Framework visibility
15353 - if checked, it means that the subfield is a URL and can be
15358 - If you enter a field/subfield here (200b), a link appears after
15359 the subfield in the MARC Detail view. This view is present only
15360 in the staff client, not the OPAC. If the librarian clicks on
15361 the link, a search is done on the database for the
15362 field/subfield with the same value. This can be used for 2 main
15365 - on a field like author (200f in UNIMARC), put 200f here, you
15366 will be able to see all bib records with the same author.
15368 - on a field that is a link (4xx) to reach another bib record.
15369 For example, put 011a in 464$x, will find the serials that
15370 are with this ISSN.
15374 This value should not change after data has been added to
15375 your catalog. If you need to change this value you must ask
15376 your system administrator to run
15377 misc/batchRebuildBiblioTables.pl.
15381 - Koha is multi-MARC compliant. So, it does not know what the
15382 245$a means, neither what 200$f (those 2 fields being both the
15383 title in MARC21 and UNIMARC). So, in this list you can "map" a
15384 MARC subfield to its meaning. Koha constantly maintains
15385 consistency between a subfield and its meaning. When the user
15386 want to search on "title", this link is used to find what is
15387 searched (245 if you're MARC21, 200 if you're UNIMARC).
15389 - For each subfield you can set the following Other option values
15395 - means the value cannot by typed by the librarian, but must be
15396 chosen from a pull down generated by the :ref:`authorized
15397 value <authorized-values-label>` list
15399 - In the example above, the 504a field will show the MARC504
15400 Authorized Values when cataloging
15402 Example of an Authorized Subfield
15407 - means that the value is not free text, but must be searched in
15408 the authority/thesaurus of the selected category
15412 - means the value is calculated or managed by a plugin. Plugins
15413 can do almost anything.
15417 - For call numbers there is an option to add a call number
15418 browser next to the the call number subfield so that you can
15419 identify which call numbers are in use and which are not.
15420 Simply choose the cn\_browser.pl plugin. Learn more in the
15421 :ref:`cataloging section <adding-items-label>` of this manual.
15423 - If you'd like to let file uploads via cataloging you can
15424 choose the upload.pl plugin and this will allow you to
15425 :ref:`upload files to Koha to link to your
15426 records <attaching-files-to-records-label>`.
15428 - In UNIMARC there are plugins for every 1xx fields that are
15429 coded fields. The plugin is a huge help for cataloger! There
15430 are also two plugins (unimarc\_plugin\_210c and
15431 unimarc\_plugin\_225a that can "magically" find the editor
15432 from an ISBN, and the collection list for the editor)
15434 - To save your changes simply click the 'Save Changes' button at the
15437 .. _import/export-frameworks-label:
15439 Import/Export Frameworks
15440 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15442 Next to each framework is a link to either import or export the
15445 .. _export-framework-label:
15448 ''''''''''''''''''''''''''''''''''''''''
15450 To export a framework simply click the 'Export' link to the right of
15453 Export link next to framework
15456 When you click 'Export' you will be prompted to choose what format to
15457 export the file in.
15462 A framework exported this way can be imported into any other Koha
15463 installation using the import framework option.
15465 .. _import-framework-label:
15468 ''''''''''''''''''''''''''''''''''''''''
15470 An easy way to create a new framework is to import one created for your
15471 or another Koha installation. This framework would need to be exported
15472 from the other system :ref:`using the instructions
15473 above <export-framework-label>` to be available for import here.
15475 To import a framework you first need to create :ref:`a new
15476 framework <add-new-framework-label>`. Once you have that framework, click
15477 'Import' to the right of the new framework.
15479 Import link next to framework
15482 You will be prompted to find a file on your computer to import into the
15485 Choose a file to import
15488 You will be asked to confirm your actions before the file is imported.
15490 Confirm your desire to import
15493 As your file is uploaded you will see an image that will confirm that
15494 the system is working.
15499 Once your import is complete you will be brought to the framework edit
15500 tool where you can make any changes you need to the framework you
15503 .. _koha-to-marc-mapping-label:
15505 Koha to MARC Mapping
15506 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15508 While Koha stores the entire MARC record, it also stores common fields
15509 for easy access in various tables in the database. Koha to MARC Mapping
15510 is used to tell Koha where to find these values in the MARC record. In
15511 many cases you will not have to change the default values set by in this
15512 tool on installation, but it is important to know that the tool is here
15513 and can be used at any time.
15515 - *Get there:* More > Administration > Catalog > Koha to MARC Mapping
15517 The Koha to MARC Mapping page offers you the option of choosing from one
15518 of three tables in the database to assign values to.
15520 Koha to MARC Mapping Table Pull Down
15523 After choosing the table you would like to view, click 'OK.' To edit any
15524 mapping click on the 'Koha Filed' or the 'Edit' link.
15526 Map MARC Field to Koha Field
15529 Choose which MARC field you would like to map to this Koha Field and
15530 click the 'OK' button. If you would like to clear all mappings, click
15531 the 'Click to "Unmap"' button.
15535 At this time you can map only 1 MARC field to 1 Koha field. This
15536 means that you won't be able to map both the 100a and the 700a to
15537 the author field, you need to choose one or the other.
15539 .. _keywords-to-marc-mapping-label:
15541 Keywords to MARC Mapping
15542 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15544 This tool will allow you to map MARC fields to a set of predefined
15547 - *Get there:* More > Administration > Catalog > Keywords to MARC
15552 This tool only effects sites that are not using the XSLT
15555 At this time the only keyword in use is 'subtitle.'
15557 Using this tool you can define what MARC field prints to the detail
15558 screen of the bibliographic record using keywords. The following example
15559 will use the subtitle field.
15561 Using the Framework pull down menu, choose the
15562 :ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
15563 For example, the subtitle for books can be found in the 245$b field.
15565 Assigning Book Subtitle
15568 However the subtitle for DVDs appears in 245$p
15570 Assigning DVD Subtitle
15573 Using this tool you can tell Koha to print the right field as the
15574 subtitle when viewing the bibliographic record in the OPAC.
15576 Subtitle display in the OPAC
15579 This tool can be used to chain together pieces of the record as well. If
15580 you want the series number to show in the title on your search results
15581 you simply have to map 490 $v to 'subtitle' along with the 245 $b.
15585 Chain together the fields you want to show after the item title in
15586 the order in which you want them to appear.
15588 Future developments will include additional keyword assigned fields.
15590 .. _marc-bibliographic-framework-test-label:
15592 MARC Bibliographic Framework Test
15593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15595 Checks the MARC structure.
15597 - *Get there:* More > Administration > Catalog > MARC Bibliographic
15600 If you change your MARC Bibliographic framework it's recommended that
15601 you run this tool to test for errors in your definition.
15606 .. _authority-types-label:
15609 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15611 Authority Types are basically MARC Frameworks for Authority records and
15612 because of that they follow the same editing rules found in the :ref:`MARC
15613 Bibliographic Frameworks <marc-bibliographic-frameworks-label>` section of this manual.
15614 Koha comes with many of the necessary Authority frameworks already
15615 installed. To learn how to add and edit Authority Types, simply review
15616 the :ref:`MARC Bibliographic Frameworks` section of
15619 - *Get there:* More > Administration > Catalog > Authority Types
15621 .. _classification-sources-label:
15623 Classification Sources
15624 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15626 Source of classification or shelving scheme is an :ref:`Authorized
15627 Values <authorized-values-label>` category that is mapped to field 952$2 and
15628 942$2 in Koha's MARC Bibliographic frameworks and stored in the
15629 items.cn\_source field in the database.
15631 - *Get there:* More > Administration > Catalog > Classification sources
15633 Classification Sources
15636 Commonly used values of this field are:
15638 - ddc - Dewey Decimal Classification
15640 - lcc - Library of Congress Classification
15642 If you chose to install classification sources during Koha's
15643 installation, you would see other values too:
15645 - ANSCR (sound recordings)
15647 - SuDOC classification
15649 - Universal Decimal Classification
15651 - Other/Generic Classification
15653 .. _adding/editing-classification-sources-label:
15655 Adding/Editing Classification Sources
15656 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15658 You can add your own source of classification by using the New
15659 Classification Source button. To edit use the Edit link.
15661 Add classification source
15664 When creating or editing:
15666 - You will need to enter a code and a description.
15668 - Check the 'Source in use?' checkbox if you want the value to appear
15669 in the drop down list for this category.
15671 - Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
15674 .. _classification-filing-rules-label:
15676 Classification Filing Rules
15677 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15679 Filing rules determine the order in which items are placed on shelves.
15681 Values that are pre-configured in Koha are:
15689 Filing rules are mapped to :ref:`Classification
15690 sources <adding/editing-classification-sources-label>`. You can setup new filing rules by using
15691 the New Filing Rule button. To edit use the Edit link.
15693 When creating or editing:
15695 - Enter a code and a description
15697 - Choose an appropriate filing routine - dewey, generic or lcc
15699 .. _record-matching-rules-label:
15701 Record Matching Rules
15702 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15704 Record matching rules are used when importing MARC records into Koha.
15706 - *Get there:* More > Administration > Catalog > Record Matching Rules
15708 The rules that you set up here will be referenced with you :ref:`Stage MARC
15709 Records for Import <stage-marc-records-for-import-label>`.
15711 It is important to understand the difference between Match Points and
15712 Match Checks before adding new matching rules to Koha.
15714 Match Points are the criteria that you enter that must be met in order
15715 for an incoming record to match an existing MARC record in your catalog.
15716 You can have multiple match points on an import rule each with its own
15717 score. An incoming record will be compared against your existing records
15718 (â
\80\98one record at a timeâ
\80\99) and given a score for each match point. When
15719 the total score of the matchpoints matches or exceeds the threshold
15720 given for the matching rule, Koha assumes a good match and
15721 imports/overlays according your specifications in the import process. An
15722 area to watch out for here is the sum of the match points. Doublecheck
15723 that the matches you want will add up to a successful match.
15729 Match Point on 020$a 1000
15731 Match Point on 022$a 1000
15733 Match Point on 245$a 500
15735 Match Point on 100$a 100
15737 In the example above, a match on either the 020$a or the 022$a will
15738 result in a successful match. A match on 245$a title and 100$a author
15739 (and not on 020$a or 022$a) will only add up to 600 and not be a match.
15740 And a match on 020$a and 245$a will result in 1500 and while this is a
15741 successful match, the extra 500 point for the 245$a title match are
15742 superfluous. The incoming record successfully matched on the 020$a
15743 without the need for the 245$a match. However, if you assigned a score
15744 of 500 to the 100$a Match Point, a match on 245$a title and 100$a author
15745 will be considered a successful match (total of 1000) even if the 020$a
15748 Match Checks are not commonly used in import rules. However, they can
15749 serve a couple of purposes in matching records. First, match checks can
15750 be used as the matching criteria instead of the match points if your
15751 indexes are stale and out of date. The match checks go right for the
15752 data instead of relying on the data in the indexes. (If you fear your
15753 indexes are out of date, a rebuild of your indexes would be a great idea
15754 and solve that situation!) The other use for a Match Check is as a
15755 â
\80\9cdouble checkâ
\80\9d or â
\80\9cvetoâ
\80\9d of your matching rule. For example, if you have
15756 a matching rule as below:
15760 Match Point on 020$a 1000
15762 Match Check on 245$a
15764 Koha will first look at the 020$a tag/subfield to see if the incoming
15765 record matches an existing record. If it does, it will then move on to
15766 the Match Check and look directly at the 245$a value in the incoming
15767 data and compare it to the 245$a in the existing â
\80\98matchedâ
\80\99 record in
15768 your catalog. If the 245$a matches, Koha continues on as if a match was
15769 successful. If the 245$a does not match, then Koha concludes that the
15770 two records are not a match after all. The Match Checks can be a really
15771 useful tool in confirming true matches.
15773 When looking to create matching rules for your authority records the
15774 following indexes will be of use:
15776 +--------------------------+--------------------+
15777 | Index name | Matches Marc Tag |
15778 +==========================+====================+
15779 | LC-cardnumber | 010$a |
15780 +--------------------------+--------------------+
15781 | Personal-name | 100$a |
15782 +--------------------------+--------------------+
15783 | Corporate-name-heading | 110$a |
15784 +--------------------------+--------------------+
15785 | Meeting-name | 111$a |
15786 +--------------------------+--------------------+
15787 | Title-uniform | 130$a |
15788 +--------------------------+--------------------+
15789 | Chronological-term | 148$a |
15790 +--------------------------+--------------------+
15791 | Subject-topical | 150$a |
15792 +--------------------------+--------------------+
15793 | Name-geographic | 151$a |
15794 +--------------------------+--------------------+
15795 | Term-genre-form | 155$a |
15796 +--------------------------+--------------------+
15798 Table: Authority Indexes
15800 .. _adding-matching-rules-label:
15802 Adding Matching Rules
15803 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15805 To create a new matching rule :
15807 - Click 'New Record Matching Rule'
15809 Add record matching rule
15812 - Choose a unique name and enter it in the 'Matching rule code'
15815 - 'Description' can be anything you want to make it clear to you
15816 what rule you're picking
15818 - 'Match threshold' is the total number of 'points' a biblio must
15819 earn to be considered a 'match'
15821 - 'Record type' is the type of import this rule will be used for -
15822 either authority or bibliographic
15824 - Match points are set up to determine what fields to match on
15826 - 'Search index' can be found by looking at the ccl.properties file
15827 on your system which tells the zebra indexing what data to search
15828 for in the MARC data". Or you can review the index for standard
15829 index names used. :ref:`Koha Search Indexes`
15831 - 'Score' - The number of 'points' a match on this field is worth.
15832 If the sum of each score is greater than the match threshold, the
15833 incoming record is a match to the existing record
15835 - Enter the MARC tag you want to match on in the 'Tag' field
15837 - Enter the MARC tag subfield you want to match on in the
15840 - 'Offset' - For use with control fields, 001-009
15842 - 'Length' - For use with control fields, 001-009
15844 - Koha only has one 'Normalization rule' that removes extra
15845 characters such as commas and semicolons. The value you enter in
15846 this field is irrelevant to the normalization process.
15848 - 'Required match checks' - ??
15850 .. _sample-bibliographic-record-matching-rule:-control-number-label:
15852 Sample Bibliographic Record Matching Rule: Control Number
15853 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15858 - Match threshold: 100
15860 - Record type: Bibliographic
15864 If you'd like a rule to match on the 001 in authority records
15865 you will need the repeat all of these values and change just
15866 the record type to 'Authority record'
15868 - Matchpoints (just the one):
15870 - Search index: Control-number
15878 this field is for the control number assigned by the
15879 organization creating, using, or distributing the record
15887 - Normalization rule: Control-number
15889 - Required Match checks: none (remove the blank one)
15894 .. _oai-sets-configuration-label:
15896 OAI Sets Configuration
15897 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15899 On this page you can create, modify and delete OAI-PMH sets
15901 .. _create-a-set-label:
15904 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15908 - Click on the link 'Add a new set'
15910 - Fill the mandatory fields 'setSpec' and 'setName'
15912 - Then you can add descriptions for this set. To do this click on 'Add
15913 description' and fill the newly created text box. You can add as many
15914 descriptions as you want.
15916 - Click on 'Save' button'
15918 .. _modify/delete-a-set-label:
15920 Modify/Delete a set
15921 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15923 To modify a set, just click on the link 'Modify' on the same line of the
15924 set you want to modify. A form similar to set creation form will appear
15925 and allow you to modify the setSpec, setName and descriptions.
15927 To delete a set, just click on the link 'Delete' on the same line of the
15928 set you want to delete.
15930 .. _define-mappings-label:
15933 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15935 Here you can define how a set will be build (what records will belong to
15936 this set) by defining mappings. Mappings are a list of conditions on
15937 record content. A record only need to match one condition to belong to
15940 - Fill the fields 'Field', 'Subfield' and 'Value'. For example if you
15941 want to include in this set all records that have a 999$9 equal to
15942 'XXX'. Fill 'Field' with 999, 'Subfield' with 9 and 'Value' with XXX.
15944 - If you want to add another condition, click on 'OR' button and repeat
15949 To delete a condition, just leave at least one of 'Field', 'Subfield' or
15950 'Value' empty and click on 'Save'.
15954 Actually, a condition is true if value in the corresponding subfield
15955 is strictly equal to what is defined if 'Value'. A record having
15956 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9
15959 And it is case sensitive : a record having 999$9 = 'xxx' will not belong
15960 to a set where condition is 999$9 = 'XXX'.
15962 .. _build-sets-label:
15965 ^^^^^^^^^^^^^^^^^^^^^^^^^^
15967 Once you have configured all your sets, you have to build the sets. This
15968 is done by calling the script misc/migration\_tools/build\_oai\_sets.pl.
15970 .. _item-search-fields-label:
15973 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15975 From here you can add custom search fields to the :ref:`item
15976 search <item-searching-label>` option in the staff client. Item
15979 To add a new search term simply click the 'New search field' buttonAdd
15982 - Name is a field for you to identify the search term
15984 - Label is what will appear on the item search page
15986 - MARC field allows you to pick which field you'd like to search in
15988 - MARC subfield is the subfield you'd like to search in
15990 - Authorised values category can be used to turn this search field in
15991 to a pull down instead of a free text field
15993 Once your new field is added it will be visible at the top of this page
15994 and on the item search pageSearch option
15996 .. _acquisitions-module-label:
15999 ----------------------------
16001 The Koha Acquisitions module provides a way for the library to record
16002 orders placed with vendors and manage purchase budgets.
16004 Before using the `Acquisitions Module <#acqmodule>`__, you will want to
16005 make sure that you have completed all of the set up.
16007 - *Get there:* More > Administration > Acquisitions
16009 .. _currencies-and-exchange-rates-label:
16011 Currencies and Exchange Rates
16012 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16014 If you place orders from more than one country you will want to input
16015 currency exchange rates so that your acquisitions module will properly
16018 - *Get there:* More > Administration > Acquisitions > Currencies and
16026 This data is not automatically updated, so be sure to keep it up to
16027 date so that your accounting is kept correct.
16029 The ISO code you enter will be used when importing MARC files via the
16030 staging tools, the tool will attempt to find and use the price of the
16031 currently active currency.
16033 The active currency is the main currency you use in your library. Your
16034 active currency will have a check mark in the 'Active' column. If you
16035 don't have an active currency you will see an error message telling you
16036 to choose an active currency.
16038 No active currency warning
16044 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16046 Budgets are used for tracking accounting values related to acquisitions.
16047 For example you could create a Budget for the current year (ex. 2015)
16048 and then break that into :ref:`Funds` for different areas of the
16049 library (ex. Books, Audio, etc).
16051 - *Get there:* More > Administration > Acquisitions > Budgets
16053 When visiting the main budget administration you will see two tabs, one
16054 for active and one for inactive budgets.
16059 .. _adding-budgets-label:
16062 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16064 Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
16065 :ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
16066 :ref:`closing a previous year's budget <close-a-budget-label>`.
16068 .. _add-a-new-budget-label:
16071 ''''''''''''''''''''''''''''''''''''
16073 If you haven't used Koha before for acquisitions then you'll need to
16074 start fresh with a new budget. To add a new budget click the 'New
16080 - Choose the time period this budget is for, whether it's an academic
16081 year, a fiscal year, a quarter, etc.
16083 - The Description should be something that will help you identify the
16084 budget when ordering
16086 - In the amount box do not use any symbols, simply enter the amount of
16087 the budget with numbers and decimals.
16089 - Marking a budget active makes it usable when placing orders in the
16090 acquisitions module, even if the order is placed after the budget end
16091 date. This will allow you to record orders that were places in a
16092 previous budget period.
16094 - Locking a budget means that Funds will not be able to be modified by
16097 Once you have made your edits, click the 'Save Changes' button. You will
16098 be brought to a list of your existing budgets.
16103 .. _duplicate-a-budget-label:
16106 '''''''''''''''''''''''''''''''''''''''''
16108 To duplicate a budget from a previous year, click on the link for the
16109 budget name from the list of budgets
16114 On the screen listing the budget breakdown click the Edit button at the
16115 top and choose to Duplicate budget
16120 You can also click the 'Actions' button to the right of the budget and
16121 choose 'Duplicate'.Duplicate budget
16123 In both cases you will be presented with a form where you simply need to
16124 enter the new start and end date and save the budget.
16126 New Duplicate Budget
16129 Check the box for 'Mark the original budget as inactive' if the original
16130 budget should no longer be used.
16132 Check the box for 'Set all funds to zero' if you wish the new budget to
16133 contain all the same fund structures as the previous budget but no
16134 allocations until you manually enter an amount in the fund.
16136 This will not only duplicate your budget, but all of the funds
16137 associated with that budget so that you can reuse budgets and funds from
16138 year to year and so that you can move unreceived orders and if desired
16139 unspent funds from a previous budget to the new budget.
16141 .. _close-a-budget-label:
16144 '''''''''''''''''''''''''''''''''
16146 Close a budget to move or roll over unreceived orders and if desired
16147 unspent funds from a previous budget to a new budget. Before closing
16148 your budget you might want to :ref:`duplicate the previous year's
16149 budget <duplicate-a-budget-label>` so that you have somewhere for the
16150 unreceived orders to roll to.
16152 Find the previous budget with unreceived orders on the Active budgets or
16153 the Inactive budgets tab and select 'Close' under 'Actions'. Close a
16158 In order for the unreceived orders to be automatically moved to the
16159 new budget, the fund structures in the previous budget must exist in
16160 the new budget. Budgets without unreceived orders cannot be closed.
16162 When you select 'Close' you will be presented with a form.Closing a
16165 Use the 'Select a budget' drop down to choose the new budget for the
16168 Check the box for 'Move remaining unspent funds' to move the unspent
16169 amounts from the funds of the budget being closed to the selected
16172 Once you have made your choices, click the 'Move unreceived orders'
16173 button. You will be presented with a dialog box that says 'You have
16174 chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This
16175 action cannot be reversed. Do you wish to continue?' Budget X is the
16176 budget to be closed and Budget Y is the selected budget. Close warning
16178 If everything seems correct click 'OK' and the unreceived orders and, if
16179 selected, unspent funds will be moved.
16181 Wait until the 'Report after moving unreceived orders from budget X to
16182 Y' displays. This will list the order numbers which have been impacted
16183 (grouped by fund) and detail if the unreceived order was moved or if
16184 there was a problem. For example, if the new budget does not contain a
16185 fund with the same name as the previous budget, the order will not be
16196 - *Get there:* More > Administration > Acquisitions > Funds
16198 .. _add-a-fund-label:
16201 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16203 A fund is added to a budget.
16207 A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
16210 To add a new fund click the New button and then choose which Budget you
16211 would like to add the fund to.
16213 Choose which budget to add a fund to
16216 In the form that appears you want to enter the basics about your fund.
16221 The three first fields are required, the rest are optional
16223 - Fund Code is a unique identifier for your fund
16225 - The Fund Name should be something that librarians will understand
16227 - Amount should be entered with only numbers and decimals, no other
16230 - Warning at (%) or Warning at (amount) can be filled in to make Koha
16231 warn you before you spend a certain percentage or amount of your
16232 budget. This will prevent you from overspending.
16234 - You can choose to assign this fund to a librarian. Doing so will make
16235 it so that only that librarian can make changes to the Fund
16237 - Choose which library will be using this fund
16239 - You can restrict who can order from this fund by choosing either the
16240 'owner', 'owner and users' or 'owner, users and library' from the
16241 'Restrict access to' menu
16243 Restrict Fund Access
16248 Without an owner, the access restriction will be ignored, be
16249 sure to enter an owner as well as choose a restriction
16251 - Notes are simply for any descriptive notes you might want to add so
16252 that librarians know when to use this fund
16254 - Planning categories are used for statistical purposes. If you will be
16255 using the Asort1 and/or Asort2 authorised values lists to track your orders
16256 you need to select them when setting up the fund. Select the Asort1/Asort2
16257 option from the dropdown lists for the Statiscal 1 done on: and
16258 Statistical 2 done on: fields.
16260 - To learn more about planning categories, check out the :ref:`Planning Category
16261 FAQ <planning-categories-label>`.
16263 When complete, click 'Submit' and you will be brought to a list of all
16264 of the funds for the budget.
16269 The monetary columns in the fund table break down as follows:
16271 1. Base-level allocated is the "Amount" value you defined when creating
16274 2. Base-level ordered is the ordered amount for this fund (without child
16277 3. Total ordered is the base-level ordered for this fund and all its
16280 4. Base-level spent is the spent amount for this fund (without child
16283 5. Total spent is the base-level spent for this fund and all its child
16286 6. Base-level available is 1 - 2
16288 7. Total available is 1 - 3
16290 To the right of each fund you will find the 'Actions' button under which
16291 you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options.
16296 A child fund simply a sub-fund of the fund listed. An example would be
16297 to have a fund for 'Fiction' and under that have a fund for 'New
16298 Releases' and a fund for 'Science Fiction.' It is an optional way to
16299 further organize your finances.
16301 Funds with children will show with a small arrow to the left. Clicking
16302 that will show you the children funds.
16307 .. _budget-planning-label:
16310 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16312 When viewing the list of funds click the 'Planning' button and choose
16313 how you would like to plan to spend your budget.
16315 Planning pull down menu
16318 If you choose 'Plan by MONTHS' you will see the budgeted amount broken
16321 Budget Planning Formula
16324 To hide some of the columns you can click the 'hide' link to the right
16325 (or below as in the screenshot above) the dates. To add more columns you
16326 can click the 'Show a column' link found below the 'Fund Remaining'
16329 Choose columns to add
16332 From here you can plan your budget spending by manually entering values
16333 or by clicking the 'Auto-fill row' button. If you choose to auto-fill
16334 the form the system will try to divide the amount accordingly, you may
16335 have to make some edits to split things more accurately.
16337 Auto-filled columns
16340 Once your changes are made, click the 'Save' button. If you would like
16341 to export your data as a CSV file you can do so by entering a file name
16342 in the 'Output to a file named' field and clicking the 'Output' button.
16344 Export planning as CSV
16347 .. _edi-accounts-label:
16350 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16352 From here you can set up the information needed to connect to your
16353 acquisitions vendors.
16357 Before you begin you will need at least one :ref:`Vendor set up in
16358 Acquisitions <add-a-vendor-label>`.
16360 To add account information click the 'New account' button.New account
16362 In the form that appears you will want to enter your vendor information.
16364 New account information
16366 Each vendor will have one account.
16368 .. _library-eans-label:
16371 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16373 A library EAN is the identifier the vendor gives the library to send
16374 back to them so they know which account to use when billing. One EDI
16375 account can have multiple EANs.
16377 To add an EAN click the 'New EAN' button.
16381 In the form that appears enter the information provided by your vendor.
16385 .. _additional-parameters-label:
16387 Additional Parameters
16388 --------------------------------------------
16390 - *Get there:* More > Administration > Additional Parameters
16392 .. _z39.50/sru-servers-label:
16395 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16397 Z39.50 is a clientâ
\80\93server protocol for searching and retrieving
16398 information from remote computer databases, in short it's a tool used
16399 for copy cataloging.
16401 SRU- Search/Retrieve via URL - is a standard XML-based protocol for
16402 search queries, utilizing CQL - Contextual Query Language - a standard
16403 syntax for representing queries.
16405 Using Koha you can connect to any Z39.50 or SRU target that is publicly
16406 available or that you have the log in information to and copy both
16407 bibliographic and/or authority records from that source.
16409 - *Get there:* More > Administration > Additional Parameters >
16412 Koha comes with a default list of Z39.50/SRU targets set up that you can
16413 add to, edit or delete
16415 List of Z39.50 Servers in Koha
16418 To find additional Z39.50 targets you use IndexData's IRSpy:
16419 `http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
16420 Library of Congress's List of Targets http://www.loc.gov/z3950/
16422 .. _add-a-z39.50-target-label:
16424 Add a Z39.50 Target
16425 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16427 - From the main Z39.50 page, click 'New Z39.50 Server'
16429 New Z39.50 Server Form
16432 - 'Z39.50 server' should be populated with a name that will help you
16433 identify the source (such as the library name).
16435 - 'Hostname' will be the address to the Z39.50 target.
16437 - 'Port' tells Koha what port to listen on to get results from this
16440 - 'Userid' and 'Password' are only required for servers that are
16441 password protected.
16443 - Check the 'Preselected' box if you want this target to always be
16444 selected by default.
16446 - 'Rank' lets you enter where in the list you'd like this target to
16449 - If this is left blank the targets will be in alphabetical
16452 - 'Syntax' is the MARC flavor you use.
16454 - 'Encoding' tells the system how to read special characters.
16456 - 'Timeout' is helpful for targets that take a long while. You can
16457 set the timeout so that it doesn't keep trying the target if
16458 results aren't found in a reasonable amount of time.
16460 - 'Record type' lets you define if this is a bibliographic or an
16463 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
16464 names that you want to apply on the search results.
16466 - When retrieving records from external targets you may wish to
16467 automate some changes to those records. XSLT's allow you to do
16468 this. Koha ships with some sample XSLT files in the
16469 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
16471 - Del952.xsl: Remove items (MARC21/NORMARC)
16473 - Del995.xsl: Remove items (UNIMARC)
16475 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
16478 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
16481 .. _suggested-bibliographic-z39.50-targets-label:
16483 Suggested Bibliographic Z39.50 Targets
16484 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16486 Koha libraries with open Z39.50 targets can share and find connection
16487 information on the Koha wiki:
16488 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources. You can
16489 also find open Z39.50 targets by visiting IRSpy:
16490 http://irspy.indexdata.com.
16492 The following targets have been used successfully by other Koha
16493 libraries (in the Americas):
16495 - ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC
16497 - CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC
16499 - GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC
16501 - HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon
16503 - HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton\_hills
16505 - LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB
16507 - LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC
16509 - MANITOBA PUBLIC library.gov.mb.ca:210 horizon
16511 - MILTON PL cat.mpl.on.ca:210 horizon
16513 - NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default
16515 - NHUPAC 199.192.6.130:211 nh\_nhupac
16517 - OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC
16519 - OHIOLINK olc1.ohiolink.edu:210 INNOPAC
16521 - PUBCAT prod890.dol.state.vt.us:2300 unicorn
16523 - SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210
16526 - SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON
16528 - TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn
16530 - TRI-UNI 129.97.129.194:7090 voyager
16532 - VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
16534 .. _suggested-authority-z39.50-targets-label:
16536 Suggested Authority Z39.50 Targets
16537 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16539 The following targets have been used successfully by other Koha
16540 libraries (in the Americas):
16542 - LIBRARIESAUSTRALIA AUTHORITIES
16543 z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid:
16544 ANLEZ / Password: z39.50
16546 - LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF
16548 - LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
16550 .. _add-a-sru-target-label:
16553 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16555 - From the main Z39.50/SRU page, click 'New SRU Server'
16557 New SRU Server Form
16560 - 'Server name' should be populated with a name that will help you
16561 identify the source (such as the library name).
16563 - 'Hostname' will be the address to the Z39.50 target.
16565 - 'Port' tells Koha what port to listen on to get results from this
16568 - 'Userid' and 'Password' are only required for servers that are
16569 password protected.
16571 - Check the 'Preselected' box if you want this target to always be
16572 selected by default.
16574 - 'Rank' lets you enter where in the list you'd like this target to
16577 - If this is left blank the targets will be in alphabetical
16580 - 'Syntax' is the MARC flavor you use.
16582 - 'Encoding' tells the system how to read special characters.
16584 - 'Timeout' is helpful for targets that take a long while. You can
16585 set the timeout so that it doesn't keep trying the target if
16586 results aren't found in a reasonable amount of time.
16588 - 'Additional SRU options' is where you can enter additional options
16589 of the external server here, like sru\_version=1.1 or
16590 schema=marc21, etc. Note that these options are server dependent.
16592 - 'SRU Search field mapping' lets you add or update the mapping from
16593 the available fields on the Koha search form to the specific
16594 server dependent index names.
16596 - To further refine your searches, you could add the following
16597 index names to the SRU search field mappings. To do this, edit
16598 the server and click the Modify button next to this field.
16600 +---------------+---------------------------+
16601 | Title | dc.title |
16602 +---------------+---------------------------+
16603 | ISBN | bath.isbn |
16604 +---------------+---------------------------+
16605 | Any | cql.anywhere |
16606 +---------------+---------------------------+
16607 | Author | dc.author |
16608 +---------------+---------------------------+
16609 | ISSN | bath.issn |
16610 +---------------+---------------------------+
16611 | Subject | dc.subject |
16612 +---------------+---------------------------+
16613 | Standard ID | bath.standardIdentifier |
16614 +---------------+---------------------------+
16618 - 'XSLT file(s)' lets enter one or more (comma-separated) XSLT file
16619 names that you want to apply on the search results.
16621 - When retrieving records from external targets you may wish to
16622 automate some changes to those records. XSLT's allow you to do
16623 this. Koha ships with some sample XSLT files in the
16624 /koha-tmpl/intranet-tmpl/prog/en/xslt/ directory ready for use:
16626 - Del952.xsl: Remove items (MARC21/NORMARC)
16628 - Del995.xsl: Remove items (UNIMARC)
16630 - Del9LinksExcept952.xsl: Remove $9 links. Skip item fields
16633 - Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
16636 .. _did-you-mean?-label:
16639 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16641 *Get there:* More > Administration > Additional Parameters > Did you
16644 Koha can offer 'Did you mean?' options on searches based on values in
16645 your :ref:`authorities <authorities-label>`.
16649 Did you mean? only works in the OPAC at this time. The Intranet
16650 options are here for future development.
16652 Using this page you can control which options Koha gives patrons on
16653 their search results.
16658 To turn on the 'Did you mean?' bar on your search results you need to
16659 check the box next to each plugin you would like to use. The two plugins
16660 you have to choose from are:
16662 - The ExplodedTerms plugin suggests that the user try searching for
16663 broader/narrower/related terms for a given search (e.g. a user
16664 searching for "New York (State)" would click the link for narrower
16665 terms if they're also interested in "New York (City)"). This is only
16666 relevant for libraries with highly hierarchical authority data.
16668 - The AuthorityFile plugin searches the authority file and suggests the
16669 user might be interested in bibs linked to the top 5 authorities
16671 If you want one plugin to take priority over another you simply drag it
16674 Drag and drop options
16677 If you choose both plugins you will see several options at the top of
16678 your search results
16683 If you choose just the AuthorityFile you'll see just authorities.
16688 .. _column-settings-label:
16691 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16693 This administration area will help you hide or display columns on fixed
16694 tables throughout the staff client.
16696 - *Get there:* Administration > Additional Parameters > Column settings
16701 Clicking on the module you'd like to edit tables for will show you the
16702 options available to you.
16704 This area lets you control the columns that show in the table in
16705 question. If nothing is hidden you will see no check marks in the 'is
16706 hidden by default' column.
16711 And will see all of the columns when viewing the table on its regular
16714 Columns on currency table
16717 If columns are hidden they will have checks in the 'is hidden by
16723 And hidden when you view the table.
16725 Columns on currency table
16728 You can also toggle columns using the 'Show/Hide Columns button in the
16729 top right of the page
16734 .. _audio-alerts-label:
16737 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16739 If you have your :ref:`AudioAlerts` preference set to
16740 'Enable' you will be able to control the various alert sounds that Koha
16741 uses from this area.
16743 - *Get there:* More > Administration > Additional Parameters > Audio
16746 Each dialog box in Koha has a CSS class assigned to it that can be used
16747 as a selector for a sound.Audio alerts
16749 You can edit the defaults by clicking the 'Edit' button to the right of
16750 each alertEdit alert
16752 You can assign alerts to other CSS classes in Koha by entering that
16753 information in the selector box. For example if you enter
16757 body:contains('Check in message')
16759 Then when you visit the checkin page you will hear an alert.
16761 Every page in Koha has a unique ID in the body tag which can be used to
16762 limit a sound to a specific page
16764 Any ID selector (where html contains id="name\_of\_id" ) and can also be
16765 a trigger as: #name\_of\_selector
16767 .. _sms-cellular-providers-label:
16769 SMS cellular providers
16770 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16774 This option will only appear if the
16775 :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
16777 From here you can enter as many cellular providers as you need to send
16778 SMS notices to your patrons using the email protocol.SMS Providers
16780 Some examples in the US are:
16782 +---------------------+-----------------------------+
16783 | Mobile Carrier | SMS Gateway Domain |
16784 +=====================+=============================+
16785 | Alltel | sms.alltelwireless.com |
16786 +---------------------+-----------------------------+
16787 | AT&T | txt.att.net |
16788 +---------------------+-----------------------------+
16789 | Boost Mobile | sms.myboostmobile.com |
16790 +---------------------+-----------------------------+
16791 | Project Fi | msg.fi.google.com |
16792 +---------------------+-----------------------------+
16793 | Republic Wireless | text.republicwireless.com |
16794 +---------------------+-----------------------------+
16795 | Sprint | messaging.sprintpcs.com |
16796 +---------------------+-----------------------------+
16797 | T-Mobile | tmomail.net |
16798 +---------------------+-----------------------------+
16799 | U.S. Cellular | email.uscc.net |
16800 +---------------------+-----------------------------+
16801 | Verizon Wireless | vtext.com |
16802 +---------------------+-----------------------------+
16803 | Virgin Mobile | vmobl.com |
16804 +---------------------+-----------------------------+
16806 Table: SMS Provider Examples
16808 To add new providers enter the details in the form and click 'Add new'
16809 to save.Add SMS Provider
16811 These options will appear in the OPAC for patrons to choose from on the
16812 :ref:`messaging tab <my-messaging-label>` if you have
16813 :ref:`EnhancedMessagingPreferences`
16814 enabled.Options for providers in the OPAC