Koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref
Robin Sheat ecb1e046a6 Bug 12296: make search box customisable with OpacCustomSearch
This allows the search box to be replaced by some custom HTML, useful
when you're needing to integrate with some other search system, and
don't want to maintain a template change across upgrades.

Test plan:
* Install patch
* Look at the OPAC, see that nothing has changed.
* Change the OpacCustomSearch syspref to something like <h1>Zuul</h1>
* Look at the OPAC again, you can no longer search, there is only Zuul.

Signed-off-by: Owen Leonard <oleonard@myacpl.org>

Works as advertised. Seems like it would be really easy to screw up your
OPAC with this feature, but since we already offer other easy ways to
screw up your OPAC I guess this fits in.

New patch changes: removed the bootstrap code, changed the entry in
syspref.sql

Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de>
Works as described, passes QA script and tests.
The feature has some limitations, described on the bug.

Signed-off-by: Tomas Cohen Arazi <tomascohen@gmail.com>
2014-10-18 10:44:45 -03:00

667 lines
28 KiB
Text

OPAC:
Appearance:
-
- Use the
- pref: opacthemes
choices: opac-templates
- theme on the OPAC.
-
- "The OPAC is located at http://"
- 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.)
-
- Show
- pref: LibraryName
class: long
- as the name of the library on the OPAC.
-
- pref: OpacPublic
choices:
yes: Enable
no: Disable
- "Koha OPAC as public. Private OPAC requires authentification 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)"
-
- "Show star-ratings on"
- pref: OpacStarRatings
choices:
all: "results and details"
disable: "no"
details: "only details"
- "pages."
-
- pref: OpacMaintenance
choices:
yes: Show
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."
-
- By default, show bib records
- pref: BiblioDefaultView
choices:
normal: in simple form.
marc: in their MARC form.
isbd: as specified in the ISBD template.
-
- When patrons click on a link to another website from your OPAC (like Amazon or OCLC),
- pref: OPACURLOpenInNewWindow
choices:
yes: do
no: "don't"
- open the website in a new window.
-
- pref: hidelostitems
choices:
yes: "Don't show"
no: Show
- lost items on search and detail pages.
-
- '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'
-
- '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'
-
- 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.
-
- pref: COinSinOPACResults
choices:
yes: Include
no: "Don't include"
- "COinS / OpenURL / Z39.88 in OPAC search results. <br/>Warning: Enabling this feature will slow OPAC search response times."
-
- pref: OPACShowUnusedAuthorities
choices:
yes: Show
no: "Do not show"
- unused authorities in the OPAC authority browser.
-
- pref: OPACShowHoldQueueDetails
choices:
none: "Don't show any hold details"
priority: "Show priority level"
holds: "Show holds"
holds_priority: "Show holds and their priority level"
- to patrons in the OPAC.
-
- pref: OPACShowCheckoutName
default: 0
choices:
yes: Show
no: "Don't show"
- the name of the patron that has an item checked out on item detail pages on the OPAC.
-
- Display the
- pref: OpacLocationBranchToDisplay
choices:
home: "home library"
holding: "holding library"
both: "home and holding libraries"
- for items on the OPAC record details page.
-
- Display the shelving location under the
- pref: OpacLocationBranchToDisplayShelving
choices:
home: "home library"
holding: "holding library"
both: "home and holding libraries"
- for items on the OPAC record details page.
-
- pref: OpacKohaUrl
default: 0
choices:
yes: Show
no: "Don't show"
- "'Powered by Koha' text on OPAC footer."
-
- pref: OpacShowRecentComments
default: 0
choices:
yes: Show
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: 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
- pref: NotHighlightedWords
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
type: textarea
class: code
-
- Include the additional CSS stylesheet
- pref: opaccolorstylesheet
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.
-
- 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.
-
- "Include the following CSS on all pages in the OPAC:"
- pref: OPACUserCSS
type: textarea
class: code
-
- "Include the following CSS for the mobile view on all pages in the OPAC:"
- pref: OPACMobileUserCSS
type: textarea
class: code
-
- "Show the following HTML in its own column on the main page of the OPAC:"
- pref: OpacMainUserBlock
type: textarea
class: code
-
- "Show the following HTML in its own column on the main page of the OPAC (mobile version):"
- pref: OpacMainUserBlockMobile
type: textarea
class: code
-
- pref: OpacShowLibrariesPulldownMobile
choices:
yes: Show
no: "Don't show"
- the libraries pulldown on the mobile version of the OPAC.
-
- "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
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
class: code
-
- "Include the following HTML in the header of all pages in the OPAC:"
- pref: opacheader
type: textarea
class: code
-
- "Include the following HTML in the footer of all pages in the OPAC:"
- pref: opaccredits
type: textarea
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
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
class: code
-
- "Note to display on the patron summary page. This note only appears if the patron is logged in:"
- pref: OPACMySummaryNote
type: textarea
-
- "Include the following HTML under the facets in OPAC search results:"
- pref: OPACResultsSidebar
type: textarea
class: code
-
- pref: OpacAddMastheadLibraryPulldown
choices:
yes: Add
no: "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: textarea
class: code
-
- 'Display the URI in the 856u field as an image on: '
- pref: OPACDisplay856uAsImage
choices:
OFF: "Neither Details or Results pages"
Details: "Details page only"
Results: "Results page only"
Both: "Both Details and Results pages"
- 'Note: The corresponding OPACXSLT option must be turned on.'
-
- 'List export options that should be available from OPAC detail page separated by |:'
- pref: OpacExportOptions
class: multi
- '<br />Note: Available options are: BIBTEX (<code>bibtex</code>), Dublin Core (<code>dc</code>),'
- 'MARCXML (<code>marcxml</code>), MARC-8 encoded MARC (<code>marc8</code>), Unicode/UTF-8 encoded MARC (<code>utf8</code>),'
- 'Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9- fields and subfields (<code>marcstd</code>), MODS (<code>mods</code>), RIS (<code>ris</code>)'
-
- pref: OpacSeparateHoldings
choices:
yes: Separate
no: 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."
-
- pref: OpacSuggestionManagedBy
choices:
yes: Show
no: 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 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).
-
- "Show the following HTML on the OPAC login form when a patron is not logged in:"
- pref: NoLoginInstructions
type: textarea
class: code
-
- "Replace the search box at the top of OPAC pages with the following HTML:"
- pref: OpacCustomSearch
type: textarea
class: code
Features:
-
- pref: opacuserlogin
choices:
yes: Allow
no: "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"
- for items on the OPAC search results.
-
- pref: OpacPasswordChange
choices:
yes: Allow
no: "Don't allow"
- patrons to change their own password on the OPAC. Note that this must be off to use LDAP authentication.
-
- pref: OPACPatronDetails
choices:
yes: Allow
no: "Don't allow"
- patrons to notify the library of changes to their contact information from the OPAC.
-
- pref: OPACpatronimages
choices:
yes: Show
no: "Don't show"
- patron images on the patron information page in the OPAC.
-
- pref: OPACFinesTab
choices:
yes: Allow
no: "Don't allow"
- patrons to access the Fines tab on the My Account page on the OPAC.
-
- pref: OpacBrowser
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)
-
- pref: OpacCloud
choices:
yes: Show
no: "Don't show"
- a subject cloud on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to build)
-
- pref: OpacAuthorities
choices:
yes: Allow
no: "Don't allow"
- patrons to search your authority records.
-
- pref: opacbookbag
choices:
yes: Allow
no: "Don't allow"
- patrons to store items in a temporary "Cart" on the OPAC.
-
- pref: OpacTopissue
choices:
yes: Allow
no: "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"
- patrons to make purchase suggestions on the OPAC.
-
- pref: reviewson
choices:
yes: Allow
no: "Don't allow"
- patrons to make comments on items on the OPAC.
-
- Show
- pref: ShowReviewer
choices:
none: no name
full: full name
first: first name
surname: last name
firstandinitial: first name and last name initial
username: username
- of commenter with comments in OPAC.
-
- pref: ShowReviewerPhoto
choices:
yes: Show
no: Hide
- reviewer's photo beside comments in OPAC.
-
- pref: RequestOnOpac
choices:
yes: Allow
no: "Don't allow"
- patrons to place holds on items from the OPAC.
-
- Display
- pref: numSearchRSSResults
class: long
- search results in the RSS feed.
-
- pref: SocialNetworks
default: 0
choices:
yes: Enable
no: Disable
- social network links in opac detail pages
-
- pref: OpacBrowseResults
default: 1
choices:
yes: Enable
no: Disable
- browsing and paging search results from the OPAC detail page.
-
- pref: QuoteOfTheDay
default: 0
choices:
yes: Enable
no: Disable
- Quote of the Day display on OPAC home page
-
- pref: OPACPopupAuthorsSearch
default: 0
choices:
yes: Display
no: 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.
-
- pref: OPACAcquisitionDetails
default: 0
choices:
yes: Display
no: Don't display
- the acquisition details on OPAC detail pages.
Policy:
-
- pref: singleBranchMode
default: 0
choices:
yes: "Don't allow"
no: Allow
- patrons to select their branch on the OPAC or show branch names with callnumbers.
-
- pref: SearchMyLibraryFirst
choices:
yes: Limit
no: "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: OPACItemHolds
choices:
no: "Don't allow"
yes: Allow
force: Force
- patrons to place holds on specific items in the OPAC. If this is disabled, users can only put a hold on the next available item. If this is forced, users must put a hold on a specific item.
-
- pref: OpacRenewalAllowed
choices:
yes: Allow
no: "Don't allow"
- patrons to renew their own books on the OPAC.
-
- Use
- pref: OpacRenewalBranch
choices:
itemhomebranch: "the item's home library"
patronhomebranch: "the patron's home library"
checkoutbranch: "the library the item was checked out from"
null: "NULL"
opacrenew: "'OPACRenew'"
- as branchcode to store in the statistics table.
-
- Only allow patrons to renew their own books on the OPAC if they have less than
- pref: OPACFineNoRenewals
class: currency
- '[% local_currency %] in fines (leave blank to disable).'
-
- pref: OPACViewOthersSuggestions
choices:
yes: Show
no: "Don't show"
- purchase suggestions from other patrons on the OPAC.
-
- pref: AllowPurchaseSuggestionBranchChoice
default: 0
choices:
no: "Don't allow"
yes: Allow
- patrons to select library when making a purchase suggestion
-
- 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
-
- pref: OpacAllowPublicListCreation
default: 1
choices:
no: "Don't allow"
yes: 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.
-
- 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.
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"
-
- pref: opacreadinghistory
choices:
yes: Allow
no: "Don't allow"
- patrons to see what books they have checked out in the past.
-
- pref: EnableOpacSearchHistory
default: 0
choices:
yes: Keep
no: "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
-
- Use borrowernumber
- pref: AnonymousPatron
class: integer
- as the Anonymous Patron (for anonymous suggestions and reading history)
-
- pref: TrackClicks
default: 0
choices:
anonymous: "Track anonymously"
track: "Track"
no: "Don't track"
- links that patrons click on
Shelf Browser:
-
- pref: OPACShelfBrowser
choices:
yes: Show
no: "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"
- "the item location when finding items for the shelf browser."
-
- pref: ShelfBrowserUsesHomeBranch
default: 1
choices:
yes: Use
no: "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"
- "the item collection code when finding items for the shelf browser."
Self Registration:
-
- pref: PatronSelfRegistration
choices:
yes: Allow
no: "Don't allow"
- "library patrons to register an account via the OPAC."
-
- pref: PatronSelfRegistrationVerifyByEmail
choices:
yes: Require
no: "Don't require"
- "that a self-registering patron verify his or herself via email."
-
- "Use the patron category code"
- pref: PatronSelfRegistrationDefaultCategory
class: short
- "as the default patron category for patrons registered via the OPAC."
-
- "Delete patrons registered via the OPAC, but not yet verified after"
- pref: PatronSelfRegistrationExpireTemporaryAccountsDelay
class: integer
- "days."
-
- "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:"
- 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:"
- pref: PatronSelfRegistrationBorrowerUnwantedField
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
class: html