Bug 22318: Example implementation: OpacNavRight system preference
[koha-equinox.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / opac.pref
index c26d048..b2495d2 100644 (file)
@@ -1,6 +1,19 @@
 OPAC:
     Appearance:
         -
+            - 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"
+        -
+            - For search results in the OPAC, show the item's
+            - pref: OPACResultsLibrary
+              choices:
+                  holdingbranch: "current location"
+                  homebranch: "home library"
+            - . Please note that this feature is currently available for MARC21 and UNIMARC.
+        -
             - Use the
             - pref: opacthemes
               choices: opac-templates
@@ -13,10 +26,10 @@ OPAC:
                   prog: prog
             - theme as the fallback theme on the OPAC.
         -
-            - "The OPAC is located at http://"
+            - "The OPAC is located at "
             - pref: OPACBaseURL
               class: url
-            - . Do not include a trailing slash in the URL. (This must be filled in correctly for RSS, unAPI, and search plugins to work.)
+            - . This should be a complete URL, starting with <code>http://</code> or <code>https://</code>. Do not include a trailing slash in the URL. (This must be filled in correctly for RSS, unAPI, and search plugins to work.)
         -
             - Show
             - pref: LibraryName
@@ -27,7 +40,7 @@ OPAC:
               choices:
                   yes: Enable
                   no: Disable
-            - "Koha OPAC as public. Private OPAC requires authentification before accessing the OPAC."
+            - "Koha OPAC as public. Private OPAC requires authentication before accessing the OPAC."
         -
             - pref: HighlightOwnItemsOnOPAC
               choices:
@@ -54,6 +67,13 @@ OPAC:
                   no: "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:"
+            - pref: OpacMaintenanceNotice
+              type: textarea
+              syntax: text/html
+              class: code
+        -
             - By default, show bib records
             - pref: BiblioDefaultView
               choices:
@@ -74,6 +94,11 @@ OPAC:
                   no: 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'
+        -
             - 'Display OPAC results using XSLT stylesheet at: '
             - pref: OPACXSLTResultsDisplay
               class: file
@@ -125,13 +150,15 @@ OPAC:
                   both: "home and holding libraries"
             - for items on the OPAC record details page.
         -
-            - Display the shelving location under the
-            - pref: OpacLocationBranchToDisplayShelving
+            - 'Display the shelving location '
+            - pref: OpacLocationOnDetail
               choices:
-                  home: "home library"
-                  holding: "holding library"
-                  both: "home and holding libraries"
-            - for items on the OPAC record details page.
+                  home: "below the home library"
+                  holding: "below the holding library"
+                  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"
         -
             - pref: OpacKohaUrl
               default: 0
@@ -147,13 +174,6 @@ OPAC:
                   no: "Don't show"
             - a link to recent comments in the OPAC masthead.
         -
-            - pref: OPACShowBarcode
-              default: 0
-              choices:
-                  yes: Show
-                  no: "Don't show"
-            - the item's barcode on the holdings tab.
-        -
             - pref: GoogleIndicTransliteration
               default: 0
               choices:
@@ -170,20 +190,15 @@ OPAC:
               class: multi
             - (separate columns with |)
         -
-            - pref: AuthorisedValueImages
-              choices:
-                  yes: Show
-                  no: "Don't show"
-            - images for <a href="/cgi-bin/koha/admin/authorised_values.pl">authorized values</a> (such as lost statuses and locations) in search results and item detail pages on the OPAC.
-        -
             - Use the image at
             - pref: OpacFavicon
               class: url
             - for the OPAC's favicon. (This should be a complete URL, starting with <code>http://</code>.)
         -
             - "Include the following JavaScript on all pages in the OPAC:"
-            - pref: opacuserjs
+            - pref: OPACUserJS
               type: textarea
+              syntax: javascript
               class: code
         -
             - Include the additional CSS stylesheet
@@ -199,57 +214,67 @@ OPAC:
             - "Include the following CSS on all pages in the OPAC:"
             - pref: OPACUserCSS
               type: textarea
+              syntax: css
               class: code
         -
             - "Show the following HTML in its own column on the main page of the OPAC:"
             - pref: OpacMainUserBlock
               type: textarea
+              syntax: text/html
               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: textarea
-              class: code
-        -
-            - "Show the following HTML in the right hand column of the main page under the main login form:"
-            - pref: OpacNavRight
-              type: textarea
+              syntax: text/html
               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: textarea
+              syntax: text/html
               class: code
         -
             - "Include the following HTML in the header of all pages in the OPAC:"
             - pref: opacheader
               type: textarea
+              syntax: text/html
               class: code
         -
             - "Include the following HTML in the footer of all pages in the OPAC:"
             - pref: opaccredits
               type: textarea
+              syntax: text/html
               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
+        -
+            - 'Add additional elements to the "More Searches" bar on the OPAC, with the following HTML (leave blank to disable):'
+            - pref: OpacMoreSearches
+              type: textarea
               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):'
             - '<br />Note: The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR} will be replaced with information from the displayed record.'
             - pref: OPACMySummaryHTML
               type: textarea
