Bug 14576: (QA follow-up) Tidy up feature documentation
[koha-equinox.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / circulation.pref
index b46fc44..ffe4062 100644 (file)
@@ -2,6 +2,19 @@ Circulation:
 # FIXME: printcirculationslips is also omitted. It _technically_ could work, but C4::Print is HLT specific and needs a little bit of refactoring.
     Interface:
         -
+            - pref: CircSidebar
+              choices:
+                  yes: Activate
+                  no: Deactivate
+            - the navigation sidebar on all Circulation pages.
+        -
+            - pref: AutoSwitchPatron
+              choices:
+                  yes: "Enable"
+                  no: "Don't enable"
+            - the automatic redirection to another patron when a patron barcode is scanned instead of a book.
+            - This should not be enabled if you have overlapping patron and book barcodes.
+        -
             - pref: CircAutocompl
               choices:
                   yes: Try
@@ -117,11 +130,13 @@ Circulation:
                   no: "Do not"
             - 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).
         -
-            - Use the
-            - pref: ExportWithCsvProfile
-            - CSV profile when exporting patron checkout history (enter CSV Profile name)
+            - pref: ExportCircHistory
+              choices:
+                  yes: Show
+                  no: "Don't show"
+            - the export patron checkout history options.
         -
-            - The following fields should be excluded from the patron checkout history CSV or iso2709 export
+            - The following fields should be excluded from the patron checkout history CSV or MARC (ISO 2709) export
             - pref: ExportRemoveFields
             - (separate fields with space, e.g. 100a 200b 300c)
         -
@@ -129,10 +144,36 @@ Circulation:
               choices:
                   yes: Enable
                   no: "Do not enable"
-            - "offline circulation on regular circulation computers. (NOTE: This system preference does not affect the Firefox plugin or the desktop application)"
+            - "offline circulation on regular circulation computers. (<strong>NOTE:</strong> This system preference does not affect the Firefox plugin or the desktop application)"
+        -
+            - pref: ShowAllCheckins
+              choices:
+                  yes: Show
+                  no: "Do not show"
+            - all items in the "Checked-in items" list, even items that were not checked out.
+        -
+            - pref: AllowCheckoutNotes
+              choices:
+                  yes: Allow
+                  no: "Don't allow"
+            - patrons to submit notes about checked out items.
+
+    Accounts:
+        -
+            - pref: AccountAutoReconcile
+              choices:
+                  yes: "Do"
+                  no: "Do not"
+            - reconcile patron balances automatically on each transaction adding debits or credits.
 
     Checkout Policy:
         -
+            - pref: AutoReturnCheckedOutItems
+              choices:
+                  yes: Don't
+                  no: Do
+            - require librarians to manually confirm a checkout where the item is already checked out to another patron.
+        -
             - pref: AllowTooManyOverride
               choices:
                   yes: Allow
@@ -161,7 +202,13 @@ Circulation:
               choices:
                   yes: Allow
                   no: "Don't allow"
-            - checkouts of items reserved to someone else. If allowed do not generate RESERVE_WAITING and RESERVED warning. This allows self checkouts for those items.
+            - checkouts of items reserved to someone else. If allowed do not generate RESERVE_WAITING and RESERVED warning. 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".
+        -
+            - pref: AllowItemsOnHoldCheckoutSCO
+              choices:
+                  yes: Allow
+                  no: "Don't allow"
+            - 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.
         -
             - pref: AllFinesNeedOverride
               choices:
@@ -175,18 +222,6 @@ Circulation:
                   no: "Don't allow"
             - staff to manually override and check out items to patrons who have more than noissuescharge in fines.
         -
-            - pref: InProcessingToShelvingCart
-              choices:
-                  yes: Move
-                  no: "Don't move"
-            - items that have the location PROC to the location CART when they are checked in.
-        -
-            - pref: ReturnToShelvingCart
-              choices:
-                  yes: Move
-                  no: "Don't move"
-            - all items to the location CART when they are checked in.
-        -
             - pref: AutomaticItemReturn
               choices:
                   yes: Do
@@ -248,6 +283,13 @@ Circulation:
                   Calendar: the calendar to skip all days the library is closed.
                   Datedue: the calendar to push the due date to the next open day
         -
+            - Calculate "No renewal before" based on
+            - pref: NoRenewalBeforePrecision
+              choices:
+                  date: date.
+                  exact_time: exact time.
+            - Only relevant for loans calculated in days, hourly loans are not affected.
+        -
             - When renewing checkouts, base the new due date on
             - pref: RenewalPeriodBase
               choices:
