Bug 5668 - Star ratings in the opac
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / opac.pref
1 OPAC:
2     Appearance:
3         -
4             - Use the
5             - pref: opacthemes
6               choices: opac-templates
7             - theme on the OPAC.
8         -
9
10
11
12
13             - "The OPAC is located at http://"
14             - pref: OPACBaseURL
15               class: url
16             - . (This must be filled in correctly for RSS, unAPI, and search plugins to work.)
17         -
18             - Show
19             - pref: LibraryName
20               class: long
21             - as the name of the library on the OPAC.
22         -
23             - pref: OpacPublic
24               choices:
25                   yes: Enable
26                   no: Disable
27             - "Koha OPAC as public. Private OPAC requires authentification before accessing the OPAC."
28         -
29             - "Show star-ratings on"
30             - pref: OpacStarRatings
31               choices:
32                   all: "results and details"
33                   disable: "no"
34                   details: "only details"
35             - "pages."
36         -
37             - pref: OpacMaintenance
38               choices:
39                   yes: Show
40                   no: "Don't show"
41             - "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."
42         -
43             - By default, show bib records
44             - pref: BiblioDefaultView
45               choices:
46                   normal: in simple form.
47                   marc: in their MARC form.
48                   isbd: as specified in the ISBD template.
49         -
50             - When patrons click on a link to another website from your OPAC (like Amazon or OCLC),
51             - pref: OPACURLOpenInNewWindow
52               choices:
53                   yes: do
54                   no: "don't"
55             - open the website in a new window.
56         -
57             - pref: hidelostitems
58               choices:
59                   yes: "Don't show"
60                   no: Show
61             - lost items on search and detail pages.
62         -
63             - 'Display OPAC results using XSLT stylesheet at: '
64             - pref: OPACXSLTResultsDisplay
65               class: file
66             - '<br />Options:<br />- leave empty for "no xslt"<br />- enter "default" for the default one<br />- put a path to define a xslt file<br />- put an URL for an external specific stylesheet.<br />{langcode} will be replaced with current interface language'
67         -
68             - 'Display OPAC details using XSLT stylesheet at: '
69             - pref: OPACXSLTDetailsDisplay
70               class: file
71             - '<br />Options:<br />- leave empty for "no xslt"<br />- enter "default" for the default one<br />- put a path to define a xslt file<br />- put an URL for an external specific stylesheet.<br />{langcode} will be replaced with current interface language'
72         -
73             - On pages displayed with XSLT stylesheets on the OPAC,
74             - pref: DisplayOPACiconsXSLT
75               choices:
76                   yes: show
77                   no: "don't show"
78             - icons for itemtype and authorized values.
79         -
80             - pref: COinSinOPACResults
81               choices:
82                   yes: Include
83                   no: "Don't include"
84             - "COinS / OpenURL / Z39.88 in OPAC search results.  <br/>Warning: Enabling this feature will slow OPAC search response times."
85         -
86             - pref: OPACDisplayRequestPriority
87               choices:
88                   yes: Show
89                   no: "Don't show"
90             - patrons the priority level of their holds in the OPAC.
91         -
92             - pref: OPACShowCheckoutName
93               default: 0
94               choices:
95                   yes: Show
96                   no: "Don't show"
97             - the name of the patron that has an item checked out on item detail pages on the OPAC.
98         -
99             - pref: OpacKohaUrl
100               default: 0
101               choices:
102                   yes: Show
103                   no: "Don't show"
104             - "'Powered by Koha' text on OPAC footer."
105         -
106             - pref: OpacShowRecentComments
107               default: 0
108               choices:
109                   yes: Show
110                   no: "Don't show"
111             - a link to recent comments in the OPAC masthead.
112         -
113             - pref: OpacHighlightedWords
114               choices:
115                   yes: Highlight
116                   no: "Don't highlight"
117             - words the patron searched for in their search results.
118         -
119             - pref: AuthorisedValueImages
120               choices:
121                   yes: Show
122                   no: "Don't show"
123             - 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.
124         -
125             - Use the image at
126             - pref: opacsmallimage
127               class: url
128             - in the OPAC header, instead of the Koha logo. If this image is a different size than the Koha logo, you will need to customize the CSS. (This should be a complete URL, starting with <code>http://</code>.)
129         -
130             - Use the image at
131             - pref: OpacFavicon
132               class: url
133             - for the OPAC's favicon. (This should be a complete URL, starting with <code>http://</code>.)
134         -
135             - "Include the following JavaScript on all pages in the OPAC:"
136             - pref: opacuserjs
137               type: textarea
138               class: code
139         -
140             - Include the additional CSS stylesheet
141             - pref: opaccolorstylesheet
142               class: file
143             - to override specified settings from the default stylesheet (leave blank to disable). Enter a filename or a complete URL beginning with <code>http://</code> (if the file lives on a remote server). Please note that if you enter a filename, the file should be in the css subdirectory for each active theme and language within the Koha templates directory.
144         -
145             - Use the CSS stylesheet
146             - pref: opaclayoutstylesheet
147               class: file
148             - on all pages in the OPAC, instead of the default (leave blank to disable). Please enter filename only. The file should be in the css subdirectory for each active theme and language within the Koha templates directory.
149         -
150             - Use the remote CSS stylesheet
151             - pref: opacstylesheet
152               class: file
153             - on all pages in the OPAC, instead of the default. (This should be a complete URL, starting with <code>http://</code>.)
154         -
155             - "Include the following CSS on all pages in the OPAC:"
156             - pref: OPACUserCSS
157               type: textarea
158               class: code
159         -
160             - "Show the following HTML in its own column on the main page of the OPAC:"
161             - pref: OpacMainUserBlock
162               type: textarea
163               class: code
164         -
165             - "Show the following HTML on the left hand column of the main page and patron account on the OPAC (generally navigation links):"
166             - pref: OpacNav
167               type: textarea
168               class: code
169         -
170             - "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:"
171             - pref: OpacNavBottom
172               type: textarea
173               class: code
174         -
175             - "Include the following HTML in the header of all pages in the OPAC:"
176             - pref: opacheader
177               type: textarea
178               class: code
179         -
180             - "Include the following HTML in the footer of all pages in the OPAC:"
181             - pref: opaccredits
182               type: textarea
183               class: code
184         -
185             - 'Include a "More Searches" box on the detail pages of items on the OPAC, with the following HTML (leave blank to disable):'
186             - '<br />Note: The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN}, {ISSN} and {AUTHOR} will be replaced with information from the displayed record.'
187             - pref: OPACSearchForTitleIn
188               type: textarea
189               class: code
190         -
191             - 'Include a "Links" column on the "my summary" tab when a user is logged in to the OPAC, with the following HTML (leave blank to disable):'
192             - '<br />Note: The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR} will be replaced with information from the displayed record.'
193             - pref: OPACMySummaryHTML
194               type: textarea
195               class: code
196         -
197             - "Include the following HTML under the facets in OPAC search results:"
198             - pref: OPACResultsSidebar
199               type: textarea
200               class: code
201         -
202             - pref: OpacAddMastheadLibraryPulldown
203               choices: 
204                   yes: Add
205                   no: "Don't add"
206             - a library select pulldown menu on the OPAC masthead.
207         -
208             - 'Display this HTML when no results are found for a search in the OPAC:'
209             - pref: OPACNoResultsFound
210               type: textarea
211               class: code
212         -
213             - 'Display the URI in the 856u field as an image on: '
214             - pref: OPACDisplay856uAsImage
215               choices:
216                   OFF: "Neither Details or Results pages"
217                   Details: "Details page only"
218                   Results: "Results page only"
219                   Both: "Both Details and Results pages"
220             - 'Note: The corresponding OPACXSLT option must be turned on.'
221         -
222             - 'List export options that should be available from OPAC detail page separated by |:'
223             - pref: OpacExportOptions
224               class: multi
225             - '<br />Note: Available options are: BIBTEX (<code>bibtex</code>), Dublin Core (<code>dc</code>),'
226             - 'MARCXML (<code>marcxml</code>), MARC-8 encoded MARC (<code>marc8</code>), Unicode/UTF-8 encoded MARC (<code>utf8</code>),'
227             - '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>)'
228     Features:
229         -
230             - pref: opacuserlogin
231               choices:
232                   yes: Allow
233                   no: "Don't allow"
234             - patrons to log in to their accounts on the OPAC.
235         -
236             - pref: OpacPasswordChange
237               choices:
238                   yes: Allow
239                   no: "Don't allow"
240             - patrons to change their own password on the OPAC. Note that this must be off to use LDAP authentication.
241         -
242             - pref: OPACPatronDetails
243               choices:
244                   yes: Allow
245                   no: "Don't allow"
246             - patrons to notify the library of changes to their contact information from the OPAC.
247         -
248             - pref: OPACpatronimages
249               choices:
250                   yes: Show
251                   no: "Don't show"
252             - patron images on the patron information page in the OPAC.
253         -
254             - pref: OPACFinesTab
255               choices:
256                   yes: Allow
257                   no: "Don't allow"
258             - patrons to access the Fines tab on the My Account page on the OPAC.
259         -
260             - pref: OpacBrowser
261               choices:
262                   yes: Allow
263                   no: "Don't allow"
264             - patrons to browse subject authorities on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to create the browser list)
265         -
266             - pref: OpacAuthorities
267               choices:
268                   yes: Allow
269                   no: "Don't allow"
270             - patrons to search your authority records.
271         -
272             - pref: opacbookbag
273               choices:
274                   yes: Allow
275                   no: "Don't allow"
276             - patrons to store items in a temporary "Cart" on the OPAC.
277         -
278             - pref: OpacTopissue
279               choices:
280                   yes: Allow
281                   no: "Don't allow"
282             - 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.
283         -
284             - pref: suggestion
285               choices:
286                   yes: Allow
287                   no: "Don't allow"
288             - patrons to make purchase suggestions on the OPAC.
289         -
290             - pref: reviewson
291               choices:
292                   yes: Allow
293                   no: "Don't allow"
294             - patrons to make comments on items on the OPAC.
295         -
296             - Show
297             - pref: ShowReviewer
298               choices:
299                   none: no name
300                   full: full name
301                   first: first name
302                   surname: last name
303                   firstandinitial: first name and last name initial
304                   username: username
305             - of commenter with comments in OPAC.
306         -
307             - pref: ShowReviewerPhoto
308               choices:
309                   yes: Show
310                   no: Hide
311             - reviewer's photo beside comments in OPAC.
312         -
313             - pref: RequestOnOpac
314               choices:
315                   yes: Allow
316                   no: "Don't allow"
317             - patrons to place holds on items from the OPAC.
318         -
319             - Display
320             - pref: numSearchRSSResults
321               class: long
322             -  search results in the RSS feed.
323         -
324             - pref: SocialNetworks
325               default: 0
326               choices:
327                   yes: Enable
328                   no: Disable
329             - social network links in opac detail pages
330     Policy:
331         -
332             - pref: singleBranchMode
333               default: 0
334               choices:
335                   yes: "Don't allow"
336                   no: Allow
337             - patrons to select their library on the OPAC.
338         -
339             - pref: SearchMyLibraryFirst
340               choices:
341                   yes: Limit
342                   no: "Don't limit"
343             - "patrons' searches to the library they are registered at."
344 #        -
345 #            This system preference does not actually affect anything
346 #            - pref: OpacBrowser
347 #              choices:
348 #                  yes: Show
349 #                  no: "Don't show"
350 #            - a subject browser on the OPAC (generated using <code>misc/cronjobs/build_browser_and_cloud.pl</code>).
351 #        -
352 #            opac-tags_subject.pl is the only script affected by this, and it is not linked to by any other page
353 #            - pref: OpacCloud
354 #              choices:
355 #            - If ON, enables subject cloud on OPAC
356         -
357             - pref: OPACItemHolds
358               choices:
359                   yes: Allow
360                   no: "Don't allow"
361             - 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.
362         -
363             - pref: OpacRenewalAllowed
364               choices:
365                   yes: Allow
366                   no: "Don't allow"
367             - patrons to renew their own books on the OPAC.
368         -
369             - Use 
370             - pref: OpacRenewalBranch
371               choices:
372                   itemhomebranch: "the item's home library"
373                   patronhomebranch: "the patron's home library"
374                   checkoutbranch: "the library the item was checked out from"
375                   null: "NULL"
376                   opacrenew: "'OPACRenew'"
377             - as branchcode to store in the statistics table.
378         -
379             - Only allow patrons to renew their own books on the OPAC if they have less than
380             - pref: OPACFineNoRenewals
381               class: currency
382             - '[% local_currency %] in fines (leave blank to disable).'
383         -
384             - pref: OPACViewOthersSuggestions
385               choices:
386                   yes: Show
387                   no: "Don't show"
388             - purchase suggestions from other patrons on the OPAC.
389         -
390             - pref: AllowPurchaseSuggestionBranchChoice
391               default: 0
392               choices:
393                   no: "Don't allow"
394                   yes: Allow
395             - patrons to select library when making a purchase suggestion
396         -
397             - pref: OpacHiddenItems
398               type: textarea
399               class: code
400             - Allows to define custom rules for hiding specific items at opac. See docs/opac/OpacHiddenItems.txt for more informations
401         -
402             - pref: OpacAllowPublicListCreation
403               default: 1
404               choices:
405                   no: "Don't allow"
406                   yes: Allow
407             - opac users to create public lists
408         -
409             - pref: OpacAllowSharingPrivateLists
410               default: 0
411               choices:
412                   no: "Don't allow"
413                   yes: Allow
414             - opac users to share private lists with other patrons. This feature is not active yet but will be released soon
415
416     Privacy:
417         -
418             - pref: AnonSuggestions
419               choices:
420                   yes: Allow
421                   no: "Don't allow"
422             - "patrons that aren't logged in to make purchase suggestions. Suggestions are connected to the AnonymousPatron syspref"
423         -
424             - pref: opacreadinghistory
425               choices:
426                   yes: Allow
427                   no: "Don't allow"
428             - patrons to see what books they have checked out in the past.
429         -
430             - pref: EnableOpacSearchHistory
431               default: 0
432               choices:
433                   yes: Keep
434                   no: "Don't keep"
435             - patron search history in the OPAC.
436         -
437             - pref: OPACPrivacy
438               default: 0
439               choices:
440                   yes: Allow
441                   no: "Don't allow"
442             - patrons to choose their own privacy settings for their reading history.  This requires opacreadinghistory and AnonymousPatron
443         -
444             - Use borrowernumber
445             - pref: AnonymousPatron
446               class: integer
447             - as the Anonymous Patron (for anonymous suggestions and reading history)
448
449     Shelf Browser:
450         -
451             - pref: OPACShelfBrowser
452               choices:
453                   yes: Show
454                   no: "Don't show"
455             - "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."
456         -
457             - pref: ShelfBrowserUsesLocation
458               default: 1
459               choices:
460                   yes: Use
461                   no: "Don't use"
462             - "the item location when finding items for the shelf browser."
463         -
464             - pref: ShelfBrowserUsesHomeBranch
465               default: 1
466               choices:
467                   yes: Use
468                   no: "Don't use"
469             - "the item home library when finding items for the shelf browser."
470         -
471             - pref: ShelfBrowserUsesCcode
472               default: 0
473               choices:
474                   yes: Use
475                   no: "Don't use"
476             - "the item collection code when finding items for the shelf browser."