+              syntax: text/html
               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
         -
             - "Include the following HTML under the facets in OPAC search results:"
             - pref: OPACResultsSidebar
               type: textarea
+              syntax: text/html
               class: code
         -
             - pref: OpacAddMastheadLibraryPulldown
@@ -262,6 +287,7 @@ OPAC:
             - '<br />Note: You can insert placeholders {QUERY_KW} that will be replaced with the keywords of the query.'
             - pref: OPACNoResultsFound
               type: textarea
+              syntax: text/html
               class: code
         -
             - 'Display the URI in the 856u field as an image on: '
@@ -273,7 +299,7 @@ OPAC:
                   Both: "Both detail and result pages"
             - '. Note: The corresponding OPACXSLT option must be turned on.'
         -
-            - 'List export options that should be available from OPAC detail page separated by |:'
+            - 'Select export options that should be available from OPAC detail page:'
             - pref: OpacExportOptions
               multiple:
                 bibtex: BibTeX
@@ -297,6 +323,13 @@ OPAC:
                 holdingbranch: 'holding library'
             - "is the logged in user'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"
+        -
             - pref: OpacSuggestionManagedBy
               choices:
                   yes: Show
@@ -306,17 +339,26 @@ OPAC:
             - Display up to
             - pref: OpacMaxItemsToDisplay
               class: integer
-            - items on the biblio detail page (if the biblio has more items than this, a link is displayed instead that allows the user to choose to display all items).
+            - 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: NoLoginInstructions
+            - pref: OpacLoginInstructions
               type: textarea
+              syntax: text/html
               class: code
         -
             - "Replace the search box at the top of OPAC pages with the following HTML:"
             - pref: OpacCustomSearch
               type: textarea
+              syntax: text/html
               class: code
+        -
+            - "Display language selector on "
+            - pref: OpacLangSelectorMode
+              choices:
+                  both: "both top and footer"
+                  top: "top"
+                  footer: "only footer"
     Features:
         -
             - pref: opacuserlogin
@@ -339,6 +381,14 @@ OPAC:
                   no: "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 "
+            - 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
@@ -361,13 +411,15 @@ OPAC:
               choices:
                   yes: Allow
                   no: "Don't allow"
-            - patrons to browse subject authorities on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to create the browser list)
+            - 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 your system administrator to schedule it."
         -
             - pref: OpacCloud
               choices:
                   yes: Show
                   no: "Don't show"
-            - a subject cloud on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to build)
+            - 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 your system administrator to schedule it."
         -
             - pref: OpacAuthorities
               choices:
@@ -414,7 +466,7 @@ OPAC:
               choices:
                   yes: Show
                   no: Hide
-            - reviewer's photo beside comments in OPAC.
+            - reviewer's avatar beside comments in OPAC. The avatar will be searched on www.libravatar.org using the patron's e-mail address.
         -
             - pref: RequestOnOpac
               choices:
@@ -468,14 +520,20 @@ OPAC:
                   yes: Display
                   no: Don't display
             - the acquisition details on OPAC detail pages.
-    Policy:
         -
-            - pref: singleBranchMode
+            - pref: OpacNewsLibrarySelect
               default: 0
               choices:
