Bug 15736 [QA Followup] - Make add more details to the syspref description
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / circulation.pref
1 Circulation:
2 # FIXME: printcirculationslips is also omitted. It _technically_ could work, but C4::Print is HLT specific and needs a little bit of refactoring.
3     Interface:
4         -
5             - pref: CircAutocompl
6               choices:
7                   yes: Try
8                   no: "Don't try"
9             - to guess the patron being entered while typing a patron search on the circulation screen.
10             - Only returns the first 10 results at a time.
11         -
12             - pref: itemBarcodeInputFilter
13               choices:
14                   OFF: "Don't filter"
15                   whitespace: Remove spaces from
16                   cuecat: Convert from CueCat form
17                   T-prefix: Remove the first number from T-prefix style
18                   libsuite8: Convert from Libsuite8 form
19                   EAN13: EAN-13 or zero-padded UPC-A from
20             - scanned item barcodes.
21         -
22             - pref: itemBarcodeFallbackSearch
23               choices:
24                   yes: "Enable"
25                   no: "Don't enable"
26             - 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.
27         -
28             - Sort previous checkouts on the circulation page from
29             - pref: previousIssuesDefaultSortOrder
30               choices:
31                   asc: earliest to latest
32                   desc: latest to earliest
33             - due date.
34         -
35             - "Sort today's checkouts on the circulation page from"
36             - pref: todaysIssuesDefaultSortOrder
37               type: choice
38               choices:
39                   asc: earliest to latest
40                   desc: latest to earliest
41             - due date.
42         -
43             - pref: SpecifyDueDate
44               choices:
45                   yes: Allow
46                   no: "Don't allow"
47             - staff to specify a due date for a checkout.
48         -
49             - pref: SpecifyReturnDate
50               choices:
51                   yes: Allow
52                   no: "Don't allow"
53             - staff to specify a return date for a check in.
54         -
55             - Set the default start date for the Holds to pull list to
56             - pref: HoldsToPullStartDate
57               class: integer
58             - day(s) ago. Note that the default end date is controlled by preference ConfirmFutureHolds.
59         -
60             - pref: AllowAllMessageDeletion
61               choices:
62                   yes: Allow
63                   no: "Don't allow"
64             - staff to delete messages added from other libraries.
65         -
66             - Show the
67             - pref: numReturnedItemsToShow
68               class: integer
69             - last returned items on the checkin screen.
70         -
71             - pref: FineNotifyAtCheckin
72               choices:
73                   yes: Notify
74                   no: "Don't notify"
75             - librarians of overdue fines on the items they are checking in.
76         -
77             - pref: WaitingNotifyAtCheckin
78               choices:
79                   yes: Notify
80                   no: "Don't notify"
81             - librarians of waiting holds for the patron whose items they are checking in.
82         -
83             - pref: FilterBeforeOverdueReport
84               choices:
85                   yes: Require
86                   no: "Don't require"
87             - staff to choose which checkouts to show before running the overdues report.
88         -
89             - pref: DisplayClearScreenButton
90               choices:
91                   yes: Show
92                   no: "Don't show"
93             - a button to clear the current patron from the screen on the circulation screen.
94         -
95             - pref: RecordLocalUseOnReturn
96               choices:
97                   yes: Record
98                   no: "Don't record"
99             - local use when an unissued item is checked in.
100         -
101             - When an empty barcode field is submitted in circulation
102             - pref: CircAutoPrintQuickSlip
103               choices:
104                   clear: "clear the screen"
105                   qslip: "open a print quick slip window"
106                   slip: "open a print slip window"
107             - .
108         -
109             - Include the stylesheet at
110             - pref: NoticeCSS
111               class: url
112             - on Notices. (This should be a complete URL, starting with <code>http://</code>)
113         -
114             - pref: UpdateTotalIssuesOnCirc
115               choices:
116                   yes: Do
117                   no: "Do not"
118             - 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).
119         -
120             - Use the
121             - pref: ExportWithCsvProfile
122             - CSV profile when exporting patron checkout history (enter CSV Profile name)
123         -
124             - The following fields should be excluded from the patron checkout history CSV or iso2709 export
125             - pref: ExportRemoveFields
126             - (separate fields with space, e.g. 100a 200b 300c)
127         -
128             - pref: AllowOfflineCirculation
129               choices:
130                   yes: Enable
131                   no: "Do not enable"
132             - "offline circulation on regular circulation computers. (NOTE: This system preference does not affect the Firefox plugin or the desktop application)"
133         -
134             - pref: ShowAllCheckins
135               choices:
136                   yes: Show
137                   no: "Do not show"
138             - all items in the "Checked-in items" list, even items that were not checked out.
139
140     Checkout Policy:
141         -
142             - pref: AllowTooManyOverride
143               choices:
144                   yes: Allow
145                   no: "Don't allow"
146             - staff to override and check out items when the patron has reached the maximum number of allowed checkouts.
147         -
148             - pref: AutoRemoveOverduesRestrictions
149               choices:
150                   yes: "Do"
151                   no: "Do not"
152             - allow OVERDUES restrictions triggered by sent notices to be cleared automatically when all overdue items are returned by a patron.
153         -
154             - pref: AllowNotForLoanOverride
155               choices:
156                   yes: Allow
157                   no: "Don't allow"
158             - staff to override and check out items that are marked as not for loan.
159         -
160             - pref: AllowRenewalLimitOverride
161               choices:
162                   yes: Allow
163                   no: "Don't allow"
164             - 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.
165         -
166             - pref: AllowItemsOnHoldCheckout
167               choices:
168                   yes: Allow
169                   no: "Don't allow"
170             - checkouts of items reserved to someone else. If allowed do not generate RESERVE_WAITING and RESERVED warning. This allows self checkouts for those items.
171         -
172             - pref: AllFinesNeedOverride
173               choices:
174                   yes: Require
175                   no: "Don't require"
176             - staff to manually override all fines, even fines less than noissuescharge.
177         -
178             - pref: AllowFineOverride
179               choices:
180                   yes: Allow
181                   no: "Don't allow"
182             - staff to manually override and check out items to patrons who have more than noissuescharge in fines.
183         -
184             - pref: InProcessingToShelvingCart
185               choices:
186                   yes: Move
187                   no: "Don't move"
188             - items that have the location PROC to the location CART when they are checked in.
189         -
190             - pref: ReturnToShelvingCart
191               choices:
192                   yes: Move
193                   no: "Don't move"
194             - all items to the location CART when they are checked in.
195         -
196             - pref: AutomaticItemReturn
197               choices:
198                   yes: Do
199                   no: "Don't"
200             - automatically transfer items to their home library when they are returned.
201         -
202             - pref: UseBranchTransferLimits
203               choices:
204                   yes: Enforce
205                   no: "Don't enforce"
206             - library transfer limits based on
207             - pref: BranchTransferLimitsType
208               choices:
209                   ccode: collection code
210                   itemtype: item type
211             - .
212         -
213             - pref: UseTransportCostMatrix
214               choices:
215                   yes: Use
216                   no: "Don't use"
217             - Transport Cost Matrix for calculating optimal holds filling between branches.
218         -
219             - Use the checkout and fines rules of
220             - pref: CircControl
221               type: choice
222               choices:
223                   PickupLibrary: the library you are logged in at.
224                   PatronLibrary: the library the patron is from.
225                   ItemHomeLibrary: the library the item is from.
226         -
227             - Use the checkout and fines rules of
228             - pref: HomeOrHoldingBranch
229               type: choice
230               choices:
231                   homebranch: the library the item is from.
232                   holdingbranch: the library the item was checked out from.
233         -
234             - Allow materials to be returned to
235             - pref: AllowReturnToBranch
236               type: choice
237               choices:
238                   anywhere: to any library.
239                   homebranch: only the library the item is from.
240                   holdingbranch: only the library the item was checked out from.
241                   homeorholdingbranch: either the library the item is from or the library it was checked out from.
242         -
243             - For search results in the staff client, display the branch of
244             - pref: StaffSearchResultsDisplayBranch
245               type: choice
246               choices:
247                   homebranch: the library the item is from.
248                   holdingbranch: the library the item is held by.
249         -
250             - Calculate the due date using 
251             - pref: useDaysMode
252               choices:
253                   Days: circulation rules only.
254                   Calendar: the calendar to skip all days the library is closed.
255                   Datedue: the calendar to push the due date to the next open day
256         -
257             - When renewing checkouts, base the new due date on
258             - pref: RenewalPeriodBase
259               choices:
260                   date_due: the old due date of the checkout.
261                   now: the current date.
262         -
263             - pref: RenewalSendNotice
264               choices:
265                   yes: Send
266                   no: "Don't send"
267             - a renewal notice according to patron checkout alert preferences.
268         -
269             - Prevent patrons from making holds on the OPAC if they owe more than
270             - pref: maxoutstanding
271               class: currency
272             - '[% local_currency %] in fines.'
273         -
274             - Show a warning on the "Transfers to Receive" screen if the transfer has not been received
275             - pref: TransfersMaxDaysWarning
276               class: integer
277             - days after it was sent.
278         -
279             - pref: IssuingInProcess
280               choices:
281                   yes: "Don't prevent"
282                   no: "Prevent"
283             - patrons from checking out an item whose rental charge would take them over the limit.
284         -
285             - "Restrict patrons with the following target audience values from checking out inappropriate materials:"
286             - pref: AgeRestrictionMarker
287             - "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."
288         -
289             - pref: AgeRestrictionOverride
290               choices:
291                   yes: Allow
292                   no: "Don't allow"
293             - staff to check out an item with age restriction.
294         -
295             - Prevent patrons from checking out books if they have more than
296             - pref: noissuescharge
297               class: integer
298             - '[% local_currency %] in fines.'
299         -
300             - pref: RentalsInNoissuesCharge
301               choices:
302                   yes: Include
303                   no: "Don't include"
304             - rental charges when summing up charges for noissuescharge.
305         -
306             - pref: ManInvInNoissuesCharge
307               choices:
308                   yes: Include
309                   no: "Don't include"
310             - MANUAL_INV charges when summing up charges for noissuescharge.
311         -
312             - pref: HoldsInNoissuesCharge
313               choices:
314                   yes: Include
315                   no: "Don't include"
316             - hold charges when summing up charges for noissuescharge.
317         -
318             - pref: ReturnBeforeExpiry
319               choices:
320                   yes: Require
321                   no: "Don't require"
322             - "patrons to return books before their accounts expire (by restricting due dates to before the patron's expiration date)."
323         -
324             - Send all notices as a BCC to this email address
325             - pref: OverdueNoticeBcc
326         -
327             - pref: OverdueNoticeCalendar
328               choices:
329                   yes: "Use Calendar"
330                   no: "Ignore Calendar"
331             - when working out the period for overdue notices
332         -
333             - Include up to
334             - pref: PrintNoticesMaxLines
335               class: integer
336             - "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 borrower 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."
337         -
338             - pref: OverduesBlockCirc
339               choices:
340                   block: Block
341                   noblock: "Don't block"
342                   confirmation: Ask for confirmation
343             - when checking out to a borrower that has overdues outstanding
344         -
345             - "When checking out an item with rental fees, "
346             - pref: RentalFeesCheckoutConfirmation
347               choices:
348                   yes: ask
349                   no: "do not ask"
350             - "for confirmation."
351         -
352             - By default, set the LOST value of an item to
353             - pref: DefaultLongOverdueLostValue
354               class: integer
355             - when the item has been overdue for more than
356             - pref: DefaultLongOverdueDays
357               class: integer
358             - days.
359             - <br>WARNING â€” These preferences will activate the automatic item loss process. Leave these fields empty if you don't want to activate this feature.
360             - "<br>Example: [1] [30] Sets an item to the LOST value 1 when it has been overdue for more than 30 days."
361             - <br>(Used when the longoverdue.pl script is called without the --lost parameter)
362         -
363             - "Charge a lost item to the borrower's account when the LOST value of the item changes to :"
364             - pref: DefaultLongOverdueChargeValue
365               class: integer
366             - <br>Leave this field empty if you don't want to charge the user for lost items.
367             - <br>(Used when the longoverdue.pl script is called without the --charge parameter)
368         -
369             - "When issuing an item that has been marked as lost, "
370             - pref: IssueLostItem
371               choices:
372                   confirm: "require confirmation"
373                   alert: "display a message"
374                   nothing : "do nothing"
375             - .
376         -
377             - pref: AllowMultipleIssuesOnABiblio
378               choices:
379                   yes: Allow
380                   no: "Don't allow"
381             - "patrons to check out multiple items from the same record.  (NOTE: This will only effect records without a subscription attached.)"
382         -
383             - pref: OnSiteCheckouts
384               choices:
385                   yes: Enable
386                   no: Disable
387             - the on-site checkouts feature.
388         -
389             - pref: OnSiteCheckoutsForce
390               choices:
391                   yes: Enable
392                   no: Disable
393             - the on-site for all cases (Even if a user is debarred, etc.).
394         -
395             - pref: ConsiderOnSiteCheckoutsAsNormalCheckouts
396               choices:
397                   yes: Consider
398                   no: "Don't consider"
399             - on-site checkouts as normal checkouts.
400             - If enabled, the number of checkouts allowed will be normal checkouts + on-site checkouts.
401             - If disabled, both values will be checked separately.
402         -
403             - When a patron's checked out item is overdue,
404             - pref: OverduesBlockRenewing
405               type: choice
406               choices:
407                   allow: allow renewing.
408                   blockitem: block renewing only for this item.
409                   block: block renewing for all the patron's items.
410         -
411             - If patron is restricted,
412             - pref: RestrictionBlockRenewing
413               choices:
414                   yes: Block
415                   no: Allow
416             - renewing of items.
417     Checkin Policy:
418         -
419             - pref: BlockReturnOfWithdrawnItems
420               choices:
421                   yes: Block
422                   no: "Don't block"
423             - returning of items that have been withdrawn.
424         -
425             - pref: CalculateFinesOnReturn
426               choices:
427                   yes: Do
428                   no: "Don't"
429             - calculate and update overdue charges when an item is returned.
430             - <br /><b>NOTE If you are doing hourly loans then you should have this on.</b>
431         -
432             - pref: UpdateNotForLoanStatusOnCheckin
433               type: textarea
434               class: code
435             - 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
436             - "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."
437             - Each pair of values should be on a separate line.
438     Holds Policy:
439         -
440             - pref: AllowRenewalIfOtherItemsAvailable
441               choices:
442                   yes: Allow
443                   no: "Don't allow"
444             - a patron to renew an item with unfilled holds if other available items can fill that hold.
445         -
446             - pref: AllowHoldPolicyOverride
447               choices:
448                   yes: Allow
449                   no: "Don't allow"
450             - staff to override hold policies when placing holds.
451         -
452             - pref: AllowHoldsOnDamagedItems
453               choices:
454                   yes: Allow
455                   no: "Don't allow"
456             - hold requests to be placed on and filled by damaged items.
457         -
458             - pref: AllowHoldDateInFuture
459               choices:
460                   yes: Allow
461                   no: "Don't allow"
462             - hold requests to be placed that do not enter the waiting list until a certain future date.
463         -
464             - pref: OPACAllowHoldDateInFuture
465               choices:
466                   yes: Allow
467                   no: "Don't allow"
468             - "patrons to place holds that don't enter the waiting list until a certain future date. (AllowHoldDateInFuture must also be enabled)."
469         -
470             - Confirm future hold requests (starting no later than
471             - pref: ConfirmFutureHolds
472               class: integer
473             - 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.
474         -
475             - Check the
476             - pref: ReservesControlBranch
477               choices:
478                   ItemHomeLibrary: "item's home library"
479                   PatronLibrary: "patron's home library"
480             - to see if the patron can place a hold on the item.    
481         -
482             - Mark a hold as problematic if it has been waiting for more than
483             - pref: ReservesMaxPickUpDelay
484               class: integer
485             - days.
486         -
487             - pref: ExpireReservesMaxPickUpDelay
488               choices:
489                   yes: Allow
490                   no: "Don't allow"
491             - "holds to expire automatically if they have not been picked by within the time period specified in ReservesMaxPickUpDelay"
492         -
493             - If using ExpireReservesMaxPickUpDelay, charge a borrower who allows his or her waiting hold to expire a fee of
494             - pref: ExpireReservesMaxPickUpDelayCharge
495               class: currency
496         -
497             - Satisfy holds from the libraries
498             - pref: StaticHoldsQueueWeight
499               class: multi
500             - (as branchcodes, separated by commas; if empty, uses all libraries)
501             - pref: RandomizeHoldsQueueWeight
502               choices:
503                   yes: in random order.
504                   no: in that order.
505             -
506         -
507             - pref: canreservefromotherbranches
508               choices:
509                   yes: Allow
510                   no: "Don't allow (with independent branches)"
511             - a user from one library to place a hold on an item from another library
512         -
513             - pref: OPACAllowUserToChooseBranch
514               choices:
515                   yes: Allow
516                   no: "Don't allow"
517             - a user to choose the library to pick up a hold from.
518         -
519             - pref: ReservesNeedReturns
520               choices:
521                   yes: "Don't automatically"
522                   no: Automatically
523             - mark a hold as found and waiting when a hold is placed on a specific item and that item is already checked in.
524         -
525             - Patrons can only have
526             - pref: maxreserves
527               class: integer
528             - holds at once.
529         -
530             - pref: emailLibrarianWhenHoldIsPlaced
531               choices:
532                   yes: Enable
533                   no:  "Don't enable"
534             - "sending an email to the Koha administrator email address whenever a hold request is placed."
535         -
536             - pref: DisplayMultiPlaceHold
537               choices:
538                   yes: Enable
539                   no:  "Don't enable"
540             - "the ability to place holds on multiple biblio from the search results"       
541         -
542             - pref: TransferWhenCancelAllWaitingHolds
543               choices:
544                   yes: Transfer
545                   no: "Don't transfer"
546             - items when cancelling all waiting holds.
547         -
548             - pref: AutoResumeSuspendedHolds
549               choices:
550                   yes: Allow
551                   no: "Don't allow"
552             - suspended holds to be automatically resumed by a set date.
553         -
554             - pref: SuspendHoldsIntranet
555               choices:
556                   yes: Allow
557                   no: "Don't allow"
558             - holds to be suspended from the intranet.
559         -
560             - pref: SuspendHoldsOpac
561               choices:
562                   yes: Allow
563                   no: "Don't allow"
564             - holds to be suspended from the OPAC.
565         -
566             - pref: ExpireReservesOnHolidays
567               choices:
568                   yes: Allow
569                   no: "Don't allow"
570             - expired holds to be canceled on days the library is closed.
571         -
572             - pref: decreaseLoanHighHolds
573               choices:
574                   yes: Enable
575                   no:  "Don't enable"
576             - the reduction of loan period to
577             - pref: decreaseLoanHighHoldsDuration
578               class: integer
579             - days for items with more than
580             - pref: decreaseLoanHighHoldsValue
581               class: integer
582             - holds.
583         -
584             - pref: AllowHoldsOnPatronsPossessions
585               choices:
586                   yes: Allow
587                   no: "Don't allow"
588             - a patron to place a hold on a record where the patron already has one or more items attached to that record checked out.
589         -
590             - pref: LocalHoldsPriority
591               choices:
592                   yes: Give
593                   no: "Don't give"
594             - priority for filling holds to patrons whose
595             - pref: LocalHoldsPriorityPatronControl
596               choices:
597                   PickupLibrary: "pickup library"
598                   HomeLibrary: "home library"
599             - matches the item's
600             - pref: LocalHoldsPriorityItemControl
601               choices:
602                   homebranch: "home library"
603                   holdingbranch: "holding library"
604     Fines Policy:
605         -
606             - Calculate fines based on days overdue
607             - pref: finesCalendar
608               type: choice
609               choices:
610                   ignoreCalendar: directly.
611                   noFinesWhenClosed: not including days the library is closed.
612             -
613         -
614             - pref: finesMode
615               type: choice
616               choices:
617                   off: "Don't calculate"
618                   test: Calculate (but only for mailing to the admin)
619                   production: Calculate and charge
620             - fines (when <code>misc/cronjobs/fines.pl</code> is being run).
621             - <br><b>Note:</b> Fines can also be charged by the CalculateFinesOnReturn system preference.
622         -
623             - pref: RefundLostItemFeeOnReturn
624               choices:
625                   yes: Refund
626                   no: "Don't refund"
627             - lost item fees charged to a borrower when the lost item is returned.
628         -
629             - pref: FinesIncludeGracePeriod
630               choices:
631                   yes: Include
632                   no: "Don't include"
633             - the grace period when calculating the fine for an overdue item.
634         -
635             - pref: WhenLostForgiveFine
636               choices:
637                   yes: Forgive
638                   no: "Don't Forgive"
639             - the fines on an item when it is lost.
640         -
641             - pref: WhenLostChargeReplacementFee
642               choices:
643                   yes: Charge
644                   no: "Don't Charge"
645             - the replacement price when a patron loses an item.
646         -
647             - Charge a hold fee
648             - pref: HoldFeeMode
649               choices:
650                   always: "any time a hold is placed."
651                   not_always: "only if all items are checked out and the record has at least one hold already."
652     Self Checkout:
653         -
654             - "Include the following JavaScript on all pages in the web-based self checkout:"
655             - pref: SCOUserJS
656               type: textarea
657               class: code
658         -
659             - "Include the following CSS on all pages in the web-based self checkout:"
660             - pref: SCOUserCSS
661               type: textarea
662               class: code
663         -
664             - pref: ShowPatronImageInWebBasedSelfCheck
665               choices:
666                   yes: Show
667                   no: "Don't show"
668             - "the patron's picture (if one has been added) when they use the web-based self checkout."
669         -
670             - pref: WebBasedSelfCheck
671               choices:
672                   yes: Enable
673                   no: "Don't enable"
674             - "the web-based self checkout system. (available at: /cgi-bin/koha/sco/sco-main.pl)"
675         -
676             - Have patrons login into the web-based self checkout system with their 
677             - pref: SelfCheckoutByLogin
678               choices:
679                   yes: Username and Password
680                   no: Barcode
681         -
682             - "Time out the current patron's web-based self checkout system login after"
683             - pref: SelfCheckTimeout
684               class: integer
685             - seconds.
686         -
687             - pref: AllowSelfCheckReturns
688               choices:
689                   yes: Allow
690                   no: "Don't allow"
691             - patrons to return items through web-based self checkout system. 
692         -
693             - "Include the following HTML in the Help page of the web-based self checkout system:"
694             - pref: SelfCheckHelpMessage
695               type: htmlarea
696               class: code
697         -
698             - pref: AutoSelfCheckAllowed
699               choices:
700                   yes: Allow
701                   no: "Don't allow"
702             - "the web-based self checkout system to automatically login with this staff login"
703             - pref: AutoSelfCheckID
704             - and this password
705             - pref: AutoSelfCheckPass
706             - .
707         -
708             - pref: SelfCheckReceiptPrompt
709               choices:
710                   yes: Show
711                   no: "Don't show"
712             - "the print receipt popup dialog when self checkout is finished"
713     Course Reserves:
714         -
715             - pref: UseCourseReserves
716               choices:
717                   yes: Use
718                   no: "Don't use"
719             - course reserves
720     Batch checkout:
721         -
722             - pref: BatchCheckouts
723               choices:
724                   yes: Allow
725                   no: "Don't allow"
726             - "batch checkouts"
727         -
728             - "Patron categories allowed to checkout in a batch"
729             - pref: BatchCheckoutsValidCategories
730             - "(list of patron categories separated with a pipe '|')"