@@ -291,6 +333,11 @@ Circulation:
               class: integer
             - '[% local_currency %] in fines.'
         -
+            - Prevent a patron from checking out if the patron has guarantees owing in total more than
+            - pref: NoIssuesChargeGuarantees
+              class: integer
+            - '[% local_currency %] in fines.'
+        -
             - pref: RentalsInNoissuesCharge
               choices:
                   yes: Include
@@ -316,7 +363,7 @@ Circulation:
             - "patrons to return books before their accounts expire (by restricting due dates to before the patron's expiration date)."
         -
             - Send all notices as a BCC to this email address
-            - pref: OverdueNoticeBcc
+            - pref: NoticeBcc
         -
             - pref: OverdueNoticeCalendar
               choices:
@@ -353,12 +400,14 @@ Circulation:
             - <br>WARNING — These preferences will activate the automatic item loss process. Leave these fields empty if you don't want to activate this feature.
             - "<br>Example: [1] [30] Sets an item to the LOST value 1 when it has been overdue for more than 30 days."
             - <br>(Used when the longoverdue.pl script is called without the --lost parameter)
+            - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask your system administrator to schedule it."
         -
             - "Charge a lost item to the borrower's account when the LOST value of the item changes to :"
             - pref: DefaultLongOverdueChargeValue
               class: integer
             - <br>Leave this field empty if you don't want to charge the user for lost items.
             - <br>(Used when the longoverdue.pl script is called without the --charge parameter)
+            - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask your system administrator to schedule it."
         -
             - "When issuing an item that has been marked as lost, "
             - pref: IssueLostItem
@@ -368,11 +417,21 @@ Circulation:
                   nothing : "do nothing"
             - .
         -
+            - "Mark items as returned when flagged as lost "
+            - pref: MarkLostItemsAsReturned
+              multiple:
+                cronjob: "from the longoverdue cronjob"
+                batchmod: "from the batch item modification tool"
+                additem: "when cataloguing an item"
+                moredetail: "from the items tab of the catalog module"
+                pendingreserves: "from the 'Holds to pull' list"
+            - .
+        -
             - pref: AllowMultipleIssuesOnABiblio
               choices:
                   yes: Allow
                   no: "Don't allow"
-            - "patrons to check out multiple items from the same record.  (NOTE: This will only effect records without a subscription attached.)"
+            - "patrons to check out multiple items from the same record.  (<strong>NOTE:</strong> This will only affect records without a subscription attached.)"
         -
             - pref: OnSiteCheckouts
               choices:
@@ -394,6 +453,12 @@ Circulation:
             - If enabled, the number of checkouts allowed will be normal checkouts + on-site checkouts.
             - If disabled, both values will be checked separately.
         -
+            - pref: SwitchOnSiteCheckouts
+              choices:
+                  yes: Switch
+                  no: "Don't switch"
+            - on-site checkouts to normal checkouts when checked out.
+        -
             - When a patron's checked out item is overdue,
             - pref: OverduesBlockRenewing
               type: choice
@@ -408,20 +473,72 @@ Circulation:
                   yes: Block
                   no: Allow
             - renewing of items.
+        -
+            - If a patron owes more than the value of OPACFineNoRenewals,
+            - pref: OPACFineNoRenewalsBlockAutoRenew
+              choices:
+                  yes: Block
+                  no: Allow
+            - their auto renewals.
+        -
+            - pref: ItemsDeniedRenewal
+              type: textarea
+              class: code
+            - Define custom rules to deny specific items from renewal.
+            - "<br />Can name any field in the items table followed by a colon then a space then"
+            - "a bracketed list of values separated by commas."
+            - "e.g."
+            - "<br />ccode: [NEWFIC,NULL,DVD]"
+            - "<br />itype: [NEWBK,\"\"]"
+            - "<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."
     Checkin Policy:
         -
+            - pref: HoldsAutoFill
+              choices:
+                  yes: Do
+                  no: "Don't"
+            - automatically fill holds instead of asking the librarian.
+        -
+            - pref: HoldsAutoFillPrintSlip
+              choices:
+                  yes: Do
+                  no: "Don't"
+            - automatically display the hold slip dialog for auto-filled holds.
+        -
             - pref: BlockReturnOfWithdrawnItems
               choices:
                   yes: Block
                   no: "Don't block"
             - returning of items that have been withdrawn.
         -
+            - pref: BlockReturnOfLostItems
+              choices:
+                  yes: Block
+                  no: "Don't block"
+            - returning of items that have been lost.
+        -
             - pref: CalculateFinesOnReturn
               choices:
                   yes: Do
                   no: "Don't"
             - calculate and update overdue charges when an item is returned.