-                  yes: "Don't allow"
-                  no: Allow
-            - patrons to select their branch on the OPAC or show branch names with callnumbers.
+                  yes: Display
+                  no: Don't display
+            - a branch selection list for news items in the OPAC.
+        -
+            - "Use the following as the OPAC ISBD template:"
+            - pref: OPACISBD
+              type: textarea
+              syntax: text/html
+              class: code
+    Policy:
         -
             - pref: SearchMyLibraryFirst
               choices:
@@ -529,10 +587,29 @@ OPAC:
                   yes: Allow
             - patrons to select library when making a purchase suggestion
         -
+            - "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
+            - "<br />Note: if none of the above options are selected, 'Title' field would be mandatory anyway, by default."
+        -
             - pref: OpacHiddenItems
               type: textarea
               class: code
-            - Allows to define custom rules for hiding specific items at opac. See docs/opac/OpacHiddenItems.txt for more informations
+            - 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>.
+        -
+            - pref: OpacHiddenItemsExceptions
+            - List of borrower categories, separated by |, that can see items otherwise hidden by <tt>OpacHiddenItems</tt>
         -
             - pref: OpacAllowPublicListCreation
               default: 1
@@ -553,9 +630,20 @@ OPAC:
                 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.
-
+        -
+            - Limit patrons to
+            - pref: MaxOpenSuggestions
+              class: integer
+            - "open suggestions. Leave empty for no limit. **Note: this setting does not affect anonymous suggestions"
     Privacy:
         -
+            - 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.
+        -
             - pref: AnonSuggestions
               choices:
                   yes: Allow
@@ -582,6 +670,13 @@ OPAC:
                   no: "Don't allow"
             - patrons to choose their own privacy settings for their reading history.  This requires opacreadinghistory and AnonymousPatron
         -
+            - 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".
+        -
             - Use borrowernumber
             - pref: AnonymousPatron
               class: integer
@@ -594,7 +689,22 @@ OPAC:
                   track: "Track"
                   no: "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')"
+        -
+            - "HTML content of your restricted page"
+            - 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:
         -
             - pref: OPACShelfBrowser
@@ -630,13 +740,15 @@ OPAC:
               choices:
                   yes: Allow
                   no: "Don't allow"
-            - "library patrons to register an account via the OPAC."
+            - "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."
         -
             - pref: PatronSelfRegistrationVerifyByEmail
               choices:
                   yes: Require
                   no: "Don't require"
-            - "that a self-registering patron verify his or herself via email."
+            - "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"
             - pref: PatronSelfRegistrationDefaultCategory
@@ -647,21 +759,46 @@ OPAC:
             - pref: PatronSelfRegistrationExpireTemporaryAccountsDelay
               class: integer
             - "days."
+            - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/cleanup_database.pl</code> cronjob. Ask your system administrator to schedule it."
         -
-            - "The following <a href='http://schema.koha-community.org/tables/borrowers.html' target='blank'>database columns</a> must be filled in on the patron entry screen:"
+            - "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 |)
         -
-            - "The following <a href='http://schema.koha-community.org/tables/borrowers.html' target='blank'>database columns</a> will not appear on the patron entry screen:"
+            - "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 |)
         -
+            - "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 |)
+        -
             - "Display the following additional instructions for patrons who self register via the OPAC ( HTML is allowed ):"
             - pref: PatronSelfRegistrationAdditionalInstructions
               type: textarea
+              syntax: text/html
               class: html
+        -
+            - pref: PatronSelfRegistrationEmailMustBeUnique
+              choices:
+                  yes: "Consider"
+                  no: "Do not 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: PatronSelfRegistrationLibraryList
+            - (separate branchcode with |).
+            - If empty, all libraries will be listed.
+        -
+            - pref: PatronSelfRegistrationPrefillForm
+              choices:
+                  yes: "Display and prefill"
+                  no: "Do not display and prefill"
+            - "password and login form after a patron has self registered."
+
     Advanced Search Options:
         -
             - Show search options
@@ -683,3 +820,33 @@ OPAC:
                 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
+              class: long
+        -
+            - "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