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