-            - <br /><b>NOTE If you are doing hourly loans then you should have this on.</b>
+            - "<br /><strong>NOTE: If you are doing hourly loans then you should have this on.</strong>"
+        -
+            - pref: UpdateItemLocationOnCheckin
+              type: textarea
+              class: code
+            - "This a list of value pairs. the first value is followed immediately by colon space then the second value.<br/><br/>"
+            - "Examples:<br/>"
+            - "PROC: FIC - causes an item in the Processing Center location to be updated into the Fiction location on check in.<br/>"
+            - "FIC: GEN - causes an item in the Fiction location to be updated into the General stacks location on check in.<br/>"
+            - "_BLANK_: FIC - causes an item that has no location to be updated into the Fiction location on check in.<br/>"
+            - "FIC: _BLANK_ - causes an item in location FIC to be updated to a blank location on check in.<br/>"
+            - "_ALL_: FIC - causes all items to be updated into the Fiction location on check in.<br/>"
+            - "PROC: _PERM_ - causes an item that is in the Processing Center to be updated to it's permanent location.<br/><br/>"
+            - "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/>"
+            - "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/>"
+            - "The special term _BLANK_ may be used on either side of a value pair to update or remove the location from items with no locaiton assigned.<br/>"
+            - "The special term _ALL_ is used on the left side of the colon (:) to affect all items, <strong>and overrides all other rules.</strong>"
         -
             - pref: UpdateNotForLoanStatusOnCheckin
               type: textarea
@@ -429,8 +546,40 @@ Circulation:
             - 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
             - "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."
             - Each pair of values should be on a separate line.
+        -
+            - pref: CumulativeRestrictionPeriods
+              choices:
+                  yes: Cumulate
+                  no: "Don't cumulate"
+            - the restriction periods.
+        -
+            - pref: HidePersonalPatronDetailOnCirculation
+              choices:
+                  yes: "Hide"
+                  no: "Don't hide"
+            - patrons phone number, email address, street address and city on the circulation page.
     Holds Policy:
         -
+            - In the staff client, split the holds queue into separate tables by
+            - pref: HoldsSplitQueue
+              choices:
+                  nothing: nothing
+                  branch: "pickup library"
+                  itemtype: "hold itemtype"
+                  branch_itemtype: "pickup library & itemtype"
+        -
+            - If the holds queue is split, show librarians
+            - pref: HoldsSplitQueueNumbering
+              choices:
+                  actual: "the actual priority, which may be out of order"
+                  virtual: "'virtual' priorities, where each group is numbered separately"
+        -
+            - pref: AllowHoldItemTypeSelection
+              choices:
+                  yes: Allow
+                  no: "Don't allow"
+            - hold fulfillment to be limited by itemtype.
+        -
             - pref: AllowRenewalIfOtherItemsAvailable
               choices:
                   yes: Allow
@@ -482,20 +631,26 @@ Circulation:
               choices:
                   yes: Allow
                   no: "Don't allow"
-            - "holds to expire automatically if they have not been picked by within the time period specified in ReservesMaxPickUpDelay"
+            - "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."
         -
-            - If using ExpireReservesMaxPickUpDelay, charge a borrower who allows his or her waiting hold to expire a fee of
+            - If using ExpireReservesMaxPickUpDelay, charge a borrower who allows their waiting hold to expire a fee of
             - pref: ExpireReservesMaxPickUpDelayCharge
               class: currency
         -
-            - Satisfy holds from the libraries
+            - Satisfy holds using items from the libraries
             - pref: StaticHoldsQueueWeight
               class: multi
             - (as branchcodes, separated by commas; if empty, uses all libraries)
+            - when they are
+            - pref: HoldsQueueSkipClosed
+              choices:
+                  yes: open
+                  no: open or closed
             - pref: RandomizeHoldsQueueWeight
               choices:
                   yes: in random order.
                   no: in that order.
+            - "<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."
             -
         -
             - pref: canreservefromotherbranches
@@ -531,7 +686,7 @@ Circulation:
               choices:
                   yes: Enable
                   no:  "Don't enable"
-            - "the ability to place holds on multiple biblio from the search results"      
+            - "the ability to place holds on multiple bibliographic records from the search results"
         -
             - pref: TransferWhenCancelAllWaitingHolds
               choices:
@@ -543,7 +698,8 @@ Circulation:
               choices:
                   yes: Allow
                   no: "Don't allow"
-            - suspended holds to be automatically resumed by a set date.
+            - "suspended holds to be automatically resumed by a set date."
+            - "<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."
         -
             - pref: SuspendHoldsIntranet
               choices:
