Bug 14394: fix documentation of OpacHiddenItems
[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             - Use the
10             - pref: OPACFallback
11               choices:
12                   bootstrap: bootstrap
13                   prog: prog
14             - theme as the fallback theme on the OPAC.
15         -
16             - "The OPAC is located at "
17             - pref: OPACBaseURL
18               class: url
19             - . 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.)
20         -
21             - Show
22             - pref: LibraryName
23               class: long
24             - as the name of the library on the OPAC.
25         -
26             - pref: OpacPublic
27               choices:
28                   yes: Enable
29                   no: Disable
30             - "Koha OPAC as public. Private OPAC requires authentification before accessing the OPAC."
31         -
32             - pref: HighlightOwnItemsOnOPAC
33               choices:
34                   yes: Emphasize
35                   no: "Don't emphasize"
36             - "results from the "
37             - pref: HighlightOwnItemsOnOPACWhich
38               choices:
39                   PatronBranch: "patron's home branch"
40                   OpacURLBranch: "OPAC's branch via the URL"
41             - " by moving the results to the front and increasing the size or highlighting the rows for those results. (Non-XSLT Only)"
42         -
43             - "Show star-ratings on"
44             - pref: OpacStarRatings
45               choices:
46                   all: "results and details"
47                   disable: "no"
48                   details: "only details"
49             - "pages."
50         -
51             - pref: OpacMaintenance
52               choices:
53                   yes: Show
54                   no: "Don't show"
55             - "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."
56         -
57             - By default, show bib records
58             - pref: BiblioDefaultView
59               choices:
60                   normal: in simple form.
61                   marc: in their MARC form.
62                   isbd: as specified in the ISBD template.
63         -
64             - When patrons click on a link to another website from your OPAC (like Amazon or OCLC),
65             - pref: OPACURLOpenInNewWindow
66               choices:
67                   yes: do
68                   no: "don't"
69             - open the website in a new window.
70         -
71             - pref: hidelostitems
72               choices:
73                   yes: "Don't show"
74                   no: Show
75             - lost items on search and detail pages.
76         -
77             - 'Display OPAC results using XSLT stylesheet at: '
78             - pref: OPACXSLTResultsDisplay
79               class: file
80             - '<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'
81         -
82             - 'Display OPAC details using XSLT stylesheet at: '
83             - pref: OPACXSLTDetailsDisplay
84               class: file
85             - '<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'
86         -
87             - pref: DisplayOPACiconsXSLT
88               choices:
89                   yes: Show
90                   no: "Don't show"
91             - the format, audience, and material type icons in XSLT MARC21 results and detail pages in the OPAC.
92         -
93             - pref: COinSinOPACResults
94               choices:
95                   yes: Include
96                   no: "Don't include"
97             - "COinS / OpenURL / Z39.88 in OPAC search results.  <br/>Warning: Enabling this feature will slow OPAC search response times."
98         -
99             - pref: OPACShowUnusedAuthorities
100               choices:
101                   yes: Show
102                   no: "Do not show"
103             - unused authorities in the OPAC authority browser.
104         -
105             - pref: OPACShowHoldQueueDetails
106               choices:
107                   none: "Don't show any hold details"
108                   priority: "Show priority level"
109                   holds: "Show holds"
110                   holds_priority: "Show holds and their priority level"
111             - to patrons in the OPAC.
112         -
113             - pref: OPACShowCheckoutName
114               default: 0
115               choices:
116                   yes: Show
117                   no: "Don't show"
118             - the name of the patron that has an item checked out on item detail pages on the OPAC.
119         -
120             - Display the
121             - pref: OpacLocationBranchToDisplay
122               choices:
123                   home: "home library"
124                   holding: "holding library"
125                   both: "home and holding libraries"
126             - for items on the OPAC record details page.
127         -
128             - Display the shelving location under the
129             - pref: OpacLocationBranchToDisplayShelving
130               choices:
131                   home: "home library"
132                   holding: "holding library"
133                   both: "home and holding libraries"
134             - for items on the OPAC record details page.
135         -
136             - pref: OpacKohaUrl
137               default: 0
138               choices:
139                   yes: Show
140                   no: "Don't show"
141             - "'Powered by Koha' text on OPAC footer."
142         -
143             - pref: OpacShowRecentComments
144               default: 0
145               choices:
146                   yes: Show
147                   no: "Don't show"
148             - a link to recent comments in the OPAC masthead.
149         -
150             - pref: OPACShowBarcode
151               default: 0
152               choices:
153                   yes: Show
154                   no: "Don't show"
155             - the item's barcode on the holdings tab.
156         -
157             - pref: GoogleIndicTransliteration
158               default: 0
159               choices:
160                   yes: Show
161                   no: "Don't show"
162             - GoogleIndicTransliteration on the OPAC.
163         -
164             - pref: OpacHighlightedWords
165               choices:
166                   yes: Highlight
167                   no: "Don't highlight"
168             - 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
169             - pref: NotHighlightedWords
170               class: multi
171             - (separate columns with |)
172         -
173             - pref: AuthorisedValueImages
174               choices:
175                   yes: Show
176                   no: "Don't show"
177             - 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.
178         -
179             - Use the image at
180             - pref: OpacFavicon
181               class: url
182             - for the OPAC's favicon. (This should be a complete URL, starting with <code>http://</code>.)
183         -
184             - "Include the following JavaScript on all pages in the OPAC:"
185             - pref: OPACUserJS
186               type: textarea
187               class: code
188         -
189             - Include the additional CSS stylesheet
190             - pref: OpacAdditionalStylesheet
191               class: file
192             - 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.
193         -
194             - Use the CSS stylesheet
195             - pref: opaclayoutstylesheet
196               class: file
197             - 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.
198         -
199             - "Include the following CSS on all pages in the OPAC:"
200             - pref: OPACUserCSS
201               type: textarea
202               class: code
203         -
204             - "Show the following HTML in its own column on the main page of the OPAC:"
205             - pref: OpacMainUserBlock
206               type: textarea
207               class: code
208         -
209             - "Show the following HTML on the left hand column of the main page and patron account on the OPAC (generally navigation links):"
210             - pref: OpacNav
211               type: textarea
212               class: code
213         -
214             - "Show the following HTML in the right hand column of the main page under the main login form:"
215             - pref: OpacNavRight
216               type: textarea
217               class: code
218         -
219             - "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:"
220             - pref: OpacNavBottom
221               type: textarea
222               class: code
223         -
224             - "Include the following HTML in the header of all pages in the OPAC:"
225             - pref: opacheader
226               type: textarea
227               class: code
228         -
229             - "Include the following HTML in the footer of all pages in the OPAC:"
230             - pref: opaccredits
231               type: textarea
232               class: code
233         -
234             - 'Include a "More Searches" box on the detail pages of items on the OPAC, with the following HTML (leave blank to disable):'
235             - '<br />Note: The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN}, {ISSN} and {AUTHOR} will be replaced with information from the displayed record.'
236             - pref: OPACSearchForTitleIn
237               type: textarea
238               class: code
239         -
240             - '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):'
241             - '<br />Note: The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR} will be replaced with information from the displayed record.'
242             - pref: OPACMySummaryHTML
243               type: textarea
244               class: code
245         -
246             - "Note to display on the patron summary page. This note only appears if the patron is logged in:"
247             - pref: OPACMySummaryNote
248               type: textarea
249         -
250             - "Include the following HTML under the facets in OPAC search results:"
251             - pref: OPACResultsSidebar
252               type: textarea
253               class: code
254         -
255             - pref: OpacAddMastheadLibraryPulldown
256               choices: 
257                   yes: Add
258                   no: "Don't add"
259             - a library select pulldown menu on the OPAC masthead.
260         -
261             - 'Display this HTML when no results are found for a search in the OPAC:'
262             - '<br />Note: You can insert placeholders {QUERY_KW} that will be replaced with the keywords of the query.'
263             - pref: OPACNoResultsFound
264               type: textarea
265               class: code
266         -
267             - 'Display the URI in the 856u field as an image on: '
268             - pref: OPACDisplay856uAsImage
269               choices:
270                   OFF: "Neither detail or result pages"
271                   Details: "Detail page only"
272                   Results: "Result page only"
273                   Both: "Both detail and result pages"
274             - '. Note: The corresponding OPACXSLT option must be turned on.'
275         -
276             - 'Select export options that should be available from OPAC detail page:'
277             - pref: OpacExportOptions
278               multiple:
279                 bibtex: BibTeX
280                 dc: Dublin Core
281                 marcxml: MARCXML
282                 marc8: MARC-8 encoded MARC
283                 utf8: Unicode/UTF-8 encoded MARC
284                 marcstd: Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9- fields and subfields
285                 mods: MODS
286                 ris: RIS
287                 isbd: ISBD
288         -
289             - pref: OpacSeparateHoldings
290               choices:
291                   yes: Separate
292                   no: Don't separate
293             - "items display into two tabs, where the first tab contains items whose"
294             - pref: OpacSeparateHoldingsBranch
295               choices:
296                 homebranch: 'home library'
297                 holdingbranch: 'holding library'
298             - "is the logged in user's library. The second tab will contain all other items."
299         -
300             - pref: OpacSuggestionManagedBy
301               choices:
302                   yes: Show
303                   no: Don't show
304             - "the name of the staff member who managed a suggestion in OPAC."
305         -
306             - Display up to
307             - pref: OpacMaxItemsToDisplay
308               class: integer
309             - 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).
310         -
311             - "Show the following HTML on the OPAC login form when a patron is not logged in:"
312             - pref: NoLoginInstructions
313               type: textarea
314               class: code
315         -
316             - "Replace the search box at the top of OPAC pages with the following HTML:"
317             - pref: OpacCustomSearch
318               type: textarea
319               class: code
320     Features:
321         -
322             - pref: opacuserlogin
323               choices:
324                   yes: Allow
325                   no: "Don't allow"
326             - patrons to log in to their accounts on the OPAC.
327         -
328             - Show
329             - pref: OpacItemLocation
330               choices:
331                   location: location
332                   ccode: "collection code"
333                   callnum: "call number only"
334             - for items on the OPAC search results.
335         -
336             - pref: OpacPasswordChange
337               choices:
338                   yes: Allow
339                   no: "Don't allow"
340             - patrons to change their own password on the OPAC. Note that this must be off to use LDAP authentication.
341         -
342             - pref: OPACPatronDetails
343               choices:
344                   yes: Allow
345                   no: "Don't allow"
346             - patrons to notify the library of changes to their contact information from the OPAC.
347         -
348             - pref: OPACpatronimages
349               choices:
350                   yes: Show
351                   no: "Don't show"
352             - patron images on the patron information page in the OPAC.
353         -
354             - pref: OPACFinesTab
355               choices:
356                   yes: Allow
357                   no: "Don't allow"
358             - patrons to access the Fines tab on the My Account page on the OPAC.
359         -
360             - pref: OpacBrowser
361               choices:
362                   yes: Allow
363                   no: "Don't allow"
364             - patrons to browse subject authorities on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to create the browser list)
365         -
366             - pref: OpacCloud
367               choices:
368                   yes: Show
369                   no: "Don't show"
370             - a subject cloud on OPAC (run misc/cronjobs/build_browser_and_cloud.pl to build)
371         -
372             - pref: OpacAuthorities
373               choices:
374                   yes: Allow
375                   no: "Don't allow"
376             - patrons to search your authority records.
377         -
378             - pref: opacbookbag
379               choices:
380                   yes: Allow
381                   no: "Don't allow"
382             - patrons to store items in a temporary "Cart" on the OPAC.
383         -
384             - pref: OpacTopissue
385               choices:
386                   yes: Allow
387                   no: "Don't allow"
388             - 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.
389         -
390             - pref: suggestion
391               choices:
392                   yes: Allow
393                   no: "Don't allow"
394             - patrons to make purchase suggestions on the OPAC.
395         -
396             - pref: reviewson
397               choices:
398                   yes: Allow
399                   no: "Don't allow"
400             - patrons to make comments on items on the OPAC.
401         -
402             - Show
403             - pref: ShowReviewer
404               choices:
405                   none: no name
406                   full: full name
407                   first: first name
408                   surname: last name
409                   firstandinitial: first name and last name initial
410                   username: username
411             - of commenter with comments in OPAC.
412         -
413             - pref: ShowReviewerPhoto
414               choices:
415                   yes: Show
416                   no: Hide
417             - reviewer's avatar beside comments in OPAC. The avatar will be searched on www.libravatar.org using the patron's e-mail address.
418         -
419             - pref: RequestOnOpac
420               choices:
421                   yes: Allow
422                   no: "Don't allow"
423             - patrons to place holds on items from the OPAC.
424         -
425             - Display
426             - pref: numSearchRSSResults
427               class: long
428             -  search results in the RSS feed.
429         -
430             - pref: SocialNetworks
431               default: 0
432               choices:
433                   yes: Enable
434                   no: Disable
435             - social network links in opac detail pages
436         -
437             - pref: OpacBrowseResults
438               default: 1
439               choices:
440                   yes: Enable
441                   no: Disable
442             - browsing and paging search results from the OPAC detail page.
443         -
444             - pref: QuoteOfTheDay
445               default: 0
446               choices:
447                   yes: Enable
448                   no: Disable
449             - Quote of the Day display on OPAC home page
450         -
451             - pref: OPACPopupAuthorsSearch
452               default: 0
453               choices:
454                 yes: Display
455                 no: Don't display
456             - the list of authors/subjects in a popup for a combined search on OPAC detail pages.
457         -
458             - pref: OpacHoldNotes
459               default: 0
460               choices:
461                   yes: Allow
462                   no: Do not allow
463             - users to add a note when placing a hold.
464         -
465             - pref: OPACAcquisitionDetails
466               default: 0
467               choices:
468                   yes: Display
469                   no: Don't display
470             - the acquisition details on OPAC detail pages.
471     Policy:
472         -
473             - pref: singleBranchMode
474               default: 0
475               choices:
476                   yes: "Don't allow"
477                   no: Allow
478             - patrons to select their branch on the OPAC or show branch names with callnumbers.
479         -
480             - pref: SearchMyLibraryFirst
481               choices:
482                   yes: Limit
483                   no: "Don't limit"
484             - "patrons' searches to the library they are registered at."
485 #        -
486 #            This system preference does not actually affect anything
487 #            - pref: OpacBrowser
488 #              choices:
489 #                  yes: Show
490 #                  no: "Don't show"
491 #            - a subject browser on the OPAC (generated using <code>misc/cronjobs/build_browser_and_cloud.pl</code>).
492 #        -
493 #            opac-tags_subject.pl is the only script affected by this, and it is not linked to by any other page
494 #            - pref: OpacCloud
495 #              choices:
496 #            - If ON, enables subject cloud on OPAC
497         -
498             - pref: OpacRenewalAllowed
499               choices:
500                   yes: Allow
501                   no: "Don't allow"
502             - patrons to renew their own books on the OPAC.
503         -
504             - Use 
505             - pref: OpacRenewalBranch
506               choices:
507                   itemhomebranch: "the item's home library"
508                   patronhomebranch: "the patron's home library"
509                   checkoutbranch: "the library the item was checked out from"
510                   null: "NULL"
511                   opacrenew: "'OPACRenew'"
512             - as branchcode to store in the statistics table.
513         -
514             - Only allow patrons to renew their own books on the OPAC if they have less than
515             - pref: OPACFineNoRenewals
516               class: currency
517             - '[% local_currency %] in fines (leave blank to disable).'
518         -
519             - pref: OPACViewOthersSuggestions
520               choices:
521                   yes: Show
522                   no: "Don't show"
523             - purchase suggestions from other patrons on the OPAC.
524         -
525             - pref: AllowPurchaseSuggestionBranchChoice
526               default: 0
527               choices:
528                   no: "Don't allow"
529                   yes: Allow
530             - patrons to select library when making a purchase suggestion
531         -
532             - pref: OpacHiddenItems
533               type: textarea
534               class: code
535             - 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>.
536         -
537             - pref: OpacAllowPublicListCreation
538               default: 1
539               choices:
540                   no: "Don't allow"
541                   yes: Allow
542             - opac users to create public lists
543         -
544             - pref: OpacAllowSharingPrivateLists
545               default: 0
546               choices:
547                   no: "Don't allow"
548                   yes: Allow
549             - opac users to share private lists with other patrons.
550         -
551             - pref: BlockExpiredPatronOpacActions
552               choices:
553                 yes: "Block"
554                 no: "Don't block"
555             - 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.
556
557     Privacy:
558         -
559             - pref: AnonSuggestions
560               choices:
561                   yes: Allow
562                   no: "Don't allow"
563             - "patrons that aren't logged in to make purchase suggestions. Suggestions are connected to the AnonymousPatron syspref"
564         -
565             - pref: opacreadinghistory
566               choices:
567                   yes: Allow
568                   no: "Don't allow"
569             - patrons to see what books they have checked out in the past.
570         -
571             - pref: EnableOpacSearchHistory
572               default: 0
573               choices:
574                   yes: Keep
575                   no: "Don't keep"
576             - patron search history in the OPAC.
577         -
578             - pref: OPACPrivacy
579               default: 0
580               choices:
581                   yes: Allow
582                   no: "Don't allow"
583             - patrons to choose their own privacy settings for their reading history.  This requires opacreadinghistory and AnonymousPatron
584         -
585             - Use borrowernumber
586             - pref: AnonymousPatron
587               class: integer
588             - as the Anonymous Patron (for anonymous suggestions and reading history)
589         -
590             - pref: TrackClicks
591               default: 0
592               choices:
593                   anonymous: "Track anonymously"
594                   track: "Track"
595                   no: "Don't track"
596             - links that patrons click on
597
598     Shelf Browser:
599         -
600             - pref: OPACShelfBrowser
601               choices:
602                   yes: Show
603                   no: "Don't show"
604             - "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."
605         -
606             - pref: ShelfBrowserUsesLocation
607               default: 1
608               choices:
609                   yes: Use
610                   no: "Don't use"
611             - "the item location when finding items for the shelf browser."
612         -
613             - pref: ShelfBrowserUsesHomeBranch
614               default: 1
615               choices:
616                   yes: Use
617                   no: "Don't use"
618             - "the item home library when finding items for the shelf browser."
619         -
620             - pref: ShelfBrowserUsesCcode
621               default: 0
622               choices:
623                   yes: Use
624                   no: "Don't use"
625             - "the item collection code when finding items for the shelf browser."      
626
627     Self Registration:
628         -
629             - pref: PatronSelfRegistration
630               choices:
631                   yes: Allow
632                   no: "Don't allow"
633             - "library patrons to register an account via the OPAC."
634         -
635             - pref: PatronSelfRegistrationVerifyByEmail
636               choices:
637                   yes: Require
638                   no: "Don't require"
639             - "that a self-registering patron verify his or herself via email."
640         -
641             - "Use the patron category code"
642             - pref: PatronSelfRegistrationDefaultCategory
643               class: short
644             - "as the default patron category for patrons registered via the OPAC."
645         -
646             - "Delete patrons registered via the OPAC, but not yet verified after"
647             - pref: PatronSelfRegistrationExpireTemporaryAccountsDelay
648               class: integer
649             - "days."
650         -
651             - "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:"
652             - pref: PatronSelfRegistrationBorrowerMandatoryField
653               class: multi
654             - (separate columns with |)
655         -
656             - "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:"
657             - pref: PatronSelfRegistrationBorrowerUnwantedField
658               class: multi
659             - (separate columns with |)
660         -
661             - "Display the following additional instructions for patrons who self register via the OPAC ( HTML is allowed ):"
662             - pref: PatronSelfRegistrationAdditionalInstructions
663               type: textarea
664               class: html
665     Advanced Search Options:
666         -
667             - Show search options
668             - pref: OpacAdvSearchOptions
669               multiple:
670                 pubdate: Publication date
671                 itemtype: Item types
672                 language: Language
673                 subtype: Subtypes
674                 sorting: Sorting
675                 location: Location and availability
676         -
677             - Show search options for the expanded view
678             - pref: OpacAdvSearchMoreOptions
679               multiple:
680                 pubdate: Publication date
681                 itemtype: Item types
682                 language: Language
683                 subtype: Subtypes
684                 sorting: Sorting
685                 location: Location and availability