-
- pref: OPACUserSummary
choices:
- yes: Show
- no: "Don't show"
- - "a summary of a logged in user's checkouts, overdues, holds and fines on the mainpage"
+ 1: Show
+ 0: "Don't show"
+ - "a summary of a logged in patron's checkouts, overdues, holds and charges on the OPAC start page."
-
- For search results in the OPAC, show the item's
- pref: OPACResultsLibrary
choices:
- holdingbranch: "current location"
+ holdingbranch: "current library"
homebranch: "home library"
- . Please note that this feature is currently available for MARC21 and UNIMARC.
-
-
- pref: OpacPublic
choices:
- yes: Enable
- no: Disable
- - "Koha OPAC as public. Private OPAC requires authentication before accessing the OPAC."
- -
- - pref: HighlightOwnItemsOnOPAC
- choices:
- yes: Emphasize
- no: "Don't emphasize"
- - "results from the "
- - pref: HighlightOwnItemsOnOPACWhich
- choices:
- PatronBranch: "patron's home branch"
- OpacURLBranch: "OPAC's branch via the URL"
- - " by moving the results to the front and increasing the size or highlighting the rows for those results. (Non-XSLT Only)"
+ 1: Enable
+ 0: Disable
+ - "Koha OPAC as public. Private OPAC requires authentication before accessing the OPAC. "
+ - 'Note: This does not affect the public API, see the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=RESTPublicAnonymousRequests">RESTPublicAnonymousRequests</a> to control the API.'
-
- "Show star-ratings on"
- pref: OpacStarRatings
choices:
- all: "results and details"
+ all: "results, details, and patron"
disable: "no"
details: "only details"
- "pages."
-
- pref: OpacMaintenance
choices:
- yes: Show
- no: "Don't show"
+ 1: Show
+ 0: "Don't show"
- "a warning that the OPAC is under maintenance, instead of the OPAC itself. Note: this shows the same warning as when the database needs to be upgraded, but unconditionally."
-
- -
- - "Show the following HTML when OpacMaintenance is enabled:"
+ - 'Show the following HTML when <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OpacMaintenance">OpacMaintenance</a> is enabled:'
- pref: OpacMaintenanceNotice
- type: htmlarea
+ type: textarea
+ syntax: text/html
class: code
-
- - By default, show bib records
+ - "This description will show in search engine results (160 characters)."
+ - pref: OpacMetaDescription
+ type: textarea
+ -
+ - By default, show bibliographic records
- pref: BiblioDefaultView
choices:
normal: in simple form.
- When patrons click on a link to another website from your OPAC (like Amazon or OCLC),
- pref: OPACURLOpenInNewWindow
choices:
- yes: do
- no: "don't"
+ 1: do
+ 0: "don't"
- open the website in a new window.
-
- pref: hidelostitems
choices:
- yes: "Don't show"
- no: Show
+ 1: "Don't show"
+ 0: Show
- lost items on search and detail pages.
-
- 'Display lists in the OPAC using XSLT stylesheet at: '
- pref: OPACXSLTListsDisplay
class: file
- - '<br />Options:<ul><li><a href="#" class="set_syspref" data-syspref="OPACXSLTListsDisplay" data-value="">Leave empty</a> for "no xslt"</li><li>enter "<a href="#" class="set_syspref" data-syspref="OPACXSLTListsDisplay" data-value="default">default</a>" for the default one</li><li> put a path to define a xslt file</li><li>put an URL for an external specific stylesheet.</li></ul>{langcode} will be replaced with current interface language'
+ - '<br />Options:<ul><li>Enter "<a href="#" class="set_syspref" data-syspref="OPACXSLTListsDisplay" data-value="default">default</a>" for the default stylesheet</li><li>Put a path to define an xslt file</li><li>Put a URL for an external specific stylesheet.</li><li>NOTE: The system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PassItemMarcToXSLT">PassItemMarcToXSLT</a> must be enabled if your custom stylesheet utilizes data in the item fields</li></ul>If you have multiple stylesheets for different languages the placeholder {langcode} will be replaced with current interface language.'
-
- 'Display OPAC results using XSLT stylesheet at: '
- pref: OPACXSLTResultsDisplay
class: file
- - '<br />Options:<ul><li><a href="#" class="set_syspref" data-syspref="OPACXSLTResultsDisplay" data-value="">Leave empty</a> for "no xslt"</li><li>enter "<a href="#" class="set_syspref" data-syspref="OPACXSLTResultsDisplay" data-value="default">default</a>" for the default one</li><li> put a path to define a xslt file</li><li>put an URL for an external specific stylesheet.</li></ul>{langcode} will be replaced with current interface language'
+ - '<br />Options:<ul><li>Enter "<a href="#" class="set_syspref" data-syspref="OPACXSLTResultsDisplay" data-value="default">default</a>" for the default stylesheet</li><li>Put a path to define an xslt file</li><li>Put a URL for an external specific stylesheet.</li><li>NOTE: The system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PassItemMarcToXSLT">PassItemMarcToXSLT</a> must be enabled if your custom stylesheet utilizes data in the item fields</li></ul>If you have multiple stylesheets for different languages the placeholder {langcode} will be replaced with current interface language.'
-
- 'Display OPAC details using XSLT stylesheet at: '
- pref: OPACXSLTDetailsDisplay
class: file
- - '<br />Options:<ul><li><a href="#" class="set_syspref" data-syspref="OPACXSLTDetailsDisplay" data-value="">Leave empty</a> for "no xslt"</li><li>enter "<a href="#" class="set_syspref" data-syspref="OPACXSLTDetailsDisplay" data-value="default">default</a>" for the default one</li><li>put a path to define a xslt file</li><li>put an URL for an external specific stylesheet.</li></ul>{langcode} will be replaced with current interface language'
+ - '<br />Options:<ul><li>Enter "<a href="#" class="set_syspref" data-syspref="OPACXSLTDetailsDisplay" data-value="default">default</a>" for the default stylesheet</li><li>Put a path to define an xslt file</li><li>Put a URL for an external specific stylesheet.</li><li>NOTE: The system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PassItemMarcToXSLT">PassItemMarcToXSLT</a> must be enabled if your custom stylesheet utilizes data in the item fields</li></ul>If you have multiple stylesheets for different languages the placeholder {langcode} will be replaced with current interface language.'
+ -
+ - "Show itemtype icons in the OPAC: "
+ - pref: OpacNoItemTypeImages
+ default: 0
+ choices:
+ 1: "No"
+ 0: "Yes"
-
- pref: DisplayOPACiconsXSLT
choices:
- yes: Show
- no: "Don't show"
- - the format, audience, and material type icons in XSLT MARC21 results and detail pages in the OPAC.
+ 1: Show
+ 0: "Don't show"
+ - the format, audience, and material type icons and descriptions in XSLT MARC21 results and detail pages in the OPAC.
-
- pref: COinSinOPACResults
choices:
- yes: Include
- no: "Don't include"
+ 1: Include
+ 0: "Don't include"
- "COinS / OpenURL / Z39.88 in OPAC search results. <br/>Warning: Enabling this feature will slow OPAC search response times."
+ - "<br/>If you want to display a link to an OpenURL resolver, look at the following system preferences:"
+ - '<br/><a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OpenURLResolverURL">OpenURLResolverURL</a>, <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACShowOpenURL">OPACShowOpenURL</a>, <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACOpenURLItemTypes">OPACOpenURLItemTypes</a>, <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OpenURLText">OpenURLText</a>, <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OpenURLImageLocation">OpenURLImageLocation</a>'
-
- pref: OPACShowUnusedAuthorities
choices:
- yes: Show
- no: "Do not show"
+ 1: Show
+ 0: "Don't show"
- unused authorities in the OPAC authority browser.
-
- pref: OPACShowHoldQueueDetails
- pref: OPACShowCheckoutName
default: 0
choices:
- yes: Show
- no: "Don't show"
+ 1: Show
+ 0: "Don't show"
- the name of the patron that has an item checked out on item detail pages on the OPAC.
-
- Display the
both: "below both home and holding libraries"
column: "on a separate column"
- "for items on the OPAC record details page."
- - "<br />Note: If 'on a separate column' is selected, you still need to enable the item_shelving_location display on the <a href='/cgi-bin/koha/admin/columns_settings.pl'>configure columns</a> administration page"
+ - "<br />Note: If 'on a separate column' is selected, you still need to enable the item_shelving_location display on the <a href='/cgi-bin/koha/admin/columns_settings.pl'>configure columns</a> administration page."
+ -
+ - pref: OPACShowMusicalInscripts
+ default: 0
+ choices:
+ 1: Show
+ 0: "Don't show"
+ - musical inscripts on the OPAC record details page.
+ -
+ - pref: OPACPlayMusicalInscripts
+ default: 0,'','If displayed musical inscripts, play midi conversion for items on the OPAC record details page.'
+ choices:
+ 1: Play
+ 0: "Don't play"
+ - MIDI representation of musical inscripts on the OPAC record details page.
-
- pref: OpacKohaUrl
default: 0
choices:
- yes: Show
- no: "Don't show"
+ 1: Show
+ 0: "Don't show"
- "'Powered by Koha' text on OPAC footer."
-
- pref: OpacShowRecentComments
default: 0
choices:
- yes: Show
- no: "Don't show"
+ 1: Show
+ 0: "Don't show"
- a link to recent comments in the OPAC masthead.
-
- - pref: GoogleIndicTransliteration
- default: 0
- choices:
- yes: Show
- no: "Don't show"
- - GoogleIndicTransliteration on the OPAC.
- -
- pref: OpacHighlightedWords
choices:
- yes: Highlight
- no: "Don't highlight"
- - words the patron searched for in their search results and detail pages; To prevent certain words from ever being highlighted, enter a list of stopwords here
+ 1: Highlight
+ 0: "Don't highlight"
+ - "words the patron searched for in their search results and detail pages. To prevent certain words from ever being highlighted, enter a list of stopwords here:"
- pref: NotHighlightedWords
class: multi
- - (separate columns with |)
+ - (separate columns with |).
-
- Use the image at
- pref: OpacFavicon
- "Include the following JavaScript on all pages in the OPAC:"
- pref: OPACUserJS
type: textarea
+ syntax: javascript
class: code
-
- Include the additional CSS stylesheet
- pref: OpacAdditionalStylesheet
class: file
- - to override specified settings from the default stylesheet (leave blank to disable). Enter just a filename, a full local path or a complete URL starting with <code>http://</code> (if the file lives on a remote server). Please note that if you just enter a filename, the file should be in the css subdirectory for each active theme and language within the Koha templates directory. A full local path is expected to start from your HTTP document root.
+ - to override specific settings from the default stylesheet (leave blank to disable). Enter just a filename, a full local path or a complete URL starting with <code>http://</code> (if the file lives on a remote server). Please note that if you just enter a filename, the file should be in the css subdirectory for each active theme and language within the Koha templates directory. A full local path is expected to start from your HTTP document root.
-
- Use the CSS stylesheet
- pref: opaclayoutstylesheet
class: file
- - on all pages in the OPAC, instead of the default css (used when leaving this field blank). Enter just a filename, a full local path or a complete URL starting with <code>http://</code> (if the file lives on a remote server). Please note that if you just enter a filename, the file should be in the css subdirectory for each active theme and language within the Koha templates directory. A full local path is expected to start from your HTTP document root.
+ - on all pages in the OPAC, instead of the default CSS (used when leaving this field blank). Enter just a filename, a full local path or a complete URL starting with <code>http://</code> (if the file lives on a remote server). Please note that if you just enter a filename, the file should be in the css subdirectory for each active theme and language within the Koha templates directory. A full local path is expected to start from your HTTP document root.
-
- "Include the following CSS on all pages in the OPAC:"
- pref: OPACUserCSS
type: textarea
- class: code
- -
- - "Show the following HTML in its own column on the main page of the OPAC:"
- - pref: OpacMainUserBlock
- type: htmlarea
- class: code
- -
- - "Show the following HTML on the left hand column of the main page and patron account on the OPAC (generally navigation links):"
- - pref: OpacNav
- type: htmlarea
- class: code
- -
- - "Show the following HTML in the right hand column of the main page under the main login form:"
- - pref: OpacNavRight
- type: htmlarea
- class: code
- -
- - "Show the following HTML on the left hand column of the main page and patron account on the OPAC, after OpacNav, and before patron account links if available:"
- - pref: OpacNavBottom
- type: htmlarea
- class: code
- -
- - "Include the following HTML in the header of all pages in the OPAC:"
- - pref: opacheader
- type: htmlarea
- class: code
- -
- - "Include the following HTML in the footer of all pages in the OPAC:"
- - pref: opaccredits
- type: htmlarea
+ syntax: css
class: code
-
- 'Include a "More Searches" box on the detail pages of items on the OPAC, with the following HTML (leave blank to disable):'
- '<br />Note: The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN}, {ISSN} and {AUTHOR} will be replaced with information from the displayed record.'
- pref: OPACSearchForTitleIn
type: textarea
+ syntax: text/html
class: code
-
- - 'Include a "Links" column on the "my summary" and "my reading history" tabs when a user is logged in to the OPAC, with the following HTML (leave blank to disable):'
+ - 'Include a "Links" column on the "my summary" and "my checkout history" tabs when a patron is logged in to the OPAC, with the following HTML (leave blank to disable):'
- '<br />Note: The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR} will be replaced with information from the displayed record.'
- pref: OPACMySummaryHTML
- type: htmlarea
- class: code
- -
- - "Note to display on the patron summary page. This note only appears if the patron is logged in:"
- - pref: OPACMySummaryNote
type: textarea
+ syntax: text/html
+ class: code
-
- "Include the following HTML under the facets in OPAC search results:"
- pref: OPACResultsSidebar
- type: htmlarea
+ type: textarea
+ syntax: text/html
class: code
-
- pref: OpacAddMastheadLibraryPulldown
choices:
- yes: Add
- no: "Don't add"
+ 1: Add
+ 0: "Don't add"
- a library select pulldown menu on the OPAC masthead.
-
- 'Display this HTML when no results are found for a search in the OPAC:'
- '<br />Note: You can insert placeholders {QUERY_KW} that will be replaced with the keywords of the query.'
- pref: OPACNoResultsFound
- type: htmlarea
+ type: textarea
+ syntax: text/html
class: code
-
- 'Display the URI in the 856u field as an image on: '
- pref: OPACDisplay856uAsImage
choices:
- OFF: "Neither detail or result pages"
- Details: "Detail page only"
- Results: "Result page only"
- Both: "Both detail and result pages"
- - '. Note: The corresponding OPACXSLT option must be turned on.'
+ OFF: "neither detail or result pages"
+ Details: "detail page only"
+ Results: "result page only"
+ Both: "both detail and result pages"
+ - '. Note: The corresponding <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACXSLT">OPACXSLT</a> option must be turned on.'
-
- 'Select export options that should be available from OPAC detail page:'
- pref: OpacExportOptions
-
- pref: OpacSeparateHoldings
choices:
- yes: Separate
- no: Don't separate
+ 1: Separate
+ 0: Don't separate
- "items display into two tabs, where the first tab contains items whose"
- pref: OpacSeparateHoldingsBranch
choices:
homebranch: 'home library'
holdingbranch: 'holding library'
- - "is the logged in user's library. The second tab will contain all other items."
+ - "is the logged in patrons's library. The second tab will contain all other items."
-
- pref: OPACHoldingsDefaultSortField
choices:
first_column: First column of the table
homebranch: Home library
holdingbranch: Holding library
- - "is the default sort field for the holdings table"
+ - "is the default sort field for the holdings table."
-
- pref: OpacSuggestionManagedBy
choices:
- yes: Show
- no: Don't show
+ 1: Show
+ 0: Don't show
- "the name of the staff member who managed a suggestion in OPAC."
-
- Display up to
- pref: OpacMaxItemsToDisplay
class: integer
- - items on the bibliographic record detail page (if the bibliographic record has more items than this, a link is displayed instead that allows the user to choose to display all items).
- -
- - "Show the following HTML on the OPAC login form when a patron is not logged in:"
- - pref: OpacLoginInstructions
- type: htmlarea
- class: code
- -
- - "Replace the search box at the top of OPAC pages with the following HTML:"
- - pref: OpacCustomSearch
- type: textarea
- class: code
+ - items on the bibliographic record detail page (if the bibliographic record has more items than this, a link is displayed instead that allows the patron to choose to display all items).
-
- "Display language selector on "
- pref: OpacLangSelectorMode
both: "both top and footer"
top: "top"
footer: "only footer"
+ - "."
+ -
+ - "List the following not for loan statuses as available for reference in OPAC search results:"
+ - pref: Reference_NFL_Statuses
+ - "(Use | as delimiter.)"
+ -
+ - Show no more than
+ - pref: OPACResultsMaxItems
+ - (available) individual items on the OPAC XSLT search results, and show no more than
+ - pref: OPACResultsMaxItemsUnavailable
+ - "(unavailable) individual items for categories like Checked out, Damaged, On Hold, but only when you group them by branch.<br>"
+ - Group unavailable items by
+ - pref: OPACResultsUnavailableGroupingBy
+ choices:
+ branch: "branch"
+ substatus: "substatus"
+ - ". (NOTE: For large consortia we recommend to group unavailable items by substatus, listing item counts only.)"
+
Features:
-
+ - pref: OPACReportProblem
+ choices:
+ 1: Allow
+ 0: "Don't allow"
+ - patrons to submit problem reports for OPAC pages to the library or Koha administrator.
+ - "<br/>"
+ - '<strong>NOTE:</strong> You must have <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=KohaAdminEmailAddress">KohaAdminEmailAddress</a> enabled.'
+ -
- pref: opacuserlogin
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to log in to their accounts on the OPAC.
-
- Show
- pref: OpacItemLocation
choices:
- location: location
- ccode: "collection code"
- callnum: "call number only"
+ location: "library, location, and call number"
+ ccode: "library, collection code, and call number"
+ callnum: "library and call number"
+ library: "only library"
- for items on the OPAC search results.
-
- pref: OpacPasswordChange
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to change their own password on the OPAC. Note that this must be off to use LDAP authentication.
-
- - "Library users are "
+ - "Library patrons are "
- pref: OpacResetPassword
default: 1
choices:
- yes: "allowed"
- no: "not allowed"
- - " to recover their password via e-mail in the OPAC"
- -
- - pref: OPACPatronDetails
- choices:
- yes: Allow
- no: "Don't allow"
- - patrons to notify the library of changes to their contact information from the OPAC.
+ 1: "allowed"
+ 0: "not allowed"
+ - " to recover their password via e-mail in the OPAC."
-
- pref: OPACpatronimages
choices:
- yes: Show
- no: "Don't show"
+ 1: Show
+ 0: "Don't show"
- patron images on the patron information page in the OPAC.
-
+ - pref: OPACDetailQRCode
+ choices:
+ 1: Enable
+ 0: Disable
+ - the option to show a QR Code on the OPAC bibliographic detail page.
+ -
- pref: OPACFinesTab
choices:
- yes: Allow
- no: "Don't allow"
- - patrons to access the Fines tab on the My Account page on the OPAC.
+ 1: Allow
+ 0: "Don't allow"
+ - patrons to access the charges tab on their account page on the OPAC.
-
- pref: OpacBrowser
choices:
- yes: Allow
- no: "Don't allow"
- - patrons to browse subject authorities on OPAC
- - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/build_browser_and_cloud.pl</code> cronjob. Ask you system administrator to schedule it."
+ 1: Allow
+ 0: "Don't allow"
+ - "patrons to browse subject authorities on the OPAC."
+ - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/build_browser_and_cloud.pl</code> cronjob. Ask your system administrator to schedule it."
-
- pref: OpacCloud
choices:
- yes: Show
- no: "Don't show"
- - a subject cloud on OPAC
- - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/build_browser_and_cloud.pl</code> cronjob. Ask you system administrator to schedule it."
+ 1: Show
+ 0: "Don't show"
+ - "a subject cloud on the OPAC."
+ - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/build_browser_and_cloud.pl</code> cronjob. Ask your system administrator to schedule it."
-
- pref: OpacAuthorities
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to search your authority records.
-
- pref: opacbookbag
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to store items in a temporary "Cart" on the OPAC.
-
- pref: OpacTopissue
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to access a list of the most checked out items on the OPAC. Note that this is somewhat experimental, and should be avoided if your collection has a large number of items.
-
- pref: suggestion
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to make purchase suggestions on the OPAC.
-
- - pref: reviewson
+ - pref: OPACComments
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to make comments on items on the OPAC.
-
- Show
-
- pref: ShowReviewerPhoto
choices:
- yes: Show
- no: Hide
- - reviewer's avatar beside comments in OPAC. The avatar will be searched on www.libravatar.org using the patron's e-mail address.
+ 1: Show
+ 0: Hide
+ - reviewer's avatar beside comments in OPAC. The avatar will be searched on <a href="https://www.libravatar.org" target="_blank">Libravatar</a> using the patron's e-mail address.
-
- - pref: RequestOnOpac
+ - pref: OPACHoldRequests
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to place holds on items from the OPAC.
-
- Display
class: long
- search results in the RSS feed.
-
+ - Show
- pref: SocialNetworks
- default: 0
- choices:
- yes: Enable
- no: Disable
- - social network links in opac detail pages
+ multiple:
+ facebook: Facebook
+ linkedin: LinkedIn
+ email: Email
+ twitter: Twitter
+
+ - "social network links on the OPAC detail pages."
-
- pref: OpacBrowseResults
default: 1
choices:
- yes: Enable
- no: Disable
+ 1: Enable
+ 0: Disable
- browsing and paging search results from the OPAC detail page.
-
+ - Show quote of the day in the
- pref: QuoteOfTheDay
- default: 0
- choices:
- yes: Enable
- no: Disable
- - Quote of the Day display on OPAC home page
+ multiple:
+ intranet: staff interface
+ opac: OPAC
+ - main page.
-
- pref: OPACPopupAuthorsSearch
default: 0
choices:
- yes: Display
- no: Don't display
+ 1: Display
+ 0: Don't display
- the list of authors/subjects in a popup for a combined search on OPAC detail pages.
-
- pref: OpacHoldNotes
default: 0
choices:
- yes: Allow
- no: Do not allow
- - users to add a note when placing a hold.
+ 1: Allow
+ 0: "Don't allow"
+ - patrons to add a note when placing a hold.
-
- pref: OPACAcquisitionDetails
default: 0
choices:
- yes: Display
- no: Don't display
+ 1: Display
+ 0: Don't display
- the acquisition details on OPAC detail pages.
-
- pref: OpacNewsLibrarySelect
default: 0
choices:
- yes: Display
- no: Don't display
- - a branch selection list for news items in the OPAC.
+ 1: Display
+ 0: Don't display
+ - a library selection list for news items in the OPAC.
+ -
+ - pref: OPACSuggestionAutoFill
+ default: 0
+ choices:
+ yes: Enable
+ no: Disable
+ - OPAC suggestions form automatically filling with data from Google Books API.
-
- "Use the following as the OPAC ISBD template:"
- pref: OPACISBD
type: textarea
+ syntax: text/html
class: code
+ -
+ - pref: OpacBrowseSearch
+ default: 0
+ choices:
+ 1: Enable
+ 0: Disable
+ - "interface for browsing all holdings (Elasticsearch only)."
+ OpenURL:
+ -
+ - 'Complete URL of OpenURL resolver (starting with <code>http://</code> or <code>https://</code>):'
+ - pref: OpenURLResolverURL
+ class: url
+ -
+ - 'Text of OpenURL links (or image title if <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OpenURLImageLocation">OpenURLImageLocation</a> is defined):'
+ - pref: OpenURLText
+ -
+ - 'Location of image for OpenURL links:'
+ - pref: OpenURLImageLocation
+ class: url
+ - '<br />Can be an absolute URL starting with <code>http://</code> or'
+ - '<code>https://</code> or a relative URL'
+ - '<br />Examples:'
+ - '<br />- <code>http://www.example.com/img/openurl.png</code>'
+ - '<br />- <code>/opac-tmpl/bootstrap/images/OpenURL.png</code>'
+ -
+ - pref: OPACShowOpenURL
+ choices:
+ 1: Enable
+ 0: Disable
+ - 'display of OpenURL link in OPAC search results and detail page.'
+ -
+ - 'List of item type codes (separated by spaces) for those you want to show the OpenURL link:'
+ - pref: OPACOpenURLItemTypes
+ - '<br />'
Policy:
-
- pref: SearchMyLibraryFirst
choices:
- yes: Limit
- no: "Don't limit"
+ 1: Limit
+ 0: "Don't limit"
- "patrons' searches to the library they are registered at."
-# -
-# This system preference does not actually affect anything
-# - pref: OpacBrowser
-# choices:
-# yes: Show
-# no: "Don't show"
-# - a subject browser on the OPAC (generated using <code>misc/cronjobs/build_browser_and_cloud.pl</code>).
-# -
-# opac-tags_subject.pl is the only script affected by this, and it is not linked to by any other page
-# - pref: OpacCloud
-# choices:
-# - If ON, enables subject cloud on OPAC
-
- pref: OpacRenewalAllowed
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to renew their own books on the OPAC.
-
- Use
itemhomebranch: "the item's home library"
patronhomebranch: "the patron's home library"
checkoutbranch: "the library the item was checked out from"
- null: "NULL"
+ none: "NULL"
opacrenew: "'OPACRenew'"
- as branchcode to store in the statistics table.
-
class: currency
- '[% local_currency %] in fines (leave blank to disable).'
-
- - pref: OPACViewOthersSuggestions
+ - pref: OPACFineNoRenewalsIncludeCredits
choices:
- yes: Show
- no: "Don't show"
- - purchase suggestions from other patrons on the OPAC.
+ 1: Include
+ 0: "Don't include"
+ - outstanding/unapplied credits when applying the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACFineNoRenewals">OPACFineNoRenewals</a> rule to patrons.
-
- - pref: AllowPurchaseSuggestionBranchChoice
- default: 0
+ - pref: OPACViewOthersSuggestions
choices:
- no: "Don't allow"
- yes: Allow
- - patrons to select library when making a purchase suggestion
+ 1: Show
+ 0: "Don't show"
+ - purchase suggestions from other patrons on the OPAC.
-
- "Fields that should be mandatory for patron purchase suggestions:"
- pref: OPACSuggestionMandatoryFields
- multiple:
- title: Title
- author: Author
- copyrightdate: Copyright or publication date
- isbn: ISBN, ISSN or other standard number
- publishercode: Publisher name
- collectiontitle: Collection title
- place: Publication place
- itemtype: Item type
- branch: Library or branch
- patronreason: Patron reason
- note: Note
+ type: modalselect
+ source: suggestions
+ required: title
- "<br />Note: if none of the above options are selected, 'Title' field would be mandatory anyway, by default."
-
+ - "Fields that should be hidden for patron purchase suggestions:"
+ - pref: OPACSuggestionUnwantedFields
+ type: modalselect
+ source: suggestions
+ exclusions: title
+ - '<br />Note: Do not make <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACSuggestionMandatoryFields">OPACSuggestionMandatoryFields</a> unwanted fields '
+ -
- pref: OpacHiddenItems
type: textarea
+ syntax: text/x-yaml
class: code
- Define custom rules to hide specific items from search and view on the OPAC. How to write these rules is documented on the <a href="http://wiki.koha-community.org/wiki/OpacHiddenItems" target="_blank">Koha wiki</a>.
-
+ - 'List of patron categories, separated by |, that can see items otherwise hidden by <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OpacHiddenItems">OpacHiddenItems</a>:'
- pref: OpacHiddenItemsExceptions
- - List of borrower categories, separated by |, that can see items otherwise hidden by <tt>OpacHiddenItems</tt>
+ -
+ - pref: OpacHiddenItemsHidesRecord
+ default: 1
+ choices:
+ 0: "Don't hide"
+ 1: Hide
+ - "the bibliographic record when all its items are hidden by <a href='/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OpacHiddenItems'>OpacHiddenItems</a>."
-
- pref: OpacAllowPublicListCreation
default: 1
choices:
- no: "Don't allow"
- yes: Allow
- - opac users to create public lists
+ 0: "Don't allow"
+ 1: Allow
+ - "OPAC users to create public lists."
-
- pref: OpacAllowSharingPrivateLists
default: 0
choices:
- no: "Don't allow"
- yes: Allow
- - opac users to share private lists with other patrons.
+ 0: "Don't allow"
+ 1: Allow
+ - "OPAC users to share private lists with other patrons."
-
- pref: BlockExpiredPatronOpacActions
choices:
- yes: "Block"
- no: "Don't block"
- - expired patrons from OPAC actions such as placing a hold or renewing. Note that the setting for a patron category takes priority over this system preference.
+ 1: "Block"
+ 0: "Don't block"
+ - expired patrons from OPAC actions such as placing a hold or renewing. Note that the setting for a patron category takes priority over this system preference.
-
- Limit patrons to
- pref: MaxOpenSuggestions
class: integer
- - "open suggestions. Leave empty for no limit. **Note: this setting does not affect anonymous suggestions"
- Privacy:
+ - "open suggestions. Leave empty for no limit. **Note: this setting does not affect anonymous suggestions."
-
- - pref: StoreLastBorrower
- default: 0
- choices:
- yes: Store
- no: "Don't store"
- - the last patron to return an item. This setting is independent of opacreadinghistory/AnonymousPatron.
+ - Number of total suggestions allowed
+ - pref: MaxTotalSuggestions
+ class: integer
+ - "in"
+ - pref: NumberOfSuggestionDays
+ class: integer
+ - "days."
+ Privacy:
-
- pref: AnonSuggestions
choices:
- yes: Allow
- no: "Don't allow"
- - "patrons that aren't logged in to make purchase suggestions. Suggestions are connected to the AnonymousPatron syspref"
+ 1: Allow
+ 0: "Don't allow"
+ - 'patrons that aren''t logged in to make purchase suggestions. Suggestions are connected to the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=AnonymousPatron">AnonymousPatron</a> system preference.'
-
- pref: opacreadinghistory
choices:
- yes: Allow
- no: "Don't allow"
+ 1: Allow
+ 0: "Don't allow"
- patrons to see what books they have checked out in the past.
-
+ - pref: OPACHoldsHistory
+ choices:
+ 1: Allow
+ 0: "Don't allow"
+ - patrons to see the list of their past holds.
+ -
- pref: EnableOpacSearchHistory
default: 0
choices:
- yes: Keep
- no: "Don't keep"
+ 1: Keep
+ 0: "Don't keep"
- patron search history in the OPAC.
-
- pref: OPACPrivacy
default: 0
choices:
- yes: Allow
- no: "Don't allow"
- - patrons to choose their own privacy settings for their reading history. This requires opacreadinghistory and AnonymousPatron
+ 1: Allow
+ 0: "Don't allow"
+ - 'patrons to choose their own privacy settings for their checkout history. This requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=opacreadinghistory">opacreadinghistory</a> and <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=AnonymousPatron">AnonymousPatron</a> system preferences.'
-
- pref: AllowPatronToSetCheckoutsVisibilityForGuarantor
default: 0
choices:
- yes: Allow
- no: "Don't allow"
- - patrons to choose their own privacy settings for showing the patron's checkouts to the patron's guarantor".
+ 1: Allow
+ 0: "Don't allow"
+ - "patrons to choose their own privacy settings for showing the patron's checkouts to the patron's guarantor."
+ -
+ - pref: AllowPatronToSetFinesVisibilityForGuarantor
+ default: 0
+ choices:
+ 1: Allow
+ 0: "Don't allow"
+ - "patrons to choose their own privacy settings for showing the patron's fines to the patron's guarantor."
-
- Use borrowernumber
- pref: AnonymousPatron
class: integer
- - as the Anonymous Patron (for anonymous suggestions and reading history)
+ - "as the anonymous patron (for anonymous suggestions and checkout history)."
-
- pref: TrackClicks
default: 0
choices:
anonymous: "Track anonymously"
track: "Track"
- no: "Don't track"
- - links that patrons click on
+ 0: "Don't track"
+ - "links that patrons click on."
Restricted page:
-
- "Access from IP addresses beginning with"
- pref: RestrictedPageLocalIPs
- - "do not need to be authenticated (comma separated - ex: '127.0.0,127.0.1')"
+ - "do not need to be authenticated (comma separated - ex: '127.0.0,127.0.1')."
-
- - "HTML content of your restricted page"
+ - "HTML content of your restricted page (available at /cgi-bin/koha/opac-restrictedpage.pl)"
- pref: RestrictedPageContent
type: textarea
+ syntax: text/html
class: HTML
-
- Use
- pref: RestrictedPageTitle
class: long
- - "as title of your restricted page (appears in the breadcrumb and on the top of the restricted page)"
- Shelf Browser:
+ - "as title of your restricted page (appears in the breadcrumb and on the top of the restricted page)."
+ Shelf browser:
-
- pref: OPACShelfBrowser
choices:
- yes: Show
- no: "Don't show"
+ 1: Show
+ 0: "Don't show"
- "a shelf browser on item details pages, allowing patrons to see what's near that item on the shelf. Note that this uses up a fairly large amount of resources on your server, and should be avoided if your collection has a large number of items."
-
- pref: ShelfBrowserUsesLocation
default: 1
choices:
- yes: Use
- no: "Don't use"
+ 1: Use
+ 0: "Don't use"
- "the item location when finding items for the shelf browser."
-
- pref: ShelfBrowserUsesHomeBranch
default: 1
choices:
- yes: Use
- no: "Don't use"
+ 1: Use
+ 0: "Don't use"
- "the item home library when finding items for the shelf browser."
-
- pref: ShelfBrowserUsesCcode
default: 0
choices:
- yes: Use
- no: "Don't use"
+ 1: Use
+ 0: "Don't use"
- "the item collection code when finding items for the shelf browser."
- Self Registration:
+ Self registration and modification:
-
- pref: PatronSelfRegistration
choices:
- yes: Allow
- no: "Don't allow"
- - "library patrons to register or modify their account via the OPAC."
- - "<br><strong>NOTE:</strong> This needs PatronSelfRegistrationDefaultCategory to be set to a valid patron category code."
+ 1: Allow
+ 0: "Don't allow"
+ - "library patrons to register for an account via the OPAC."
+ - "<br><strong>NOTE:</strong> This needs <a href='/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PatronSelfRegistrationDefaultCategory'>PatronSelfRegistrationDefaultCategory</a> to be set to a valid patron category code."
-
- pref: PatronSelfRegistrationVerifyByEmail
choices:
- yes: Require
- no: "Don't require"
- - "that a self-registering patron verify his or herself via email."
- - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/delete_unverified_opac_registrations.pl</code> cronjob. Ask you system administrator to schedule it."
+ 1: Require
+ 0: "Don't require"
+ - "that a self-registering patron verify themselves via email."
+ - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/cleanup_database.pl</code> cronjob. Ask your system administrator to schedule it."
-
- - "Use the patron category code"
+ - "Use"
- pref: PatronSelfRegistrationDefaultCategory
- class: short
+ choices: patron-categories
- "as the default patron category for patrons registered via the OPAC."
+ - "<br><strong>WARNING: Do not use a regular patron category for self registration.</strong>"
+ - "<br>If the <code>misc/cronjobs/cleanup_database.pl</code> cronjob is setup to delete unverified and unfinished OPAC self registrations, it will permanently and unrecoverably delete all patrons that have registered more than <a href='/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PatronSelfRegistrationExpireTemporaryAccountsDelay'>PatronSelfRegistrationExpireTemporaryAccountsDelay</a> days ago (unless that delay is empty or zero)."
-
- - "Delete patrons registered via the OPAC, but not yet verified after"
+ - Delete patrons still in the category indicated by <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PatronSelfRegistrationDefaultCategory">PatronSelfRegistrationDefaultCategory</a>
- pref: PatronSelfRegistrationExpireTemporaryAccountsDelay
class: integer
- - "days."
- - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/delete_expired_opac_registrations.pl</code> cronjob. Ask you system administrator to schedule it."
+ - "days after account creation."
+ - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/cleanup_database.pl</code> cronjob. Ask your system administrator to schedule it.<br>No patrons will be deleted if you set the pref to zero or make it empty."
+ -
+ - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> must be filled in on the patron modification screen:"
+ - pref: PatronSelfModificationMandatoryField
+ type: modalselect
+ source: borrowers
+ exclusions: password|cardnumber|dateexpiry|categorycode|sort1|sort2|opacnote|borrowernotes
-
- "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> must be filled in on the patron entry screen:"
- pref: PatronSelfRegistrationBorrowerMandatoryField
- class: multi
- - (separate columns with |)
+ type: modalselect
+ source: borrowers
+ exclusions: sort1|sort2|opacnote|borrowernotes
-
- "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> will not appear on the patron self-registration screen:"
- pref: PatronSelfRegistrationBorrowerUnwantedField
- class: multi
- - (separate columns with |)
+ type: modalselect
+ source: borrowers
+ exclusions: branchcode|sort1|sort2
-
- "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> will not appear on the patron self-modification screen:"
- pref: PatronSelfModificationBorrowerUnwantedField
- class: multi
- - (separate columns with |)
+ type: modalselect
+ source: borrowers
+ exclusions: sort1|sort2
-
- "Display the following additional instructions for patrons who self register via the OPAC ( HTML is allowed ):"
- pref: PatronSelfRegistrationAdditionalInstructions
- type: htmlarea
+ type: textarea
+ syntax: text/html
class: html
-
- pref: PatronSelfRegistrationEmailMustBeUnique
choices:
- yes: "Consider"
- no: "Do not consider"
+ 1: "Consider"
+ 0: "Don't consider"
- "patron's email (borrowers.email) as unique on self registering. An email won't be accepted if it already exists in the database."
-
- "Enable the self registration for the following libraries:"
-
- pref: PatronSelfRegistrationPrefillForm
choices:
- yes: "Display and prefill"
- no: "Do not display and prefill"
+ 1: "Display and prefill"
+ 0: "Don't display and prefill"
- "password and login form after a patron has self registered."
+ -
+ - pref: PatronSelfRegistrationConfirmEmail
+ choices:
+ 1: Require
+ 0: "Don't require"
+ - patrons to confirm their email address by entering it twice.
+ -
+ - pref: OPACPatronDetails
+ choices:
+ 1: Allow
+ 0: "Don't allow"
+ - patrons to notify the library of changes to their contact information from the OPAC.
- Advanced Search Options:
+ Advanced search options:
-
- - Show search options
+ - "Show search options:"
- pref: OpacAdvSearchOptions
multiple:
pubdate: Publication date
sorting: Sorting
location: Location and availability
-
- - Show search options for the expanded view
+ - "Show search options for the expanded view:"
- pref: OpacAdvSearchMoreOptions
multiple:
pubdate: Publication date
subtype: Subtypes
sorting: Sorting
location: Location and availability
- Payments:
-
- - pref: EnablePayPalOpacPayments
- default: 1
- choices:
- yes: Allow
- no: "Don't allow"
- - "patrons to make payments from the OPAC via PayPal in"
- - pref: PayPalSandboxMode
- default: 1
- choices:
- yes: "Sandbox"
- no: "Production"
- - "mode."
- -
- - "The email address to receive PayPal payments is "
- - pref: PayPalUser
- class: long
- -
- - "The password for the PayPal account to receive payments is "
- - pref: PayPalPwd
+ - Show tabs in the OPAC advanced search for limiting searches on the
+ - pref: OpacAdvancedSearchTypes
class: long
+ - "fields (separate values with |). Tabs appear in the order listed.<br/>"
+ - "<em>Currently supported values</em>: Item types (<strong>itemtypes</strong>), Collection, (<strong>ccode</strong>) and Shelving Location (<strong>loc</strong>)."
+ Authentication:
-
- - "The signature for the PayPal account to receive payments is "
- - pref: PayPalSignature
- class: long
- -
- - "The patron should see the charge description as "
- - pref: PayPalChargeDescription
- class: long
+ - pref: OPACShibOnly
+ choices:
+ 1: "Don't allow"
+ 0: Allow
+ - patrons to login by means other than Shibboleth.
projects / koha-ffzg.git / blobdiff