@@ -563,6 +719,12 @@ Circulation:
                   no: "Don't allow"
             - expired holds to be canceled on days the library is closed.
         -
+            - pref: ExcludeHolidaysFromMaxPickUpDelay
+              choices:
+                  yes: Allow
+                  no: "Don't allow"
+            - Closed days to be taken into account in reserves max pickup delay.
+        -
             - pref: decreaseLoanHighHolds
               choices:
                   yes: Enable
@@ -570,10 +732,21 @@ Circulation:
             - the reduction of loan period to
             - pref: decreaseLoanHighHoldsDuration
               class: integer
-            - days for items with more than
+            - days for high demand items with more than
             - pref: decreaseLoanHighHoldsValue
               class: integer
-            - holds.
+            - holds
+            - pref: decreaseLoanHighHoldsControl
+              choices:
+                  static: "on the record"
+                  dynamic: "over the number of holdable items on the record"
+            - . Ignore items with the following statuses when counting items
+            - pref: decreaseLoanHighHoldsIgnoreStatuses
+              multiple:
+                damaged: Damaged
+                itemlost: Lost
+                withdrawn: Withdrawn
+                notforloan: Not for loan
         -
             - pref: AllowHoldsOnPatronsPossessions
               choices:
@@ -595,6 +768,55 @@ Circulation:
               choices:
                   homebranch: "home library"
                   holdingbranch: "holding library"
+        -
+            - pref: OPACHoldsIfAvailableAtPickup
+              choices:
+                  yes: Allow
+                  no: "Don't allow"
+            - to pickup up holds at libraries where the item is available.
+        -
+            - "Patron categories not affected by OPACHoldsIfAvailableAtPickup"
+            - pref: OPACHoldsIfAvailableAtPickupExceptions
+            - "(list of patron categories separated with a pipe '|')"
+        -
+            - pref: CanMarkHoldsToPullAsLost
+              choices:
+                  do_not_allow: "Do not allow to mark items as lost"
+                  allow: "Allow to mark items as lost"
+                  allow_and_notify: "Allow to mark items as lost and notify the patron"
+            - "from the 'Holds to pull' screen"
+        -
+            - Update item's values when marked as lost from the hold to pull screen.
+            - This is a list of values to update an item when it is marked as lost from the holds to pull screen.
+            - 'Example: "itemlost: 1" to set items.itemlost to 1 when the item is marked as lost'
+            - pref: UpdateItemWhenLostFromHoldList
+              type: textarea
+    Interlibrary Loans:
+        -
+            - pref: ILLModule
+              default: 0
+              choices:
+                  yes: Enable
+                  no: Disable
+            - the interlibrary loans module (master switch).
+        -
+            - "Adding text will enable the copyright clearance stage in request creation. The text you enter will be the text displayed."
+            - pref: ILLModuleCopyrightClearance
+              type: textarea
+              class: long
+        -
+            - "Enabled ILL backends for OPAC initiated requests:"
+            - pref: ILLOpacbackends
+              class: multi
+            - (separated with |). If left empty, all installed backends will be enabled.
+        -
+            - Allow unmediated Interlibrary loan requests
+            - pref: ILLModuleUnmediated
+              default: 0
+              choices:
+                  yes: Enable
+                  no: Disable
+            - unmediated Interlibrary loan requests. If enabled and the ILL backend supports it, the newly created requests are immediately requested by backend.
     Fines Policy:
         -
             - Calculate fines based on days overdue
@@ -612,13 +834,15 @@ Circulation:
                   test: Calculate (but only for mailing to the admin)
                   production: Calculate and charge
             - fines (when <code>misc/cronjobs/fines.pl</code> is being run).
-            - <br><b>Note:</b> Fines can also be charged by the CalculateFinesOnReturn system preference.
+            - "<br><strong>NOTE:</strong> Fines can also be charged by the CalculateFinesOnReturn system preference."
+            - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/fines.pl</code> cronjob. Ask your system administrator to schedule it."
         -
-            - pref: RefundLostItemFeeOnReturn
+            - If a lost item is returned, apply the refunding rules defined in the
+            - pref: RefundLostOnReturnControl
               choices:
-                  yes: Refund
-                  no: "Don't refund"
-            - lost item fees charged to a borrower when the lost item is returned.
+                  CheckinLibrary: "check-in library."
+                  ItemHomeBranch: "item home branch."
+                  ItemHoldingBranch: "item holding branch."
         -
             - pref: FinesIncludeGracePeriod
               choices:
@@ -638,21 +862,71 @@ Circulation:
                   no: "Don't Charge"
             - the replacement price when a patron loses an item.
         -
