Bug 27936: Clarify AllowItemsOnHoldCheckoutSIP syspref help text
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / circulation.pref
1 Circulation:
2     Interface:
3         -
4             - pref: CircSidebar
5               choices:
6                   yes: Activate
7                   no: Deactivate
8             - the navigation sidebar on all Circulation pages.
9         -
10             - pref: AutoSwitchPatron
11               choices:
12                   yes: "Enable"
13                   no: "Don't enable"
14             - the automatic redirection to another patron when a patron barcode is scanned instead of a book.
15             - This should not be enabled if you have overlapping patron and book barcodes.
16         -
17             - pref: PatronAutoComplete
18               choices:
19                   yes: Try
20                   no: "Don't try"
21             - to guess the patron being entered while typing a patron search for circulation or patron search.
22             - Only returns the first 10 results at a time.
23         -
24             - pref: itemBarcodeInputFilter
25               choices:
26                   OFF: "Don't filter"
27                   whitespace: Remove spaces from
28                   cuecat: Convert from CueCat form
29                   T-prefix: Remove the first number from T-prefix style
30                   libsuite8: Convert from Libsuite8 form
31                   EAN13: EAN-13 or zero-padded UPC-A from
32             - scanned item barcodes.
33         -
34             - pref: itemBarcodeFallbackSearch
35               choices:
36                   yes: "Enable"
37                   no: "Don't enable"
38             - the automatic use of a keyword catalog search if the phrase entered as a barcode on the checkout page does not turn up any results during an item barcode search.
39         -
40             - Sort previous checkouts on the circulation page from
41             - pref: previousIssuesDefaultSortOrder
42               choices:
43                   asc: earliest to latest
44                   desc: latest to earliest
45             - due date.
46         -
47             - "Sort today's checkouts on the circulation page from"
48             - pref: todaysIssuesDefaultSortOrder
49               type: choice
50               choices:
51                   asc: earliest to latest
52                   desc: latest to earliest
53             - checkout time.
54         -
55             - pref: SpecifyDueDate
56               choices:
57                   yes: Allow
58                   no: "Don't allow"
59             - staff to specify a due date for a checkout.
60         -
61             - pref: SpecifyReturnDate
62               choices:
63                   yes: Allow
64                   no: "Don't allow"
65             - staff to specify a return date for a check in.
66         -
67             - Set the default start date for the Holds to pull list to
68             - pref: HoldsToPullStartDate
69               class: integer
70             - day(s) ago. Note that the default end date is controlled by preference ConfirmFutureHolds.
71         -
72             - pref: AllowAllMessageDeletion
73               choices:
74                   yes: Allow
75                   no: "Don't allow"
76             - staff to delete messages added from other libraries.
77         -
78             - Show the
79             - pref: numReturnedItemsToShow
80               class: integer
81             - last returned items on the checkin screen.
82         -
83             - pref: FineNotifyAtCheckin
84               choices:
85                   yes: Notify
86                   no: "Don't notify"
87             - librarians of overdue fines on the items they are checking in.
88         -
89             - pref: WaitingNotifyAtCheckin
90               choices:
91                   yes: Notify
92                   no: "Don't notify"
93             - librarians of waiting holds for the patron whose items they are checking in.
94         -
95             - pref: FilterBeforeOverdueReport
96               choices:
97                   yes: Require
98                   no: "Don't require"
99             - staff to choose which checkouts to show before running the overdues report.
100         -
101             - pref: DisplayClearScreenButton
102               choices:
103                   yes: Show
104                   no: "Don't show"
105             - a button to clear the current patron from the screen on the circulation screen.
106         -
107             - pref: RecordLocalUseOnReturn
108               choices:
109                   yes: Record
110                   no: "Don't record"
111             - local use when an unissued item is checked in.
112         -
113             - When an empty barcode field is submitted in circulation
114             - pref: CircAutoPrintQuickSlip
115               choices:
116                   clear: "clear the screen"
117                   qslip: "open a print quick slip window"
118                   slip: "open a print slip window"
119             - .
120         -
121             - Include the stylesheet at
122             - pref: NoticeCSS
123               class: url
124             - on Notices. (This should be a complete URL, starting with <code>http://</code>)
125         -
126             - pref: UpdateTotalIssuesOnCirc
127               choices:
128                   yes: Do
129                   no: "Do not"
130             - update a bibliographic record's total issues count whenever an item is issued (WARNING! This increases server load significantly; if performance is a concern, use the update_totalissues.pl cron job to update the total issues count).
131         -
132             - pref: ExportCircHistory
133               choices:
134                   yes: Show
135                   no: "Don't show"
136             - the export patron checkout history options.
137         -
138             - The following fields should be excluded from the patron checkout history CSV or MARC (ISO 2709) export
139             - pref: ExportRemoveFields
140             - (separate fields with space, e.g. 100a 200b 300c)
141         -
142             - pref: AllowOfflineCirculation
143               choices:
144                   yes: Enable
145                   no: "Do not enable"
146             - "offline circulation on regular circulation computers. (<strong>NOTE:</strong> This system preference does not affect the Firefox plugin or the desktop application)"
147         -
148             - pref: ShowAllCheckins
149               choices:
150                   yes: Show
151                   no: "Do not show"
152             - all items in the "Checked-in items" list, even items that were not checked out.
153         -
154             - pref: AllowCheckoutNotes
155               choices:
156                   yes: Allow
157                   no: "Don't allow"
158             - patrons to submit notes about checked out items.
159         -
160             - pref: UseCirculationDesks
161               choices:
162                   yes: "Use"
163                   no: "Don't use"
164             - circulation desks with circulation.
165
166     Checkout policy:
167         -
168             - pref: OnSiteCheckoutAutoCheck
169               choices:
170                   yes: Enable
171                   no: Don't enable
172             - onsite checkout by default if last checkout was an onsite one
173         -
174             - pref: AutoReturnCheckedOutItems
175               choices:
176                   yes: Don't
177                   no: Do
178             - require librarians to manually confirm a checkout where the item is already checked out to another patron.
179         -
180             - pref: AllowTooManyOverride
181               choices:
182                   yes: Allow
183                   no: "Don't allow"
184             - staff to override and check out items when the patron has reached the maximum number of allowed checkouts.
185         -
186             - pref: AutoRemoveOverduesRestrictions
187               choices:
188                   yes: "Do"
189                   no: "Do not"
190             - allow OVERDUES restrictions triggered by sent notices to be cleared automatically when all overdue items are returned by a patron.
191         -
192             - pref: AllowNotForLoanOverride
193               choices:
194                   yes: Allow
195                   no: "Don't allow"
196             - staff to override and check out items that are marked as not for loan.
197         -
198             - pref: AllowRenewalLimitOverride
199               choices:
200                   yes: Allow
201                   no: "Don't allow"
202             - staff to manually override renewal blocks and renew a checkout when it would go over the renewal limit or be premature with respect to the "No renewal before" setting in the circulation policy or has been scheduled for automatic renewal.
203         -
204             - pref: AllowRenewalOnHoldOverride
205               choices:
206                   yes: Allow
207                   no: "Don't allow"
208             - staff to renew items that are on hold by manually specifying a due date.
209         -
210             - pref: AllowItemsOnHoldCheckoutSIP
211               choices:
212                   yes: Allow
213                   no: "Don't allow"
214             - checkouts of items reserved to someone else via SIP checkout messages.
215             - If allowed do not generate RESERVED warning.
216             - This allows self checkouts for those items. If using the holds queue items with pending holds will be marked as "unavailable" if this set to "Don't allow".
217         -
218             - pref: AllowItemsOnHoldCheckoutSCO
219               choices:
220                   yes: Allow
221                   no: "Don't allow"
222             - checkouts of items reserved to someone else in the SCO module. If allowed do not generate RESERVE_WAITING and RESERVED warning. This allows self checkouts for those items.
223         -
224             - pref: AllFinesNeedOverride
225               choices:
226                   yes: Require
227                   no: "Don't require"
228             - staff to manually override all fines, even fines less than noissuescharge.
229         -
230             - pref: AllowFineOverride
231               choices:
232                   yes: Allow
233                   no: "Don't allow"
234             - staff to manually override and check out items to patrons who have more than noissuescharge in fines.
235         -
236             - pref: AutomaticItemReturn
237               choices:
238                   yes: Do
239                   no: "Don't"
240             - automatically transfer items to their home library when they are returned.
241         -
242             - pref: UseBranchTransferLimits
243               choices:
244                   yes: Enforce
245                   no: "Don't enforce"
246             - library transfer limits based on
247             - pref: BranchTransferLimitsType
248               choices:
249                   ccode: collection code
250                   itemtype: item type
251             - .
252         -
253             - pref: UseTransportCostMatrix
254               choices:
255                   yes: Use
256                   no: "Don't use"
257             - Transport Cost Matrix for calculating optimal holds filling between branches.
258         -
259             - Use the checkout and fines rules of
260             - pref: CircControl
261               type: choice
262               choices:
263                   PickupLibrary: the library you are logged in at.
264                   PatronLibrary: the library the patron is from.
265                   ItemHomeLibrary: the library the item is from.
266         -
267             - Use the checkout and fines rules of
268             - pref: HomeOrHoldingBranch
269               type: choice
270               choices:
271                   homebranch: the item's home library (homebranch).
272                   holdingbranch: the item's holding library (holdingbranch).
273         -
274             - Allow materials to be returned to
275             - pref: AllowReturnToBranch
276               type: choice
277               choices:
278                   anywhere: to any library.
279                   homebranch: only the library the item is from.
280                   holdingbranch: only the library the item was checked out from.
281                   homeorholdingbranch: either the library the item is from or the library it was checked out from.
282         -
283             - For search results in the staff client, display the branch of
284             - pref: StaffSearchResultsDisplayBranch
285               type: choice
286               choices:
287                   homebranch: the library the item is from.
288                   holdingbranch: the library the item is held by.
289         -
290             - pref: useDaysMode
291               choices:
292                   Days: Ignore the calendar
293                   Calendar: Use the calendar to skip days the library is closed
294                   Datedue: Use the calendar to push the due date to the next open day
295                   Dayweek: Use the calendar to push the due date to the next open matching weekday for weekly loan periods, or the next open day otherwise
296             - when calculating the date due.
297         -
298             - Calculate "No renewal before" based on
299             - pref: NoRenewalBeforePrecision
300               choices:
301                   date: date.
302                   exact_time: exact time.
303             - Only relevant for loans calculated in days, hourly loans are not affected.
304         -
305             - When renewing checkouts, base the new due date on
306             - pref: RenewalPeriodBase
307               choices:
308                   date_due: the old due date of the checkout.
309                   now: the current date.
310         -
311             - pref: RenewalSendNotice
312               choices:
313                   yes: Send
314                   no: "Don't send"
315             - a renewal notice according to patron checkout alert preferences.
316         -
317             - Prevent patrons from making holds on the OPAC if they owe more than
318             - pref: maxoutstanding
319               class: currency
320             - '[% local_currency %] in fines.'
321         -
322             - Show a warning on the "Transfers to Receive" screen if the transfer has not been received
323             - pref: TransfersMaxDaysWarning
324               class: integer
325             - days after it was sent.
326         -
327             - pref: IssuingInProcess
328               choices:
329                   yes: "Don't prevent"
330                   no: "Prevent"
331             - patrons from checking out an item whose rental charge would take them over the limit.
332         -
333             - "Restrict patrons with the following target audience values from checking out inappropriate materials:"
334             - pref: AgeRestrictionMarker
335             - "E.g. enter target audience keyword(s) split by | (bar) FSK|PEGI|Age| (No white space near |). Be sure to map agerestriction in Koha to MARC mapping (e.g. 521$a). A MARC field value of FSK 12 or PEGI 12 would mean: Borrower must be 12 years old. Leave empty to not apply an age restriction."
336         -
337             - pref: AgeRestrictionOverride
338               choices:
339                   yes: Allow
340                   no: "Don't allow"
341             - staff to check out an item with age restriction.
342         -
343             - Prevent patrons from checking out books if they have more than
344             - pref: noissuescharge
345               class: integer
346             - '[% local_currency %] in fines.'
347         -
348             - Prevent a patron from checking out if the patron has guarantees owing in total more than
349             - pref: NoIssuesChargeGuarantees
350               class: integer
351             - '[% local_currency %] in fines.'
352         -
353             - pref: RentalsInNoissuesCharge
354               choices:
355                   yes: Include
356                   no: "Don't include"
357             - rental charges when summing up charges for noissuescharge.
358         -
359             - pref: ManInvInNoissuesCharge
360               choices:
361                   yes: Include
362                   no: "Don't include"
363             - custom debit type charges when summing up charges for noissuescharge.
364         -
365             - pref: HoldsInNoissuesCharge
366               choices:
367                   yes: Include
368                   no: "Don't include"
369             - hold charges when summing up charges for noissuescharge.
370         -
371             - pref: ReturnBeforeExpiry
372               choices:
373                   yes: Require
374                   no: "Don't require"
375             - "patrons to return books before their accounts expire (by restricting due dates to before the patron's expiration date)."
376         -
377             - Send all notices as a BCC to this email address
378             - pref: NoticeBcc
379         -
380             - pref: OverdueNoticeCalendar
381               choices:
382                   yes: "Use Calendar"
383                   no: "Ignore Calendar"
384             - when working out the period for overdue notices
385         -
386             - Include up to
387             - pref: PrintNoticesMaxLines
388               class: integer
389             - "item lines in a printed overdue notice. If the number of items is greater than this number, the notice will end with a warning asking the patron to check their online account for a full list of overdue items. Set to 0 to include all overdue items in the notice, no matter how many there are."
390         -
391             - pref: OverduesBlockCirc
392               choices:
393                   block: Block
394                   noblock: "Don't block"
395                   confirmation: Ask for confirmation
396             - "when checking out to a patron that has overdues outstanding."
397         -
398             - "When checking out an item with rental fees, "
399             - pref: RentalFeesCheckoutConfirmation
400               choices:
401                   yes: ask
402                   no: "do not ask"
403             - "for confirmation."
404         -
405             - By default, set the LOST value of an item to
406             - pref: DefaultLongOverdueLostValue
407               class: integer
408             - when the item has been overdue for more than
409             - pref: DefaultLongOverdueDays
410               class: integer
411             - days.
412             - <br>WARNING â€” These preferences will activate the automatic item loss process. Leave these fields empty if you don't want to activate this feature.
413             - "<br>Example: [1] [30] Sets an item to the LOST value 1 when it has been overdue for more than 30 days."
414             - <br>(Used when the longoverdue.pl script is called without the --lost parameter)
415             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask your system administrator to schedule it."
416         -
417             - "Charge a lost item to the borrower's account when the LOST value of the item changes to :"
418             - pref: DefaultLongOverdueChargeValue
419               class: integer
420             - <br>Leave this field empty if you don't want to charge the user for lost items.
421             - <br>(Used when the longoverdue.pl script is called without the --charge parameter)
422             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask your system administrator to schedule it."
423         -
424             - When using the automatic item loss process, skip items with lost values matching any of
425             - pref: DefaultLongOverdueSkipLostStatuses
426             - "."
427             - <br>Leave this field empty if you don't want to skip any lost statuses.
428             - <br>Set to a list of comma separated values, e.g. <em>5,6,7</em>.
429         -
430             - "When issuing an item that has been marked as lost, "
431             - pref: IssueLostItem
432               choices:
433                   confirm: "require confirmation"
434                   alert: "display a message"
435                   nothing : "do nothing"
436             - .
437         -
438             - "Mark items as returned when flagged as lost "
439             - pref: MarkLostItemsAsReturned
440               multiple:
441                 cronjob: "from the longoverdue cronjob"
442                 batchmod: "from the batch item modification tool"
443                 additem: "when cataloguing an item"
444                 moredetail: "from the items tab of the catalog module"
445                 pendingreserves: "from the 'Holds to pull' list"
446                 onpayment: "when receiving payment for the item"
447                 claim_returned: "when marking an item as a return claim"
448             - .
449         -
450             - pref: AllowMultipleIssuesOnABiblio
451               choices:
452                   yes: Allow
453                   no: "Don't allow"
454             - "patrons to check out multiple items from the same record.  (<strong>NOTE:</strong> This will only affect records without a subscription attached.)"
455         -
456             - pref: OnSiteCheckouts
457               choices:
458                   yes: Enable
459                   no: Disable
460             - the on-site checkouts feature.
461         -
462             - pref: OnSiteCheckoutsForce
463               choices:
464                   yes: Enable
465                   no: Disable
466             - the on-site for all cases (Even if a user is debarred, etc.).
467         -
468             - pref: ConsiderOnSiteCheckoutsAsNormalCheckouts
469               choices:
470                   yes: Consider
471                   no: "Don't consider"
472             - on-site checkouts as normal checkouts.
473             - If enabled, on-site checkouts will count toward the checkout limit for regular checkouts. The on-site limit will still apply for on-site checkouts.
474             - If disabled, both values will be checked separately.
475         -
476             - pref: SwitchOnSiteCheckouts
477               choices:
478                   yes: Switch
479                   no: "Don't switch"
480             - on-site checkouts to normal checkouts when checked out.
481         -
482             - When a patron's checked out item is overdue,
483             - pref: OverduesBlockRenewing
484               type: choice
485               choices:
486                   allow: allow renewing.
487                   blockitem: block renewing only for this item.
488                   block: block renewing for all the patron's items.
489         -
490             - If patron is restricted,
491             - pref: RestrictionBlockRenewing
492               choices:
493                   yes: Block
494                   no: Allow
495             - renewing of items.
496         -
497             - If a patron owes more than the value of OPACFineNoRenewals,
498             - pref: OPACFineNoRenewalsBlockAutoRenew
499               choices:
500                   yes: Block
501                   no: Allow
502             - their auto-renewals.
503         -
504             - If a patron pays off all fines on an overdue item that is accruing fines
505             - pref: RenewAccruingItemWhenPaid
506               choices:
507                   yes: Renew
508                   no: "Don't renew"
509             - the item automatically. If the syspref "RenewalPeriodBase" is set to "due date", renewed items may still be overdue.
510         -
511             - If a patron pays off all fines on an overdue item that is accruing fines in the OPAC via a payment plugin
512             - pref: RenewAccruingItemInOpac
513               choices:
514                   yes: Renew
515                   no: "Don't renew"
516             - the item automatically. If the syspref "RenewalPeriodBase" is set to "due date", renewed items may still be overdue.
517         -
518             - pref: ItemsDeniedRenewal
519               type: textarea
520               syntax: text/x-yaml
521               class: code
522             - Define custom rules to deny specific items from renewal.
523             - "<br />Can name any field in the items table followed by a colon then a space then"
524             - "a bracketed list of values separated by commas."
525             - "e.g."
526             - "<br />ccode: [NEWFIC,NULL,DVD]"
527             - "<br />itype: [NEWBK,\"\"]"
528             - "<br /> Note: the word 'NULL' can be used to block renewal on undefined fields, while an empty string \"\" will block on an empty (but defined) field."
529     Checkin policy:
530         -
531             - pref: TrapHoldsOnOrder
532               choices:
533                   yes: Trap
534                   no: "Don't trap"
535             - items that are not for loan but holdable ( notforloan < 0 ) to fill holds.
536         -
537             - Never trap items with 'not for loan' values of
538             - pref: SkipHoldTrapOnNotForLoanValue
539               class: integer
540             - to fill holds.
541             - "(list of not for loan values separated with a pipe '|')"
542         -
543             - pref: HoldsAutoFill
544               choices:
545                   yes: Do
546                   no: "Don't"
547             - automatically fill holds instead of asking the librarian.
548         -
549             - pref: HoldsAutoFillPrintSlip
550               choices:
551                   yes: Do
552                   no: "Don't"
553             - automatically display the hold slip dialog for auto-filled holds.
554         -
555             - pref: BlockReturnOfWithdrawnItems
556               choices:
557                   yes: Block
558                   no: "Don't block"
559             - returning of items that have been withdrawn.
560         -
561             - pref: BlockReturnOfLostItems
562               choices:
563                   yes: Block
564                   no: "Don't block"
565             - returning of items that have been lost.
566         -
567             - pref: CalculateFinesOnReturn
568               choices:
569                   yes: Do
570                   no: "Don't"
571             - calculate and update overdue charges when an item is returned.
572             - "<br /><strong>NOTE: If you are doing hourly loans then you should have this on.</strong>"
573             - "<br /><strong>NOTE: This system preference requires FinesMode to be set to 'Calculate and charge.'</strong>"
574         -
575             - pref: CalculateFinesOnBackdate
576               choices:
577                   yes: Do
578                   no: "Don't"
579             - calculate and update overdue charges when an item is returned with a backdated return date.
580         -
581             - pref: UpdateItemLocationOnCheckin
582               type: textarea
583               syntax: text/x-yaml
584               class: code
585             - "This is a list of value pairs. The first value is followed immediately by colon space then the second value.<br/><br/>"
586             - "Examples:<br/>"
587             - "PROC: FIC - causes an item in the Processing Center location to be updated into the Fiction location on check in.<br/>"
588             - "FIC: GEN - causes an item in the Fiction location to be updated into the General stacks location on check in.<br/>"
589             - "_BLANK_: FIC - causes an item that has no location to be updated into the Fiction location on check in.<br/>"
590             - "FIC: _BLANK_ - causes an item in location FIC to be updated to a blank location on check in.<br/>"
591             - "_ALL_: FIC - causes all items to be updated into the Fiction location on check in.<br/>"
592             - "PROC: _PERM_ - causes an item that is in the Processing Center to be updated to it's permanent location.<br/><br/>"
593             - "General rule: if the location value on the left of the colon (:) matches the item's current location, it will be updated to match the location value on the right of the colon (:).<br/>"
594             - "Note: PROC and CART are special values, for these locations only can location and permanent_location differ, in all other cases an update will affect both. Items in the CART location will be returned to their permanent location on checkout.<br/>"
595             - "The special term _BLANK_ may be used on either side of a value pair to update or remove the location from items with no location assigned.<br/>"
596             - "The special term _ALL_ is used on the left side of the colon (:) to affect all items, <strong>and overrides all other rules.</strong>"
597         -
598             - pref: UpdateNotForLoanStatusOnCheckin
599               type: textarea
600               syntax: text/x-yaml
601               class: code
602             - This is a list of value pairs. When an item is checked in, if the not for loan value on the left matches the items not for loan value
603             - "it will be updated to the right-hand value. E.g. '-1: 0' will cause an item that was set to 'Ordered' to now be available for loan."
604             - Each pair of values should be on a separate line.
605         -
606             - pref: CumulativeRestrictionPeriods
607               choices:
608                   yes: Cumulate
609                   no: "Don't cumulate"
610             - the restriction periods.
611         -
612             - pref: HidePersonalPatronDetailOnCirculation
613               choices:
614                   yes: "Hide"
615                   no: "Don't hide"
616             - patrons phone number, email address, street address and city on the circulation page.
617         -
618             - pref: TransfersBlockCirc
619               choices:
620                   yes: "Block"
621                   no: "Don't block"
622             - staff from continuing to checkin items when a transfer is triggered.
623         -
624             - pref: StoreLastBorrower
625               default: 0
626               choices:
627                   yes: Store
628                   no: "Don't store"
629             - the last patron to return an item. This setting is independent of opacreadinghistory/AnonymousPatron.
630     Holds policy:
631         -
632             - In the staff client, split the holds queue into separate tables by
633             - pref: HoldsSplitQueue
634               choices:
635                   nothing: nothing
636                   branch: "pickup library"
637                   itemtype: "hold itemtype"
638                   branch_itemtype: "pickup library & itemtype"
639         -
640             - If the holds queue is split, show librarians
641             - pref: HoldsSplitQueueNumbering
642               choices:
643                   actual: "the actual priority, which may be out of order"
644                   virtual: "'virtual' priorities, where each group is numbered separately"
645         -
646             - pref: AllowHoldItemTypeSelection
647               choices:
648                   yes: Allow
649                   no: "Don't allow"
650             - hold fulfillment to be limited by itemtype.
651         -
652             - pref: AllowRenewalIfOtherItemsAvailable
653               choices:
654                   yes: Allow
655                   no: "Don't allow"
656             - a patron to renew an item with unfilled holds if other available items can fill that hold.
657         -
658             - pref: AllowHoldPolicyOverride
659               choices:
660                   yes: Allow
661                   no: "Don't allow"
662             - staff to override hold policies when placing holds.
663         -
664             - pref: AllowHoldsOnDamagedItems
665               choices:
666                   yes: Allow
667                   no: "Don't allow"
668             - hold requests to be placed on and filled by damaged items.
669         -
670             - pref: AllowHoldDateInFuture
671               choices:
672                   yes: Allow
673                   no: "Don't allow"
674             - hold requests to be placed that do not enter the waiting list until a certain future date.
675         -
676             - pref: OPACAllowHoldDateInFuture
677               choices:
678                   yes: Allow
679                   no: "Don't allow"
680             - "patrons to place holds that don't enter the waiting list until a certain future date. (AllowHoldDateInFuture must also be enabled)."
681         -
682             - Confirm future hold requests (starting no later than
683             - pref: ConfirmFutureHolds
684               class: integer
685             - days from now) at checkin time. Note that this number of days will be used too in calculating the default end date for the Holds to pull-report. But it does not interfere with issuing, renewing or transferring books.
686         -
687             - Check the
688             - pref: ReservesControlBranch
689               choices:
690                   ItemHomeLibrary: "item's home library"
691                   PatronLibrary: "patron's home library"
692             - to see if the patron can place a hold on the item.    
693         -
694             - Mark a hold as problematic if it has been waiting for more than
695             - pref: ReservesMaxPickUpDelay
696               class: integer
697             - days.
698         -
699             - pref: ExpireReservesMaxPickUpDelay
700               choices:
701                   yes: Allow
702                   no: "Don't allow"
703             - "holds to expire automatically if they have not been picked by within the time period specified in ReservesMaxPickUpDelay.<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/holds/cancel_expired_holds.pl</code> cronjob. Ask your system administrator to schedule it."
704         -
705             - If using ExpireReservesMaxPickUpDelay, charge a patron who allows their waiting hold to expire a fee of
706             - pref: ExpireReservesMaxPickUpDelayCharge
707               class: currency
708         -
709             - Satisfy holds using items from the libraries
710             - pref: StaticHoldsQueueWeight
711               class: multi
712             - (as branchcodes, separated by commas; if empty, uses all libraries)
713             - when they are
714             - pref: HoldsQueueSkipClosed
715               choices:
716                   yes: open
717                   no: open or closed
718             - pref: RandomizeHoldsQueueWeight
719               choices:
720                   yes: in random order.
721                   no: in that order.
722             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/holds/build_holds_queue.pl</code> cronjob. Ask your system administrator to schedule it."
723             -
724         -
725             - pref: canreservefromotherbranches
726               choices:
727                   yes: Allow
728                   no: "Don't allow (with independent branches)"
729             - a user from one library to place a hold on an item from another library
730         -
731             - pref: OPACAllowUserToChooseBranch
732               choices:
733                   yes: Allow
734                   no: "Don't allow"
735             - a user to choose the library to pick up a hold from.
736         -
737             - pref: ReservesNeedReturns
738               choices:
739                   yes: "Don't automatically"
740                   no: Automatically
741             - mark a hold as found and waiting when a hold is placed on a specific item and that item is already checked in.
742         -
743             - Patrons can only have
744             - pref: maxreserves
745               class: integer
746             - holds at once.
747         -
748             - pref: emailLibrarianWhenHoldIsPlaced
749               choices:
750                   yes: Enable
751                   no:  "Don't enable"
752             - "sending an email to the Koha administrator email address whenever a hold request is placed."
753         -
754             - pref: DisplayMultiPlaceHold
755               choices:
756                   yes: Enable
757                   no:  "Don't enable"
758             - "the ability to place holds on multiple bibliographic records from the search results"
759         -
760             - pref: TransferWhenCancelAllWaitingHolds
761               choices:
762                   yes: Transfer
763                   no: "Don't transfer"
764             - items when cancelling all waiting holds.
765         -
766             - pref: AutoResumeSuspendedHolds
767               choices:
768                   yes: Allow
769                   no: "Don't allow"
770             - "suspended holds to be automatically resumed by a set date."
771             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/holds/auto_unsuspend_holds.pl</code> cronjob. Ask your system administrator to schedule it."
772         -
773             - pref: SuspendHoldsIntranet
774               choices:
775                   yes: Allow
776                   no: "Don't allow"
777             - holds to be suspended from the intranet.
778         -
779             - pref: SuspendHoldsOpac
780               choices:
781                   yes: Allow
782                   no: "Don't allow"
783             - holds to be suspended from the OPAC.
784         -
785             - pref: ExpireReservesOnHolidays
786               choices:
787                   yes: Allow
788                   no: "Don't allow"
789             - expired holds to be canceled on days the library is closed.
790         -
791             - pref: ExcludeHolidaysFromMaxPickUpDelay
792               choices:
793                   yes: Use the calendar
794                   no: Ignore the calendar
795             - when calculating the period for reserves max pickup delay.
796         -
797             - pref: decreaseLoanHighHolds
798               choices:
799                   yes: Enable
800                   no:  "Don't enable"
801             - the reduction of loan period to
802             - pref: decreaseLoanHighHoldsDuration
803               class: integer
804             - days for high demand items with more than
805             - pref: decreaseLoanHighHoldsValue
806               class: integer
807             - holds
808             - pref: decreaseLoanHighHoldsControl
809               choices:
810                   static: "on the record"
811                   dynamic: "over the number of holdable items on the record"
812             - . Ignore items with the following statuses when counting items
813             - pref: decreaseLoanHighHoldsIgnoreStatuses
814               multiple:
815                 damaged: Damaged
816                 itemlost: Lost
817                 withdrawn: Withdrawn
818                 notforloan: Not for loan
819         -
820             - pref: AllowHoldsOnPatronsPossessions
821               choices:
822                   yes: Allow
823                   no: "Don't allow"
824             - a patron to place a hold on a record where the patron already has one or more items attached to that record checked out.
825         -
826             - pref: LocalHoldsPriority
827               choices:
828                   yes: Give
829                   no: "Don't give"
830             - priority for filling holds to patrons whose
831             - pref: LocalHoldsPriorityPatronControl
832               choices:
833                   PickupLibrary: "pickup library"
834                   HomeLibrary: "home library"
835             - matches the item's
836             - pref: LocalHoldsPriorityItemControl
837               choices:
838                   homebranch: "home library"
839                   holdingbranch: "holding library"
840         -
841             - pref: OPACHoldsIfAvailableAtPickup
842               choices:
843                   yes: Allow
844                   no: "Don't allow"
845             - to pickup up holds at libraries where the item is available.
846         -
847             - "Patron categories not affected by OPACHoldsIfAvailableAtPickup"
848             - pref: OPACHoldsIfAvailableAtPickupExceptions
849             - "(list of patron categories separated with a pipe '|')"
850         -
851             - pref: CanMarkHoldsToPullAsLost
852               choices:
853                   do_not_allow: "Do not allow to mark items as lost"
854                   allow: "Allow to mark items as lost"
855                   allow_and_notify: "Allow to mark items as lost and notify the patron"
856             - "from the 'Holds to pull' screen. Values to be applied must be defined in UpdateItemWhenLostFromHoldList."
857         -
858             - Update item's values when marked as lost from the hold to pull screen.
859             - This is a list of values to update an item when it is marked as lost from the holds to pull screen.
860             - 'Example: "itemlost: 1" to set items.itemlost to 1 when the item is marked as lost. (Requires CanMarkHoldsToPullAsLost)'
861             - pref: UpdateItemWhenLostFromHoldList
862               type: textarea
863               syntax: text/x-yaml
864     Interlibrary loans:
865         -
866             - pref: ILLModule
867               default: 0
868               choices:
869                   yes: Enable
870                   no: Disable
871             - the interlibrary loans module (master switch).
872         -
873             - "Adding text will enable the copyright clearance stage in request creation. The text you enter will be the text displayed."
874             - pref: ILLModuleCopyrightClearance
875               type: textarea
876               class: long
877         -
878             - "Enabled ILL backends for OPAC initiated requests:"
879             - pref: ILLOpacbackends
880               class: multi
881             - (separated with |). If left empty, all installed backends will be enabled.
882         -
883             - Allow unmediated Interlibrary loan requests
884             - pref: ILLModuleUnmediated
885               default: 0
886               choices:
887                   yes: Enable
888                   no: Disable
889             - unmediated Interlibrary loan requests. If enabled and the ILL backend supports it, the newly created requests are immediately requested by backend.
890         -
891             - pref: CirculateILL
892               default: 0
893               choices:
894                   yes: Enable
895                   no: Disable
896             - the circulation of ILL requested items
897         -
898             - pref: ILLCheckAvailability
899               default: 0
900               choices:
901                   yes: Check
902                   no: Don't check
903             - external sources for availability during the request process
904     Fines policy:
905         -
906             - pref: finesCalendar
907               type: choice
908               choices:
909                   ignoreCalendar: Ignore the calendar
910                   noFinesWhenClosed: Use the calendar
911             - when calculating the period for fines.
912         -
913             - pref: SuspensionsCalendar
914               type: choice
915               choices:
916                   ignoreCalendar: Ignore the calendar
917                   noSuspensionsWhenClosed: Use the calendar
918             - when calculating the period for suspension expiration.
919         -
920             - pref: finesMode
921               type: choice
922               choices:
923                   off: "Don't calculate"
924                   production: Calculate and charge
925             - fines (when <code>cronjobs/fines.pl</code> is being run).
926             - "<br><strong>NOTE:</strong> If the cronjobs/fines.pl cronjob is being run, accruing and final fines will be calculated when the cron runs and accruing fines will be finalized when an item is returned. If CalculateFinesOnReturn is enabled, final fines will be calculated when an item is returned.<br/>"
927             - pref: ChargeFinesOnClosedDays
928               type: choice
929               choices:
930                   0: "Don't charge"
931                   1: Charge
932             - on close days. If set the fines.pl cronjob will not generate fines when run on days marked as closed in the calendar.
933         -
934             - If a lost item is returned, apply the refunding rules defined in the
935             - pref: RefundLostOnReturnControl
936               choices:
937                   CheckinLibrary: "check-in library."
938                   ItemHomeBranch: "item home branch."
939                   ItemHoldingBranch: "item holding branch."
940         -
941             - pref: FinesIncludeGracePeriod
942               choices:
943                   yes: Include
944                   no: "Don't include"
945             - the grace period when calculating the fine for an overdue item.
946         -
947             - pref: WhenLostForgiveFine
948               choices:
949                   yes: Forgive
950                   no: "Don't Forgive"
951             - the fines on an item when it is lost.
952         -
953             - pref: WhenLostChargeReplacementFee
954               choices:
955                   yes: Charge
956                   no: "Don't Charge"
957             - the replacement price when a patron loses an item.
958         -
959             - Charge a hold fee
960             - pref: HoldFeeMode
961               choices:
962                   any_time_is_placed: "any time a hold is placed."
963                   not_always: "only if all items are checked out and the record has at least one hold already."
964                   any_time_is_collected: "any time a hold is collected."
965         -
966             - pref: useDefaultReplacementCost
967               choices:
968                   yes: use
969                   no: "Don't use"
970             - the default replacement cost defined in item type.
971         -
972             - "Set the text to be recorded in the column 'note', table 'accountlines' when the processing fee (defined in item type) is applied."
973             - pref: ProcessingFeeNote
974               type: textarea
975               class: code
976     Self check-in module:
977         -
978             - "Include the following HTML on the self check-in screen:"
979             - pref: SelfCheckInMainUserBlock
980               type: textarea
981               syntax: text/html
982               class: code
983         -
984             - pref: SelfCheckInModule
985               choices:
986                   yes: Enable
987                   no: "Don't enable"
988             - "the standalone self check-in module (available at: /cgi-bin/koha/sci/sci-main.pl)"
989         -
990             - "Reset the current self check-in screen after"
991             - pref: SelfCheckInTimeout
992               class: integer
993             - seconds.
994         -
995             - "Include the following CSS on all the self check-in screens:"
996             - pref: SelfCheckInUserCSS
997               type: textarea
998               syntax: css
999               class: code
1000         -
1001             - "Include the following JavaScript on all the self check-in screens:"
1002             - pref: SelfCheckInUserJS
1003               type: textarea
1004               syntax: javascript
1005               class: code
1006     Self check-out module:
1007         -
1008             - "Include the following JavaScript on all pages in the web-based self checkout:"
1009             - pref: SCOUserJS
1010               type: textarea
1011               syntax: javascript
1012               class: code
1013         -
1014             - "Include the following HTML on the the web-based self checkout screen:"
1015             - pref: SCOMainUserBlock
1016               type: textarea
1017               syntax: text/html
1018               class: code
1019         -
1020             - "Include the following CSS on all pages in the web-based self checkout:"
1021             - pref: SCOUserCSS
1022               type: textarea
1023               syntax: css
1024               class: code
1025         -
1026             - pref: ShowPatronImageInWebBasedSelfCheck
1027               choices:
1028                   yes: Show
1029                   no: "Don't show"
1030             - "the patron's picture (if one has been added) when they use the web-based self checkout."
1031         -
1032             - pref: WebBasedSelfCheck
1033               choices:
1034                   yes: Enable
1035                   no: "Don't enable"
1036             - "the web-based self checkout system. (available at: /cgi-bin/koha/sco/sco-main.pl)"
1037         -
1038             - Have patrons login into the web-based self checkout system with their 
1039             - pref: SelfCheckoutByLogin
1040               choices:
1041                   yes: Username and Password
1042                   no: Cardnumber
1043         -
1044             - "Time out the current patron's web-based self checkout system login after"
1045             - pref: SelfCheckTimeout
1046               class: integer
1047             - seconds.
1048         -
1049             - pref: SCOAllowCheckin
1050               choices:
1051                   yes: Allow
1052                   no: "Don't allow"
1053             - patrons to return items through web-based self checkout system. 
1054         -
1055             - "Include the following HTML in the Help page of the web-based self checkout system:"
1056             - pref: SelfCheckHelpMessage
1057               type: textarea
1058               syntax: text/html
1059               class: code
1060         -
1061             - pref: AutoSelfCheckAllowed
1062               choices:
1063                   yes: Allow
1064                   no: "Don't allow"
1065             - "the web-based self checkout system to automatically login with this staff login"
1066             - pref: AutoSelfCheckID
1067             - and this password
1068             - pref: AutoSelfCheckPass
1069               class: password
1070             - .
1071             - "Note: Any patron entered here will be unable to log into the OPAC."
1072         -
1073             - pref: SelfCheckReceiptPrompt
1074               choices:
1075                   yes: Show
1076                   no: "Don't show"
1077             - "the print receipt popup dialog when self checkout is finished"
1078         -
1079             - pref: SelfCheckAllowByIPRanges
1080               class: short
1081             - (Leave blank if not used. Use ranges or simple ip addresses separated by spaces, like <code>192.168.1.1 192.168.0.0/24</code>.)
1082     Course reserves:
1083         -
1084             - pref: UseCourseReserves
1085               choices:
1086                   yes: Use
1087                   no: "Don't use"
1088             - course reserves
1089     Batch checkout:
1090         -
1091             - pref: BatchCheckouts
1092               choices:
1093                   yes: Allow
1094                   no: "Don't allow"
1095             - "batch checkouts"
1096         -
1097             - "Patron categories allowed to checkout in a batch"
1098             - pref: BatchCheckoutsValidCategories
1099             - "(list of patron categories separated with a pipe '|')"
1100     Housebound module:
1101         -
1102             - pref: HouseboundModule
1103               choices:
1104                   yes: Enable
1105                   no: Disable
1106             - "housebound module"
1107     Stock rotation module:
1108         -
1109             - pref: StockRotation
1110               choices:
1111                   yes: Enable
1112                   no: Disable
1113             - "the stock rotation module"
1114     Article requests:
1115         -
1116             - pref: ArticleRequests
1117               choices:
1118                   yes: Enable
1119                   no: "Don't enable"
1120             - patrons to place article requests.
1121         -
1122             - pref: ArticleRequestsLinkControl
1123               choices:
1124                   always: Always show
1125                   calc: Use algorithm to show or hide
1126             - article request link on search results.
1127         -
1128             - For records that are record level or item level requestable, make the following fields mandatory
1129             - pref: ArticleRequestsMandatoryFields
1130               multiple:
1131                 title: Title
1132                 author: Author
1133                 volume: Volume
1134                 issue: Issue
1135                 date: Date
1136                 pages: Pages
1137                 chapters: Chapters
1138             -
1139         -
1140             - For records that are only record level requestable, make the following fields mandatory
1141             - pref: ArticleRequestsMandatoryFieldsRecordOnly
1142               multiple:
1143                 title: Title
1144                 author: Author
1145                 volume: Volume
1146                 issue: Issue
1147                 date: Date
1148                 pages: Pages
1149                 chapters: Chapters
1150             -
1151         -
1152             - For records that are only item level requestable, make the following fields mandatory
1153             - pref: ArticleRequestsMandatoryFieldsItemOnly
1154               multiple:
1155                 title: Title
1156                 author: Author
1157                 volume: Volume
1158                 issue: Issue
1159                 date: Date
1160                 pages: Pages
1161                 chapters: Chapters
1162             -
1163     Return claims:
1164         -
1165             - When marking a checkout as "claims returned",
1166             - pref: ClaimReturnedChargeFee
1167               default: ask
1168               choices:
1169                   ask: ask if a lost fee should be charged
1170                   charge: charge a lost fee
1171                   no_charge: don't charge a lost fee
1172             - .
1173         -
1174             - Use the LOST authorised value
1175             - pref: ClaimReturnedLostValue
1176             - to represent returns claims
1177         -
1178             - Warn librarians that a patron has excessive return claims if the patron has claimed the return of more than
1179             - pref: ClaimReturnedWarningThreshold
1180               class: integer
1181             - items.