+            - Charge a hold fee
             - pref: HoldFeeMode
               choices:
-                  always: Always
-                  not_always: "Don't always"
-            - Charge fee when a hold is placed.
+                  any_time_is_placed: "any time a hold is placed."
+                  not_always: "only if all items are checked out and the record has at least one hold already."
+                  any_time_is_collected: "any time a hold is collected."
+        -
+            - pref: useDefaultReplacementCost
+              choices:
+                  yes: use
+                  no: "Don't use"
+            - the default replacement cost defined in item type.
+        -
+            - "Set the text to be recorded in the column 'note', table 'accountlines' when the processing fee (defined in item type) is applied."
+            - pref: ProcessingFeeNote
+              type: textarea
+              class: code
+    Self check-in module:
+        -
+            - "Include the following HTML on the self check-in screen:"
+            - pref: SelfCheckInMainUserBlock
+              type: textarea
+              syntax: text/html
+              class: code
+        -
+            - pref: SelfCheckInModule
+              choices:
+                  yes: Enable
+                  no: "Don't enable"
+            - "the standalone self check-in module (available at: /cgi-bin/koha/sci/sci-main.pl)"
+        -
+            - "Reset the current self check-in screen after"
+            - pref: SelfCheckInTimeout
+              class: integer
+            - seconds.
+        -
+            - "Include the following CSS on all the self check-in screens:"
+            - pref: SelfCheckInUserCSS
+              type: textarea
+              syntax: css
+              class: code
+        -
+            - "Include the following JavaScript on all the self check-in screens:"
+            - pref: SelfCheckInUserJS
+              type: textarea
+              syntax: javascript
+              class: code
     Self Checkout:
         -
             - "Include the following JavaScript on all pages in the web-based self checkout:"
             - pref: SCOUserJS
               type: textarea
+              syntax: javascript
+              class: code
+        -
+            - "Include the following HTML on the the web-based self checkout screen:"
+            - pref: SCOMainUserBlock
+              type: textarea
+              syntax: text/html
               class: code
         -
             - "Include the following CSS on all pages in the web-based self checkout:"
             - pref: SCOUserCSS
               type: textarea
+              syntax: css
               class: code
         -
             - pref: ShowPatronImageInWebBasedSelfCheck
@@ -671,7 +945,7 @@ Circulation:
             - pref: SelfCheckoutByLogin
               choices:
                   yes: Username and Password
-                  no: Barcode
+                  no: Cardnumber
         -
             - "Time out the current patron's web-based self checkout system login after"
             - pref: SelfCheckTimeout
@@ -722,3 +996,72 @@ Circulation:
             - "Patron categories allowed to checkout in a batch"
             - pref: BatchCheckoutsValidCategories
             - "(list of patron categories separated with a pipe '|')"
+    Housebound module:
+        -
+            - pref: HouseboundModule
+              choices:
+                  yes: Enable
+                  no: Disable
+            - "housebound module"
+    Stockrotation module:
+        -
+            - pref: StockRotation
+              choices:
+                  yes: Enable
+                  no: Disable
+            - "the stock rotation module"
+        -
+            - pref: RotationPreventTransfers
+              choices:
+                  yes: Disallow
+                  no: Allow
+            - "library transfers on items in stockrotation rotas"
+    Article Requests:
+        -
+            - pref: ArticleRequests
+              choices:
+                  yes: Enable
+                  no: "Don't enable"
+            - patrons to place article requests.
+        -
+            - pref: ArticleRequestsLinkControl
+              choices:
+                  always: Always show
+                  calc: Use algorithm to show or hide
+            - article request link on search results.
+        -
+            - For records that are record level or item level requestable, make the following fields mandatory
+            - pref: ArticleRequestsMandatoryFields
+              multiple:
+                title: Title
+                author: Author
+                volume: Volume
+                issue: Issue
+                date: Date
+                pages: Pages
+                chapters: Chapters
+            -
+        -
+            - For records that are only record level requestable, make the following fields mandatory
+            - pref: ArticleRequestsMandatoryFieldsRecordOnly
+              multiple:
+                title: Title
+                author: Author
+                volume: Volume
+                issue: Issue
+                date: Date
+                pages: Pages
+                chapters: Chapters
+            -
+        -
+            - For records that are only item level requestable, make the following fields mandatory
+            - pref: ArticleRequestsMandatoryFieldsItemOnly
+              multiple:
+                title: Title
+                author: Author
+                volume: Volume
+                issue: Issue
+                date: Date
+                pages: Pages
+                chapters: Chapters
+            -