View | Details | Raw Unified | Return to bug 2326
Collapse All | Expand All

(-)a/help.pl (+4 lines)
Lines 30-35 sub _help_template_file_of_url { Link Here
30
    my $file;
30
    my $file;
31
    if ($url =~ /koha\/(.*)\.pl/) {
31
    if ($url =~ /koha\/(.*)\.pl/) {
32
        $file = $1;
32
        $file = $1;
33
        if (index($url, "tab") >= 0 && index($url, "preferences") >= 0) {
34
            $url=~s/.*=//;
35
            return "help/$file\_$url.tt";
36
        }
33
    } else {
37
    } else {
34
        $file = 'mainpage';
38
        $file = 'mainpage';
35
    }
39
    }
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_acquisitions.tt (+103 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Acquisitions System Preferences</h1>
4
5
<h3>Policy</h3>
6
7
<p><strong>AcqCreateItem</strong>
8
<ul>
9
    <li>Default: placing an order</li>
10
    <li>Asks: Create an item when ___.</li>
11
    <li>Description: This preference lets you decide when you'd like to create an item record in Koha. If you choose to add an item record when 'placing an order' then you will enter item information in as you place records in your basket. If you choose to add the item when 'receiving an order' you will be asked for item record information when you're receiving orders in acquisitions. If you choose to add the item when 'cataloging a record' then item records will not be created in acquisitions at all, you will need to go to the cataloging module to add the items.</li>
12
</ul></p>
13
14
<p><strong>AcqEnableFiles</strong>
15
<ul>
16
    <li>Default: Don't</li>
17
    <li>Asks: ___ enable the ability to upload and attach arbitrary files to invoices.</li>
18
    <li>Description: This preference controls whether or not you allow the uploading of invoice files via the acquisitions module.</li>
19
</ul></p>
20
21
<p><strong>AcqItemSetSubfieldsWhenReceiptIsCancelled</strong>
22
<ul>
23
    <li>Asks: Upon cancelling a receipt, update the item's subfields if they were created when placing an order (e.g. o=5|a="bar foo""). ___</li>
24
    <li>Description: This preference is used in conjunction with the AcqItemSetSubfieldsWhenReceived preference. If you have the system set to enter default values when you receive you will want to have those values revert back if reeipt is cancelled. This preference allows you to do that.</li>
25
</ul></p>
26
27
<p><strong>AcqItemSetSubfieldsWhenReceived</strong>
28
<ul>
29
    <li>Asks: Upon receiving items, update their subfields if they were created when placing an order (e.g. o=5|a="foo bar"). ___</li>
30
    <li>Description: This preference allows you to set default values for items that you receive via acquisitions. Enter the data as subfield=value and split your values with a bar ( | ). For example you can remove the Ordered status on the item automatically when you receive it just by entering 7=0 in this preference. That will set the Not for Loan status (subfield 7) to 0 which is available.</li>
31
</ul></p>
32
33
<p><strong>AcqViewBaskets</strong>
34
<ul>
35
    <li>Default: created by staff member</li>
36
    <li>Asks: Show baskets ___</li>
37
    <li>Description: When in acquisitions this preference allows you to control whose baskets you can see when looking at a vendor. The default value of 'created by staff member' makes it so that you only see the baskets you created. Choosing to see baskets 'from staff member's branch' will show you the baskets created by anyone at the branch you're logged in at. Finally, you can choose to set this preference to show you all baskets regardless of who created it ('in system, regardless of owner). Regardless of which value you choose for this preference, superlibrarians can see all baskets created in the system.</li>
38
</ul></p>
39
40
<p><strong>AcqWarnOnDuplicateInvoice</strong>
41
<ul>
42
    <li>Default: Do not warn</li>
43
    <li>Asks: ___ when the librarian tries to create an invoice with a duplicate number.</li>
44
</ul></p>
45
46
<p><strong>BasketConfirmations</strong>
47
<ul>
48
    <li>Default: always ask for confirmation</li>
49
    <li>Asks: When closing or reopening a basket, ___.</li>
50
    <li>Description: This preference adds the option to skip confirmations on closing and reopening a basket. If you skip the confirmation, you do not create a new basket group.</li>
51
</ul></p>
52
53
<p><strong>ClaimsBccCopy</strong>
54
<ul>
55
    <li>Default: Don't send</li>
56
    <li>Asks: ___ blind copy (BCC) to logged in user when sending serial or acquisitions claims notices.</li>
57
    <li>Description: When filing a claim in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/serialclaims.html">serials</a> or <a href="http://manual.koha-community.org/[% helpVersion %]/en/acqclaims.html">acquisitions</a> module this preference will allow for the sending of a copy of the email to the librarian.</li>
58
</ul></p>
59
60
<p><strong>CurrencyFormat</strong>
61
<ul>
62
    <li>Default: 360,000.00 (US)</li>
63
    <li>Asks: Display currencies using the following format ___</li>
64
</ul></p>
65
66
<p><strong>gist</strong>
67
<ul>
68
    <li>Default: 0</li>
69
    <li>Asks: The default tax rate is ___</li>
70
    <li>Description: This preference will allow the library to define a default Goods and Services Tax rate. The default of value of 0 will disable this preference.</li>
71
    <li>Note: Enter this value as a number (.06) versus a percent (6%).</li>
72
</ul></p>
73
74
<p><strong>MarcFieldsToOrder</strong>
75
<ul>
76
    <li>Asks: Set the mapping values for a new order line created from a MARC record in a staged file.</li>
77
    <li>Description: This preference includes MARC fields to check for order information to use when <a href="http://manual.koha-community.org/[% helpVersion %]/en/placingacqorder.html#orderfromstagedfile">ordering from a staged file</a> in acquisitions. You can use the following fields: price, quantity, budget_code, discount, sort1, sort2.</li>
78
    <li>For example:</li>
79
    <ul>
80
        <li>price: 947$a|947$c</li>
81
        <li>quantity: 969$h</li>
82
        <li>budget_code: 922$a</li>
83
    </ul>
84
</ul></p>
85
86
<p><strong>UniqueItemFields</strong>
87
<ul>
88
    <li>Default: barcode</li>
89
    <li>Asks:___ (space-separated list of fields that should be unique for items, must be valid SQL fields of <a href="http://schema.koha-community.org/[% helpVersion.replace('\.','_') %]/tables/items.html">items</a> table)</li>
90
    <li>Description: If this preference is left blank when adding items in acquisitions there will be no check for uniqueness. This means that a duplicate barcode can be created in acquisitions which will cause errors later when checking items in and out.</li>
91
</ul></p>
92
93
<h3>Printing</h3>
94
95
<p><strong>OrderPdfFormat</strong>
96
<ul>
97
    <li>Default: pdfformat::layout2pages</li>
98
    <li>Asks: Use ___ when printing basket groups.</li>
99
</ul>
100
101
<p><strong>See the full documentation for Acquisitions System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#acqprefs">manual</a> (online).</strong></p>
102
103
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_admin.tt (+233 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Administration System Preferences</h1>
4
5
<h3>CAS Authentication</h3>
6
<p>The Central Authentication Service (CAS) is a single sign-on protocol for the web. If you don't know what this is, leave these preferences set to their defaults.</p>
7
8
<p><strong>AllowPKIAuth</strong>
9
<ul>
10
    <li>Default: no</li>
11
    <li>Asks: Use ___ field for SSL client certificate authentication</li>
12
</ul></p>
13
14
<p><strong>casAuthentication</strong>
15
<ul>
16
    <li>Default: Don't use</li>
17
    <li>Asks: ___ CAS for login authentication.</li>
18
</ul></p>
19
20
<p><strong>casLogout</strong></p>
21
<ul>
22
    <li>Default: Don't logout</li>
23
    <li>Asks: ___ of CAS when logging out of Koha.</li>
24
</ul></p>
25
26
<p><strong>casServerUrl</strong>
27
<ul>
28
    <li>Asks: The CAS Authentication Server can be found at ___</li>
29
</ul></p>
30
31
<p><strong>Google OpenID Connect</strong>
32
Visit the <a href="https://console.developers.google.com/apis/library">Google Developers Console</a> to obtain OAuth 2.0 credentials such as a client ID and client secret that are known to both Google and your application.
33
<ul>
34
    <li>Create a project, and give it some details to help you identify it later</li>
35
    <li>Next search for the Google Identity and Access Management API</li>
36
    <li>Enable the Google Identity and Access Management API</li>
37
    <li>Go to 'Credentials' and set the OAuth cosent screen values</li>
38
    <li>Next choose to 'Create credentials' from the 'Credentials' page</li>
39
    <li>Choose 'Web application' from the 'Application type' menu and fill in the form presented</li>
40
    <ul>
41
        <li>Set 'Authorized JavaScript origins' to your OPACBaseURL</li>
42
        <li>Change the 'Authorized Redirect URIs' to http://YOUROPAC/cgi-bin/koha/svc/auth/googleopenidconnect</li>
43
    </ul>
44
    <li>You will be presented with your values for your client ID and your client secret after saving</li>
45
</ul></p>
46
47
<p><strong>GoogleOAuth2ClientID</strong>
48
<ul>
49
    <li>Asks: Google OAuth2 Client ID ___</li>
50
</ul></p>
51
52
<p><strong>GoogleOAuth2ClientSecret</strong>
53
<ul>
54
    <li>Asks: Google OAuth2 Client Secret ___</li>
55
</ul></p>
56
57
<p><strong>GoogleOpenIDConnect</strong>
58
<ul>
59
    <li>Default: Don't use</li>
60
    <li>Asks ___ Google OpenID Connect login.</li>
61
    <li style="color: #990000;">Important: You will need to select OAuth2 when creating an app in the google cloud console, and set the web origin to your_opac_url and the redirect url to your_opac_url/cgi-bin/koha/svc/auth/googleopenidconnect</li>
62
</ul></p>
63
64
<p><strong>GoogleOpenIDConnectDomain</strong>
65
<ul>
66
    <li>Asks: Google OpenID Connect Restrict to domain (or subdomain of this domain) ___.
67
    <li>Note: Leave blank for all google domains</li>
68
</ul></p>
69
70
<h3>Interface options</h3>
71
<p>These preferences are related to your Koha interface.</p>
72
73
<p><strong>DebugLevel</strong>
74
<ul>
75
    <li>Default: lots of</li>
76
    <li>Asks: Show ___ debugging information in the browser when an internal error occurs.</li>
77
    <li>Description: This preference determines how much information will be sent to the user's screen when the system encounters an error. The most detail will be sent when the value level is set at 2, some detail will be sent when the value is set at 1, and only a basic error message will display when the value is set at 0. This setting is especially important when a system is new and the administration is interested in working out the bugs (errors or problems) quickly. Having detailed error messages makes quick fixes more likely in problem areas.</li>
78
</ul></p>
79
80
<p><strong>DefaultToLoggedInLibraryCircRules</strong>
81
<ul>
82
    <li>Default: all libraries</li>
83
    <li>Asks: When editing circulation rules show ___ the rules by default.</li>
84
    <li>Description: This preference controls the default value in the branch pull down found at the top of the <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">circulation and fine rules</a>.</li>
85
</ul></p>
86
87
<p><strong>DefaultToLoggedInLibraryNoticesSlips</strong>
88
<ul>
89
    <li>Default: all libraries</li>
90
    <li>Asks: When editing notices and slips show the ___ notices and slips by default.</li>
91
    <li>Description: This preference controls the default value in the branch pull down found at the top of the <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#notices">notices and slips</a> tool.</li>
92
</ul></p>
93
94
<p><strong>DefaultToLoggedInLibraryOverdueTriggers</strong>
95
<ul>
96
    <li>Default: all libraries</li>
97
    <li>Asks: When editing overdue notice/status triggers show the ___ rules by default.</li>
98
    <li>Description: This preference controls the default value in the branch pull down found at the top of the <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#noticetriggers">overdue notices and triggers</a>.</li>
99
</ul></p>
100
101
<p><strong>delimiter</strong>
102
<ul>
103
    <li>Default: semicolons</li>
104
    <li>Asks: Separate columns in an exported report file with ___ by default.</li>
105
    <li>Description: This preference determines how reports exported from Koha will separate data. In many cases you will be able to change this option when exporting if you'd like.</li>
106
</ul></p>
107
108
<p><strong>KohaAdminEmailAddress</strong>
109
<ul>
110
    <li>This is the default 'From' address for emails unless there is one for the particular branch, and is referred to when an internal error occurs.</li>
111
    <li>Asks: Use ___ as the email address for the administrator of Koha.</li>
112
    <li>Description: This preference allows one email address to be used in warning messages set to the OPAC. If no email address is set for the branch this address will receive messages from patrons regarding modification requests, purchase suggestions, and questions or information regarding overdue notices. It is recommended that a email address that can be accessed by multiple staff members be used for this purpose so that if one librarian is out the others can address these requests. This email address can be changed when needed.</li>
113
</ul></p>
114
115
<p><strong>noItemTypeImages</strong>
116
<ul>
117
    <li>Default: Show</li>
118
    <li>Asks: ___ itemtype icons in the catalog.</li>
119
    <li>Description: This preference allows the system administrator to determine if users will be able to set and see an <a href="http://manual.koha-community.org/[% helpVersion %]/en/basicparams.html#itemtypeadmin">item type icon</a> the catalog on both the OPAC and the Staff Client. The images will display in both the OPAC and the Staff Client/Intranet. If images of item types are disabled, text labels for item types will still appear in the OPAC and Staff Client.</li>
120
</ul></p>
121
122
<p><strong>ReplytoDefault</strong>
123
<ul>
124
    <li>Asks: Use ___ as the email address that will be set as the replyto in emails</li>
125
    <li>Description: By default replies to notice emails will go to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/basicparams.html#libsgroups">library email address</a>, if you would like to specify a default email address for all replies to notices you can do that here.</li>
126
</ul></p>
127
128
<p><strong>ReturnpathDefault</strong>
129
<ul>
130
    <li>Asks: Use ___ as the email address set as the return path, if you leave this empty the KohaAdminEmailAddress will be used.</li>
131
    <li>Description: The return path is the email address that bounces will be delivered to. By default bounced notices will go to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/basicparams.html#libsgroups">library email address</a>, if you would like to specify a default email address for bounces to go to then fill in this preference.</li>
132
</ul></p>
133
134
<p><strong>virtualshelves</strong>
135
<ul>
136
    <li>Default: Allow</li>
137
    <li>Asks: ___ staff and patrons to create and view saved lists of books.</li>
138
    <li>Description: This preference controls whether the lists functionality will be available in the staff client and OPAC. If this is set to "Don't allow" then no one will be able to save items to public or private lists.</li>
139
</ul></p>
140
141
<h3>Login options</h3>
142
<p>These preferences are related to logging into your Koha system</p>
143
144
<p><strong>AutoLocation</strong>
145
<ul>
146
    <li>Default: Don't require</li>
147
    <li>Asks: ___ staff to log in from a computer in the IP address range specified by their library (if any).</li>
148
    <li>Set IP address range in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/basicparams.html#libsgroups">library administration area</a></li>
149
    <li>Description: This preference protects the system by blocking unauthorized users from accessing the staff client program and settings. Authorized and unauthorized users are determined by their computer's IP addresses. When the preference is set to 'Require', IP authorization is in effect and unauthorized IP addresses will be blocked. This means that staff cannot work from home unless their IP address has been authorized. When set to 'Don't require', anyone with a staff client login will have access no matter which IP address they are using.</li>
150
</ul></p>
151
152
<p><strong>IndependentBranches</strong>
153
<ul>
154
    <li>Default: Don't prevent</li>
155
    <li>Asks: ___ staff (but not superlibrarians) from modifying objects (holds, items, patrons, etc.) belonging to other libraries.</li>
156
    <li>Description: This preference should only be used by library systems which are sharing a single Koha installation among multiple branches but are considered independent organizations, meaning they do not share material or patrons with other branches and do not plan to change that in the future. If set to 'Prevent' it increases the security between library branches by: prohibiting staff users from logging into another branch from within the staff client, filtering out patrons from patron searches who are not a part of the login branch conducting the search, limiting the location choices to the login branch when adding or modifying an item record, preventing users from other branch locations from placing holds or checking out materials from library branches other than their own, and preventing staff from editing item records which belong to other library branches. All of these security safeguards can be overridden only by the superlibrarian, the highest level of privileges.</li>
157
    <li style="color: #990000;">Important: It is important that this value be set before going live and that it NOT be changed</li>
158
</ul></p>
159
160
<p><strong>SessionRestrictionByIP</strong>
161
<ul>
162
    <li>Default: Enable</li>
163
    <li>Asks: ___ check for change in remote IP address for session security. Disable only when remote IP address changes frequently.</li>
164
    <li>Description: When this preference is set to 'Enable' Koha will log you out of the staff client if your IP address changes as a security measure. For some systems the IP address changes frequently so you'll want to set this preference to 'Disable' to prevent Koha from logging you out of the staff client every time that happens.</li>
165
    <li style="color: #990000;">Important: This is meant to help those whose IP address changes several times during the day, setting this preference to 'Disable' is not recommended otherwise because it is removing important security features from your staff client.</li>
166
</ul></p>
167
168
<p><strong>SessionStorage</strong>
169
<ul>
170
    <li>Default: in the MySQL database</li>
171
    <li>Asks: Store login session information ___</li>
172
    <li>Description: This preference allows administrators to choose what format session data is stored in during web sessions.</li>
173
</ul></p>
174
175
<p><strong>timeout</strong>
176
<ul>
177
    <li>Default: 12000000</li>
178
    <li>Asks: Automatically log out users after ___ seconds of inactivity.</li>
179
    <li>Description: This preference sets the length of time the Staff Client or OPAC accounts can be left inactive before re-logging in is necessary. The value of this preference is in seconds. At this time, the amount of time before a session times out must be the same for both the Staff Client and the OPAC.</li>
180
</ul></p>
181
182
<h3>Mozilla Persona</h3>
183
184
<p><strong>Persona</strong>
185
<ul>
186
    <li>Default: Don't allow</li>
187
    <li>Asks: ___ Mozilla persona for login.</li>
188
    <li>Description: Mozilla Persona is an OpenID-like service that lets you log in to multiple websites with your Mozilla credentials. If you allow Persona log in for Koha then your patrons can log in to the OPAC using their Mozilla Persona. Learn more about Persona on the <a href="https://developer.mozilla.org/en-US/Persona">official Mozilla site</a>.</li>
189
    <li style="color: #990000;">Important: For Persona log in to work you will need your <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACBaseURL">OPACBaseURL</a> preference to be set correctly.</li>
190
</ul></p>
191
192
<h3>Share anonymous usage statistics</h3>
193
<p>As an open source project Koha is used all over the world. These preference will help us keep more accurate statistics on where Koha is being used. If you choose to share your information, it will be published on the <a href="http://hea.koha-community.org">Hea Koha community website</a>. You will need to enable the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#usagecron">matching cron job</a> to send this information at regular intervals to the community.</p>
194
195
<p><strong>UsageStats</strong>
196
<ul>
197
    <li>Default: Don't share</li>
198
    <li>Asks: ___ anonymous Koha usage data with the Koha community.</li>
199
    <li>Description: This data is stored to help track usage of Koha around the world. If you choose to share your information, it will be published on the <a href="http://hea.koha-community.org">Hea Koha community website</a>. This information is sent using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#usagecron">Usage Sharing Cron Job</a>.</li>
200
</ul></p>
201
202
<p><strong>UsageStatsCountry</strong>
203
<ul>
204
    <li>Asks: The country where your library is located: ___</li>
205
    <li>Description: This data is stored to help track usage of Koha around the world. If you choose to share your information, it will be published on the <a href="http://hea.koha-community.org">Hea Koha community website</a>. This information is sent using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#usagecron">Usage Sharing Cron Job</a>.</li>
206
    <li style="color: #990000;">Important: This preference depends on the <a href="http://manual.    koha-community.org/[% helpVersion %]/en/cronjobsch.html#UsageStats">UsageStats</a> preference. Set that to 'Share' to share your information.</li>
207
</ul></p>
208
209
<p><strong>UsageStatsLibraryName</strong>
210
<ul>
211
    <li>Asks: The library name ___ will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website.</a></li>
212
    <li>Description: This data is stored to help track usage of Koha around the world. If you choose to share your information, it will be published on the <a href="http://hea.koha-community.org">Hea Koha community website</a>. This information is sent using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#usagecron">Usage Sharing Cron Job</a>.</li>
213
    <li style="color: #990000;">Important: This preference depends on the <a href="http://manual.    koha-community.org/[% helpVersion %]/en/cronjobsch.html#UsageStats">UsageStats</a> preference. Set that to 'Share' to share your information. If this field is empty data will be sent anonymously if you choose 'Share' for the UsageStats preference.</li>
214
</ul></p>
215
216
<p><strong>UsageStatsLibraryType</strong>
217
<ul>
218
    <li>Default: public</li>
219
    <li>Asks: The library type ___ will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.</li>
220
    <li>Description: This data is stored to help track usage of Koha around the world. If you choose to share your information, it will be published on the <a href="http://hea.koha-community.org">Hea Koha community website</a>. This information is sent using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#usagecron">Usage Sharing Cron Job</a>.</li>
221
    <li style="color: #990000;">Important: This preference depends on the <a href="http://manual.    koha-community.org/[% helpVersion %]/en/cronjobsch.html#UsageStats">UsageStats</a> preference. Set that to 'Share' to share your information.</li>
222
</ul></p>
223
224
<p><strong>UsageStatsLibraryUrl</strong>
225
<ul>
226
    <li>Asks: The library URL ___ will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.</li>
227
    <li>Description: This data is stored to help track usage of Koha around the world. If you choose to share your information, it will be published on the <a href="http://hea.koha-community.org">Hea Koha community website</a>. This information is sent using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#usagecron">Usage Sharing Cron Job</a>.</li>
228
    <li style="color: #990000;">Important: This preference depends on the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#UsageStats">UsageStats</a> preference. Set that to 'Share' to share your information.</li>
229
</ul></p>
230
231
<p><strong>See the full documentation for Administration System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#adminprefs">manual</a> (online).</strong></p>
232
233
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_authorities.tt (+107 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Authorities System Preferences</h1>
4
5
<h3>General</h3>
6
7
<p><strong>AuthDisplayHierarchy</strong>
8
<ul>
9
    <li>Default: Don't display</li>
10
    <li>Asks: ___ broader term/narrower term hierarchies when viewing authorities.</li>
11
    <li>Description: If your authority records includes 5xx fields with linked references to broader and/or narrower see also references this preference will turn on a display of those authorities at the top of the record.</li>
12
</ul></p>
13
14
<p><strong>AutoCreateAuthorities</strong>
15
<ul>
16
    <li>Default: do not generate</li>
17
    <li>Asks: When editing records, ___ authority records that are missing.</li>
18
    <li style="color: #990000;">Important: <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BiblioAddsAuthorities">BiblioAddsAuthorities</a> must be set to "allow" for this to have any effect.</li>
19
    <li>Description: When this and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BiblioAddsAuthorities">BiblioAddsAuthorities</a> are both turned on, automatically create authority records for headings that don't have any authority link when cataloging. When BiblioAddsAuthorities is on and AutoCreateAuthorities is turned off, do not automatically generate authority records, but allow the user to enter headings that don't match an existing authority. When BiblioAddsAuthorities is off, this has no effect.</li>
20
</ul></p>
21
22
<p><strong>BiblioAddsAuthorities</strong>
23
<ul>
24
    <li>Default: allow</li>
25
    <li>Asks: When editing records, ___ them to automatically create new authority records if needed, rather than having to reference existing authorities.</li>
26
</ul></p>
27
28
<p><strong>dontmerge</strong>
29
<ul>
30
    <li>Default: Don't</li>
31
    <li>Asks: ___ automatically update attached biblios when changing an authority record.</li>
32
    <li>Description: This preference tells Koha how to handle changes to your Authority records. If you edit an authority record and this preference is set to 'Do' Koha will immediately update all of the bib records linked to the authority with the new authority record's data. If this is set to "Don't" then Koha won't edit bib records when changes are made to authorities, rather, this is done later by the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#mergeauthcron">merge_authority.pl cronjob</a>.</li>
33
    <li style="color: #990000;">Important: If this is set to "Don't automatically update" you will need to ask your administrator to enable the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#mergeauthcron">merge_authority.pl cronjob</a>.</li>
34
</ul></p>
35
36
<p><strong>MARCAuthorityControlField008</strong>
37
<ul>
38
    <li>Default: || aca||aabn | a|a d</li>
39
    <li>Asks: Use the following text for the contents of MARC21 authority control field 008 position 06-39 (fixed length data elements).</li>
40
    <li style="color: #990000;">Important: Do not include the date (position 00-05) in this preference, Koha will calculate automatically and put that in before the values in this preference.</li>
41
    <li>Description: This preference controls the default value in the 008 field on Authority records. It does not effect bibliographic records.</li>
42
</ul></p>
43
44
<p><strong>UNIMARCAuthorityField100</strong>
45
<ul>
46
    <li>Default: afrey50 ba0</li>
47
    <li>Asks: Use the following text for the contents of UNIMARC authority field 100 position (fixed length data elements).</li>
48
    <li style="color: #990000;">Important: Do not include the date (position 00-07) in this preference, Koha will calculate automatically and put that in before the values in this preference.</li>
49
    <li>Description: This preference controls the default value in the 100 field on Authority records cataloged in UNIMARC. It does not effect bibliographic records.</li>
50
</ul></p>
51
52
<p><strong>UseAuthoritiesForTracings</strong>
53
<ul>
54
    <li>Default: Don't use</li>
55
    <li>Asks: ___ authority record numbers instead of text strings for searches from subject tracings.</li>
56
    <li>Description: For libraries that have authority files, they may want to make it so that when a link to an authorized subject or author is clicked on the OPAC or staff client it takes the searcher only to a list of results with that authority record. Most libraries do not have complete authority files and so setting this preference to 'Don't use' will allow searchers to click on links to authors and subject headings and perform a keyword search against those fields, finding all possible relevant results instead.</li>
57
</ul></p>
58
59
<h3>Linker</h3>
60
<p>These preferences will control how Koha links bibliographic records to authority records. All bibliographic records added to Koha after these preferences are set will link automatically to authority records, for records added before these preferences are set there is a script (misc/link_bibs_to_authorities.pl) that your system administrator can run to link records together.</p>
61
62
<p><strong>CatalogModuleRelink</strong>
63
<ul>
64
    <li>Default: Do not</li>
65
    <li>Asks: ___ automatically relink headings that have previously been linked when saving records in the cataloging module.</li>
66
    </ul>
67
    <li>Description: Longtime users of Koha don't expect the authority and bib records to link consistently. This preference makes it possible to disable authority relinking in the cataloging module only (i.e. relinking is still possible if link_bibs_to_authorities.pl is run). Note that though the default behavior matches the previous behavior of Koha (retaining links to outdated authority records), it does not match the intended behavior (updating biblio/authority link after bibliographic record is edited). Libraries that want the intended behavior of authority control rather than the way Koha used to handle linking should set CatalogModuleRelink to 'Do'. Once setting this to 'Do' the following preferences can also be set.</li>
68
</ul></p>
69
70
<p><strong>LinkerKeepStale</strong>
71
<ul>
72
    <li>Default: Do not</li>
73
    <li>Asks: ___ keep existing links to authority records for headings where the linker is unable to find a match.</li>
74
    <li>Description: When set to 'Do', the linker will never remove a link to an authority record, though, depending on the value of <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#LinkerRelink">LinkerRelink</a>, it may change the link.</li>
75
</ul></p>
76
77
<p><strong>LinkerModule</strong>
78
<ul>
79
    <li>Default: Default</li>
80
    <li>Asks: Use the ___ linker module for matching headings to authority records.</li>
81
    <li>Description: This preference tells Koha which match to use when searching for authority matches when saving a record.</li>
82
</ul></p>
83
84
<p><strong>LinkerOptions</strong>
85
<ul>
86
    <li>Asks: Set the following options for the authority linker ___</li>
87
    <li style="color: #990000;">Important: This feature is experimental and shouldn't be used in a production environment until further expanded upon.</li>
88
    <li>Description: This is a pipe separated (|) list of options. At the moment, the only option available is "broader_headings." With this option set to "broader_headings", the linker will try to match the following heading as follows:
89
    <ul>
90
        <li>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</li>
91
        <li>First: Camins-Esakov, Jared--Coin collections--Catalogs--Early works to 1800</li>
92
        <li>Next: Camins-Esakov, Jared--Coin collections--Catalogs</li>
93
        <li>Next: Camins-Esakov, Jared--Coin collections</li>
94
        <li>Next: Camins-Esakov, Jared (matches! if a previous attempt had matched, it would not have tried this)</li>
95
    </ul>
96
</ul></p>
97
98
<p><strong>LinkerRelink</strong>
99
<ul>
100
    <li>Default: Do</li>
101
    <li>Asks: ___ relink headings that have previously been linked to authority records.</li>
102
    <li>Description: When set to 'Do', the linker will confirm the links for headings that have previously been linked to an authority record when it runs, correcting any incorrect links it may find. When set to 'Do not', any heading with an existing link will be ignored, even if the existing link is invalid or incorrect.</li>
103
</ul></p>
104
105
<p><strong>See the full documentation for Authorities System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#authprefs">manual</a> (online).</strong></p>
106
107
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_cataloguing.tt (+296 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Cataloging System Preferences</h1>
4
5
<h3>Display</h3>
6
7
<p><strong>AcquisitionDetails</strong>
8
<ul>
9
    <li>Default: Display</li>
10
    <li>Asks: ___ acquisition details on the biblio detail page.</li>
11
    <li>Description: This preference controls whether a tab will show on the detail page in the staff client that includes detailed acquisitions information for the title. This tab will include links to order information stored in the acquisitions module.</li>
12
</ul></p>
13
14
<p><strong>AuthoritySeparator</strong>
15
<ul>
16
    <li>Default: --</li>
17
    <li>Asks: Separate multiple displayed authors, series or subjects with ___.</li>
18
</ul></p>
19
20
<p><strong>hide_marc</strong>
21
<ul>
22
    <li>Default: Display</li>
23
    <li>Asks: ___ MARC tag numbers, subfield codes and indicators in MARC views.</li>
24
</ul></p>
25
26
<p><strong>IntranetBiblioDefaultView</strong>
27
<ul>
28
    <li>Default: ISBD form</li>
29
    <li>Asks: By default, display biblio records in ___</li>
30
    <li>Description: This setting determines the bibliographic record display when searching the catalog on the staff client. This setting does not affect the display in the OPAC which is changed using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BiblioDefaultView">BiblioDefaultView</a> preference under the OPAC preference tab. This setting changes the look of the record when first displayed. The MARC and ISBD views can still be seen by clicking in the sidebar.</li>
31
</ul></p>
32
33
<p><strong>ISBD</strong>
34
<ul>
35
    <li>Default: <a href="http://manual.koha-community.org/[% helpVersion %]/en/sysprefdefaults.html#isbddefault">MARC21 Default Appendix</a> or <a href="http://manual.koha-community.org/[% helpVersion %]/en/sysprefdefaults.html#unimarcdefault">UNIMARC Default Appendix</a></li>
36
    <li>Asks: Use the following as the ISBD template:</li>
37
    <li>Description: This determines how the ISBD information will display in the staff client. Elements in the list can be reordered to produce a different ISBD view. ISBD, the International Standard Bibliographic Description, was first introduced by IFLA (International Federation of Library Associations) in 1969 in order to provide guidelines for descriptive cataloging. The purpose of ISBD is to aid the international exchange of bibliographic records for a variety of materials.</li>
38
</ul></p>
39
40
<p><strong>LabelMARCView</strong>
41
<ul>
42
    <li>Default: Don't</li>
43
    <li>Asks: ___ collapse repeated tags of the same type into one tag entry.</li>
44
</ul></p>
45
46
<p><strong>MergeReportFields</strong>
47
<ul>
48
    <li>Asks: ___ fields to display for deleted records after merge</li>
49
    <li>Description: When merging records together you can receive a report of the merge process once it's done, this preference lets you set the default values for this report.</li>
50
    <li>Example: '001,245ab,600' displays:</li>
51
    <ul>
52
        <li>value of 001</li>
53
        <li>subfields a and b of fields 245</li>
54
        <li>all subfields of fields 600</li>
55
    </ul>
56
</ul></p>
57
58
<p><strong>NotesBlacklist</strong>
59
<ul>
60
    <li>Asks: Don't show these ___ note fields in title notes separator (OPAC record details) and in the description separator (Staff client record details).</li>
61
    <li>Description: This preference lets you define which of your note fields are hidden from the title notes (OPAC) and descriptions (Staff) tabs. Enter the values as a comma separated list. For example to hide the local note and the bibliography note in MARC21 enter 504, 590.</li>
62
</ul></p>
63
64
<p><strong>OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and OpacSuppressionMessage</strong>
65
<ul>
66
    <li>OpacSuppression Default: Don't hide</li>
67
    <li>Asks: ___ items marked as suppressed from OPAC search results. Note that you must have the Suppress index set up in Zebra and at least one suppressed item, or your searches will be broken. Restrict the suppression to IP adresses outside of the IP range ___ (Leave blank if not used. Define a range like 192.168..) Redirect the opac detail page for suppressed records to ___ Display the following message on the redirect page for suppressed biblios ___.</li>
68
    <li>Description: These preferences control hiding of bibliographic records from display in the OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have the value "1" in the field mapped with Suppress index (942$n field in MARC21, no official field in UNIMARC). The indexer then hides it from display in OPAC but will still display it in the Staff Client. If you want to further control suppression you can set an IP address range to still show suppressed items to. Define a range like 192.168.. If you don't want to limit suppression in this way, leave the IP field blank. You can also decide what the patrons will see in the OPAC when a title is suppressed by setting the OpacSuppressionRedirect and OpacSuppressionMessage preferences. You can either show the patron a 404 page if they try to see a suppressed record or you can create a custom page by entering the HTML in the OpacSuppressionMessage part of this preference.</li>
69
    <li>Note: An <a href="http://manual.koha-community.org/[% helpVersion %]/en/basicparams.html#authorizedvalues">authorized value</a> for the MARC21 942$n field (or the equivalent UNIMARC field) should be set to eliminate errors. One example would be to create an authorized value titled SUPPRESS with a value of 0 for don't suppress and 1 for suppress.</li>
70
    <li style="color: #990000;">Important: If this preference is set to 'hide' and you have the 942n field set to 1, it will hide the entire bib record - not just an individual item.</li>
71
    <li style="color: #990000;">Important: You must have the Suppress index set up in Zebra and at least one record with the value "1" in the field mapped with this index, or your searches will be completely broken in OPAC (you won't get any results at all).</li>
72
    <li>Note: Suppressed records will show a note in the staff client indicating that they are suppressed from view in the OPAC. This note can be styled by using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#IntranetUserCSS">IntranetUserCSS</a> preference to stand out more if you'd like.</li>
73
</ul></p>
74
75
<p><strong>SeparateHoldings & SeparateHoldingsBranch</strong>
76
<ul>
77
    <li>SeparateHoldings default: Don't separate</li>
78
    <li>SeparateHoldingsBranch default: home library</li>
79
    <li>Asks: ___ items display into two tabs, where the first tab contains items whose ___ is the logged in user's library. The second tab will contain all other items.</li>
80
    <li>Description: This preference lets you decide if you would like to have the holding information on the bibliographic detail page in the staff client split in to multiple tabs. The default is to show all holdings on one tab.</li>
81
</ul></p>
82
83
<p><strong>URLLinkText</strong>
84
<ul>
85
    <li>Default: Online Resource</li>
86
    <li>Asks: Show ___ as the text of links embedded in MARC records.</li>
87
    <li>Description: If the 856 field does not have a subfield 3 or y defined, the OPAC will say 'Click here to access online.' If you would like the field to say something else enter that in this field.</li>
88
</ul></p>
89
90
<p><strong>UseControlNumber</strong>
91
<ul>
92
    <li>Default: Don't use</li>
93
    <li>Asks: ___ record control number ($w subfields) and control number (001) for linking of bibliographic records.</li>
94
    <li style="color: #990000;">Important: Unless you are going in and manually changing 773$w to match your rigorously-defined bibliographic relationships, you should set this preference to "Don't use" and instead set <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#EasyAnalyticalRecords">EasyAnalyticalRecords</a> to "Display"</li>
95
    <li>Description: If you have a serial called "Journal of Interesting Things" which has a separate record from when it was called "Transactions of the Interesting Stuff Society," you could add linking fields to indicate the relationship between the two records. UseControlNumber allows you to use your local accession numbers for those links. In MARC21, the relevant sections of the two records might look like this:</li>
96
    <ul>
97
        <li>=001    12345</li>
98
        <li>=110  2_$aInteresting Stuff Society.</li>
99
        <li>=245  10$aTransactions of the Interesting Stuff Society.</li>
100
        <li>=785  00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346</li>
101
        <li>=001    12346</li>
102
        <li>=110  2_$aInteresting Stuff Society.</li>
103
        <li>=245  10$aJournal of Interesting Things.</li>
104
        <li>=780  00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</li>
105
    </ul>
106
    <li>With UseControlNumber set to 'Use', the 78x links will use the Control Numbers is subfield $w, instead of doing a title search on "Journal of Interesting Things" and "Transactions of the Interesting Stuff Society" respectively.</li>
107
</ul></p>
108
109
<h3>Exporting</h3>
110
111
<p><strong>BibtexExportAdditionalFields</strong>
112
<ul>
113
    <li>Asks: Include following fields when exporting BibTeX</li>
114
    <li>Description:</li>
115
    <ul>
116
        <li>Use one line per tag in the format BT_TAG: TAG$SUBFIELD ( e.g. lccn: 010$a )</li>
117
        <li>To specificy multiple marc tags/subfields as targets for a repeating BibTex tag, use the following format: BT_TAG: [TAG2$SUBFIELD1, TAG2$SUBFIELD2] ( e.g. notes: [501$a, 505$g] )</li>
118
        <li>All values of repeating tags and subfields will be printed with the given BibTeX tag.</li>
119
        <li>Use '@' ( with quotes ) as the BT_TAG to replace the bibtex record type with a field value of your choosing.</li>
120
    </ul>
121
</ul></p>
122
123
<p><strong>RisExportAdditionalFields</strong>
124
<ul>
125
    <li>Asks: Include following fields when exporting RIS</li>
126
    <li>Description:</li>
127
    <ul>
128
        <li>Use one line per tag in the format RIS_TAG: TAG$SUBFIELD ( e.g. LC: 010$a )</li>
129
        <li>To specificy multiple marc tags/subfields as targets for a repeating RIS tag, use the following format: RIS_TAG: [TAG2$SUBFIELD1, TAG2$SUBFIELD2] ( e.g. NT: [501$a, 505$g] )</li>
130
        <li>All values of repeating tags and subfields will be printed with the given RIS tag.</li>
131
        <li>Use of TY ( record type ) as a key will replace the default TY with the field value of your choosing.</li>
132
    </ul>
133
</ul></p>
134
135
<h3>Importing</h3>
136
137
<p><strong>AggressiveMatchOnISBN</strong>
138
<ul>
139
    <li>Default: don't</li>
140
    <li>Asks: When matching on ISBN with the record import tool, ___ attempt to match aggressively by trying all variations of the ISBNs in the imported record as a phrase in the ISBN fields of already cataloged records.</li>
141
    <li>Description: This preference allows you to choose to alter the ISBN matching rule used when staging records for import to be more aggressive. This means that all text will be stripped from the ISBN field so that a pure number match is possible. If this preference is set to "Don't" then Koha will find a match only if the ISBN fields are identical.</li>
142
    <li style="color: #990000;">Important: Note that this preference has no effect if <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#UseQueryParser">UseQueryParser</a> is on.</li>
143
</ul></p>
144
145
<h3>Interface</h3>
146
147
<p><strong>advancedMARCeditor</strong>
148
<ul>
149
    <li>Default: Don't display</li>
150
    <li>Asks: ___ descriptions of fields and subfields in the MARC editor.</li>
151
    <li>Description: This preference determines whether or not MARC field names will be present when editing or creating MARC records.</li>
152
</ul></p>
153
154
<p><strong>DefaultClassificationSource</strong>
155
<ul>
156
    <li>Default: Dewey Decimal System</li>
157
    <li>Asks: Use ___ as the default classification source.</li>
158
</ul></p<
159
160
<p><strong>EasyAnalyticalRecords</strong>
161
<ul>
162
    <li>Default: Don't Display</li>
163
    <li>Asks: ___ easy ways to create analytical record relationships</li>
164
    <li style="color: #990000;">Important: If you decide to use this feature you'll want to make sure that your <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#UseControlNumber">UseControlNumber</a> preference is set to "Don't use" or else the "Show analytics" links in the staff client and the OPAC will be broken.</li>
165
    <li>Description: An analytic entry in a catalog is one that describes a part of a larger work that is also described in the catalog. In bibliographic cataloging, analytic entries may be made for chapters in books or special issues of articles in periodicals. In archival cataloging, analytic entries may be made for series or items within a collection. This feature in Koha allows for an easy way of linking analytic entries to the host records, and this system preference adds several new menu options to the staff cataloging detail pages to allow that to happen.</li>
166
</ul></p>
167
168
<h3>Record Structure</h3>
169
170
<p><strong>AlternateHoldingsField & AlternateHoldingsSeparator</strong>
171
<ul>
172
    <li>Asks: Display MARC subfield ___ as holdings information for records that do not have items, with the subfields separated by ___.</li>
173
    <li>Description: Sometimes libraries migrate to Koha with their holding info in the 852 field (OCLC holdings information field) and choose not to transfer that information into the 952 (Koha holdings information field) because they don't plan on circulating those items. For those libraries or other libraries that have data in the 852 fields of their records that they want to display, these preferences let you choose to display holdings info from a field other than the 952 field. The AlternateHoldingsField preference can contain multiple subfields to look in; for instance 852abhi would look in 852 subfields a, b, h, and i.</li>
174
</ul></p>
175
176
<p><strong>autoBarcode</strong>
177
<ul>
178
    <li>Default: generated in the form <branchcode>yymm0001</li>
179
    <li>Asks: Barcodes are ___</li>
180
    <li>Description: This setting is for libraries wishing to generate barcodes from within Koha (as opposed to scanning in pre-printed barcodes or manually assigning them). The default behavior makes it so that when you click in the barcode field (952$p in MARC21) it will populate with the automatic barcode you have chosen. If you would rather it only enter an automatic barcode when you click on the plugin (the ... to the right of the field) you can change the plugin used for that field in the framework. Set the plugin for 952$p (if using MARC21 or equivalent field mapped to items.barcode in your local MARC format) for your frameworks to barcode_manual.pl instead of barcode.pl. Learn more about editing frameworks under the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catadmin.html#marcbibframeworks">MARC Bibliographic Frameworks</a> section of this manual.</li>
181
</ul></p>
182
183
<p><strong>DefaultLanguageField008</strong>
184
<ul>
185
    <li>Default: Empty defaults to eng</li>
186
    <li>Asks: Fill in the default language for field 008 Range 35-37 of MARC21 records ___.</li>
187
    <li>Description: This preference will allow you to set the language for your MARC21 008 field by default. If this is left empty it will default to English (eng). See the <a href="http://www.loc.gov/marc/languages/language_code.html">MARC Code List for Languages</a> for additional values for this preference.</li>
188
    <li>Note: This preference won't have any effect if your records are in UNIMARC.</li>
189
</ul></p>
190
191
<p><strong>item-level_itypes</strong>
192
<ul>
193
    <li>Default: specific item</li>
194
    <li>Asks: Use the item type of the ___ as the authoritative item type (for determining circulation and fines rules, etc).</li>
195
    <li>Description: This preference determines whether the item type Koha uses for issuing rules will be an attribute of the bibliographic record or the item record. Most libraries refer to the item record for item types. It also determines if the item type icon appears on the OPAC search results. If you have the preference set to 'biblio record' then Koha displays the item type icon on the search results to the left of the result info.</li>
196
</ul></p>
197
198
<p><strong>itemcallnumber</strong>
199
<ul>
200
    <li>Default: 082ab</li>
201
    <li>Asks: Map the MARC subfield to an item's callnumber.</li>
202
    <li>Note: This can contain multiple subfields to look in; for instance 082ab would look in 082 subfields a and b.</li>
203
    <li>Description: This setting determines which MARC field will be used to determine the call number that will be entered into item records automatically (952$o). The value is set by providing the MARC field code (050, 082, 090, 852 are all common in MARC21) and the subfield codes without the delimiters ($a, $b would be ab).</li>
204
    <li>Examples: Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the item record: 852hi</li>
205
</ul></p>
206
207
<p><strong>marcflavour</strong>
208
<ul>
209
    <li>Default: MARC21</li>
210
    <li>Asks: Interpret and store MARC records in the ___ format.</li>
211
    <li>Description: This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used for encoding.</li>
212
    <li style="color: #990000;">Important: Changing the value of this preference will not convert your records from one MARC style to an other.</li>
213
</ul></p>
214
215
<p><strong>MARCOrgCode</strong>
216
<ul>
217
    <li>Default: OSt</li>
218
    <li>Asks: Fill in the MARC organization code ___ by default in new MARC21 records (leave blank to disable).</li>
219
    <li>Description: The MARC Organization Code is used to identify libraries with holdings of titles and more. Learn more and find your library's MARC21 code on the <a href="http://www.loc.gov/marc/organizations/orgshome.html">MARC Code list for Organizations</a> or in Canada on the <a href="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian Symbols Directory</a>.</li>
220
    <li>Note: This preference won't have any effect if your records are in UNIMARC.</li>
221
</ul></p>
222
223
<p><strong>NewItemsDefaultLocation</strong>
224
<ul>
225
    <li>Asks: When items are created, give them the temporary location of ___ (should be a location code, or blank to disable).</li>
226
</ul>
227
228
<p><strong>PrefillItem</strong>
229
<ul>
230
    <li>Default: the new item is not prefilled with last created item values.</li>
231
    <li>Asks: When a new item is added ___</li>
232
    <li>Description: This preference controls the behavior used when adding new items. Using the options here you can choose to have your next new item prefill with the values used in the last item was added to save time typing values or to have the item form appear completely blank. Using <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</a> you can control specifically which fields are prefilled.</li>
233
</ul></p>
234
235
<p><strong>SubfieldsToAllowForRestrictedBatchmod</strong>
236
<ul>
237
    <li>Asks: Define a list of subfields for which editing is authorized when <a href="http://manual.koha-community.org/[% helpVersion %]/en/patronpermissions.html#items_batchmod_restricted">items_batchmod_restricted</a> permission is enabled, separated by spaces. ___</li>
238
    <li>Examples:</li>
239
    <ul>
240
        <li>UNIMARC: "995$f 995$h 995$j"</li>
241
        <li>MARC21: "952$a 952$b 952$c"</li>
242
    </ul>
243
    <li>Description: This preference lets you define what fields can be edited via the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catalogtools.html#batchmodifyitems">batch item modification tool</a> if the items_batchmod_restricted permission is enabled.</li>
244
    <li>Note: The FA framework is excluded from the permission. If the pref is empty, no fields are restricted.</li>
245
</ul></p>
246
247
<p><strong>SubfieldsToAllowForRestrictedEditing</strong>
248
<ul>
249
    <li>Asks: Define a list of subfields for which editing is authorized when <a href="http://manual.koha-community.org/[% helpVersion %]/en/patronpermissions.html#edit_items_restricted">edit_items_restricted</a> permission is enabled, separated by spaces. ___</li>
250
    <li>Examples:</li>
251
    <ul>
252
        <li>UNIMARC: "995$f 995$h 995$j"</li>
253
        <li>MARC21: "952$a 952$b 952$c"</li>
254
    </ul>
255
    <li>Description: This preference lets you define what fields can be edited via cataloging if the edit_items_restricted permission is enabled</li>
256
    <li>Note: The Fast Add (FA) framework is excluded from the permission. If the pref is empty, no fields are restricted.</li>
257
</ul></p>
258
259
<p><strong>SubfieldsToUseWhenPrefill</strong>
260
<ul>
261
    <li>Asks: Define a list of subfields to use when prefilling items ___</li>
262
    <li style="color: #990000;">Important: Separate values with a space.</li>
263
    <li>Description: When the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#PrefillItem">PrefillItem</a> preference is set to prefill item values with those from the last added item, this preference can control which fields are prefilled (and which are not). Enter a space separated list of fields that you would like to prefill when adding a new item.</li>
264
</ul></p>
265
266
<p><strong>z3950NormalizeAuthor & z3950AuthorAuthFields</strong>
267
<ul>
268
    <li>Defaults: Don't copy & 701,702,700</li>
269
    <li>Asks: ___ authors from the UNIMARC ___ tags (separated by commas) to the correct author tags when importing a record using Z39.50.</li>
270
    <li>Description for z3950NormalizeAuthor: This preference allows for 'Personal Name Authorities' to replace authors as the bibliographic authority. This preference should only be considered by libraries using UNIMARC.</li>
271
    <li>Description for z3950AuthorAuthFields: This preference defines which MARC fields will be used for 'Personal Name Authorities' to replace authors as the bibliographic authorities. This preference only applies to those using UNIMARC encoding. The MARC fields selected here will only be used if 'z3950NormalizeAuthor' is set to "Copy". The default field are 700, 701, and 702.</li>
272
</ul></p>
273
274
<h3>Spine Labels</h3>
275
276
<p><strong>SpineLabelAutoPrint</strong>
277
<ul>
278
    <li>Default: don't</li>
279
    <li>Asks: When using the quick spine label printer, ___ automatically pop up a print dialog.</li>
280
</ul></p>
281
282
<p><strong>SpineLabelFormat</strong>
283
<ul>
284
    <li>Default: <itemcallnumber><copynumber></li>
285
    <li>Asks: Include the following fields on a quick-printed spine label: (Enter in columns from the biblio, biblioitems or items tables, surrounded by < and >.)</li>
286
</ul></p>
287
288
<p><strong>SpineLabelShowPrintOnBibDetails</strong>
289
<ul>
290
    <li>Default: Don't display</li>
291
    <li>Asks: ___ buttons on the bib details page to print item spine labels.</li>
292
</ul></p>
293
294
<p><strong>See the full documentation for Cataloging System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#catprefs">manual</a> (online).</strong></p>
295
296
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_circulation.tt (+824 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Circulation System Preferences</h1>
4
5
<h3>Batch Checkout</h3>
6
7
<p><strong>BatchCheckouts</strong>
8
<ul>
9
    <li>Default: Don't allow</li>
10
    <li>Asks: ___ batch checkouts</li>
11
</ul></p>
12
13
<p><strong>BatchCheckoutsValidCategories</strong>
14
<ul>
15
    <li>Asks: Patron categories allowed to checkout in a batch ___ (list of patron categories separated with a pipe '|')</li>
16
</ul></p>
17
18
<h3>Checkin Policy</h3>
19
20
<p><strong>AllowMultipleIssuesOnABiblio</strong>
21
<ul>
22
    <li>Default: Allow</li>
23
    <li>Asks: ___ patrons to check out multiple items from the same record.</li>
24
    <li>Description: If this preference is set to 'Allow' then patrons will be able to check out multiple copies of the same title at the same time. If it's set to "Don't allow" then patrons will only be allowed to check out one item attached to a record at a time. Regardless of the option chosen in this preference records with subscriptions attached will allow multiple check outs.</li>
25
    <li style="color: #990000;">Important: This will only effect records without a subscription attached.</li>
26
</ul></p>
27
28
<p><strong>BlockReturnOfWithdrawnItems</strong>
29
<ul>
30
    <li>Default: Block</li>
31
    <li>Asks: ___ returning of items that have been withdrawn.</li>
32
    <li>Description: This preference controls whether and item with a withdrawn status (952$0 in MARC21) can be checked in or not.</li>
33
</ul></p>
34
35
<p><strong>CalculateFinesOnReturn</strong>
36
<ul>
37
    <li>Default: Do</li>
38
    <li>Asks: ___ calculate and update overdue charges when an item is returned.</li>
39
    <li>Description: If this preference is set to "Do" and the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#finescronjob">fines cron job</a> is off then Koha will calculate fines only when items are returned. If you have the fines cron job on and this preference set to "Do" then this preference will calculate fines based on the cron (usually run nightly) and then again when you check the item in. This option is best for those who are doing hourly loans. If this preference is set to "Don't" then fines will only be accrued if the fines cron job is running.</li>
40
    <li style="color: #990000;">Important: If you are doing hourly loans then you should have this set to 'Do'.</li>
41
</ul></p>
42
43
<p><strong>RentalFeesCheckoutConfirmation</strong>
44
<ul>
45
    <li>Default: do not ask</li>
46
    <li>Asks: When checking out an item with rental fees, ___ for confirmation.</li>
47
    <li>Description: If you are charging rental fees for items this preference will make it so that you can show (or not show) a confirmation before checking out an item that will incur a rental charge.</li>
48
</ul></p>
49
50
<p><strong>UpdateNotForLoanStatusOnCheckin</strong>
51
<ul>
52
    <li>Asks: This is a list of value pairs. When an item is checked in, if the not for loan value on the left matches the items not for loan value it will be updated to the right-hand value. E.g. '-1: 0' will cause an item that was set to 'Ordered' to now be available for loan. Each pair of values should be on a separate line.</li>
53
</ul></p>
54
55
<h3>Checkout Policy</h3>
56
57
<p><strong>AgeRestrictionMarker</strong>
58
<ul>
59
    <li>Asks: Restrict patrons with the following target audience values from checking out inappropriate materials: ___</li>
60
    <li>Description: This preference defines certain keywords that will trigger Koha to restrict checkout based on age. These restrictions can be overridden by the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AgeRestrictionOverride">AgeRestrictionOverride</a> preference. Enter in this field a series of keywords separated by bar (|) with no spaces. For example PG|R|E|EC|Age| will look for PG followed by an age number, R folllowed by an age number, Age followed by an age number, and so on. These values can appear in any MARC field, but Library of Congress recommends the 521$a (Target Audience Note). Whatever field you decide to use you must map the word agerestriction in the biblioitems table to that field in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catadmin.html#kohamarcmapping">Koha to MARC Mapping</a>. When cataloging you can enter values like PG 13 or E 10 in the 521$a and Koha will then notify circulation librarians that the material may not be recommended for the patron based on their age.</li>
61
    <li style="color: #990000;">Important: You must map the word agerestriction in the biblioitems table to the MARC field where this information will appear via the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catadmin.html#kohamarcmapping">Koha to MARC Mapping</a> administration area.</li>
62
</ul></p>
63
64
<p><strong>AgeRestrictionOverride</strong>
65
<ul>
66
    <li>Default: Don't allow</li>
67
    <li>Asks: ___ staff to check out an item with age restriction.</li>
68
    <li>Description: When the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AgeRestrictionMarker">AgeRestrictionMarker</a> preference is set, Koha will try to warn circulation librarians before checking out an item that might have an age restriction listed in the MARC record. This preference asks if you would like the staff to be able to still check out these items to patrons under the age limit.</li>
69
</ul></p>
70
71
<p><strong>AllFinesNeedOverride</strong>
72
<ul>
73
    <li>Default: Require</li>
74
    <li>Asks: ___ staff to manually override all fines, even fines less than <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#noissuescharge">noissuescharge</a>.</li>
75
    <li>Description: This preference let's you decide if you want to always be warned that the patron has fines when checking out. If you have it set to 'Require' then no matter how much money the patron owes a message will pop up warning you that the patron owes money.</li>
76
</ul></p>
77
78
<p><strong>AllowFineOverride</strong>
79
<ul>
80
    <li>Default: Don't allow</li>
81
    <li>Asks: ___ staff to manually override and check out items to patrons who have more than <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#noissuescharge">noissuescharge</a> in fines.</li>
82
    <li>Description: This preference lets you decide if you staff can check out to patrons who owe more money than you usually let them carry on their account. If set to 'Allow' staff will be warned that the patrons owes money, but it won't stop the staff from checking out to the patron.</li>
83
</ul></p>
84
85
<p><strong>AllowItemsOnHoldCheckout</strong>
86
<ul>
87
    <li>Default: Don't allow</li>
88
    <li>Asks: ___ checkouts of items reserved to someone else. If allowed do not generate RESERVE_WAITING and RESERVED warning. This allows self checkouts for those items.</li>
89
    <li style="color: #990000;">Important: This system preference relates only to SIP based self checkout, not Koha's web based self checkout.</li>
90
    <li>Description: When this preference is set to 'Allow' patrons will be able to use your external self check machine to check out a book to themselves even if it's on hold for someone else. If you would like Koha to prevent people from checking out books that are on hold for someone else set this preference to "Don't allow."</li>
91
</ul></p>
92
93
<p><strong>AllowNotForLoanOverride</strong>
94
<ul>
95
    <li>Default: Allow</li>
96
    <li>Asks: ___ staff to override and check out items that are marked as not for loan.</li>
97
    <li>Description: This parameter is a binary setting which controls the ability of staff (patrons will always be prevented from checking these items out) to check out items that are marked as "not for loan". Setting it to "Allow" would allow such items to be checked out, setting it to "Don't allow" would prevent this. This setting determines whether items meant to stay in the library, such as reference materials, and other library resources can be checked out by patrons.</li>
98
</ul></p>
99
100
<p><strong>AllowRenewalLimitOverride</strong>
101
<ul>
102
    <li>Default: Allow</li>
103
    <li>Asks: ___ staff to manually override the renewal limit and renew a checkout when it would go over the renewal limit.</li>
104
    <li>Description: This preference is a binary setting which controls the ability of staff to override the limits placed on the number of times an item can be renewed. Setting it to "Allow" would allow such limits to be overridden, setting it to "Don't allow" would prevent this. This is a preference in which if it is set to "allow" it would allow the library staff to use their judgment for overriding the renew limit for special cases, setting it to "Don't allow" prevents an opportunity for abuse by the library staff.</li>
105
</ul></p>
106
107
<p><strong>AllowReturnToBranch</strong>
108
<ul>
109
    <li>Default: to any library</li>
110
    <li>Asks: Allow materials to be returned to ___</li>
111
    <li>Description: This preference lets the library system decide how they will accept returns. Some systems allow for items to be returned to any library in the system (the default value of this preference) others want to limit item returns to only specific branches. This preference will allow you to limit item returns (checkins) to the branch(es) set in the value.</li>
112
</ul></p>
113
114
<p><strong>AllowTooManyOverride</strong>
115
<ul>
116
    <li>Default: Allow</li>
117
    <li>Asks: ___ staff to override and check out items when the patron has reached the maximum number of allowed checkouts.</li>
118
    <li>Description: If this preference is set to "Allow" then staff all will be presented with an option to checkout more items to a patron than are normally allowed in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">Circulation and Fine Rules</a>. If this preference is set to "Don't allow" then no staff member will be able to check out more than the circulation limit.</li>
119
</ul></p>
120
121
<p><strong>AutomaticItemReturn</strong>
122
<ul>
123
    <li>Default: Do</li>
124
    <li>Asks: ___ automatically transfer items to their home branch when they are returned.</li>
125
    <li>Description: This preference is a binary setting which determines whether an item is returned to its home branch automatically or not. If set to "Don't", the staff member checking an item in at a location other than the item's home branch will be asked whether the item will remain at the non-home branch (in which case the new location will be marked as a holding location) or returned. Setting it to "Do" will ensure that items checked in at a branch other than their home branch will be sent to that home branch.</li>
126
</ul></p>
127
128
<p><strong>AutoRemoveOverduesRestrictions</strong>
129
<ul>
130
    <li>Default: Do not</li>
131
    <li>Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared automatically when all overdue items are returned by a patron.</li>
132
    <li>Description: Using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#noticetriggers">Overdue Notice/Status Triggers</a> you can restrict patrons after they receive an overdue notice. This preference lets you define whether Koha will automatically remove that restriction once the overdue items in question are returned or not.</li>
133
</ul></p>
134
135
<p><strong>CircControl</strong>
136
<ul>
137
    <li>Default: the library the item is from</li>
138
    <li>Asks: Use the checkout and fines rules of ___</li>
139
</ul></p>
140
141
<p><strong>ConsiderOnSiteCheckoutsAsNormalCheckouts</strong>
142
<ul>
143
    <li>Default: Consider</li>
144
    <li>Asks: ___ on-site checkouts as normal checkouts. If enabled, the number of checkouts allowed will be normal checkouts + on-site checkouts. If disabled, both values will be checked separately.</li>
145
    <li>Description: This preference allows you to decide if checkouts that are <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OnSiteCheckouts">OnSiteCheckouts</a> are counted toward the total checkouts a patron can have. You can also set your <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">circulation and fine rules</a> to allow only a certain number of normal and OnSite checkouts.</li>
146
</ul></p>
147
148
<p><strong>DefaultLongOverdueChargeValue</strong>
149
<ul>
150
    <li>Asks: Charge a lost item to the borrower's account when the LOST value of the item changes to ___</li>
151
    <li>Description: Leave this field empty if you don't want to charge the user for lost items. If you want the user to be charged enter the <a href="http://manual.koha-community.org/[% helpVersion %]/en/basicparams.html#lost">LOST authorized value</a> you are using in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#DefaultLongOverdueLostValue">DefaultLongOverdueLostValue</a> preference. This preference is used when the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#longoverduecron">longoverdue cron job</a> is called without the --charge parameter.</li>
152
</ul></p>
153
154
<p><strong>DefaultLongOverdueLostValue & DefaultLongOverdueDays</strong>
155
<ul>
156
    <li>Asks: By default, set the LOST value of an item to ___ when the item has been overdue for more than ___ days.</li>
157
    <li>Description: These preferences are used when the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#longoverduecron">longoverdue cron job</a> is called without the --lost parameter. It allows users to set the values of the longoverdue cron without having to edit the crontab. Setting the values to 1 and 30 for example will mark the item with the <a href="http://manual.koha-community.org/[% helpVersion %]/en/basicparams.html#lost">LOST authorized value</a> of 1 after the item is 30 days overdue.</li>
158
</ul></p>
159
160
<p><strong>HoldsInNoissuesCharge</strong>
161
<ul>
162
    <li>Default: Don't include</li>
163
    <li>Asks: ___ hold charges when summing up charges for noissuescharge.</li>
164
</ul></p>
165
166
<p><strong>HomeOrHoldingBranch</strong>
167
<ul>
168
    <li>Default: the library the item was checked out from</li>
169
    <li>Asks: Use the checkout and fines rules of ___</li>
170
    <li>Description: This preference does several things. If <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#CircControl">CircControl</a> is set to 'the library the item is from' then the <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">circulation and fines policies</a> will be determined by the item's library where HomeOrHoldingBranch chooses if item's home library is used or holding library is used. If <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#IndependentBranches">IndependentBranches</a> is set to 'Prevent' then the value of this preference is used in figuring out if the item can be checked out. If the item's home library does not match the logged in library, the item cannot be checked out unless you are a <a href="http://manual.koha-community.org/[% helpVersion %]/en/patronpermissions.html#patronpermsdefined">superlibrarian</a>.</li>
171
    <li style="color: #990000;">Important: It is not recommend that this setting be changed after initial setup of Koha because it will change the behavior of items already checked out.</li>
172
</ul></p>
173
174
<p><strong>InProcessingToShelvingCart</strong>
175
<ul>
176
    <li>Default: Don't move</li>
177
    <li>Asks: ___ items that have the location PROC to the location CART when they are checked in.</li>
178
    <li>Description: This preference is used to manage automatically changing item locations from processing (PROC) to the book cart (CART). A <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#proccartcron">cron job</a> needs to be set to run at specified intervals to age items from CART to the permanent shelving location. (For example, an hourly cron entry of cart_to_shelf.pl --hours 3 where --hours is the amount of time an item should spend on the cart before aging to its permanent location.) More information can be found in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/processinglocations.html">related chapter</a> in this manual.</li>
179
    <li>Note: If the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ReturnToShelvingCart">ReturnToShelvingCart</a> system preference is turned on, any newly checked-in item is also automatically put into the shelving cart, to be covered by the same script run.</li>
180
    <li style="color: #990000;">Important: Checkins with confirmed holds will not go into the shelving cart. If items on the shelving cart are checked out, the cart location will be cleared.</li>
181
</ul></p>
182
183
<p><strong>IssuingInProcess</strong>
184
<ul>
185
    <li>Default: Don't prevent</li>
186
    <li>Asks: ___ patrons from checking out an item whose rental charge would take them over the limit.</li>
187
    <li>Description: This preference determines if a patron can check items out if there is an overdue fine on the account and any of the materials the patron wishes to check out will potentially tip the account balance over the maximum fines policy the library has in place.</li>
188
    <li>Example: Your library has a $5 limit set for 'fines' (ie, after incurring $5 in fines, a patron can no longer check out items). A patron comes to the desk with 5 items to check out (4 books and a video) The patron has $4 in charges already on their account. One of the videos has a rental charge of $1, therefore making the total fines on the patron's account suddenly $5 (the limit).</li>
189
</ul></p>
190
191
<p><strong>IssueLostItem</strong>
192
<ul>
193
    <li>Default: display a message</li>
194
    <li>Asks: When issuing an item that has been marked as lost, ___.</li>
195
    <li>Description: This preference lets you define how library staff are notified that an item with a lost status is being checked out. This will help staff mark items as 'available' if you choose to 'display a message' or 'require confirmation.' If you choose to 'do nothing,' there will be no notification that the item being checked out is marked as 'lost.'</li>
196
</ul></p>
197
198
<p><strong>ManInvInNoissuesCharge</strong>
199
<ul>
200
    <li>Default: Include</li>
201
    <li>Asks: ___ MANUAL_INV charges when summing up charges for noissuescharge.</li>
202
    <li>Description: This preference lets you decide if charges entered as manual invoices are included when calculating the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#noissuescharge">noissuescharge</a>. If this is set to include then Koha will include all manual invoices when deciding if the patron owes too much money to check anything else out of the library. If it's set to Don't include then Koha will ignore all manual invoice charges when figuring out if the patron owes too much money to checkout additional materials.</li>
203
</ul></p>
204
205
<p><strong>maxoutstanding</strong>
206
<ul>
207
    <li>Default: 5</li>
208
    <li>Asks: Prevent patrons from making holds on the OPAC if they owe more than ___ USD in fines.</li>
209
</ul></p>
210
211
<p><strong>noissuescharge</strong>
212
<ul>
213
    <li>Default: 5</li>
214
    <li>Asks: Prevent patrons from checking out books if they have more than ___ USD in fines.</li>
215
    <li>Description: This preference is the maximum amount of money owed to the library before the user is banned from borrowing more items. Using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ManInvNoissuesCharge">ManInvInNoissuesCharge</a> and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#RentalsInNoissuesCharge">RentalsInNoissuesCharge</a> preferences you can control which types of charges are considered in this total. This also coincides with <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#maxoutstanding">maxoutstanding</a> that limits patrons from placing holds when the maximum amount is owed to the library.</li>
216
</ul></p>
217
218
<p><strong>NoIssuesChargeGuarantees</strong>
219
<ul>
220
    <li>Asks: Prevent a patron from checking out if the patron has guarantees owing in total more than ___ USD in fines.</li>
221
    <li>Description: Allows a library to prevent patrons from checking out items if his or her guarantees owe too much in fines.</li>
222
</ul></p>
223
224
<p><strong>NoRenewalBeforePrecision</strong>
225
<ul>
226
    <li>Default: date</li>
227
    <li>Asks: Calculate "No renewal before" based on ___.</li>
228
    <li>Note: Only relevant for loans calculated in days, hourly loans are not affected.</li>
229
    <li>Description: This preference allows you to control how the 'No renewal before" option in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">Circulation and fine rules</a> administration area.</li>
230
</ul></p>
231
232
<p><strong>OnSiteCheckouts</strong>
233
<ul>
234
    <li>Default: Disable</li>
235
    <li>Asks: ___ the on-site checkouts feature.</li>
236
    <li>Description: This preference lets you check out items that are 'not for loan' to patrons. A checkbox is added to the checkout screen when this preference is set to 'Enable' labeled 'On-site checkout'. This allows you to track who's using items that are normally not for loan or are in a closed stack setting.</li>
237
</ul></p>
238
239
<p><strong>OnSiteCheckoutsForce</strong>
240
<ul>
241
    <li>Default: Disable</li>
242
    <li>Asks: ___ the on-site for all cases (Even if a user is debarred, etc.).</li>
243
    <li>Description: This preference lets the staff override any restrictions a patron might have and check out items for use within the library. The <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OnSiteCheckouts">OnSiteCheckouts</a> preference must first be set to 'Enable' for this preference to be considered.</li>
244
</ul></p>
245
246
<p><strong>OverduesBlockCirc</strong>
247
<ul>
248
    <li>Default: Ask for confirmation</li>
249
    <li>Asks: ___ when checking out to a borrower that has overdues outstanding</li>
250
</ul></p>
251
252
<p><strong>OverduesBlockRenewing</strong>
253
<ul>
254
    <li>Default: allow renewing</li>
255
    <li>Asks: When a patron's checked out item is overdue, ___</li>
256
</ul></p>
257
258
<p><strong>OverdueNoticeBcc</strong>
259
<ul>
260
    <li>Asks: Send all notices as a BCC to this email address ___</li>
261
    <li>This preference makes it so that a librarian can get a copy of every notice sent out to patrons.</li>
262
    <li>Note: If you'd like more than one person to receive the blind copy you can simply enter in multiple email addresses separated by commas.</li>
263
    <li>Note: The name of this preference is misleading, it does not only send overdues, but all notices to the BCC address.</li>
264
</ul></p>
265
266
<p><strong>OverdueNoticeCalendar</strong>
267
<ul>
268
    <li>Default: Ignore calendar</li>
269
    <li>Asks: ___ when working out the period for overdue notices</li>
270
</ul></p>
271
272
<p><strong>PrintNoticesMaxLines</strong>
273
<ul>
274
    <li>Asks: Include up to ___ item lines in a printed overdue notice.</li>
275
    <li>Note: If the number of items is greater than this number, the notice will end with a warning asking the borrower to check their online account for a full list of overdue items.</li>
276
    <li>Note: Set to 0 to include all overdue items in the notice, no matter how many there are.</li>
277
    <li style="color: #990000;">Important: This preference only refers to the print notices, not those sent via email.</li>
278
</ul></p>
279
280
<p><strong>RenewalPeriodBase</strong>
281
<ul>
282
    <li>Default: the old due date of the checkout</li>
283
    <li>Asks: When renewing checkouts, base the new due date on ___</li>
284
</ul></p>
285
286
<p><strong>RenewalSendNotice</strong>
287
<ul>
288
    <li>Default: Don't send</li>
289
    <li>Asks: ____ a renewal notice according to patron checkout alert preferences.</li>
290
    <li>Description: If a patron has chosen to receive a check out notice in their messaging preferences and this preference is set to 'Send' then those patrons will also receive a notice when they renew materials. You will want to set up a new notice with the code of RENEWAL (if you don't already have it) with custom text for renewing items.</li>
291
    <li style="color: #990000;">Important: This preference requires that you have <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#EnhancedMessagingPreferences">EnhancedMessagingPreferences</a> set to 'Allow'</li>
292
</ul></p>
293
294
<p><strong>RentalsInNoissuesCharge</strong>
295
<ul>
296
    <li>Default: Include</li>
297
    <li>Asks: ___ rental charges when summing up charges for noissuescharge.</li>
298
    <li>Description: This preference lets you decide if rental charges are included when calculating the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#noissuescharge">noissuescharge</a>. If this is set to include then Koha will include all rental charges when deciding if the patron owes too much money to check anything else out of the library. If it's set to Don't include then Koha will ignore all rental charges when figuring out if the patron owes too much money to checkout additional materials.</li>
299
</ul></p>
300
301
<p><strong>RestrictionBlockRenewing</strong>
302
<ul>
303
    <li>Default: Allow</li>
304
    <li>Asks: If patron is restricted, ___ renewing of items.</li>
305
</ul></p>
306
307
<p><strong>ReturnBeforeExpiry</strong>i
308
<ul>
309
    <li>Default: Don't require</li>
310
    <li>Asks: ___ patrons to return books before their accounts expire (by restricting due dates to before the patron's expiration date).</li>
311
    <li>Description: This is preference may prevent a patron from having items checked out after their library card has expired. If this is set to "Require", then a due date of any checked out item can not be set for a date which falls after the patron's card expiration. If the setting is left "Don't require" then item check out dates may exceed the expiration date for the patron's library card.</li>
312
</ul></p>
313
314
<p><strong>ReturnToShelvingCart</strong>
315
<ul>
316
    <li>Default: Don't move</li>
317
    <li>Asks: ___ all items to the location CART when they are checked in.</li>
318
    <li>Description: More information can be found in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/processinglocations.html">related chapter</a> in this manual.</li>
319
</ul></p>
320
321
<p><strong>StaffSearchResultsDisplayBranch</strong>
322
<ul>
323
    <li>Default: the library the item is held by</li>
324
    <li>Asks: For search results in the staff client, display the branch of ___</li>
325
</ul></p>
326
327
<p><strong>TransfersMaxDaysWarning</strong>
328
<ul>
329
    <li>Default: 3</li>
330
    <li>Asks: Show a warning on the "Transfers to Receive" screen if the transfer has not been received ___ days after it is sent.</li>
331
    <li>Description: The TransferMaxDaysWarning preference is set at a default number of days. This preference allows for a warning to appear after a set amount of time if an item being transferred between library branches has not been received. The warning will appear in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/circreports.html#transferstoreceive">Transfers to Receive</a> report.</li>
332
</ul></p>
333
334
<p><strong>UseBranchTransferLimits & BranchTransferLimitsType</strong>
335
<ul>
336
    <li>Defaults: Don't enforce & collection code</li>
337
    <li>Asks: ___ branch transfer limits based on ___</li>
338
    <li>BranchTransferLimitsType Description: This parameter is a binary setting which determines whether items are transferred according to item type or collection code. This value determines how the library manager is able to restrict what items can be transferred between the branches.</li>
339
</ul></p>
340
341
<p><strong>useDaysMode</strong>
342
<ul>
343
    <li>Default: Don't include</li>
344
    <li>Asks: Calculate the due date using ___.</li>
345
    <li>Description: This preference controls how scheduled library closures affect the due date of a material. The 'the calendar to skip all days the library is closed' setting allows for a scheduled closure not to count as a day in the loan period, the 'circulation rules only' setting would not consider the scheduled closure at all, and 'the calendar to push the due date to the next open day' would only effect the due date if the day the item is due would fall specifically on the day of closure.</li>
346
    <li>Example: The library has put December 24th and 25th in as closures on the calendar. A book checked out by a patron has a due date of December 25th according to the circulation and fine rules. If this preference is set to 'circulation rules only' then the item will remain due on the 25th. If the preference is set to 'the calendar to push the due date to the next open day' then the due date will be December 26th. If the preference is set to 'the calendar to skip all days the library is closed' then the due date will be pushed to the 27th of December to accommodate for the two closed days.</li>
347
    <li>The calendar is defined on a branch by branch basis. To learn more about the calendar, check out the <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaltools.html#calholidays">'Calendar & Holidays'</a> section of this manual.</li>
348
</ul></p>
349
350
<p><strong>UseTransportCostMatrix</strong>
351
<ul>
352
    <li>Default: Don't use</li>
353
    <li>Asks: ___ Transport Cost Matrix for calculating optimal holds filling between branches.</li>
354
    <li>Description: If the system is configured to use the <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#transportcostmatrix">Transport cost matrix</a> for filling holds, then when attempting to fill a hold, the system will search for the lowest cost branch, and attempt to fill the hold with an item from that branch first. Branches of equal cost will be selected from randomly. The branch or branches of the next highest cost shall be selected from only if all the branches in the previous group are unable to fill the hold. The system will use the item's current holding branch when determining whether the item can fulfill a hold using the Transport Cost Matrix.</li>
355
</ul></p>
356
357
<h3>Course Reserves</h3>
358
359
<p><strong>UseCourseReserves</strong>
360
<ul>
361
    <li>Default: Don't use</li>
362
    <li>Asks: ___ course reserves</li>
363
    <li>Description: The Course Reserves module in Koha allows you to temporarily move items to 'reserve' and assign different circulation rules to these items while they are being used for a specific course.</li>
364
</ul></p>
365
366
<h3>Fines Policy</h3>
367
368
<p><strong>finesCalendar</strong>
369
<ul>
370
    <li>Default: not including the days the library is closed</li>
371
    <li>Asks: Calculate fines based on days overdue ___</li>
372
    <li>Description: This preference will determine whether or not fines will be accrued during instances when the library is closed. Examples include holidays, library in-service days, etc. Choosing "not including the days the library is closed" setting will enable Koha to access its <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaltools.html#calholidays">Calendar</a> module and be considerate of dates when the library is closed. To make use of this setting the administrator must first access Koha's calendar and mark certain days as "holidays" ahead of time.</li>
373
    <li>The calendar is defined on a branch by branch basis. To learn more about the calendar, check out the <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaltools.html#calholidays">'Calendar & Holidays'</a> section of this manual.</li>
374
</ul></p>
375
376
<p><strong>FinesIncludeGracePeriod</strong>
377
<ul>
378
    <li>Default: Include</li>
379
    <li>Asks: ___ the grace period when calculating the fine for an overdue item.</li>
380
    <li>Description: This preference lets you control how Koha calculates fines when there is a grace period. If you choose to include the grace period when calculating fines then Koha will charge for the days in the grace period should the item be overdue more than those days. If you choose not to include the grace period then Koha will only charge for the days overdue after the grace period.</li>
381
</ul></p>
382
383
<p><strong>finesMode</strong>
384
<ul>
385
    <li>Default: Calculate (but only for mailing to the admin)</li>
386
    <li>Asks: ___ fines</li>
387
    <li style="color: #990000;">Important: Requires that you have the fines cron job running (misc/cronjobs/fines.pl)</li>
388
</ul></p>
389
390
<p><strong>RefundLostItemFeeOnReturn</strong>
391
<ul>
392
    <li>Default: Refund</li>
393
    <li>Asks: ___ lost item fees charged to a borrower when the lost item is returned.</li>
394
    <li>Description: When an item is marked lost in Koha the system charges the patron the replacement fee for the item. This preference lets you control how Koha handles returns of these items. By default when an item that was previously marked lost is checked in Koha refunds the patron the replacement fee. Change this preference to "Don't refund" if you would like Koha to not refund the replacement fee.</li>
395
</ul></p>
396
397
<p><strong>WhenLostChargeReplacementFee</strong>
398
<ul>
399
    <li>Default: Charge</li>
400
    <li>Asks: ___ the replacement price when a patron loses an item.</li>
401
    <li>Description: This preference lets you tell Koha what to do with an item is marked lost. If you want Koha can 'Charge' the patron the replacement fee listed on the item they lost or it can do nothing in reference to the patron and just mark the item lost in the catalog.</li>
402
</ul></p>
403
404
<p><strong>WhenLostForgiveFine</strong>
405
<ul>
406
    <li>Default: Don't forgive</li>
407
    <li>Asks: ___ the fines on an item when it is lost.</li>
408
    <li>Description: This preference allows the library to decide if fines are charged in addition to the replacement fee when an item is marked as lost. If this preference is set to 'Forgive' then the patron won't be charged fines in addition to the replacement fee.</li>
409
</ul></p>
410
411
<h3>Holds Policy</h3>
412
413
<p><strong>AllowHoldDateInFuture</strong>
414
<ul>
415
    <li>Default: Allow</li>
416
    <li>Asks: ___ hold requests to be placed that do not enter the waiting list until a certain future date.</li>
417
</ul></p>
418
419
<p><strong>AllowHoldItemTypeSelection</strong>
420
<ul>
421
    <li>Default: Don't allow</li>
422
    <li>Asks: ___ hold fulfillment to be limited by itemtype.</li>
423
</ul></p>
424
425
<p><strong>AllowHoldsOnDamagedItems</strong>
426
<ul>
427
    <li>Default: Allow</li>
428
    <li>Asks: ___ hold requests to be placed on damaged items.</li>
429
    <li>Description: This parameter is a binary setting which controls whether or not hold requests can be placed on items that are marked as "damaged" (items are marked as damaged by editing subfield 4 on the item record). Setting this value to "Don't allow" will prevent anyone from placing a hold on such items, setting it to "Allow" will allow it. This preference is important because it determines whether or not a patron can place a request for an item that might be in the process of being repaired or not in good condition. The library may wish to set this to "Don't allow" if they were concerned about their patrons not receiving the item in a timely manner or at all (if it is determined that the item is beyond repair). Setting it to "Allow" would allow a patron to place a hold on an item and therefore receive it as soon as it becomes available.</li>
430
</ul></p>
431
432
<p><strong>AllowHoldsOnPatronsPossessions</strong>
433
<ul>
434
    <li>Default: Allow</li>
435
    <li>Asks: ____ a patron to place a hold on a record where the patron already has one or more items attached to that record checked out.</li>
436
    <li>Description: By setting to "Don't allow," you can prevent patrons from placing holds on items they already have out, thus preventing them from blocking anyone else from getting an item. </li>
437
</ul></p>
438
439
<p><strong>AllowHoldPolicyOverride</strong>
440
<ul>
441
    <li>Default: Allow</li>
442
    <li>Asks: ___ staff to override hold policies when placing holds.</li>
443
    <li>Description: This preference is a binary setting which controls whether or not the library staff can override the circulation and fines rules as they pertain to the placement of holds. Setting this value to "Don't allow" will prevent anyone from overriding, setting it to "Allow" will allow it. This setting is important because it determines how strict the libraries rules for placing holds are. If this is set to "Allow", exceptions can be made for patrons who are otherwise normally in good standing with the library, but there is opportunity for the staff to abuse this function. If it is set to "Don't allow", no abuse of the system is possible, but it makes the system entirely inflexible in respect to holds.</li>
444
</ul></p>
445
446
<p><strong>AllowRenewalIfOtherItemsAvailable</strong>
447
<ul>
448
    <li>Default: Don't allow</li>
449
    <li>Asks: ___ a patron to renew an item with unfilled holds if other available items can fill that hold.</li>
450
</ul></p>
451
452
<p><strong>AutoResumeSuspendedHolds</strong>
453
<ul>
454
    <li>Default: Allow</li>
455
    <li>Asks: ___ suspended holds to be automatically resumed by a set date.</li>
456
    <li>Description: If this preference is set to 'Allow' then all suspended holds will be able to have a date at after which they automatically become unsuspended. If you have this preference set to 'Allow' you will also need the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#unsuspendholdcron">Unsuspend Holds</a> cron job running.</li>
457
    <li style="color: #990000;">Important: The holds will become unsuspended the date after that entered by the patron.<li>
458
</ul></p>
459
460
<p><strong>canreservefromotherbranches</strong>
461
<ul>
462
    <li>Default: Allow</li>
463
    <li>Asks: ___ a user from one library to place a hold on an item from another library</li>
464
    <li>Description: This preference is a binary setting which determines whether patrons can place holds on items from other branches. If the preference is set to "Allow" patrons can place such holds, if it is set to "Don't allow" they cannot. This is an important setting because it determines if users can use Koha to request items from another branch. If the library is sharing an installation of Koha with other independent libraries which do not wish to allow interlibrary borrowing it is recommended that this parameter be set to "Don't allow".</li>
465
</ul></p>
466
467
<p><strong>ConfirmFutureHolds</strong>
468
<ul>
469
    <li>Default: 0</li>
470
    <li>Asks: Confirm future hold requests (starting no later than ___ days from now) at checkin time.</li>
471
    <li>Description: When confirming a hold at checkin time, the number of days in this preference is taken into account when deciding which holds to show alerts for. This preference does not interfere with renewing, checking out or transferring a book.</li>
472
    <li>Note: This number of days will be used too in calculating the default end date for the Holds to pull-report. But it does not interfere with issuing, renewing or transferring books.</li>
473
    <li style="color: #990000;">Important: This preference is only looked at if you're allowing hold dates in the future with <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AllowHoldDateInFuture">AllowHoldDateInFuture</a> or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</a></li>
474
</ul></p>
475
476
<p><strong>decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue, decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses</strong>
477
<ul>
478
    <li>Asks: ___ the reduction of loan period ___ to days for items with more than ___ holds ___ . Ignore items with the following statuses when counting items ___</li>
479
    <li>decreaseLoanHighHolds default: Don't enable</li>
480
    <li>decreaseLoanHighHoldsControl default: on the record</li>
481
    <li>Description: These preferences let you change the loan length for items that have many holds on them. This will not effect items that are already checked out, but items that are checked out after the decreaseLoanHighHoldsValue is met will only be checked out for the number of days entered in the decreaseLoanHighHoldsDuration preference.</li>
482
</ul></p>
483
484
<p><strong>DisplayMultiPlaceHold</strong>
485
<ul>
486
    <li>Default: Don't enable</li>
487
    <li>Asks: ___ the ability to place holds on multiple biblio from the search results</li>
488
</ul></p>
489
490
<p><strong>emailLibrarianWhenHoldIsPlaced</strong>
491
<ul>
492
    <li>Default: Don't enable</li>
493
    <li>Asks: ___ sending an email to the Koha administrator email address whenever a hold request is placed.</li>
494
    <li>Description: This preference enables Koha to email the library staff whenever a patron requests an item to be held. While this function will immediately alert the librarian to the patron's need, it is extremely impractical in most library settings. In most libraries the hold lists are monitored and maintained from a separate interface. That said, many libraries that allow on shelf holds prefer to have this preference turned on so that they are alerted to pull an item from the shelf.</li>
495
    <li style="color: #990000;">Important: In order for this email to send you must have a <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#notices">notice</a> template with the code of HOLDPLACED</li>
496
    <li style="color: #990000;">Important: This notice will only be sent if the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.hml#msgqueuecron">process_message_queue.pl cronjob</a> being run periodically to send the messages.</li>
497
</ul></p>
498
499
<p><strong>ExpireReservesMaxPickUpDelay</strong>
500
<ul>
501
    <li>Default: Don't allow</li>
502
    <li>Asks: ___ holds to expire automatically if they have not been picked by within the time period specified in <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</a></li>
503
    <li>Description: If set to 'allow' this will cancel holds that have been waiting for longer than the number of days specified in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</a> system preference. Holds will only be cancelled if the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#expiredholdscron">Expire Holds cron job</a> is running.</li>
504
</ul></p>
505
506
<p><strong>ExpireReservesMaxPickUpDelayCharge</strong>
507
<ul>
508
    <li>Default: 0</li>
509
    <li>Asks: If using <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</a>, charge a borrower who allows his or her waiting hold to expire a fee of ___ USD</li>
510
    <li>Description: If you are expiring holds that have been waiting too long you can use this preference to charge the patron for not picking up their hold. If you don't charge patrons for items that aren't picked up you can leave this set to the default which is 0. Holds will only be cancelled and charged if the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#expiredholdscron">Expire Holds cron job</a> is running.</li>
511
</ul></p>
512
513
<p><strong>ExpireReservesOnHolidays</strong>
514
<ul>
515
    <li>Default: Allow</li>
516
    <li>Asks: ___ expired holds to be cancelled on days the library is closed.</li>
517
</ul></p>
518
519
<p><strong>LocalHoldsPriority, LocalHoldsPriorityPatronControl, LocalHoldsPriorityItemControl</strong>
520
<ul>
521
    <li>Asks: ___ priority for filling holds to patrons whose ___ matches the item's ___</li>
522
    <li>Description: This feature will allow libraries to specify that, when an item is returned, a local hold may be given priority for fulfillment even though it is of lower priority in the list of unfilled holds.</li>
523
</ul></p>
524
525
<p><strong>maxreserves</strong>
526
<ul>
527
    <li>Default: 50</li>
528
    <li>Asks: Patrons can only have ___ holds at once.</li>
529
</ul></p>
530
531
<p><strong>OPACAllowHoldDateInFuture</strong>
532
<ul>
533
    <li>Default: Allow</li>
534
    <li>Asks: ___ patrons to place holds that don't enter the waiting list until a certain future date.</li>
535
</ul></p>
536
537
<p><strong>OPACAllowUserToChooseBranch</strong>
538
<ul>
539
    <li>Default: Allow</li>
540
    <li>Asks: ___ a user to choose the branch to pick up a hold from.</li>
541
    <li>Description: Changing this preference will not prevent staff from being able to transfer titles from one branch to another to fill a hold, it will only prevent patrons from saying they plan on picking a book up at a branch other than their home branch.</li>
542
</ul></p>
543
544
<p><strong>ReservesControlBranch</strong>
545
<ul>
546
    <li>Default: item's home library</li>
547
    <li>Asks: Check the ___ to see if the patron can place a hold on the item.</li>
548
</ul></p>
549
550
<p><strong>ReservesMaxPickUpDelay</strong>
551
<ul>
552
    <li>Default: 7</li>
553
    <li>Asks: Mark a hold as problematic if it has been waiting for more than ___ days.</li>
554
    <li>Description: This preference (based on calendar days, not the <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaltools.html#calholidays">Koha holiday calendar</a>) puts an expiration date on an item a patron has on hold. After this expiration date the staff will have the option to release the unclaimed hold which then may be returned to the library shelf or issued to the next patron on the item's hold list. Items that are 'expired' by this preference are moved to the 'Holds Over' tab on the '<a href="http://manual.koha-community.org/[% helpVersion %]/en/circreports.html#holdspickup">Holds Awaiting Pickup</a>' report.</li>
555
</ul></p>
556
557
<p><strong>ReservesNeedReturns</strong>
558
<ul>
559
    <li>Default: Don't automatically</li>
560
    <li>Asks: ___ mark holds as found and waiting when a hold is placed specifically on them and they are already checked in.</li>
561
    <li>Description: This preference refers to 'item specific' holds where the item is currently on the library shelf. This preference allows a library to decide whether an 'item specific' hold is marked as "Waiting" at the time the hold is placed or if the item will be marked as "Waiting" after the item is checked in. This preference will tell the patron that their item is 'Waiting' for them at their library and ready for check out.</li>
562
</ul></p>
563
564
<p><strong>StaticHoldsQueueWeight, HoldsQueueSkipClosed & RandomizeHoldsQueueWeight</strong>
565
<ul>
566
    <li>StaticHoldsQueueWeight Default: 0</li>
567
    <li>HoldsQueueSkipClosed Default: open or closed</li>
568
    <li>RandomizeHoldsQueueWeight Default: in that order</li>
569
    <li>Asks: Satisfy holds using items from the libraries ___ (as branchcodes, separated by commas; if empty, uses all libraries) when they are ___ ___.</li>
570
    <li>Descriptions: These preferences control how the <a href="http://manual.koha-community.org/[% helpVersion %]/en/circreports.html#holdsqueue">Holds Queue report</a> is generated using a <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#buildholdscron">cron job</a>. If you do not want all of your libraries to participate in the on-shelf holds fulfillment process, you should list the the libraries that *do* participate in the process here by inputting all the participating library's branchcodes, separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ). By default, the holds queue will be generated such that the system will first attempt to hold fulfillment using items already at the pickup library if possible. If there are no items available at the pickup library to fill a hold, build_holds_queue.pl will then use the list of libraries defined in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is disabled ( which it is by default ), the script will assign fulfillment requests in the order the branches are placed in the StaticHoldsQueueWeight system preference. For example, if your system has three libraries, of varying sizes ( small, medium and large ) and you want the burden of holds fulfillment to be on larger libraries before smaller libraries, you would want StaticHoldsQueueWeight to look something like "LRG,MED,SML". If you want the burden of holds fulfillment to be spread out equally throughout your library system, simply enable RandomizeHoldsQueueWeight. When this system preference is enabled, the order in which libraries will be requested to fulfill an on-shelf hold will be randomized each time the list is regenerated. Leaving StaticHoldsQueueWeight empty is contraindicated at this time. Doing so will cause the build_holds_queue script to ignore RandomizeHoldsQueueWeight, causing the script to request hold fulfillment not randomly, but by alphabetical order.</li>
571
    <li style="color: #990000;">Important: The <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#transportcostmatrix">Transport Cost Matrix</a> takes precedence in controlling where holds are filled from, if the matrix is not used then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix simply set your <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#UseTransportCostMatrix">UseTransportCostMatrix</a> preference to 'Use'</li>
572
</ul></p>
573
574
<p><strong>SuspendHoldsIntranet</strong>
575
<ul>
576
    <li>Default: Allow</li>
577
    <li>Asks: ___ holds to be suspended from the intranet.</li>
578
    <li>Description: The holds suspension feature can be turned on and off in the staff client by altering this system preference. If this is set to 'allow' you will want to set the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</a> system preference.</li>
579
</ul></p>
580
581
<p><strong>SuspendHoldsOpac</strong>
582
<ul>
583
    <li>Default: Allow</li>
584
    <li>Asks: ___ holds to be suspended from the OPAC.</li>
585
    <li>Description: The holds suspension feature can be turned on and off in the OPAC by altering this system preference. If this is set to 'allow' you will want to set the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</a> system preference.</li>
586
</ul></p>
587
588
<p><strong>TransferWhenCancelAllWaitingHolds</strong>
589
<ul>
590
    <li>Default: Don't transfer</li>
591
    <li>Asks: ___ items when cancelling all waiting holds.</li>
592
    <li>Description: When TransferWhenCancelAllWaitingHolds is set to "Don't transfer", no branch transfer records are created. Koha will not allow the holds to be transferred, because that would orphan the items at the library where the holds were awaiting pickup, without any further instruction to staff as to what items are at the library or where they need to go. When that system preference set to "Transfer", branch transfers are created, so the holds may be cancelled.</li>
593
</ul></p>
594
595
<h3>Interface</h3>
596
597
<p><strong>AllowAllMessageDeletion</strong>
598
<ul>
599
    <li>Default: Don't allow</li>
600
    <li>Asks: ___ staff to delete messages added from other libraries.</li>
601
</ul></p>
602
603
<p><strong>AllowOfflineCirculation</strong>
604
<ul>
605
    <li>Default: Do not enable</li>
606
    <li>Asks: ___ offline circulation on regular circulation computers.</li>
607
    <li>Description: Setting this preference to 'Enable' allows you to use the Koha interface for <a href="http://manual.koha-community.org/[% helpVersion %]/en/offlinecirc.html">offline circulation</a>. This system preference does not affect the <a href="http://manual.koha-community.org/[% helpVersion %]/en/offlinecirc.html#firefoxofflinecirc">Firefox plugin</a> or the <a href="http://manual.koha-community.org/[% helpVersion %]/en/offlinecirc.html#windowsofflinecirc">desktop application</a>, any of these three options can be used for offline circulation without effecting the other.</li>
608
</ul></p>
609
610
<p><strong>AudioAlerts</strong>
611
<ul>
612
    <li>Default: Don't enable</li>
613
    <li>Asks: ___ audio alerts for events defined in the audio alerts section of administration.</li>
614
    <li>Important: This feature is not supported by all browsers. Requires an HTML5 compliant browser.</li>
615
</ul></p>
616
617
<p><strong>CircAutocompl</strong>
618
<ul>
619
    <li>Default: Try</li>
620
    <li>Asks: ___ to automatically fill in the member when entering a patron search on the circulation screen.</li>
621
    <li>Description: This preference is a binary setting which determines whether auto-completion of fields is enabled or disabled for the circulation input field. Setting it to "Try" would enable a staff member to begin typing a name or other value into the field and have a menu pop up with suggestions for completing it. Setting it to "Don't try" would disable this feature. This preference can make staff members' jobs easier or it could potentially slow down the page loading process.</li>
622
</ul></p.
623
624
<p><strong>CircAutoPrintQuickSlip</strong>
625
<ul>
626
    <li>Default: open a print quick slip window</li>
627
    <li>Asks: When an empty barcode field is submitted in circulation ___</li>
628
    <li>Description: If this preference is set to open a quick slip (<a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#existingnotices">ISSUEQSLIP</a>) or open a slip (<a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#existingnotices">ISSUESLIP</a>) for printing it will eliminate the need for the librarian to click the print button to generate a checkout receipt for the patron they're checking out to. If the preference is set to clear the screen then "checking out" an empty barcode will clear the screen of the patron you were last working with.</li>
629
</ul></p>
630
631
<p><strong>FilterBeforeOverdueReport</strong>
632
<ul>
633
    <li>Default: Don't require</li>
634
    <li>Asks: ___ staff to choose which checkouts to show before running the overdues report.</li>
635
    <li>Description: Koha's overdue report shows you all of the overdue items in your library system. If you have a large library system you'll want to set this preference to 'Require' to force those running the report to first limit the data generated to a branch, date range, patron category or other such filter. Requiring that the report be filtered before it's run prevents your staff from running a system heavy report and slowing down other operations in the system.</li>
636
</ul></p>
637
638
<p><strong>FineNotifyAtCheckin</strong>
639
<ul>
640
    <li>Default: Don't notify</li>
641
    <li>Asks: ___ librarians of overdue fines on the items they are checking in.</li>
642
    <li>Description: With this preference set to 'Notify' all books that have overdue fines owed on them will pop up a warning when checking them in. This warning will need to acknowledged before you can continue checking items in. With this preference set to 'Don't notify,' you will still see fines owed on the patron record, you just won't have an additional notification at check in.</li>
643
</ul></p>
644
645
<p><strong>DisplayClearScreenButton</strong>
646
<ul>
647
    <li>Default: Show</li>
648
    <li>Asks: ___ a button to clear the current patron from the screen on the circulation screen.</li>
649
</ul></p>
650
651
<p><strong>ExportRemoveFields</strong>
652
<ul>
653
    <li>Asks: The following fields should be excluded from the patron checkout history CSV or iso2709 export ___</li>
654
    <li>Description: This space separated list of fields (e.g. 100a 245b) will automatically be excluded when exporting the patron's current checkout history.</li>
655
</ul></p>
656
657
<p><strong>ExportWithCsvProfile</strong>
658
<ul>
659
    <li>Asks: Use the ___ CSV profile when exporting patron checkout history</li>
660
    <li>Description: Use this preference to define which <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaltools.html#csvprofiles">CSV profile</a> should be used when exporting patron's current checkout data. Enter the CSV Profile name as the value for this preference. If this preference is left blank you will not be able to export the patron's current checkout summary.</li>
661
</ul></p>
662
663
<p><strong>HoldsToPullStartDate</strong>
664
<ul>
665
    <li>Default: 2</li>
666
    <li>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago.</li>
667
    <li>Description: The <a href="http://manual.koha-community.org/[% helpVersion %]/en/circreports.html#holdspull">Holds to Pull</a> report in circulation defaults to filtering holds placed 2 days ago. This preference allows you to set this default filter to any number of days.</li>
668
</ul></p>
669
670
<p><strong>itemBarcodeFallbackSearch</strong>
671
<ul>
672
    <li>Default: Don't enable</li>
673
    <li>Asks: ___ the automatic use of a keyword catalog search if the phrase entered as a barcode on the checkout page does not turn up any results during an item barcode search.</li>
674
    <li>Description: Sometimes libraries want to checkout using something other than the barcode. Enabling this preference will do a keyword search of Koha to find the item you're trying to check out. You can use the call number, barcode, part of the title or anything you'd enter in the keyword search when this preference is enabled and Koha will ask you which item you're trying to check out.</li>
675
    <li style="color: #990000;">Important: While you're not searching by barcode a barcode is required on every title you check out. Only titles with barcodes will appear in the search results.</li>
676
</ul></p>
677
678
<p><strong>itemBarcodeInputFilter</strong>
679
<ul>
680
    <li>Default: Don't filter</li>
681
    <li>Asks: ___ scanned item barcodes.</li>
682
</ul></p>
683
684
<p><strong>NoticeCSS</strong>
685
<ul>
686
    <li>Asks: Include the stylesheet at ___ on Notices.</li>
687
    <li style="color: #990000;">Important: This should be a complete URL, starting with http://</li>
688
    <li>Description: If you would like to style your notices with a consistent set of fonts and colors you can use this preference to point Koha to a stylesheet specifically for your notices.</li>
689
</ul></p>
690
691
<p><strong>numReturnedItemsToShow</strong>
692
<ul>
693
    <li>Default: 20</li>
694
    <li>Asks : Show the ___ last returned items on the checkin screen.</li>
695
</ul></p>
696
697
<p><strong>previousIssuesDefaultSortOrder</strong>
698
<ul>
699
    <li>Default: earliest to latest</li>
700
    <li>Asks: Sort previous checkouts on the circulation page from ___ due date.</li>
701
</ul></p>
702
703
<p><strong>RecordLocalUseOnReturn</strong>
704
<ul>
705
    <li>Default: Don't record</li>
706
    <li>Asks: ___ local use when an unissued item is checked in.</li>
707
    <li>Description: When this preference is set to "Don't record" you can record local use of items by checking items out to the statistical patron. With this preference set to "Record" you can record local use by checking out to the statistical patron and/or by checking in a book that is not currently checked out.</li>
708
</ul></p>
709
710
<p><strong>ShowAllCheckins</strong>
711
<ul>
712
    <li>Default: Do not show</li>
713
    <li>Asks: ___ all items in the "Checked-in items" list, even items that were not checked out.</li>
714
    <li>Description: When items that are not currently checked out are checked in they don't show on the list of checked in items. This preference allows you to choose how you'd like the log of checked in items displays.</li>
715
</ul></p>
716
717
<p><strong>SpecifyDueDate</strong>
718
<ul>
719
    <li>Default: Allow</li>
720
    <li>Asks: ___ staff to specify a due date for a checkout.</li>
721
    <li>Due dates are calculated using your circulation and fines rules, but staff can override that if you allow them to specify a due date at checkout.</li>
722
    <li>Description: This preference allows for circulation staff to change a due date from the automatic due date to another calendar date. This option would be used for circumstances in which the due date may need to be decreased or extended in a specific circumstance. The "Allow" setting would allow for this option to be utilized by staff, the "Don't allow" setting would bar staff from changing the due date on materials.</li>
723
</ul></p>
724
725
<p><strong>SpecifyReturnDate</strong>
726
<ul>
727
    <li>Default: Don't allow</li>
728
    <li>Asks: ___ staff to specify a return date for a check in.</li>
729
    <li>Description: This preference lets you decide if staff can specify an arbitrary return date when checking in items.</li>
730
</ul></p>
731
732
<p><strong>todaysIssuesDefaultSortOrder</strong>
733
<ul>
734
    <li>Default: latest to earliest</li>
735
    <li>Asks: Sort today's checkouts on the circulation page from ___ due date.</li>
736
</ul></p>
737
738
<p><strong>UpdateTotalIssuesOnCirc</strong>
739
<ul>
740
    <li>Default: Do not</li>
741
    <li>Asks: ___ update a bibliographic record's total issues count whenever an item is issued</li>
742
    <li>Description: Koha can track the number of times and item is checked out and store that on the item record in the database. This information is not stored by default. Setting this preference to 'Do' will tell Koha to track that info every time the item is checked out in real time. Otherwise you could use the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#updateissuescron">cron job</a> to have Koha update that field nightly.</li>
743
</ul></p>
744
745
<p><strong>WaitingNotifyAtCheckin</strong>
746
<ul>
747
    <li>Default: Don't notify</li>
748
    <li>Asks: ___ librarians of waiting holds for the patron whose items they are checking in.</li>
749
    <li>Description: When checking in books you can choose whether or not to have a notice pop up if the patron who returned the book has a hold waiting for pick up. If you choose 'Notify' for WaitingNotifyAtCheckin then every time a hold is found for the patron who had the book out last a message will appear on your check in screen.</li>
750
</ul></p>
751
752
<h3>Self Checkout</h3>
753
754
<p><strong>AllowSelfCheckReturns</strong>
755
<ul>
756
    <li>Default: Don't allow</li>
757
    <li>Asks: ___ patrons to return items through web-based self checkout system.</li>
758
    <li>Description: This preference is used to determine if you want patrons to be allowed to return items through your self check machines. By default Koha's self check interface is simply for checking items out.</li>
759
</ul></p>
760
761
<p><strong>AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass</strong>
762
<ul>
763
    <li style="color: #990000;">Important: Most libraries will want to leave this set to 'Don't allow.' This preference turns off the requirement to log into the self checkout machine with a staff username and password by storing the username and password for automatic login.</li>
764
    <li>AutoSelfCheckAllowed Default: Don't allow</li>
765
    <li>Asks: ___ the web-based self checkout system to automatically login with this staff login ___ and this password ___ .</li>
766
    <li>AutoSelfCheckID Value: The username of a staff patron with 'circulate' <a href="http://manual.koha-community.org/[% helpVersion %]/en/patronpermissions.html">permissions</a>.</li>
767
    <li>AutoSelfCheckPass Value: The password of a staff patron with 'circulate' <a href="http://manual.koha-community.org/[% helpVersion %]/en/patronpermissions.html">permissions</a>.</li>
768
</ul></p>
769
770
<p><strong>SCOUserCSS</strong>
771
<ul>
772
    <li>Asks: Include the following CSS on all pages in the web-based self checkout</li>
773
    <li>Description: The CSS entered in this preference will be used on all of your Koha self checkout screens.</li>
774
</ul>
775
776
<p><strong>SCOUserJS</strong>
777
<ul>
778
    <li>Asks: Include the following JavaScript on all pages in the web-based self checkout</li>
779
    <li>Description: The JavaScript entered in this preference will effect all of your Koha self checkout screens.</li>
780
</ul></p>
781
782
<p><strong>SelfCheckHelpMessage</strong>
783
<ul>
784
    <li>Asks: Include the following HTML in the Help page of the web-based self checkout system</li>
785
    <li>Description: Clicking the 'Help' link in the top right of the self checkout interface opens up a three step process for using the self check interface. Adding HTML to this system preference will print that additional help text above what's already included.</li>
786
</ul></p>
787
788
<p><strong>SelfCheckoutByLogin</strong>
789
<ul>
790
    <li>Default: Barcode</li>
791
    <li>Asks: Have patrons login into the web-based self checkout system with their ___</li>
792
    <li>Description: This preference lets you decide how your patrons will log in to the self checkout machine. Barcode is the patron's card number and their username and password is set using the opac/staff username and password fields on the patron record.</li>
793
</ul></p>
794
795
<p><strong>SelfCheckReceiptPrompt</strong>
796
<ul>
797
    <li>Default: Show</li>
798
    <li>Asks: ___ the print receipt popup dialog when self checkout is finished.</li>
799
    <li>Description: This preference controls whether a prompt shows up on the web based self check out when the patron clicks the 'Finish' button.</li>
800
</ul></p>
801
802
<p><strong>SelfCheckTimeout</strong>
803
<ul>
804
    <li>Default: 120</li>
805
    <li>Asks: Time out the current patron's web-based self checkout system login after ___ seconds.</li>
806
    <li>Description: After the machine is idle for the time entered in this preference the self check out system will log out the current patron and return to the starting screen.</li>
807
</ul></p>
808
809
<p><strong>ShowPatronImageInWebBasedSelfCheck</strong>
810
<ul>
811
    <li>Default: Don't show</li>
812
    <li>Asks: ___ the patron's picture (if one has been added) when they use the web-based self checkout.</li>
813
</ul></p>
814
815
<p><strong>WebBasedSelfCheck</strong>
816
<ul>
817
    <li>Default: Don't enable</li>
818
    <li>Asks: ___ the web-based self checkout system.</li>
819
    <li>Enabling this preference will allow access to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/selfcheckout.html">self checkout module</a> in Koha.</li>
820
</ul></p>
821
822
<p><strong>See the full documentation for Circulation System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#circprefs">manual</a> (online).</strong></p>
823
824
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_enhanced_content.tt (+458 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Enhanced Content System Preferences</h1>
4
5
<p style="color: #990000;">Important: Always read the terms of service associated with external data sources to be sure that you are using the products within the allowed limits.</p>
6
<p>Note: You cannot have more than one service for cover images (including local cover images) set up. If you set up more than one you will get multiple cover images. Instead choose only one source for cover images.</p>
7
8
<h3>All</h3>
9
10
<p><strong>FRBRizeEditions</strong>
11
<ul>
12
    <li>Default: Don't show</li>
13
    <li>Asks: ___ other editions of an item on the staff client</li>
14
    <li>Description: Using the rules set forth in the Functional Requirements for Bibliographic records, this option, when enabled, pulls all editions of the same title available in your collection regardless of material type. Items will appear under an 'Editions' tab on the detail page for the title in question.. According to Libraries Unlimited's Online Dictionary for Library and Information Science (<a href="http://lu.com/odlis/">http://lu.com/odlis/</a>), FRBRizing the catalog involves collating MARC records of similar materials. FRBRization brings together entities (sets of Works, Expressions, or Manifestations), rather than just sets of Items. It can aid patrons in selecting related items, expressions, and manifestations that will serve their needs. When it is set to "Show", the OPAC will query one or more ISBN web services for associated ISBNs and display an Editions tab on the details pages. Once this preference is enabled, the library must select one of the ISBN options (<a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ThingsISBN">ThingISBN</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#XISBN">XISBN</a>). This option is only for the Staff Client; the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACFRBRizeEditions">OPACFRBRizeEditions</a> option must be enabled to have the Editions tab appear on the OPAC.</li>
15
    <li style="color:#990000;">Important: Requires that you turn on one or more of the ISBN services (<a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ThingsISBN">ThingISBN</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#XISBN">XISBN</a>)</li>
16
</ul></p>
17
18
<p><strong>OPACFRBRizeEditions</strong>
19
<ul>
20
    <li>Default: Don't show</li>
21
    <li>Asks: ___ other editions of an item on the OPAC.</li>
22
    <li>Description: Using the rules set forth in the Functional Requirements for Bibliographic records, this option, when enabled, pulls all editions of the same title available in your collection regardless of material type. Items will appear under an 'Editions' tab on the detail page for the title in question.. According to Libraries Unlimited's Online Dictionary for Library and Information Science (<a href="http://lu.com/odlis/">http://lu.com/odlis/</a>), FRBRizing the catalog involves collating MARC records of similar materials. FRBRization brings together entities (sets of Works, Expressions, or Manifestations), rather than just sets of Items. It can aid patrons in selecting related items, expressions, and manifestations that will serve their needs. When it is set to "Show", the OPAC will query one or more ISBN web services for associated ISBNs and display an Editions tab on the details pages. Once this preference is enabled, the library must select one of the ISBN options (<a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ThingISBN">ThingISBN</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#XISBN">XISBN</a>). This option is only for the OPAC; the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#FRBRizeEditions">FRBRizeEditions</a> option must be turned "On" to have the Editions tab appear on the Staff Client.</li>
23
    <li>This preference pulls all editions of the same title available in your collection regardless of material type. Items will appear under an 'Editions' tab on the detail page for the title in question.</li>
24
    <li style="color: #990000;">Important: Requires that you turn on one or more of the ISBN services (<a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ThingISBN">ThingISBN</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#XISBN">XISBN</a>)</li>
25
</ul></p>
26
27
<h3>Amazon</h3>
28
29
<p><strong>AmazonAssocTag</strong>
30
<ul>
31
    <li>Asks: Put the associate tag ___ on links to Amazon.</li>
32
    <li>Note: This can net your library referral fees if a patron decides to buy an item after clicking through to Amazon from your site.</li>
33
    <li>Description: An Amazon Associates Tag allows a library to earn a percentage of all purchases made on Amazon when a patron accesses Amazon's site via links on the library's website. More information about the Amazon Associates program is available at Amazon's Affiliate Program's website, <a href="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</a>. Before a tag can be obtained, however, the library must first apply for an Amazon Web Services (AWS) account. Applications are free of charge and can be made at <a href="http://aws.amazon.com">http://aws.amazon.com</a>. Once an AWS account has been established, the library can then obtain the Amazon Associates Tag.</li>
34
    <li>Sign up at: <a href="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</a></li>
35
</ul></p>
36
37
<p><strong>AmazonCoverImages</strong>
38
<ul>
39
    <li>Default: Don't show</li>
40
    <li>Asks: ___ cover images from Amazon on search results and item detail pages on the staff interface.</li>
41
    <li>Description: This preference makes it possible to either allow or prevent Amazon cover images from being displayed in the Staff Client. Cover images are retrieved by Amazon, which pulls the content based on the first ISBN number in the item's MARC record. Amazon offers this service free of charge. If the value for this preference is set to "Show", the cover images will appear in the Staff Client, and if it is set to "Don't show", the images will not appear. Finally, if you're using Amazon cover images, all other cover image services must be disabled. If they are not disabled, they will prevent AmazonCoverImages from functioning properly.</li>
42
</ul></p>
43
44
<p><strong>AmazonLocale</strong>
45
<ul>
46
    <li>Default: American</li>
47
    <li>Asks: Use Amazon data from its ___ website.</li>
48
</ul></p>
49
50
<p><strong>OPACAmazonCoverImages</strong>
51
<ul>
52
    <li>Default: Don't show</li>
53
    <li>Asks: ___ cover images from Amazon on search results and item detail pages on the OPAC.</li>
54
    <li>Description: This preference makes it possible to either allow or prevent Amazon cover images from being displayed in the OPAC. Cover images are retrieved by Amazon, which pulls the content based on the first ISBN number in the item's MARC record. Amazon offers this service free of charge. If the value for this preference is set to "Show", the cover images will appear in the OPAC, and if it is set to "Don't show", the images will not appear. Finally, if you're using Amazon cover images, all other cover image services must be disabled. If they are not disabled, they will prevent AmazonCoverImages from functioning properly.</li>
55
</ul></p>
56
57
<h3>Babelthèque</h3>
58
59
<p><strong>Babeltheque</strong>
60
<ul>
61
    <li>Default: Don't</li>
62
    <li>Asks: ___ include information (such as reviews and citations) from Babelthèque in item detail pages on the OPAC.</li>
63
    <li>Description: This preference makes it possible to display a Babeltheque tab in the OPAC, allowing patrons to access tags, reviews, and additional title information provided by Babeltheque. The information which Babeltheque supplies is drawn from the French language-based <a href="http://babelio.com">Babelio.com</a>, a French service similar to LibraryThing for Libraries. More information about Babeltheque is available through its website, <a href="http://www.babeltheque.com">http://www.babeltheque.com</a>. Libraries that wish to allow access to this information must first register for the service at <a href="http://www.babeltheque.com">http://www.babeltheque.com</a>. Please note that this information is only provided in French.</li>
64
</ul></p>
65
66
<p><strong>Babeltheque_url_js</strong>
67
<ul>
68
    <li>Asks: ___ Defined the url for the Babeltheque javascript file (eg. http://www.babeltheque.com/bw_XX.js)</li>
69
</ul></p>
70
71
<p><strong>Babeltheque_url_update</strong>
72
<ul>
73
    <li>Asks: ___ Defined the url for the Babeltheque update periodically (eq. http://www.babeltheque.com/.../file.csv.bz2).</li>
74
</ul></p>
75
76
<h3>Baker & Taylor</h3>
77
<p style="color:#990000;">Important: This is a pay service, you must contact Baker & Taylor to subscribe to this service before setting these options.</p>
78
79
<p><strong>BakerTaylorEnabled</strong>
80
<ul>
81
    <li>Default: Don't add</li>
82
    <li>Asks: ___ Baker and Taylor links and cover images to the OPAC and staff client. This requires that you have entered in a username and password (which can be seen in image links).</li>
83
    <li>Description: This preference makes it possible to display Baker & Taylor content (book reviews, descriptions, cover images, etc.) in both the Staff Client and the OPAC. Libraries that wish to display Baker & Taylor content must first register and pay for this service with Baker & Taylor (<a href="http://www.btol.com">http://www.btol.com</a>). If Baker & Taylor content is enabled be sure to turn off other cover and review services to prevent interference.</li>
84
    <li style="color: #990000;">Important: To use this you will need to also set the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BakerTaylorUsername">BakerTaylorUsername</a> & <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BakerTaylorPassword">BakerTaylorPassword</a> system preferences</li>
85
</ul></p>
86
87
<p><strong>BakerTaylorBookstoreURL</strong>
88
<ul>
89
    <li>Asks: Baker and Taylor "My Library Bookstore" links should be accessed at https:// ___ isbn</li>
90
    <li>Description: Some libraries generate additional funding for the library by selling books and other materials that are purchased from or have been previously leased from Baker & Taylor. These materials can be accessed via a link on the library's website. This service is often referred to as "My Library Bookstore." In order to participate in this program, the library must first register and pay for the service with Baker & Taylor. Additional information about this and other services provided by Baker & Taylor is available at the Baker & Taylor website, <a href="http://www.btol.com">http://www.btol.com</a>. The BakerTaylorBookstoreURL preference establishes the URL in order to link to the library's Baker & Taylor-backed online bookstore, if such a bookstore has been established. The default for this field is left blank; if no value is entered, the links to My Library Bookstore will remain inactive. If enabling this preference, enter the library's Hostname and Parent Number in the appropriate location within the URL. The "key" value (key=) should be appended to the URL, and https:// should be prepended. This should be filled in with something like koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</li>
91
    <li>Note: Leave it blank to disable these links.</li>
92
    <li style="color: #990000;">Important: Be sure to get this information from Baker & Taylor when subscribing.</li>
93
</ul></p>
94
95
<p><strong>BakerTaylorUsername & BakerTaylorPassword</strong>
96
<ul>
97
    <li>Asks: Access Baker and Taylor using username ___ and password ___</li>
98
    <li>Descriptions: This setting in only applicable if the library has a paid subscription to the external Content Café service from Baker & Taylor. Use the box provided to enter in the library's Content Café username and password. Also, ensure that the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</a> and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BakerTaylorEnabled">BakerTaylorEnabled</a> settings are properly set. The Content Café service is a feed of enhanced content such as cover art, professional reviews, and summaries that is displayed along with Staff Client/OPAC search results. For more information on this service please see the Baker & Taylor website: <a href="http://www.btol.com">http://www.btol.com</a></li>
99
    <li style="color: #990000;">Important: Be sure to get this information from Baker & Taylor when subscribing.</li>
100
</ul></p>
101
102
<h3>Coce Cover images cache</h3>
103
<p>Coce is a remote image URL cache. With this option, cover images are not fetched directly from Amazon, Google, and so on. Their URLs are requested via a web service to Coce which manages a cache of URLs.</p>
104
105
<p><strong>Coce</strong>
106
<ul>
107
    <li>Default: Don't enable</li>
108
    <li>Asks: ___ a Coce image cache service.</li>
109
    <li>Description: Coce has many benefits when it comes to choosing and displaying cover images in Koha: If a book cover is not available from a provider, but is available from another one, Koha will be able to display a book cover, which isn't the case now. Since URLs are cached, it isn't necessary for each book cover to request, again and again, the provider, and several of them if necessary. Amazon book covers are retrieved with Amazon Product Advertising API, which means that more covers are retrieved (ISBN13).</li>
110
    <li style="color: #990000;">Important: Coce does not come bundled with Koha. Your Koha install with not already have a Coce server set up. Before enabling this functionality you will want to be sure to have a Coce server set up. Instructions on installing and setting up Coce can be found on the official github page at <a href="https://github.com/fredericd/coce">https://github.com/fredericd/coce.</a></li>
111
</ul></p>
112
113
<p><strong>CoceHost</strong>
114
<ul>
115
    <li>Asks: Coce server URL ___</li>
116
    <li>Description: This will be the full URL (starting with http://) to your Coce server.</li>
117
</ul></p>
118
119
<p><strong>CoceProviders</strong>
120
<ul>
121
    <li>Asks: Use the following providers to fetch the covers ___</li>
122
    <li>Description: The providers chosen here will be used to gather cover images for display in your Koha catalog.</li>
123
</ul></p>
124
125
<h3>Google</h3>
126
127
<p><strong>GoogleJackets</strong>
128
<ul>
129
    <li>Default: Don't add</li>
130
    <li>Asks: ___ cover images from Google Books to search results and item detail pages on the OPAC.</li>
131
    <li>Description: This setting controls the display of applicable cover art from the free Google Books database, via the Google Books API. Please note that to use this feature, all other cover services should be turned off.</li>
132
</ul></p>
133
134
<h3>HTML5 Media</h3>
135
136
<p><strong>HTML5MediaEnabled</strong>
137
<ul>
138
    <li>Default: not at all</li>
139
    <li>Asks: Show a tab with a HTML5 media player for files catalogued in field 856 ___</li>
140
    <li>Description: If you have media elements in the 856 of your MARC record this preference can run/show those media files in a separate tab using HTML5.</li>
141
</ul></p>
142
143
<p><strong>HTML5MediaExtensions</strong>
144
<ul>
145
    <li>Default: webm|ogg|ogv|oga|vtt</li>
146
    <li>Asks: Media file extensions ___</li>
147
    <li>Description: Enter in file extensions separated with bar (|)</li>
148
</ul></p>
149
150
<h3>HTML5MediaYouTube</h3>
151
<ul>
152
    <li>Default: Don't embed</li>
153
    <li style="color: #990000;">Important: To turn this on first enable <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#HTML5MediaEnabled">HTML5MediaEnabled</a></li>
154
    <li>Asks: ___ YouTube links as videos.</li>
155
    <li>Description: This preference will allow MARC21 856$u that points to YouTube to appear as a playable video on the pages defined in <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#HTML5MediaEnabled">HTML5MediaEnabled</a>.</li>
156
</ul></p>
157
158
<h3>IDreamLibraries</h3>
159
<p>IDreamBooks.com aggregates book reviews by critics to help you discover the very best of what's coming out each week. These preferences let you integrated content from <a href="http://idreambooks.com">IDreamBooks.com</a> in to your Koha OPAC.</p>
160
<p>Note: This is a new website and has limited content, so you may only see these features on new popular titles until the database grows some more.</p>
161
162
<p><strong>IDreamBooksReadometer</strong>
163
<ul>
164
    <li>Default: Don't add</li>
165
    <li>Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com to the OPAC details page.</li>
166
</ul></p>
167
168
<p><strong>IDreamBooksResults</strong>
169
<ul>
170
    <li>Default: Don't add</li>
171
    <li>Asks: ___ the rating from IDreamBooks.com to OPAC search results.</li>
172
</ul></p>
173
174
<p><strong>IDreamBooksReviews</strong>
175
<ul>
176
    <li>Default: Don't add</li>
177
    <li>Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by IDreamBooks.com.</li>
178
</ul></p>
179
180
<h3>LibraryThing</h3>
181
<p>LibraryThing for Libraries is a pay service. You must first contact LibraryThing directly for pricing and subscription information. Learn more at <a href="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</a>. Also, for further configuration instructions please see the LibraryThing Wiki: <a href="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</a></p>
182
183
<p><strong>LibraryThingForLibrariesEnabled</strong>
184
<ul>
185
    <li>Default: Don't show</li>
186
    <li>Asks: ___ reviews, similar items, and tags from Library Thing for Libraries on item detail pages on the OPAC.</li>
187
    <li>Description: This setting is only applicable if the library has a paid subscription to the external LibraryThing for Libraries service. This service can provide patrons with the display of expanded information on catalog items such as book recommendations. It also can offer advanced features like tagged browsing, patron written reviews, and a virtual library display accessed from the details tab.</li>
188
    <li style="color; #990000;">Important: If this is set to 'show' you will need to enter a value in the '<a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#LibraryThingForLibrariesID">LibraryThingForLibrariesID</a>' system preference.</li>
189
</ul></p>
190
191
<p><strong>LibraryThingForLibrariesID</strong>
192
<ul>
193
    <li>Asks: Access Library Thing for Libraries using the customer ID ___</li>
194
    <li>Description: This setting is only applicable if the library has a paid subscription to the external LibraryThing for Libraries service. Use the box provided to enter in the library's LibraryThing for Libraries ID as provided to the library by LibraryThing. The ID number is a series of numbers in the form ###-#########, and can be found on the library's account page at LibraryThing for Libraries. This service can provide patrons with the display of expanded information on catalog items such as book recommendations and cover art. It also can offer advanced features like tagged browsing, patron written reviews, and a virtual library display accessed from the details tab.</li>
195
</ul></p>
196
197
<p><strong>LibraryThingForLibrariesTabbedView</strong>
198
<ul>
199
    <li>Default: in line with bibliographic information</li>
200
    <li>Asks: Show Library Thing for Libraries content ___</li>
201
    <li>Description: This setting is only applicable if the library has a paid subscription to the external LibraryThing for Libraries service. This service can provide patrons with the display of expanded information on catalog items such as book recommendations and cover art. It also can offer advanced features like tagged browsing, patron written reviews, and a virtual library display accessed from the details tab.</li>
202
</ul></p>
203
204
<p><strong>ThingISBN</strong>
205
<ul>
206
    <li>Default: Don't use</li>
207
    <li>Asks: ___ the ThingISBN service to show other editions of a title</li>
208
    <li>Description: Set to 'Use' to display an "Editions" tab on the item's detail page. Editions are listed, complete with cover art (if you have one of the cover services enabled) and bibliographic information. The feed comes from LibraryThing's ThingISBN web service. This is a free service to non-commercial sites with fewer than 1,000 requests per day.</li>
209
    <li style="color: #990000;">Important: Requires <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#FRBRizeEditions">FRBRizeEditions</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACFRBRizeEditions">OPACFRBRizeEditions</a> set to 'show'</li>
210
    <li style="color: #990000;">Important: This is separate from Library Thing for Libraries and does not have a cost associated with it.</li>
211
</ul></p>
212
213
<h3>Local Cover Images</h3>
214
215
<p><strong>AllowMultipleCovers</strong>
216
<ul>
217
    <li>Default: Don't allow</li>
218
    <li>Asks: ___ multiple images to be attached to each bibliographic record.</li>
219
    <li>Description: If this preference is set to 'Allow' then you can upload multiple images that will appear in the images tab on the bib record in the OPAC and the staff client. This preference requires that either one or both <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#LocalCoverImages">LocalCoverImages</a> and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACLocalCoverImages">OPACLocalCoverImages</a> are set to 'Display.'</li>
220
</ul></p>
221
222
<p><strong>LocalCoverImages</strong>
223
<ul>
224
    <li>Default: Don't display</li>
225
    <li>Asks: ___ local cover images on intranet search and details pages.</li>
226
    <li>Description: Setting this preference to 'Display' allows you to upload your own cover images to bib records and display them on the detail page in the staff client. At this time the cover will only show under the 'Images' tab on the holdings table on the detail display, not next to the title at the top left or on the search results.</li>
227
</ul></p>
228
229
<p><strong>OPACLocalCoverImages</strong>
230
<ul>
231
    <li>Default: Don't display</li>
232
    <li>Asks: ___ local cover images on OPAC search and details pages.</li>
233
    <li>Description: Setting this preference to 'Display' allows you to upload your own cover images to bib records and display them on the detail page and search results in the OPAC.</li>
234
</ul></p>
235
236
<h3>Novelist Select</h3>
237
<p>Novelist Select is not a free service. Contact your Ebsco representitive to get your log in information to embed this content in the OPAC.</p>
238
<p style="color:#990000">Important: Novelist Select does not include cover images for the search results and bibliographic detail pages. You can choose any other cover image service for this content or you can contract with Ebsco to get access to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#btcontentprefs">Baker & Taylor Content Cafe</a> for an added fee.</p>
239
240
<p><strong>NovelistSelectEnabled</strong>
241
<ul>
242
    <li>Default: Don't add</li>
243
    <li>Asks: ___ Novelist Select content to the OPAC.</li>
244
    <li style="color: #990000;">Important: Enabling this requires that you have entered in a user profile and password in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#NovelistSelectProfile">NovelistSelectProfile & NovelistSelectPassword</a> preferences</li>
245
    <li>Description: Novelist Select from Ebsco is a subscription service that can provide additional content in the OPAC.</li>
246
</ul></p>
247
248
<p><strong>NovelistSelectProfile & NovelistSelectPassword</strong>
249
<ul>
250
    <li>Asks: Access Novelist Select using user profile ___ and password ___.</li>
251
    <li style="color: #990000;">Important: This information will be visible if someone views the source code on your OPAC.</li>
252
    <li>Description: Novelist Select from Ebsco is a subscription service that can provide additional content in the OPAC.</li>
253
</ul></p>
254
255
<p><strong>NovelistSelectView</strong>
256
<ul>
257
    <li>Default: in an OPAC tab</li>
258
    <li>Asks: Display Novelist Select content ___</li>
259
    <li>Description: Novelist Select provides a lot of content, for that reason you have four choices of where to display this content. The default view is in a tab in the holdings table. The content is the same if you choose to show it above the holdings table or below it. If shown in the right column of the page it's the same content, but displays a bit differently since space is limited.</li>
260
</ul></p>
261
262
<h3>OCLC</h3>
263
264
<p><strong>XISBN</strong>
265
<ul>
266
    <li>Default: Don't use</li>
267
    <li>Asks: ___ the OCLC xISBN service to show other editions of a title</li>
268
    <li>Description: Set to 'Use' to display an "Editions" tab on the item's detail page. Editions are listed, complete with cover art and bibliographic information. The feed comes from OCLC's xISBN web service. The feed limit for non-commercial sites is 1000 requests per day.</li>
269
    <li  style="color: #990000;">Important: Requires <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#FRBRizeEditions">FRBRizeEditions</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACFRBRizeEditions">OPACFRBRizeEditions</a> set to 'show'</li>
270
</ul></p>
271
272
<p><strong>OCLCAffiliateID</strong>
273
<ul>
274
    <li>Asks: Use the OCLC affiliate ID ___ to access the xISBN service.</li>
275
    <li>Description: This setting is only applicable if the library has an OCLC Affiliate ID. This allows WorldCat searching in the OPAC via the XISBN programming interface. Simply enter the library's OCLC Affiliate ID in the box provided. Please note that using this data is only necessary if <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#FRBRizeEditions">FRBRizeEditions</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACFRBRizeEditions">OPACFRBRizeEditions</a> and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#XISBN">XISBN</a> settings are enabled. For more information on this service please visit the OCLC website: <a href="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</a>.</li>
276
    <li style="color: #990000;">Important: Unless you have signed up for an ID with OCLC, you are limited to 1000 requests per day. Available at: <a href="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</a></li>
277
</ul></p>
278
279
<p><strong>XISBNDailyLimit</strong>
280
<ul>
281
    <li>Default: 999</li>
282
    <li>Asks: Only use the xISBN service ___ times a day.</li>
283
    <li style="color: #990000;">Important: Unless you have signed up for an ID with OCLC, you are limited to 1000 requests per day. Available at: <a href="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</a></li>
284
</ul></li>
285
286
<h3>Open Library</h3>
287
288
<p><strong>OpenLibraryCovers</strong>
289
<ul>
290
    <li>Default: Don't add</li>
291
    <li>Asks: ___ cover images from Open Library to search results and item detail pages on the OPAC.</li>
292
    <li>Description: This setting controls the display of applicable cover art from the free Open Library database, via the Open Library API. Please note that to use this feature, all other cover services should be turned off.</li>
293
</ul></p>
294
295
<p><strong>OpenLibrarySearch</strong>
296
<ul>
297
    <li>Default: Don't show</li>
298
    <li>Asks: ___ search results from Open Library on the OPAC.</li>
299
</ul></p>
300
301
<h3>Overdrive</h3>
302
<p>OverDrive is an pay service. You must first contact OverDrive directly for pricing and subscription information. Enabling this service will integrate Overdrive results in to your OPAC searches. You will have to apply for these 3 pieces of information through an application as an API developer. Overdrive API applications are evaluated once a week so you may not be able to use this feature immediately after signing up. To learn more please contact your OverDrive representative.</p>
303
304
<p><strong>OverDriveClientKey and OverDriveClientSecret</strong>
305
<ul>
306
    <li>Asks: Include OverDrive availability information with the client key __ and client secret ___</li>
307
    <li>Description: OverDrive customers can get this information by visiting the <a href="https://developer.overdrive.com/docs/getting-started">OverDrive Developer Portal</a> and following the instructions found there to apply as an API developer. Once this data and the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OverDriveLibraryID">OverDriveLibraryID</a> are populated you will see OverDrive results on your OPAC searches.</li>
308
</ul></p>
309
310
<p><strong>OverDriveLibraryID</strong>
311
<ul>
312
    <li>Asks: Show items from the OverDrive catalog of library # ___</li>
313
    <li>Description: OverDrive customers can get this information by visiting the <a href="https://developer.overdrive.com/docs/getting-started">OverDrive Developer Portal</a> and following the instructions found there to apply as an API developer. Once this data and the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OverDriveClientKey">OverDriveClientKey</a> and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OverDriveClientSecret">OverDriveClientSecret</a> are populated you will see OverDrive results on your OPAC searches.</li>
314
</ul></p>
315
316
<h3>Plugins</h3>
317
318
<p><strong>UseKohaPlugins</strong>
319
<ul>
320
    <li>Default: Don't enable</li>
321
    <li>Asks: ___ the ability to use Koha Plugins.</li>
322
    <li>Note: The plugin system must also be enabled in the Koha configuration file to be fully enabled. Learn more in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/pluginsystem.html">Plugins chapter</a>.</li>
323
</ul></p>
324
325
<h3>Syndetics</h3>
326
<p>Syndetics is a pay service. You must first contact Syndetics directly for pricing and subscription information.</p>
327
328
<p><strong>SyndeticsEnabled</strong>
329
<ul>
330
    <li>Default: Don't use</li>
331
    <li>Asks: ___ content from Syndetics.</li>
332
    <li>Description: When this option is enabled any of the Syndetics options can be used.</li>
333
    <li style="color: #990000;">Important: Requires that you enter your <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SydenticsClientCode">SyndeticsClientCode</a> before this content will appear.</li>
334
</ul></p>
335
336
<p><strong>SyndeticsClientCode</strong>
337
<ul>
338
    <li>Asks: Use the client code ___ to access Syndetics.</li>
339
    <li>Description: Once the library signs up for Syndetics' services, Syndetics will provide the library with an access code. (Visit the Syndetics homepage at <a href="http://www.bonker.com/syndetics/">http://www.bowker.com/syndetics/</a> for more information.) This is the code that must be entered to access Syndetics' subscription services. Syndetics is a paid subscription service. This value must be entered before <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SyndeticsEditions">SyndeticsEditions</a> can be enabled. If the code is lost, corrupted, or forgotten, a new one can be obtained from <a href="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</a>.</li>
340
    <li style="color: #990000;">Important: You will need to get your client code directly from Syndetics.</li>
341
</ul></p>
342
343
<p><strong>SyndeticsCoverImages & SyndeticsCoverImageSize</strong>
344
<ul>
345
    <li>SyndeticsCoverImages Default: Don't show</li>
346
    <li>SyndeticsCoverImageSize Default: medium</li>
347
    <li>Asks: ___ cover images from Syndetics on search results and item detail pages on the OPAC in a ___ size.</li>
348
    <li>Descriptions: When enabled, SyndeticsCoverImages, allows libraries to display Syndetics' collection of full-color cover images for books, videos, DVDs and CDs on their OPAC. For each book or item that comes up during a user search, the cover image for that title will be displayed. Since these cover images come in three sizes, the optimum size must be selected using the SyndeticsCoverImageSize preference after SyndeticsCoverImages are enabled. Syndetics cover images come in two sizes: mid-size (187 x 187 pixels), and large (400 x 400 pixels). Syndetics is a paid subscription service. The <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SyndeticsClientCode">SyndeticsClientCode</a> must be entered and the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SyndeticsEnabled">SyndeticsEnabled</a> option must be activated before this service can be used. Other cover image preferences should also be disabled to avoid interference.</li>
349
</ul></p>
350
351
<p><strong>SyndeticsAuthorNotes</strong>
352
<ul>
353
    <li>Default: Don't show</li>
354
    <li>Asks: ___ notes about the author of a title from Syndetics on item detail pages on the OPAC.</li>
355
    <li>Description: When this option is set to "Show", Syndetics provides notes and short author biographies for more that 300,000 authors, in both fiction and nonfiction. With this option enabled the library can display Syndetics Author Notes on the OPAC. According to the Syndetics Solutions website (<a href="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</a>), Author Notes include lists of contributors for many multi-author texts and compilations. The <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SyndeticsClientCode">SyndeticsClientCode</a> must be entered and the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SyndeticsEnabled">SyndeticsEnabled</a> option must be activated before this service can be used.</li>
356
</ul></p>
357
358
<p><strong>SyndeticsAwards</strong>
359
<ul>
360
    <li>Default: Don't show</li>
361
    <li>Asks: ___ information from Syndetics about the awards a title has won on item detail pages on the OPAC.</li>
362
    <li>Description: When this option is set to "Show", Syndetics provides its clients with a list of awards that any title has won. With this service enabled the library can display those awards for each book on its website. For each book or item that comes up during a user search, the list of awards for that title will be displayed. When a user clicks on a given award, information about that award is presented along with a list of the other titles that have won that award. If the user clicks on any title in the list, they will see holdings information about that title in their region. This option is a paid subscription service. The SyndeticsClientCode must be entered and the SyndeticsEnabled option must be activated before this service can be used.</li>
363
</ul></p>
364
365
<p><strong>SyndeticsEditions</strong>
366
<ul>
367
    <li>Default: Don't show</li>
368
    <li>Asks: ___ information about other editions of a title from Syndetics on item detail pages on the OPAC</li>
369
    <li>Description: When enabled this option shows information on other editions of a title from Syndetics on the item detail pages of the OPAC. Syndetics is a paid subscription service. The <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SyndeticsClientCode">SyndeticsClientCode</a> must be entered and the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SyndeticsEnabled">SyndeticsEnabled</a> option must be activated before this service can be used.</li>
370
    <li style="color: #990000;">Important: Requires <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACFRBRizeEditions">OPACFRBRizeEditions</a> set to 'show'</li>
371
</ul></p>
372
373
<p><strong>SyndeticsExcerpt</strong>
374
<ul>
375
    <li>Default: Don't show</li>
376
    <li>Asks: ___ excerpts from of a title from Syndetics on item detail pages on the OPAC.</li>
377
    <li>Description: This preference allows Syndetics to display excerpts given to them from selected publishers. The excerpts are available from prominently reviewed new titles, both fiction and non-fiction. The excerpts include poems, essays, recipes, forwards and prefaces. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high-speed Internet servers to the library OPACs. For more information see (<a href="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</a>).</li>
378
</ul></p>
379
380
<p><strong>SyndeticsReviews</strong>
381
<ul>
382
    <li>Default: Don't show</li>
383
    <li>Asks: ___ reviews of a title from Syndetics on item detail pages on the OPAC.</li>
384
    <li>Description: Syndetics Reviews is an accumulation of book reviews available from a variety of journals and serials. The reviews page displays colored images of reviewed books dust jackets, partnered with the names of the journal or serial providing the review. Clicking on an icon opens a window revealing the book title, author's name, book cover icon and the critic's opinion of the book. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high-speed Internet servers to the library OPACs. For more information see (<a href="http://www.bowker.con/syndetics/">http://www.bowker.com/syndetics/</a>).</li>
385
</ul></p>
386
387
<p><strong>SyndeticsSeries</strong>
388
<ul>
389
    <li>Default: Don't show</li>
390
    <li>Asks: ___ information on other books in a title's series from Syndetics on item detail pages on the OPAC.</li>
391
    <li>Description: Each fiction title within a series is linked to the complete series record. The record displays each title in reading order and also displays the publication order, if different. Alternate series titles are also displayed. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high- speed Internet servers to the library OPACs. For more information see (<a href="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</a>).</li>
392
</ul></p>
393
394
<p><strong>SyndeticsSummary</strong>
395
<ul>
396
    <li>Default: Don't show</li>
397
    <li>Asks: ___ a summary of a title from Syndetics on item detail pages on the OPAC.</li>
398
    <li>Description: Providing more than 5.6 million summaries and annotations derived from book jackets, edited publisher copy, or independently written annotations from Book News, Inc. Covering fiction and non-fiction, this summaries option provides annotations on both trade and scholarly titles. For more information see (<a href="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</a>).</li>
399
</ul></p>
400
401
<p><strong>SyndeticsTOC</strong>
402
<ul>
403
    <li>Default: Don't show</li>
404
    <li>Asks: ___ the table of contents of a title from Syndetics on item detail pages on the OPAC.</li>
405
    <li>Description: This preference allows staff and patrons to review the Table of Contents from a wide variety of publications from popular self-help books to conference proceedings. Specific Information access is the main purpose for this option, allowing patrons guidance to their preferred section of the book. Special arrangements with selected book services is used to obtain the table of contents for new publications each year. Automatic links provided by the ISBNs within local MARC records are required to integrate Syndetics secured, high-speed Internet servers to the library OPACs. For more information see (<a href="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</a>).</li>
406
</ul></p>
407
408
<h3>Tagging</h3>
409
410
<p><strong>TagsEnabled</strong>
411
<ul>
412
    <li>Default: Allow</li>
413
    <li>Asks: ___ patrons and staff to put tags on items.</li>
414
    <li>Description: Set to 'Allow' enable tagging. A tag is metadata, a word added to identify an item. Tags allow patrons to classify materials on their own. TagsEnabled is the main switch that permits the tagging features. TagsEnable must be set to 'Allow' to allow for other tagging features.</li>
415
</ul></p>
416
417
<p><strong>TagsModeration</strong>
418
<ul>
419
    <li>Default: Don't require</li>
420
    <li>Asks: ___ that tags submitted by patrons be reviewed by a staff member before being shown.</li>
421
    <li>Description: When set to 'Require,' all tags to be first filtered by the tag moderator. Only approved tags will be visible to patrons. When set to 'Don't require' tags will bypass the tag moderator and patrons' tags to be immediately visible. When this preference is enabled the moderator, a staff member, would approve the tag in the Staff Client. The moderator will have the option to approve or reject each pending tag suggestion. When moderation is required all tags go through the tag moderation tool before becoming visible.</li>
422
</ul></p>
423
424
<p><strong>TagsShowOnList</strong>
425
<ul>
426
    <li>Default: 6</li>
427
    <li>Asks: Show ___ tags on search results on the OPAC.</li>
428
    <li>Note: Set the value to 0 (zero) to turn this feature off.</li>
429
</ul></p>
430
431
<p><strong>TagsInputOnList</strong>
432
<ul>
433
    <li>Default: Allow</li>
434
    <li>Asks: ___ patrons to input tags on search results on the OPAC.</li>
435
</ul></p>
436
437
<p><strong>TagsShowOnDetail</strong>
438
<ul>
439
    <li>Default: 10</li>
440
    <li>Asks: Show ___ tags on item detail pages on the OPAC.</li>
441
    <li>Note: Set the value to 0 (zero) to turn this feature off.</li>
442
</ul></p>
443
444
<p><strong>TagsInputOnDetail</strong>
445
<ul>
446
    <li>Default: Allow</li>
447
    <li>sks: ___ patrons to input tags on item detail pages on the OPAC.</li>
448
</ul></p>
449
450
<p><strong>TagsExternalDictionary</strong>
451
<ul>
452
    <li>Asks: Allow tags in the dictionary of the ispell executable ___ on the server to be approved without moderation.</li>
453
    <li> Description: The dictionary includes a list of accepted and rejected tags. The accepted list includes all the tags that have been pre-allowed. The rejected list includes tags that are not allowed. This preference identifies the "accepted" dictionary used. Ispell is an open source dictionary which can be used as a list of accepted terms. Since the dictionary allows for accurately spelled obscenities, the libraries policy may dictate that modifications are made to the Ispell dictionary if this preference is use. For more information about Ispell <a href="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</a>. Enter the path on your server to a local ispell executable, used to set $Lingua::Ispell::path.</li>
454
</ul></p>
455
456
<p><strong>See the full documentation for Enhanced Content System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#enhancedcontent">manual</a> (online).</strong></p>
457
458
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_i18n_l10n.tt (+64 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>I18L/L10N System Preferences</h1>
4
5
<p>These preferences control your Internationalization and Localization settings.
6
7
<p><strong>AddressFormat</strong>
8
<ul>
9
    <li>Default: US style ([Street number], [Address] - [City], [Zip/Postal Code], [Country])</li>
10
    <li>Asks: Format postal addresses using ___</li>
11
    <li>Description: This preference will let you control how Koha displays patron addresses given the information entered in the various fields on their record.</li>
12
</ul></p>
13
14
<p><strong>alphabet</strong>
15
<ul>
16
    <li>Default: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z</li>
17
    <li>Asks: Use the alphabet ___ for lists of browsable letters. This should be a space separated list of uppercase letters.</li>
18
    <li>Description: This preference allows you define your own alphabet for browsing patrons in Koha.</li>
19
</ul></p>
20
21
<p><strong>CalendarFirstDayOfWeek</strong>
22
<ul>
23
    <li>Default: Sunday</li>
24
    <li>Asks: Use ___ as the first day of week in the calendar.</li>
25
    <li>Description: Using this preference you can control what day shows as the first day of the week in the calendar pop ups throughout Koha and on the Calendar tool. If you change this preference and don't see a change in your browser try clearing your cache since it makes changes to the Javascript on these pages.</li>
26
</ul></p>
27
28
<p><strong>dateformat</strong>
29
<ul>
30
    <li>Default: mm/dd/yyyy</li>
31
    <li>Asks: Format dates like ___</li>
32
    <li>Description: This preference controls how the date is displayed. The options are the United States method, mm/dd/yyyy (04/24/2010), the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the International Standard of Organization, yyyy/mm/dd (2010/04/24). The International Standard of Organization would primarily be used by libraries with locations in multiple nations that may use different date formats, to have a single display type, or if the library would be in a region that does not use the United States or metric method. More information regarding the ISO date format can be found at <a href="http://www.iso.org/iso/iso_catalogue.htm">http://www.iso.org/iso/iso_catalogue.htm</a>.</li>
33
</ul></p>
34
35
<p><strong>language</strong>
36
<ul>
37
    <li>Default: English</li>
38
    <li>Asks: Enable the following languages on the staff interface</li>
39
    <li>Note: To install additional languages please refer to <a href="http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client">http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client</a></li>
40
</ul></p>
41
42
<p><strong>opaclanguages</strong>
43
<ul>
44
    <li>Default: English</li>
45
    <li>Asks: Enable the following languages on the OPAC</li>
46
    <li>Note: To install additional languages you need to run misc/translation/install-code.pl. For example, to install French you would run the following command install-code.pl fr-FR to make the templates, once they exist and are in the right place then they will show up as an option in this preference.</li>
47
</ul></p>
48
49
<p><strong>opaclanguagesdisplay</strong>
50
<ul>
51
    <li>Default: Don't allow</li>
52
    <li>Asks: ___ patrons to select their language on the OPAC.</li>
53
    <li>Description: Using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OpacLangSelectorMode">OpacLangSelectorMode</a> preference you can decide where these language options will appear in the public catalog.</li>
54
</ul></p>
55
56
<p><strong>TimeFormat</strong>
57
<ul>
58
    <li>Default: 24 hour format</li>
59
    <li>Asks: Format times in ___</li>
60
</ul></p>
61
62
<p><strong>See the full documentation for I18N/L10N System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#l18nprefs">manual</a> (online).</strong></p>
63
64
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_labs.tt (+17 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Labs System Preferences</h1>
4
5
<p>The preferences in this section are for experimental features that need additional testing and debugging.</p>
6
7
<p><strong>EnableAdvancedCatalogingEditor</strong>
8
<ul>
9
    <li>Default: Don't enable</li>
10
    <li>Asks: ___ the advanced cataloging editor.</li>
11
    <li>Description: This preference will allow you to choose between a basic editor and a advanced editor for cataloging.</li>
12
    <li style="color: #990000;">Important: This feature is currently experimental, and may have bugs that cause corruption of records. It also does not include any support for UNIMARC or NORMARC fixed fields. Please help us test it and report any bugs, but do so at your own risk.</li>
13
</ul></p>
14
15
<p><strong>See the full documentation for Labs System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#labsprefs">manual</a> (online).</strong></p>
16
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_logs.tt (+87 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Logs System Preferences</h1>
4
5
<p>Logs keep track of transaction on the system. You can decide which actions you want to log and which you don't using these preferences. Logs can then be viewed in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaltools.html#logviewer">Log Viewer</a> under Tools.</p>
6
7
<h3>Debugging</h3>
8
9
<p><strong>DumpTemplateVarsIntranet</strong>
10
<ul>
11
    <li>Default: Don't</li>
12
    <li>Asks: ___ dump all Template Toolkit variable to a comment in the html source for the staff intranet.</li>
13
</ul></p>
14
15
<p><strong>DumpTemplateVarsOpac</strong>
16
<ul>
17
    <li>Default: Don't</li>
18
    <li>Asks: ___ dump all Template Toolkit variable to a comment in the html source for the OPAC.</li>
19
</ul></p>
20
21
<h3>Logging</h3>
22
23
<p><strong>AuthoritiesLog</strong>
24
<ul>
25
    <li>Default: Don't log</li>
26
    <li>Asks: ___ changes to authority records</li>
27
</ul></p>
28
29
<p><strong>BorrowersLog</strong>
30
<ul>
31
    <li>Default: Log</li>
32
    <li>Asks: ___ changes to patron records.</li>
33
</ul></p>
34
35
<p><strong>CataloguingLog</strong>
36
<ul>
37
    <li>Default: Don't log</li>
38
    <li>Asks: ___ any changes to bibliographic or item records.</li>
39
    <li style="color: #990000;">Important: Since this occurs whenever a book is cataloged, edited, or checked in or out it can be very resource intensive - slowing down your system.</li>
40
</ul></p>
41
42
<p><strong>CronjobLog</strong>
43
<ul>
44
    <li>Default: Don't log</li>
45
    <li>Asks: ___ information from cron jobs.</li>
46
</ul></li>
47
48
<p><strong>FinesLog</strong>
49
<ul>
50
    <li>Default: Log</li>
51
    <li>Asks: ___ when overdue fines are charged or automatically forgiven.</li>
52
</ul></p>
53
54
<p><strong>IssueLog</strong>
55
<ul>
56
    <li>Default: Log</li>
57
    <li>Asks: ___ when items are checked out.</li>
58
</ul></p>
59
60
<p><strong>LetterLog</strong>
61
<ul>
62
    <li>Default: Log</li>
63
    <li>Asks: ___ when an automatic claim notice is sent.</li>
64
    <li>Note: This log tracks all notices that go to patrons including the overdue notices.</li>
65
</ul></p>
66
67
<p><strong>ReportsLog</strong>
68
<ul>
69
    <li>Default: Don't log</li>
70
    <li>Asks: ___ when reports are added, deleted or changed.</li>
71
</ul></p>
72
73
<p><strong>ReturnLog</strong>
74
<ul>
75
    <li>Default: Log</li>
76
    <li>Asks: ___ when items are returned.</li>
77
</ul></p>
78
79
<p><strong>SubscriptionLog</strong>
80
<ul>
81
    <li>Default: Log</li>
82
    <li>Asks: ___ when serials are added, deleted or changed.</li>
83
</ul></p>
84
85
<p><strong>See the full documentation for Logs System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#logs">manual</a> (online).</strong></p>
86
87
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_opac.tt (+865 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>OPAC System Preferences</h1>
4
5
<h3>Advanced Search Options</h3>
6
7
<p><strong>OpacAdvSearchMoreOptions</strong>
8
<ul>
9
    <li>Default: Select All</li>
10
    <li>Asks: Show search options for the expanded view ___</li>
11
    <li>Description: The settings in this preference will determine which search fields will show when the patron is using the 'More options' mode on the advanced search page.</li>
12
</ul></p>
13
14
<p><strong>OpacAdvSearchOptions</strong>
15
<ul>
16
    <li>Default: Item types, Language, Location and availability, Publication date, Sorting</li>
17
    <li>Asks: Show search options ___</li>
18
    <li>Description: The settings in this preference will determine which search fields will show when the patron is using the 'Fewer options' mode on the advanced search page.</li>
19
</ul></p>
20
21
<h3>Appearance</h3>
22
23
<p>These preferences control how things appear in the OPAC.</li>
24
25
<p><strong>AuthorisedValueImages</strong>
26
<ul>
27
    <li>Default: Don't show</li>
28
    <li>Asks: ___ images for authorized values (such as lost statuses and locations) in search results and item detail pages on the OPAC.</li>
29
</ul></p>
30
31
<p><strong>BiblioDefaultView</strong>
32
<ul>
33
    <li>Default: in simple form</li>
34
    <li>Asks: By default, show bib records ___</li>
35
    <li>Description: This preference determines the level of bibliographic detail that the patron will see on the OPAC detail page. The simple form displays the graphical interface; MARC format displays the MARC21 cataloging view; ISBD displays the ISBD (International Standard Bibliographic Description, AACR2) view.</li>
36
</ul></p>
37
38
<p><strong>COinSinOPACResults</strong>
39
<ul>
40
    <li>Default: Include</li>
41
    <li>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search results.</li>
42
    <li>Description: COinS stands for ContextObjects in Spans. COinS is a method to embed bibliographic metadata in the HTML code of web pages. This allows bibliographic software to publish machine-readable bibliographic items and client reference management software (such as Zotero) to retrieve bibliographic metadata. The metadata can also be sent to an OpenURL resolver. This allows, for instance, searching for a copy of a book in one's own library.</li>
43
</ul></p>
44
45
<p><strong>DisplayOPACiconsXSLT</strong>
46
<ul>
47
    <li>Default: Don't show</li>
48
    <li>Asks: On pages displayed with XSLT stylesheets on the OPAC, ___ icons for itemtype and authorized values.</li>
49
    <li style="color: #990000;">Important: <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</a> must be set to use an XSLT stylesheet for this to show (default or custom)</li>
50
    <li>Note: See the <a href="http://manual.koha-community.org/[% helpVersion %]/en/XSLTiTypes.html">XSLT Icon Guide</a> for more information on these icons.</li>
51
</ul></p>
52
53
<p><strong>hidelostitems</strong>
54
<ul>
55
    <li>Default: Don't show</li>
56
    <li>Asks: ___ lost items on search and detail pages.</li>
57
    <li>Description: Items that are marked lost by the library can either be shown or not shown on the OPAC. By setting the value to "Don't show," the lost item is not shown on the OPAC. By setting the value "Show," the lost item is shown on the OPAC for patrons to view with a status of 'lost.'</li>
58
</ul></p>
59
60
<p><strong>HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich</strong>
61
<ul>
62
    <li>HighlightOwnItemsOnOPAC Default: Don't emphasize</li>
63
    <li>HighlightOwnItemsOnOPACWhich Default: patron's home library</li>
64
    <li>Asks: ___ results from the ___ by moving the results to the front and increasing the size or highlighting the rows for those results.</li>
65
    <li style="color: #990000;">Important: This preference will only effect sites that are not using an XSLT stylesheet. XSLT stylesheets are defined in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</a> and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</a> preferences.</li>
66
</ul></p>
67
68
<p><strong>GoogleIndicTransliteration</strong>
69
<ul>
70
    <li>Default: Don't show</li>
71
    <li>Asks: ___ GoogleIndicTransliteration on the OPAC.</li>
72
</ul></p>
73
74
<p><strong>LibraryName</strong>
75
<ul>
76
    <li>Asks: Show ___ as the name of the library on the OPAC.</li>
77
    <li>Note: This value will appear in the title bar of the browser</li>
78
    <li>Note: Edit '<a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opacheader">opacheader</a>' if you'd like to add a library name above your search box on the OPAC</li>
79
</ul></p>
80
81
<p><strong>NoLoginInstructions</strong>
82
<ul>
83
    <li>Asks: Show the following HTML on the OPAC login form when a patron is not logged in:</li>
84
    <li>Description: This preference allows you to override the default text seen on the log in page in the Koha OPAC. The default HTML is:
85
    &lt;h5&gt;Don't have a password yet?&lt;/h5&gt;<br>
86
    &lt;p&gt;If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.&lt;/p&gt;<br>
87
    &lt;h5&gt;Don't have a library card?&lt;/h5&gt;<br>
88
    &lt;p&gt;If you don't have a library card, stop by your local library to sign up.&lt;/p&gt;</li>
89
    <li>Any HTML in this box will replace the above text below the log in box.</li>
90
</ul></p>
91
92
<p><strong>OpacAddMastheadLibraryPulldown</strong>
93
<ul>
94
    <li>Default: Don't add</li>
95
    <li>Asks: ___ a library select pulldown menu on the OPAC masthead.</li>
96
</ul></p>
97
98
<p><strong>OPACBaseURL</strong>
99
<ul>
100
    <li>Asks: The OPAC is located at ___</li>
101
    <li>Description: This preference is looking for the URL of your public catalog (OPAC) with the http:// in front of it (enter http://www.mycatalog.com instead of www.mycatalog.com). Once it is filled in Koha will use it to generate permanent links in your RSS feeds, for your social network share buttons and in your staff client when generating links to bib records in the OPAC.</li>
102
    <li style="color: #990000;">Important: Do not include a trailing slash in the URL this will break links created using this URL. (example: http://www.google.com not http://www.google.com/)</li>
103
    <li style="color: #990000;">Important: This must be filled in with the URL of your public catalog for RSS, unAPI, and search plugins to work.</li>
104
    <li style="color: #990000;">Important: This must be filled in with the URL of your public catalog to show 'OPAC View' links from bib records in the staff client:</li>
105
</ul></p>
106
107
<p><strong>OpacAdditionalStylesheet</strong>
108
<ul>
109
    <li>Asks: Include the additional CSS stylesheet ___ to override specified settings from the default stylesheet.</li>
110
    <li>Description: The preference can look for stylesheets in the template directory for your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file, opac-mystyles.css to this directory, you can specify it by entering opac-mystyles.css in your opaccolorstylesheet system preference. This adds your custom stylesheet as a linked stylesheet alongside the OPAC's default CSS files. This method is preferable because linked stylesheets are cached by the user's browser, meaning upon repeat visits to your site the user's browser will not have to re-download the stylesheet, instead using the copy in the browser's cache.</li>
111
    <li>If you would rather, you can upload your CSS to another server and enter the full URL pointing to it's location remember to begin the URL with http://</li>
112
    <li>Note: Leave this field blank to disable it</li>
113
    <li>Note: This file will add a linked CSS, not replace the existing default CSS.</li>
114
</ul></p>
115
116
<p><strong>opaccredits</strong>
117
<ul>
118
    <li>Asks: Include the following HTML in the footer of all pages in the OPAC:</li>
119
    <li>Note: Click the 'Click to edit; link to enter HTML to appear at the bottom of every page in the OPAC</li>
120
    <li>Description: This setting is for credits that will appear at the bottom of your OPAC pages. Credits traditionally encompass copyright information, last date updated, hyperlinks or other information represented in an HTML format. This is static information and any updates must be entered manually.</li>
121
    <li>Learn more in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/impopac.html#editableopac">OPAC Editable Regions</a> section.</li>
122
</ul></p>
123
124
<p><strong>OpacCustomSearch</strong>
125
<ul>
126
    <li>Asks: Replace the search box at the top of OPAC pages with the following HTML</li>
127
    <li>Description: This preference allows you to replace the default search box at the top of the OPAC with any HTML you would like.</li>
128
</ul></p>
129
130
<p><strong>OPACDisplay856uAsImage</strong>
131
<ul>
132
    <li>Default: Neither details or results page</li>
133
    <li>Asks: Display the URI in the 856u field as an image on: ___</li>
134
    <li>Description: In addition to this option being set, the corresponding XSLT option must be turned on. Also, the corresponding 856q field must have a valid MIME image extension (e.g., "jpg") or MIME image type (i.e. starting with "image/"), or the generic indicator "img" entered in the field. When all of the requirements are met, an image file will be displayed instead of the standard link text. Clicking on the image will open it in the same way as clicking on the link text. When you click on the image it should open to full size, in the current window or in a new window depending on the value in the system pref <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACULOpenInNewWindow">OPACURLOpenInNewWindow</a></li>
135
</ul></p>
136
137
<p><strong>OpacExportOptions</strong>
138
<ul>
139
    <li>Default: [All selected]</li>
140
    <li>Asks: List export options that should be available from OPAC detail page : ___</li>
141
    <li>Description: In the OPAC on the right of each bib record there is a menu that allows for saving the record in various formats. This patch will allow you to define which options are in the pull down menu. Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9- fields and subfields (marcstd), MODS (mods), and RIS (ris).</li>
142
</ul></p>
143
144
<p><strong>OPACFallback</strong>
145
<ul>
146
    <li>Default: bootstrap</li>
147
    <li>Asks: Use the ___ theme as the fallback theme on the OPAC.</li>
148
    <li>Description: This preference has no use right now, as Koha has only one theme, but if your library has a custom theme it will show here as an option. The purpose of this preference is to provide a way to choose to what theme to fallback on when you have a partial theme in place.</li>
149
</ul></p>
150
151
<p><strong>OpacFavicon</strong>
152
<ul>
153
    <li>Asks: Use the image at ___ for the OPAC's favicon.</li>
154
    <li style="color: #990000;">Important: This should be a complete URL, starting with http://</li>
155
    <li>Note: Turn your logo into a favicon with the <a href="http://www.antifavicon.com">Favicon Generator</a>.</li>
156
    <li>Description: The favicon is the little icon that appears next to the URL in the address bar in most browsers. The default value for this field (if left blank) is the small 'K' in the Koha logo.</li>
157
</ul></p>
158
159
<p><strong>opacheader</strong>
160
<ul>
161
    <li>Asks: Include the following HTML in the header of all pages in the OPAC</li>
162
    <li>Note: This value will appear above the main content of your page</li>
163
    <li>Note: Edit '<a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#LibraryName">LibraryName</a>' if you'd like to edit the contents of the &lt;title&gt; tag</li>
164
    <li>Learn more in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/impopac.html#editableopac">OPAC Editable Regions</a> section.</li>
165
</ul></p>
166
167
<p><strong>OpacHighlightedWords & NotHighlightedWords</strong>
168
<ul>
169
    <li>OpacHighlightedWords Default: Don't highlight</li>
170
    <li>NotHighlightedWords Default: and|or|not</li>
171
    <li>Asks: ___ 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 ___ (separate columns with |)</li>
172
</ul></p>
173
174
<p><strong>OpacKohaUrl</strong>
175
<ul>
176
    <li>Default: Don't show</li>
177
    <li>Description: When this preference is set to 'Show' text will appear in the bottom right of the OPAC footer stating 'Powered by Koha' and linking to the official Koha website.</li>
178
</ul></p>
179
180
<p><strong>OpacLangSelectorMode</strong>
181
<ul>
182
    <li>Default: only footer</li>
183
    <li>Asks: Display language selector on ___.</li>
184
    <li>Description: If you have the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opaclanguagesdisplay">opaclanguagesdisplay</a> preference set to display language options in the public catlaog, then this preference will allow you to control where the language selector shows. You can choose to show it only on the top or bottom or in both places.</li>
185
</ul></p>
186
187
<p><strong>opaclayoutstylesheet</strong>
188
<ul>
189
    <li>Default: opac.css</li>
190
    <li>Asks: Use the CSS stylesheet /css/ ___ on all pages in the OPAC, instead of the default</li>
191
    <li>Description: This setting's function is to point to the *.css file used to define the OPAC layout. A *.css file is a cascading stylesheet which is used in conjunction with HTML to set how the HTML page is formatted and will look on the OPAC. There are two stylesheets that come with the system; opac.css and opac2.css. A custom stylesheet may also be used. The stylesheets listed in the opaclayoutstylesheet preference are held on the Koha server.</li>
192
    <li>Note: Leave this field blank to disable it and let Koha use the default file instead</li>
193
    <li style="color #990000;">Important: Using a custom value in this preference causes Koha to completely ignore the default layout stylesheet.</li>
194
</ul></p>
195
196
<p><strong>OpacLocationBranchToDisplay</strong>
197
<ul>
198
    <li>Default: holding library</li>
199
    <li>Asks: Display the ___ for items on the OPAC record details page.</li>
200
    <li>Description: Defines whether to display the holding library, the home library, or both for the opac details page.</li>
201
</ul></p>
202
203
<p><strong>OpacLocationBranchToDisplayShelving</strong>
204
<ul>
205
    <li>Default: holding library</li>
206
    <li>Display the shelving location under the ___ for items on the OPAC record details page.</li>
207
    <li>Description: Defines where the shelving location should be displayed, under the home library, the holding library, or both.</li>
208
</ul></p>
209
210
<p><strong>OpacMaintenance</strong>
211
<ul>
212
    <li>Default: Don't show</li>
213
    <li>Asks: ___ a warning that the OPAC is under maintenance, instead of the OPAC itself.</li>
214
    <li>Note: this shows the same warning as when the database needs to be upgraded, but unconditionally.</li>
215
    <li>Description: This preference allows the system administrator to turn off the OPAC during maintenance and display a message to users. When this preference is switched to "Show" the OPAC is not usable. The text of this message is not editable at this time. When this preference is set to show the maintenance message the ability to search the OPAC is disabled and a message appears. The default message can be altered by using the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OpacMaintenanceNotice">OpacMaintenanceNotice</a> preference.</li>
216
</ul></p>
217
218
<p><strong>OpacMaintenanceNotice</strong>
219
<ul>
220
    <li>Asks: Show the following HTML when OpacMaintenance is enabled</li>
221
    <li>Description: This preference will allow you to set the text the OPAC displays when the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OpacMaintenance">OpacMaintenance</a> preference is set to 'Show.'</li>
222
</ul></p>
223
224
<p><strong>OpacMainUserBlock</strong>
225
<ul>
226
    <li>Default: Welcome to Koha...</li>
227
    <li>Asks: Show the following HTML in its own column on the main page of the OPAC</li>
228
    <li>Description: HTML entered in this field will appear in the center of the main page of your OPAC</li>
229
    <li>Learn more in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/impopac.html#editableopac">OPAC Editable Regions</a> section.</li>
230
</ul></p>
231
232
<p><strong>OpacMaxItemsToDisplay</strong>
233
<ul>
234
    <li>Default: 50</li>
235
    <li>Asks: Display up to ___ items on the biblio detail page</li>
236
    <li>Description: This preference will help with slow load times on the bibliographic detail pages by limiting the number of items to display by default. If the biblio has more items than this, a link is displayed instead that allows the user to choose to display all items.</li>
237
</ul></p>
238
239
<p><strong>OPACMySummaryHTML</strong>
240
<ul>
241
    <li>Asks: 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).</li>
242
    <li>Description: In this preference you can enter HTML that will appear on the 'Checked Out' tab on the 'My Summary' section when logged in to the OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR} will be replaced with information from the displayed record. This can be used to enter in 'share' links for social networks or generate searches against other library catalogs.</li>
243
    <li>Sample Data:
244
    &lt;p&gt;&lt;a href="http://www.facebook.com/sharer.php?u=http://YOUROPAC.ORG/cgi-bin/koha/opac-detail.pl?biblionumber={BIBLIONUMBER}"&gt;Share on Facebook&lt;/a&gt;
245
    &lt;br&gt;TITLE: {TITLE}
246
    &lt;br&gt;AUTHOR: {AUTHOR}
247
    &lt;br&gt;ISBN: {ISBN}
248
    &lt;br&gt;BIBLIONUMBER: {BIBLIONUMBER}&lt;/p&gt;</li>
249
</ul></p>
250
251
<p><strong>OPACMySummaryNote</strong>
252
<ul>
253
    <li>Asks: Note to display on the patron summary page.</li>
254
    <li>Description: This preference will display text above the patron's summary and below the welcome message when the patron logs in to the OPAC and view their 'my summary' tab.</li>
255
</ul></p>
256
257
<p><strong>OpacNav</strong>
258
<ul>
259
    <li>Default: Important links here.</li>
260
    <li>Asks: Show the following HTML on the left hand column of the main page and patron account on the OPAC (generally navigation links)</li>
261
    <li>Learn more in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/impopac.html#editableopac">OPAC Editable Regions</a> section.</li>
262
</ul></p>
263
264
<p><strong>OpacNavBottom</strong>
265
<ul>
266
    <li>Asks: Show the following HTML on the left hand column of the main page and patron account on the OPAC, after <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OpacNav">OpacNav</a>, and before patron account links if available:</li>
267
    <li>Description: When a patron is logged in to their account they see a series of tabs to access their account information. OpacNav appears above this list of tabs and OpacNavBottom will appear below them. When not on the patron account pages the HTML in OpacNavBottom will just appear right below OpacNav.</li>
268
</ul></p>
269
270
<p><strong>OpacNavRight</strong>
271
<ul>
272
    <li>Asks: Show the following HTML in the right hand column of the main page under the main login form.</li>
273
    <li>Description: HTML entered in this preference will appear on the right hand side of the OPAC under the log in form. If the log in form is not visible this content will move up on the right column.</li>
274
</ul></p>
275
276
<p><strong>OPACNoResultsFound</strong>
277
<ul>
278
    <li>Asks: Display this HTML when no results are found for a search in the OPAC</li>
279
    <li>This HTML will display below the existing notice that no results were found for your search.</li>
280
    <li>Note: You can insert placeholders {QUERY_KW} that will be replaced with the keywords of the query.</li>
281
</ul></p>
282
283
<p><strong>OpacPublic</strong>
284
<ul>
285
    <li>Default: Enable</li>
286
    <li>Asks: ___ Koha OPAC as public. Private OPAC requires authentication before accessing the OPAC.</li>
287
    <li>Description: This preference determines if your OPAC is accessible and searchable by anyone or only by members of the library. If set to 'Don't enable' only members who are logged into the OPAC can search. Most libraries will leave this setting at its default of 'Enable' to allow their OPAC to be searched by anyone and only require login for access to personalized content.</li>
288
</ul></p>
289
290
<p><strong>OPACResultsSidebar</strong>
291
<ul>
292
    <li>Asks: Include the following HTML under the facets in OPAC search results</li>
293
    <li>Description: The HTML entered in this preference will appear on the search results pages below the list of facets on the left side of the screen.</li>
294
</ul></p>
295
296
<p><strong>OPACSearchForTitleIn</strong>
297
<ul>
298
    <li>Default: &lt;li&gt;&lt;a href="http://worldcat.org/search?q={TITLE}" target="_blank"&gt;Other Libraries (WorldCat)&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href="http://www.scholar.google.com/scholar?q={TITLE}" target="_blank"&gt;Other Databases (Google Scholar)&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href="http://www.bookfinder.com/search/?author={AUTHOR}&amp;title={TITLE}&amp;st=xl&amp;ac=qr" target="_blank"&gt;Online Stores (Bookfinder.com)&lt;/a&gt;&lt;/li&gt;</li>
299
    <li>Asks: Include a "More Searches" box on the detail pages of items on the OPAC, with the following HTML (leave blank to disable)</li>
300
    <li>Note: The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN}, {ISSN} and {AUTHOR} will be replaced with information from the displayed record.</li>
301
</ul></p>
302
303
<p><strong>OpacSeparateHoldings & OpacSeparateHoldingsBranch</strong>
304
<ul>
305
    <li>OpacSeparateHoldings default: Don't separate</li>
306
    <li>OpacSeparateHoldingsBranch default: home library</li>
307
    <li>Asks: ___ items display into two tabs, where the first tab contains items whose ___ is the logged in user's library. The second tab will contain all other items.</li>
308
    <li>Description: This preference lets you decide if you would like to have the holding information on the bibliographic detail page in the OPAC split in to multiple tabs. The default is to show all holdings on one tab.</li>
309
</ul></p>
310
311
<p><strong>OPACShowBarcode</strong>
312
<ul>
313
    <li>Default: Don't show</li>
314
    <li>Asks: ___ the item's barcode on the holdings tab.</li>
315
    <li>Description: This preference allows you to control whether patrons can see items' barcodes in the OPAC.</li>
316
</ul></p>
317
318
<p><strong>OPACShowCheckoutName</strong>
319
<ul>
320
    <li>Default: Don't show</li>
321
    <li>Asks: ___ the name of the patron that has an item checked out on item detail pages on the OPAC.</li>
322
    <li>Description: This preference allows all patrons to see who has the item checked out if it is checked out. In small corporate libraries (where the OPAC is behind a firewall and not publicly available) this can be helpful so coworkers can just contact the patron with the book themselves. In larger public and academic libraries setting this to 'Show' would pose serious privacy issues.</li>
323
</ul></p>
324
325
<p><strong>OPACShowHoldQueueDetails</strong>
326
<ul>
327
    <li>Default: Don't show any hold details</li>
328
    <li>Asks: ___ to patrons in the OPAC.</li>
329
</ul></p>
330
331
<p><strong>OpacShowRecentComments</strong>
332
<ul>
333
    <li>Default: Don't show</li>
334
    <li>Asks: ___ a link to recent comments in the OPAC masthead.</li>
335
    <li>Description: If you have chosen to allow comments in your OPAC by setting <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#reviewson">reviewson</a> to 'Allow' you can include a link to the recent comments under the search box at the top of your OPAC with this preference.</li>
336
</ul></p>
337
338
<p><strong>OPACShowUnusedAuthorities</strong>
339
<ul>
340
    <li>Default: Show</li>
341
    <li>Asks: ___ unused authorities in the OPAC authority browser.</li>
342
    <li style="color: #990000;">Important: Requires that the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OpacAuthorities">OpacAuthorities</a> preference is set to 'Allow'</li>
343
    <li>Description: When patrons search your authority file via the OPAC they will see all authorities in your system even if you don't have them linked to any bibliographic records. This preference lets you determine what the default behavior is when searching authorities via the OPAC. If you choose 'Do not show' it will only show patrons authority records that are linked to bib records in the search results. Otherwise the system will show all authority records even if they aren't linked to records.</li>
344
</ul></li>
345
346
<p><strong>OpacStarRatings</strong>
347
<ul>
348
    <li>Default: no</li>
349
    <li>Asks: Show star-ratings on ___ pages.</li>
350
    <li>Description: Star ratings are a way for your patrons to leave ratings without having to leave a full review. Patrons who are not logged in will only be able to see the stars, once logged in patrons can click on the stars on the details page to leave their own rating. Clicking on the stars on the search results will not submit a rating.</li>
351
</ul></p>
352
353
<p><strong>OpacSuggestionManagedBy</strong>
354
<ul>
355
    <li>Default: Show</li>
356
    <li>Asks: ___ the name of the staff member who managed a suggestion in OPAC.</li>
357
    <li>Description: If you're <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#suggestionspref">allowing patrons to make purchase suggestions</a> then they will see the 'my suggestions' tab when logged in. This tab shows the patron the librarian who approved or rejected the purchase suggestion. This preference controls if the patron sees the librarian's name or not.</li>
358
</ul></p>
359
360
<p><strong>opacthemes</strong>
361
<ul>
362
    <li>Default: bootstrap</li>
363
    <li>Asks: Use the ___ theme on the OPAC.</li>
364
</ul></p>
365
366
<p><strong>OPACURLOpenInNewWindow</strong>
367
<ul>
368
    <li>Default: don't</li>
369
    <li>Asks: When patrons click on a link to another website from your OPAC (like Amazon or OCLC), ___ open the website in a new window.</li>
370
    <li>Description: This preference determines if URLs in the OPAC will open in a new window or not. When clicking on a link in the OPAC, a patron does not need to worry about navigating away from their search results.</li>
371
</ul></p>
372
373
<p><strong>OPACUserCSS</strong>
374
<ul>
375
    <li>Asks: Include the following CSS on all pages in the OPAC</li>
376
    <li>Description: OPACUserCSS allows the administrator to enter styles that will overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet' or 'opacstylesheet'. Styles may be entered for any of the selectors found in the default style sheet. The default stylesheet will likely be found at http://your_koha_address/opac-tmpl/bootstrap/css/opac.css. Unlike <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OpacAdditionStylesheet">OpacAdditionalStylesheet</a> and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opaclayoutstylesheet">opaclayoutstylesheet</a> this preference will embed the CSS directly on your OPAC pages.</li>
377
</ul></p>
378
379
<p><strong>OPACUserJS</strong>
380
<ul>
381
    <li>Asks: Include the following JavaScript on all pages in the OPAC</li>
382
    <li>Description: This preference allows the administrator to enter JavaScript or JQuery that will be embedded across all pages of the OPAC. Administrators may use this preference to customize some of the interactive sections of Koha, customizing the text for the login prompts, for example. Sample JQuery scripts used by Koha libraries can be found on the wiki: <a href="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</a>.</li>
383
</ul></p>
384
385
<p><strong>OPACXSLTDetailsDisplay</strong>
386
<ul>
387
    <li>Default: default</li>
388
    <li>Asks: Display OPAC details using XSLT stylesheet at ___</li>
389
    <li>Description: XSLT stylesheets allow for the customization of the details shows on the screen when viewing a bib record. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.</li>
390
</ul></p>
391
392
<p><strong>OPACXSLTResultsDisplay</strong>
393
<ul>
394
    <li>Default: default</li>
395
    <li>Asks: Display OPAC results using XSLT stylesheet at ___</li>
396
    <li>Description: XSLT stylesheets allow for the customization of the details shows on the screen when viewing the search results. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.</li>
397
</ul></p>
398
399
<h3>Features</h3>
400
401
<p><strong>numSearchRSSResults</strong>
402
<ul>
403
    <li>Default: 50</li>
404
    <li>Asks: Display ___ search results in the RSS feed.</li>
405
    <li>Description: By default the RSS feed that is automatically generated for every search results page will list 50 items. This can sometimes be too much for some RSS feed readers and for some people this isn't enough. This preference allows you to adjust this number to show the best number of results for your patrons.</li>
406
</ul></p>
407
408
<p><strong>OPACAcquisitionDetails</strong>
409
<ul>
410
    <li>Default: Don't display</li>
411
    <li>Asks: ___ the acquisition details on OPAC detail pages.</li>
412
    <li>Description: This preference shows the patrons how many items are on order in the Holdings tab if you have the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AcqCreateItem">AcqCreateItem</a> set to 'cataloging the record'</li>
413
</ul></p>
414
415
<p><strong>OpacAuthorities</strong>
416
<ul>
417
    <li>Default: Allow</li>
418
    <li>Asks: ___ patrons to search your authority records.</li>
419
    <li>Description: This preference displays the link on the OPAC for the authority search. By setting the preference to "Allow" patrons can use this search link of the OPAC.</li>
420
</ul></p>
421
422
<p><strong>opacbookbag</strong>
423
<ul>
424
    <li>Default: Allow</li>
425
    <li>Asks: ___ patrons to store items in a temporary "Cart" on the OPAC.</li>
426
    <li>Description: This preference allows the user to temporarily save a list of items found on the catalog. By using the Book Bag, or Cart, the user can print out or email a list of items found. The user does not need to be logged in. This list is temporary and will be emptied, or cleared, at the end of the session.</li>
427
</ul></p>
428
429
<p><strong>OpacBrowser</strong>
430
<ul>
431
    <li style="color: #990000;">Important: This preference only applies to French systems at this time.</li>
432
    <li>Default: Don't allow</li>
433
    <li>Asks: ___ patrons to browse subject authorities on OPAC</li>
434
    <li style="color: #990000;">Important: run the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#authbrowsercron">Authorities Browser Cron Job</a> to create the browser list</li>
435
</ul></p>
436
437
<p><strong>OpacBrowseResults</strong>
438
<ul>
439
    <li>Default: enable</li>
440
    <li>Asks: ___ browsing and paging search results from the OPAC detail page.</li>
441
    <li>Description: This preference will control the option to return to your results and/or browse them from the detail page in the OPAC.</li>
442
</ul></p>
443
444
<p><strong>OpacCloud</strong>
445
<ul>
446
    <li style="color: #990000;">Important: This preference only applies to French systems at this time.</li>
447
    <li>Default: Don't show</li>
448
    <li>Asks: ___ a subject cloud on OPAC</li>
449
    <li style="color: #990000;">Important: run the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#authbrowsercron">Authorities Browser Cron Job</a> to create the browser list</li>
450
</ul></p>
451
452
<p><strong>OPACFinesTab</strong>
453
<ul>
454
    <li>Default: Allow</li>
455
    <li>Asks: ___ patrons to access the Fines tab on the My Account page on the OPAC.</li>
456
</ul></p>
457
458
<p><strong>OpacHoldNotes</strong>
459
<ul>
460
    <li>Default: Do not allow</li>
461
    <li>Asks: ___ users to add a note when placing a hold.</li>
462
</ul></p>
463
464
<p><strong>OPACISBD</strong>
465
<ul>
466
    <li>Default: <a href="http://manual.koha-community.org/[% helpVersion %]/en/opacisbddefaults.html#opacisbdmarcdefault">MARC21 Default Appendix</a></li>
467
    <li>Asks: Use the following as the OPAC ISBD template:</li>
468
    <li>Description: This determines how the ISBD information will display in the OPAC. Elements in the list can be reordered to produce a different ISBD view. ISBD, the International Standard Bibliographic Description, was first introduced by IFLA (International Federation of Library Associations) in 1969 in order to provide guidelines for descriptive cataloging. The purpose of ISBD is to aid the international exchange of bibliographic records for a variety of materials.</li>
469
</ul></p>
470
471
<p><strong>OpacItemLocation</strong>
472
<ul>
473
    <li>Default: call number only</li>
474
    <li>Asks: Show ____ for items on the OPAC search results.</li>
475
    <li>Description: This setting allows users of the OPAC results XSLT stylesheet to choose to display collection code or location in addition to call number.</li>
476
</ul></p>
477
478
<p><strong>OpacPasswordChange</strong>
479
<ul>
480
    <li>Default: Allow</li>
481
    <li>Asks: ___ patrons to change their own password on the OPAC.</li>
482
    <li style="color: #990000;">Important: Enabling this will break LDAP authentication.</li>
483
</ul></p>
484
485
<p><strong>OPACPatronDetails</strong>
486
<ul>
487
    <li>Default: Allow</li>
488
    <li>Asks: ___ patrons to notify the library of changes to their contact information from the OPAC.</li>
489
    <li>Description: If patrons are allowed to notify the library of changes to their account then staff will need to approve the changes via the staff client. Notification of patron account requests will appear on the dashaboard below the list of modules with other pending actions. Once you click the notification you will be presented with the changes the patron would like to make to their account and from there you can choose how to proceed.</li>
490
    <li>Note: You can control what fields patrons see and can modify via the OPAC by setting the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</a> &amp; <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</a> preferences.</li>
491
</ul></p>
492
493
<p><strong>OPACpatronimage</strong>
494
<ul>
495
    <li>Default: Don't show</li>
496
    <li>Asks: ___ patron images on the patron information page in the OPAC.</li>
497
    <li>Description: If <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#patronimages">patronimages</a> is set to allow the upload of patron images via the staff client, then setting this preference to 'show' will show the patron what image you have on file for them when they view their personal information on their account in the OPAC.</li>
498
</ul></p>
499
500
<p><strong>OPACPopupAuthorsSearch</strong>
501
<ul>
502
    <li>Default: Don't display</li>
503
    <li>Asks: ___ the list of authors/subjects in a popup for a combined search on OPAC detail pages.</li>
504
    <li>Description: If this preference is set to 'Display' then clicking a subject or author from the details page in the OPAC will present the searcher with a pop up box. From this box you can check off any of the subjects or authors listed and search them all at once by clicking 'Search' at the bottom of the pop up. The default behavior is for Koha to search just the clicked author or subject.</li>
505
</ul></p>
506
507
<p><strong>OpacResetPassword</strong>
508
<ul>
509
    <li>Default: not allowed</li>
510
    <li>Asks: Library users are ___ to recover their password via e-mail in the OPAC.</li>
511
    <li>Description: This preference controls whether you present users of the public catalog with a 'Forgot your password' link or not. Learn more in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/opacmyaccount.html#resetpwopac">OPAC section</a> of this manual.</li>
512
</ul></p>
513
514
<p><strong>OpacTopissue</strong>
515
<ul>
516
    <li>Default: Don't allow</li>
517
    <li>Asks: ___ patrons to access a list of the most checked out items on the OPAC.</li>
518
    <li>Description: This preference allows the administrator to choose to show the "Most Popular" link at the top of the OPAC under the search box. The "Most Popular" page shows the top circulated items in the library, as determined by the number of times a title has been circulated. This allows users to see what titles are popular in their community. It is recommended that you leave this preference set to 'Don't allow' until you have been live on Koha for a couple of months, otherwise the data that it shows will not be an accurate portrayal of what's popular in your library.</li>
519
</ul></p>
520
521
<p><strong>opacuserlogin</strong>
522
<ul>
523
    <li>Default: Allow</li>
524
    <li>Asks: ___ patrons to log in to their accounts on the OPAC.</li>
525
    <li>The OPAC will still be searchable if patrons can't log in, this just disables the patron account access via the OPAC</li>
526
</ul></p>
527
528
<p><strong>QuoteOfTheDay</strong>
529
<ul>
530
    <li>Default: Disable</li>
531
    <li>Asks: ___ Quote of the Day display on OPAC home page</li>
532
    <li>Description: This feature will allow you to enter a series of quotes that will then show on the OPAC homepage in random order. To add/edit quotes, visit the <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaltools.html#QOTDEditor">Quote of the Day Editor</a> under Tools.</li>
533
</ul></p>
534
535
<p><strong>RequestOnOpac</strong>
536
<ul>
537
    <li>Default: Allow</li>
538
    <li>Asks: ___ patrons to place holds on items from the OPAC.</li>
539
</ul></p>
540
541
<p><strong>reviewson</strong>
542
<ul>
543
    <li>Default: Allow</li>
544
    <li>Asks: ___ patrons to make comments on items on the OPAC.</li>
545
    <li>Description: This button allows the patrons to submit comments on books they have read via the OPAC. If this preference is set to "Allow" reviews are first sent to the staff client for staff approval before the review is displayed in the OPAC. The staff member who reviews and approves comments may find the pending comments on the <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#comments">Comments</a> tool. The staff member can then choose to approve or delete the comments.</li>
546
</ul></p>
547
548
<p><strong>ShowReviewer</strong>
549
<ul>
550
    <li>Default: full name</li>
551
    <li>Asks: Show ___ of commenter with comments in OPAC.</li>
552
    <li>Description: If you would like to protect your patron's privacy in the OPAC you can choose to hide their names or parts of their names from any of the comments they leave on bib records in your system. <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#reviewson">reviewson</a> needs to be set to 'Allow' for this to preference to come in to play</li>
553
</ul></p>
554
555
<p><strong>ShowReviewerPhoto</strong>
556
<ul>
557
    <li>Default: Show</li>
558
    <li>Asks: ___ reviewer's photo beside comments in OPAC.</li>
559
    <li><a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#reviewson">reviewson</a> needs to be set to 'Allow' and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ShowReviewer">ShowReviewer</a> needs to be set to 'Show' for this to preference to come in to play</li>
560
    <li>Description: This system preference allows libraries to show avatars next to patron's comments in the OPAC. These avatars are pulled from the <a href="https://www.libravatar.org">Libravatar</a> library, an open source powered product that allows Internet users to choose a small icon to display next to their name on various different websites. The library has no control over the images the patron chooses to display.</li>
561
</ul></p>
562
563
<p><strong>SocialNetworks</strong>
564
<ul>
565
    <li>Default: Disable</li>
566
    <li>Asks: ___ social network links in opac detail pages</li>
567
    <li>Description: This preference will enable a line of social network share buttons below the right hand column on the detail pages of records in the OPAC.</li>
568
    <li style="color: #990000;">Important: In order for these share buttons to work when clicked you must have filled in your <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACBaseURL">OPACBaseURL</a> preference.</li>
569
</ul></p>
570
571
<p><strong>suggestion</strong>
572
<ul>
573
    <li>Default: Allow</li>
574
    <li>Asks: ___ patrons to make purchase suggestions on the OPAC.</li>
575
</ul></p>
576
577
<h3>Payments</h3>
578
<p>These preferences will allow you control the tools you use to accept online payments from your patrons via the OPAC.</p>
579
580
<p><strong>EnablePayPalOpacPayments & PayPalSandboxMode</strong>
581
<ul>
582
    <li>EnablePayPalOpacPayments Default: Don't allow</li>
583
    <li>PayPalSandboxMode Default: Sandbox</li>
584
    <li>Asks: ___ patrons to make payments from the OPAC via PayPal in ___ mode.</li>
585
    <li>Description: This preference will allow you to accept credit card payments via the OPAC for fines via PayPal. You will need to set up your PayPal account and it is recommended that you run tests before using this in production.</li>
586
    <li style="color: #990000;">Important: PayPayl's terms of service state that you cannot charge your patrons for the processing fees and so this plugin will not add additional fees to the charges.</li>
587
</ul></p>
588
589
<p><strong>PayPalChargeDescription</strong>
590
<ul>
591
    <li>Default: Koha fee payment</li>
592
    <li>Asks: The patron should see the charge description as ___</li>
593
    <li>Description: This preference controls what the patron will see on their PayPal account/Bank account for this charge.</li>
594
</ul></p>
595
596
<p><strong>PayPalPwd</strong>
597
<ul>
598
    <li>Asks: The password for the PayPal account to receive payments is ___</li>
599
</ul></p>
600
601
<p><strong>PayPalSignature</strong>
602
<ul>
603
    <li>Asks: The signature for the PayPal account to receive payments is ___</li>
604
</ul>
605
606
<p><strong>PayPalUser</strong>
607
<ul>
608
    <li>Asks: The email address to receive PayPal payments is ___</li>
609
</ul></p>
610
611
<h3>Policy</h3>
612
613
<p><strong>AllowPurchaseSuggestionBranchChoice</strong>
614
<ul>
615
    <li>Default: Don't allow</li>
616
    <li>Asks: ___ patrons to select branch when making a purchase suggestion</li>
617
    <li>Description: If your library system lets patrons make purchase suggestions for a specific branch you can set this preference to 'Allow' to add a branch selection option to the purchase suggestion form.</li>
618
</ul></p>
619
620
<p><strong>BlockExpiredPatronOpacActions</strong>
621
<ul>
622
    <li>Default: Don't block</li>
623
    <li>Asks: ___ expired patrons from OPAC actions such as placing a hold or renewing.</li>
624
    <li>Description: This preference lets you set a default value for how Koha handles permissions for patrons who are expired. This preference can be overwritten by the setting on <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#patcats">individual patron categories</a>.</li>
625
</ul></p>
626
627
<p><strong>OpacAllowPublicListCreation</strong>
628
<ul>
629
    <li>Default: Allow</li>
630
    <li>Asks: ___ opac users to create public lists</li>
631
    <li>Description: Public lists are visible to anyone who visits your OPAC. With this preference you can control whether or now patrons are allowed to create these public lists. If this is set to "Don't allow" then only staff will be able to create public lists.</li>
632
    <li>Important: This preference will only be taken in to account if you have <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#virtualshelves">virtualshelves</a> set to 'Allow'</li>
633
</ul></p>
634
635
<p><strong>OpacAllowSharingPrivateLists</strong>
636
<ul>
637
    <li>Default: Don't allow</li>
638
    <li>Asks: ___ opac users to share private lists with other patrons.</li>
639
    <li>Description: This feature will add the option for patrons to share their lists with other patrons. When this is set to 'Allow' patrons will see a share link at the top of their list. When they click that link it will ask for the email of the patron they would like to share with. Koha will then email the patron an invitation to see the list.</li>
640
</ul></p>
641
642
<p><strong>OPACFineNoRenewals</strong>
643
<ul>
644
    <li>Default: 99999</li>
645
    <li>Asks: Only allow patrons to renew their own books on the OPAC if they have less than ___ USD in fines</li>
646
    <li>Note: Leave this field blank to disable</li>
647
    <li style="color: #990000;">Important: To allow renewals in the OPAC, <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opacuserlogin">opacuserlogin</a> needs to be set to 'allow'</li>
648
</ul></p>
649
650
<p><strong>OpacHiddenItems</strong>
651
<ul>
652
    <li>Asks: Allows to define custom rules for hiding specific items at opac.</li>
653
    <li>Note: See docs/opac/OpacHiddenItems.txt in your Koha install directory for more information</li>
654
    <li>Description: In this field you can enter criteria for items you would like to hide from display in the OPAC. This field takes any combination of item fields (from the items table in the Koha database) for blocking.</li>
655
</ul></p>
656
657
<p><strong>OpacRenewalAllowed</strong>
658
<ul>
659
    <li>Default: Don't allow</li>
660
    <li>Asks: ___ patrons to renew their own books on the OPAC.</li>
661
    <li>Description: This preference allows the administration to choose if patrons can renew their checked out materials via their checked out history in the OPAC. It allows patrons to renew their materials without having to contact the library or having to return to the library.</li>
662
</ul></p>
663
664
<p><strong>OpacRenewalBranch</strong>
665
<ul>
666
    <li>Default: the branch the item was checked out from</li>
667
    <li>Asks: Use ___ as branchcode to store in the statistics table</li>
668
    <li>Description: This value is used in the statistics table to help with reporting. The statistics table in Koha keeps track of all checkouts and renewals, this preference defines which branch is entered in to the table when a patron renews an item for themselves via the OPAC.</li>
669
</ul></p>
670
671
<p><strong>OPACViewOthersSuggestions</strong>
672
<ul>
673
    <li>Default: Don't show</li>
674
    <li>Asks: ___ purchase suggestions from other patrons on the OPAC.</li>
675
</ul></p>
676
677
<p><strong>SearchMyLibraryFirst</strong>
678
<ul>
679
    <li>Default: Don't limit</li>
680
    <li>Asks: ___ patrons' searches to the library they are registered at.</li>
681
</ul></p>
682
683
<h3>Privacy</h3>
684
685
<p><strong>AllowPatronToSetCheckoutsVisibilityForGuarantor</strong>
686
<ul>
687
    <li>Default: Don't allow</li>
688
    <li>Asks: ___ patrons to choose their own privacy settings for showing the patron's checkouts to the patron's guarantor".</li>
689
    <li>Description: By default staff can see checkouts to family members via the staff client. This preference will allow guarantees (children) to grant permission to guarantors (guardians) to view their current checkouts via the public catalog. This preference requires that you allow patrons to se their own privacy with the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACPrivacy">OPACPrivacy</a> preference.</li>
690
</ul></p>
691
692
<p><strong>AnonSuggestions</strong>
693
<ul>
694
    <li>Default: Don't allow</li>
695
    <li>Asks: ___ patrons that aren't logged in to make purchase suggestions.</li>
696
    <li style="color: #990000;">Important: If set to 'Allow', suggestions are connected to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AnonymousPatron">AnonymousPatron</a></li>
697
</ul></p>
698
699
<p><strong>AnonymousPatron</strong>
700
<ul>
701
    <li>Default: 0</li>
702
    <li>Asks: Use borrowernumber ___ as the Anonymous Patron (for anonymous suggestions and reading history)</li>
703
    <li>Note: Before setting this preference <a href="http://manual.koha-community.org/[% helpVersion %]/en/patrons.html#addnewpatron">create a patron</a> to be used for all anonymous suggestions and/or reading history items. This patron can be any type and should be named something to make it clear to you that they're anonymous (ex. Anonymous Patron).</li>
704
    <li style="color: #990000;">Important: Remember to use the borrowernumber note the patron's cardnumber for this value. The borrowernumber can be found on the patron record under 'Library use' on the right.</li>
705
</ul></p>
706
707
<p><strong>EnableOpacSearchHistory</strong>
708
<ul>
709
    <li>Default: Keep</li>
710
    <li>Asks: ___ patron search history in the OPAC.</li>
711
</ul></p>
712
713
<p><strong>OPACPrivacy</strong>
714
<ul>
715
    <li>Default: Don't allow</li>
716
    <li>Asks: ___ patrons to choose their own privacy settings for their reading history.</li>
717
    <li style="color: #990000;">Important: This requires <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opacreadinghistory">opacreadinghistory</a> set to 'Allow' and <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AnonymousPatron">AnonymousPatron</a> to be set to your anonymous patron's borrowernumber.</li>
718
    <li>Description: The default privacy setting for each patron category can be set in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#patcats">Patrons Categories</a> area. If you set this preference to 'allow' then patrons can change that for themselves via the OPAC.</li>
719
    <li>Important: If patron has chosen to have their reading history anonymized and you have <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#StoreLastBorrower">StoreLastBorrower</a> set to "Don't store" then as soon as the item is checked in the last borrower will be anonymized.</li>
720
</ul></p>
721
722
<p><strong>opacreadinghistory</strong>
723
<ul>
724
    <li>Default: Allow</li>
725
    <li>Asks: ___ patrons to see what books they have checked out in the past.</li>
726
    <li style="color: #990000;">Important: Enabling this will make it so that patrons can view their circulation history in the OPAC unless you have <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACPrivacy">OPACPrivacy</a> set to 'Allow.'</li>
727
    <li style="color: #990000;">Important: This data is stored in the system regardless of your choice, unless your patrons have chosen to never have their reading history kept.</li>
728
</ul></p>
729
730
<p><strong>StoreLastBorrower</strong>
731
<ul>
732
    <li>Default: Don't store</li>
733
    <li>Asks: ___ the last patron to return an item.</li>
734
    <li>Description: This preference allows you to store the last patron to borrow an item even if the patron has chosen to have their reading history anonymized.</li>
735
    <li>Note: This setting is independent of <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opacreadinghistory">opacreadinghistory</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AnonymousPatron">AnonymousPatron</a>.</li>
736
</ul></p>
737
738
<p><strong>TrackClicks</strong>
739
<ul>
740
    <li>Default: Don't track</li>
741
    <li>Asks: ___ links that patrons click on.</li>
742
    <li>Description: By setting this preference to one of the track options you will allow Koha to track every link clicked in Koha. This data will be stored in a database table so that you can run reports against that data. If you choose to 'Track' clicks then Koha will record both the link clicked and the logged in user who clicked the link. If you choose to 'Track anonymously' then the borrowernumber will not be recorded, but the rest of the data will.</li>
743
    <li>Note: Remember to update your local privacy policies and link to them from the OPAC to notify your users that you are tracking their information.</li>
744
</ul></p>
745
746
<h3>Restricted Page</h3>
747
<p>Using the following preferences you can create a page within your Koha system that is accessible by only specific IP addresses. This can be used to house links to databases that can only be accessed from with the library or other licensed content.</p>
748
749
<p><strong>RestrictedPageContent</strong>
750
<ul>
751
    <li>Asks: HTML content of your restricted page.</li>
752
</ul></p>
753
754
<p><strong>RestrictedPageLocalIPs</strong>
755
<ul>
756
    <li>Asks: Access from IP addresses beginning with ___ do not need to be authenticated</li>
757
    <li>Description: You can enter individual IPS as a comma separated list (ex: '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex: '127.0.')</li>
758
</ul></p>
759
760
<p><strong>RestrictedPageTitle</strong>
761
<ul>
762
    <li>Asks: Use ___ as title of your restricted page</li>
763
    <li>Description: This title will appear in the breadcrumb and on the top of the restricted page.</li>
764
</ul>
765
766
<h3>Self Registration</h3>
767
768
<p><strong>PatronSelfModificationBorrowerUnwantedField</strong>
769
<ul>
770
    <li>Default: password</li>
771
    <li>Asks: The following <a href="http://schema.koha-community.org/[% helpVersion.replace('\.','_') %]/tables/borrowers.html">database columns</a> will not appear on the patron self-modification screen: ___</li>
772
    <li>Description: This preference allows you to define what fields patrons can edit if you're allowing them to update their personal information via the public catalog with the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACPatronDetails">OPACPatronDetails</a> preference.</li>
773
    <li style="color: #990000;">Important: Separate columns with |</li>
774
</ul></p>
775
776
<p><strong>PatronSelfRegistration</strong>
777
<ul>
778
    <li>Default: Don't allow</li>
779
    <li>Asks: ___ library patrons to register an account via the OPAC.</li>
780
    <li>Description: Setting this preference to 'Allow' will provide a link on the OPAC to register for a new account. Using the other <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opacselfregistrationprefs">Self Registration</a> system preferences you can control how this preference will function.</li>
781
    <li style="color: #990000;">Important: Patrons registering via the OPAC will not need to be approved by a librarian. For this reason it is recommended that you set up a provisional <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#patcats">patron category</a> with no <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">circulation rights</a>. That way patrons will have to come in to the library to verify their identity before given circulation rights at the library. Once the patron confirms their identiy the library staff can change the category to one with permissions to check items out and place holds.</li>
782
</ul></p>
783
784
<p><strong>PatronSelfRegistrationAdditionalInstructions</strong>
785
<ul>
786
    <li>Asks: Display the following additional instructions for patrons who self register via the OPAC ( HTML is allowed ):</li>
787
    <li>Description: This preference takes any HTML you'd like to display on the page the patron sees after successfully registering for their library card.</li>
788
</ul></p>
789
790
<p><strong>PatronSelfRegistrationBorrowerMandatoryField</strong>
791
<ul>
792
    <li>Default: surname|firstname</li>
793
    <li>Asks: The following database columns must be filled in on the patron entry screen: ___</li>
794
    <li>Description: This preference allows you to define what fields patrons must fill in on their self regisration form. If any of the required fields are blank Koha will not let the patron register.</li>
795
    <li style="color: #990000;">Important: Separate columns with |</li>
796
    <li>Note: For help with field names, ask your system administrator or <a href="http://schema.koha-community.org/[% helpVersion.replace('\.','_') %]/tables/borrowers.html">view the database structure</a> associated with the borrowers table.</li>
797
    <li>Note: If you're going to require that patrons verify their accounts via email with the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</a> preference the email field will automatically be marked as required.</li>
798
</ul></p>
799
800
<p><strong>PatronSelfRegistrationBorrowerUnwantedField</strong>
801
<ul>
802
    <li>Default: password</li>
803
    <li>Asks: The following database columns will not appear on the patron entry screen: ___</li>
804
    <li>Description: Using this preference you can hide fields from the patron registraion and update form in the OPAC.</li>
805
    <li style="color: #990000;">Important: Separate columns with |</li>
806
    <li>Note: For help with field names, ask your system administrator or <a href="http://schema.koha-community.org/[% helpVersion.replace('\.','_') %]/tables/borrowes.html">view the database structure</a> associated with the borrowers table.</li>
807
</ul></p>
808
809
<p><strong>PatronSelfRegistrationDefaultCategory</strong>
810
<ul>
811
    <li>Asks: Use the patron category code ___ as the default patron category for patrons registered via the OPAC.</li>
812
    <li>Description: Enter in the patron category code for the category that all new patrons registered via the OPAC will be put in to.</li>
813
    <li style="color: #990000;">Important: Patrons registering via the OPAC will not need to be approved by a librarian. For this reason it is recommended that you set up a provisional <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#patcats">patron category</a> with no <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">circulation rights</a>. That way patrons will have to come in to the library to verify their identity before given circulation rights at the library. Once the patron confirms their identiy the library staff can change the category to one with permissions to check items out and place holds.</li>
814
    <li style="color: #990000;">Important: If you leave this blank or enter in an invalid code your patrons will still be able to register but will not be given a username. There will be no errors on the page to explain this, so be sure to enter a valid patron category code.</li>
815
</ul></p>
816
817
<p><strong>PatronSelfRegistrationExpireTemporaryAccountsDelay</strong>
818
<ul>
819
    <li>Default: 0</li>
820
    <li>Asks: Delete patrons registered via the OPAC, but not yet verified after ___ days.</li>
821
    <li>Description: This preference links to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#deleteexpiredregistrationcron">delete_expired_opac_registrations.pl cron job</a>. If that cron is set to run nightly it will clean up any registrations that have not been verified via email in the number of days entered on this preference. This is dependent on <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</a> preference.</li>
822
</ul></p>
823
824
<p><strong>PatronSelfRegistrationVerifyByEmail</strong>
825
<ul>
826
    <li>Default: Don't require</li>
827
    <li>Asks: ___ that a self-registering patron verify his or herself via email.</li>
828
    <li>Description: If you require patrons to verify their accounts via email they will not be able to log in to the OPAC until they acknowledge the email sent by Koha. If you don't require this then patrons will be able to log in as soon as they fill in the registration form. You can set the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</a> preference to delete the un-verified self registrations after a certain number of days.</li>
829
    <li>Note: If you're going to require that patrons verify their accounts via email then the email field will automatically be marked as required.</li>
830
</ul></p>
831
832
<h3>Shelf Browser</h3>
833
834
<p><strong>OPACShelfBrowser</strong>
835
<ul>
836
    <li>Default: Show</li>
837
    <li>Asks: ___ a shelf browser on item details pages, allowing patrons to see what's near that item on the shelf.</li>
838
    <li>Description: This preference allows patrons to view what is located on the shelf near the item they looked up. The shelf browser option appears on the details page to the right of each items' call number. Clicking the 'Browse Shelf' link allows for a virtual shelf browsing experience via the OPAC and lets patrons see other books that may relate to their search and items that sit on the shelf near the item they are looking at.</li>
839
    <li style="color: #990000;">Important: 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.</li>
840
</ul></p>
841
842
<p><strong>ShelfBrowserUsesCcode</strong>
843
<ul>
844
    <li>Default: Don't use</li>
845
    <li>Asks: ___ the item collection code when finding items for the shelf browser.</li>
846
    <li>Description: If your library uses collection codes then you might want the shelf browser to take into consideration what collection the books belong to when populating the virtual shelf browser.</li>
847
</ul></p>
848
849
<p><strong>ShelfBrowserUsesHomeBranch</strong>
850
<ul>
851
    <li>Default: Use</li>
852
    <li>Asks: ___ the item home branch when finding items for the shelf browser.</li>
853
    <li>Description: If you have a multiple branch system you may want to make sure that Koha takes into consideration what branch owns the books when populating the virtual shelf browser for accuracy.</li>
854
</ul></p>
855
856
<p><strong>ShelfBrowserUsesLocation</strong>
857
<ul>
858
    <li>Default: Use</li>
859
    <li>Asks: ___ the item location when finding items for the shelf browser.</li>
860
    <li>Description: If your library uses shelving locations then you might want the shelf browser to take into consideration what shelving location the books belong to when populating the virtual shelf browser.</li>
861
</ul></p>
862
863
<p><strong>See the full documentation for OPAC System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#opacprefs">manual</a> (online).</strong></p>
864
865
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_patrons.tt (+253 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patrons System Preferences</h1>
4
5
<h3>General</h3>
6
7
<p><strong>AutoEmailOpacUser</strong>
8
<ul>
9
    <li>Default: Don't send</li>
10
    <li>Asks: ___ an email to newly created patrons with their account details.</li>
11
    <li>Description: AutoEmailOpacUser allows library users to be notified by email of their account details when a new account is opened at the email address specified in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</a> preference. The email contains the username and password given to or chosen by the patron when signing up for their account and can be customized by editing the <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#ACCTDETAILS">ACCTDETAILS</a> notice.</li>
12
</ul></p>
13
14
<p><strong>AutoEmailPrimaryAddress</strong>
15
<ul>
16
    <li>Default: alternate</li>
17
    <li>Asks: Use ___ patron email address for sending out emails.</li>
18
    <li>Description: If you choose 'first valid' as the value for AutoEmailPrimaryAddress the system will check the email fields in this order: home, work, then alternate. Otherwise the system will use the email address you specify.</li>
19
</ul></p>
20
21
<p><strong>autoMemberNum</strong>
22
<ul>
23
    <li>Default: Do</li>
24
    <li>Asks: ___ default the card number field on the patron addition screen to the next available card number</li>
25
    <li>Description: This preference determines if the patron's barcode is automatically calculated. This prevents the person setting up the library card account from having to assign a number to the new card. If set to 'Do' the system will calculate a new patron barcode by adding 1 to the maximum barcode already present in the database.</li>
26
</ul></p>
27
28
<p><strong>BorrowerMandatoryField</strong>
29
<ul>
30
    <li>Default: surname|cardnumber|barcode</li>
31
    <li>Asks: The following database columns must be filled in on the patron entry screen: ___</li>
32
    <li>Description: This preference enables the system administrator to choose which fields your library would like required for patron accounts. Enter field names separated by | (bar). This ensures that basic information is included in each patron record. If a patron leaves one of the required fields blank an error message will issue and the account will not be created.</li>
33
    <li style="color: #990000;">Important: Separate columns with |</li>
34
    <li>Note: For help with field names, ask your system administrator or <a href="http://schema.koha-community.org/[% helpVersion.replace('\.','_') %]/tables/borrowers.html">view the database structure</a> associated with the borrowers table.</li>
35
</ul></p>
36
37
<p><strong>borrowerRelationship</strong>
38
<ul>
39
    <li>Default: father|mother</li>
40
    <li>Asks: Guarantors can be the following of those they guarantee ___</li>
41
    <li>Description: This preference enables the system administrator to define valid relationships between a guarantor (usually a parent) & a guarantee (usually a child). Defining values for this field does not make the guarantor field required when adding a guarantee type patron. This preference creates a drop down list identifying the relationship of the guarantor to the guarantee. To disable the ability to add children types in Koha you can leave this field blank.</li>
42
    <li style="color: #990000;">Important: Input multiple choices separated by |</li>
43
</ul></p>
44
45
<p><strong>BorrowerRenewalPeriodBase</strong>
46
<ul>
47
    <li>Default: current date</li>
48
    <li>Asks: When renewing borrowers, base the new expiry date on ___</li>
49
    <li>Description: This preference controls what the patron's new expiration date will be when you renew their card. Using the 'current date' will add the subscription period to today's date when calculating the new expiration date. Using 'current membership expiry date' will add the subscription period to the old expiration date for the patron when renewing their account.</li>
50
</ul></p>
51
52
<p><strong>BorrowersTitles</strong>
53
<ul>
54
    <li>Default: Mr|Mrs|Miss|Ms</li>
55
    <li>Asks: Borrowers can have the following titles ___</li>
56
    <li>Description: This preference allows the staff to choose the titles that can be assigned to patrons. The choices present as a drop down list when creating a patron record.</li>
57
    <li style="color: #990000;">Important: Input multiple choices separated by |</li>
58
</ul></p>
59
60
<p><strong>BorrowerUnwantedField</strong>
61
<ul>
62
    <li>Asks: The following database columns will not appear on the patron entry screen: ___</li>
63
    <li>Description: This preference enables the system administrator to choose which fields your library doesn't need to see on the patron entry form. Enter field names separated by | (bar).</li>
64
    <li style="color: #990000;">Important: Separate columns with |</li>
65
    <li>Note: For help with field names, ask your system administrator or <a href="http://schema.koha-community.org/[% helpVersion.replace('\.','_') %]/tables/borrowers.html">view the database structure</a> associated with the borrowers table.</li>
66
</ul></p>
67
68
<p><strong>CardnumberLength</strong>
69
<ul>
70
    <li>Asks: Card numbers for patrons must be ___ characters long.</li>
71
    <li>Description: The length can be a single number to specify an exact length, a range separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum (i.e., ',Max'). If 'cardnumber' is included in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#BorrowerMandatoryField">BorrowerMandatoryField</a> list, the minimum length, if not specified here, defaults to one.</li>
72
</ul></p>
73
74
<p><strong>checkdigit</strong>
75
<ul>
76
    <li>Default: Don't</li>
77
    <li>Asks: ___ check and construct borrower card numbers in the Katipo style.</li>
78
    <li style="color: #990000;">Important: This overrides <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#autoMemberNum">autoMemberNum</a> if on.</li>
79
</ul></p>
80
81
<p><strong>EnableBorrowerFiles</strong>
82
<ul>
83
    <li>Default: Don't</li>
84
    <li>Asks: ___ enable the ability to upload and attach arbitrary files to a borrower record.</li>
85
    <li>Description: When enabled this will add a 'Files' tab to the left of the patron detail page where you can view and upload files to the patron record.</li>
86
</ul></p>
87
88
<p><strong>EnhancedMessagingPreferences</strong>
89
<ul>
90
    <li>Default: Allow</li>
91
    <li>Asks: ___ staff to manage which notices patrons will receive and when they will receive them.</li>
92
    <li style="color: #990000;">Important: This only applies to certain kinds of notices, overdue notices will be sent based on the library's rules, not the patron's choice.</li>
93
    <li>Note: To manage if patrons have also access to these settings, use <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#EnhancedMessagingPreferencesOPAC">EnhancedMessagingPreferencesOPAC</a>.</li>
94
    <li>Description: These messages are in addition to the overdue notices that the library sends. The difference between these notices and overdues is that the patron can opt-in and out of these. Setting this preference to 'Allow' will allow staff to choose for patrons to receive any one of the following messages:</li>
95
    <ul>
96
        <li>Item Checkout : A notice that lists all the of the items the patron has just checked out and/or renewed, this is an electronic form of the checkout receipt</li>
97
        <li>Item Due : A notice on the day and item is due back at the library</li>
98
        <li>Hold Filled : A notice when you have confirmed the hold is waiting for the patron</li>
99
        <li>Item Checkin : A notice that lists all the of the items the patron has just checked in</li>
100
        <li>Advanced Notice : A notice in advance of the patron's items being due (Staff can choose the number of days in advance)</li>
101
    </ul>
102
</ul></p>
103
104
<p><strong>EnhancedMessagingPreferencesOPAC</strong>
105
<ul>
106
    <li>Default: Show</li>
107
    <li>Asks: ___ patron messaging setting on the OPAC</li>
108
    <li style="color: #990000;">Important: <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#EnhancedMessagingPreferences">EnhancedMessagingPreferences</a> must be enabled for messaging options to show in the OPAC</li>
109
    <li>Description: These messages are in addition to the overdue notices that the library sends. The difference between these notices and overdues is that the patron can opt-in and out of these. Setting this preference to 'Allow' will allow patrons to choose to receive any one of the following messages:</li>
110
    <ul>
111
        <li>Item Checkout : A notice that lists all the of the items the patron has just checked out and/or renewed, this is an electronic form of the checkout receipt</li>
112
        <li>Item Due : A notice on the day and item is due back at the library</li>
113
        <li>Hold Filled : A notice when you have confirmed the hold is waiting for the patron</li>
114
        <li>Item Checkin : A notice that lists all the of the items the patron has just checked in</li>
115
        <li>Advanced Notice : A notice in advance of the patron's items being due (The patron can choose the number of days in advance)</li>
116
    </ul>
117
</ul></p>
118
119
<p><strong>ExtendedPatronAttributes</strong>
120
<ul>
121
    <li>Default: Enable</li>
122
    <li>Asks: ___ searching, editing and display of custom attributes on patrons.</li>
123
    <li>Description: Patron attributes are library-defined custom fields that can be applied to patron records.</li>
124
    <li>Note: Use custom attributes for fields that the default patron record does not support such as driver's license number or student ID number.</li>
125
</ul></p>
126
127
<p><strong>FeeOnChangePatronCategory</strong>
128
<ul>
129
    <li>Default: Do</li>
130
    <li>Asks: ___ charge a fee when a patron changes to a category with an enrollment fee.</li>
131
</ul></p>
132
133
<p><strong>intranetreadinghistory</strong>
134
<ul>
135
    <li>Default: Allow</li>
136
    <li>Asks: ___ staff to access a patron's checkout history.</li>
137
    <li style="color: #990000;">Important: If you have the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACPrivacy">OPACPrivacy</a> preference set to 'Allow' and the patron has decided to not have their history kept staff will only see currently checked out items.</li>
138
    <li style="color: #990000;">Important: Reading history is still stored, regardless of staff being allowed access or not unless the patron has chosen to have their history anonymized via their <a href="http://manual.koha-community.org/[% helpVersion %]/en/opacmyaccount.html#opacmyprivacy">privacy page</a>.</li>
139
</ul></p>
140
141
<p><strong>MaxFine</strong>
142
<ul>
143
    <li>Default: 9999</li>
144
    <li>Asks: The late fine for all checkouts will only go up to ___ USD.</li>
145
    <li>Description: This preference controls the default cap on fines accrued by the patron. Leaving this preference blank means that there is no cap on the amount of fines a patron can accrue. If you'd like, single item caps can be specified in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/patscirc.html#circfinerules">circulation rules matrix</a>.</li>
146
</ul></p>
147
148
<p><strong>MembershipExpiryDaysNotice</strong>
149
<ul>
150
    <li>Asks: Send an account expiration notice when a patron's card will expire in ___ days.</li>
151
    <li>Description: If you would like to notify patrons that their accounts are about to expire then you can enter a number of days before expiration in this preference. The notice text can be customized in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#notices">Notices &amp; Slips</a> tool.</li>
152
    <li style="color: #990000">Important: You will need to enable the <a href="http://manual.koha-community.org/[% helpVersion %]/en/cronjobsch.html#patronexpirycron">membership expiry cron job</a> for this notice to send.</li>
153
</ul></p>
154
155
<p><strong>minPasswordLength</strong>
156
<ul>
157
    <li>Default: 3</li>
158
    <li>Asks: Login passwords for staff and patrons must be at least ___ characters long.</li>
159
    <li style="color: #990000;">Important: This applies to both the staff login and the patron OPAC login.</li>
160
</ul></p>
161
162
<p><strong>NotifyBorrowerDeparture</strong>
163
<ul>
164
    <li>Default: 30</li>
165
    <li>Asks: Show a notice that a patron is about to expire ___ days beforehand.</li>
166
    <li>Description: When the patron attempts to check out materials, a warning will appear in the check out window of the Staff Client telling the librarian that the patrons account is about to expire.</li>
167
    <li style="color: #990000">Important: This notice will appear on the patron's record in the staff client.</li>
168
</ul></p>
169
170
<p><strong>patronimages</strong>
171
<ul>
172
    <li>Default: Allow</li>
173
    <li>Asks: ___ images to be uploaded and shown for patrons on the staff client.</li>
174
    <li>Description: If this preference is set to 'Allow' the staff will be able to upload images of patrons either <a href="http://manual.koha-community.org/[% helpVersion %]/en/addpatronimages.html">one by one</a> or <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#uploadpatronimages">in bulk</a>. Patrons images will show on the detail page to the left of the patron information. They can also show in the OPAC if you set the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACpatronimage">OPACpatronimage</a> preference or in the self check out module if you set the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</a> preference.</li>
175
</ul></p>
176
177
<p><strong>PatronsPerPage</strong>
178
<ul>
179
    <li>Default: 20</li>
180
    <li>Asks: By default, show ___ results per page in the staff client.</li>
181
    <li>Description: This preference will let you define how many patrons to show on patron search results pages.</li>
182
</ul></p>
183
184
<p><strong>SMSSendDriver, SMSSendUsername, and SMSSendPassword</strong>
185
<ul>
186
    <li>Asks: Use the SMS::Send:: ___ driver to send SMS messages. Define a username/login ___ and a password ___.</li>
187
    <li style="color: #990000;">Important: Please refer to your national laws concerning the sending of bulk SMS messages before enabling this feature.</li>
188
    <li>Description: There are two options for using SMS in Koha. You can use the Email protocol for free by entering 'Email' as the SMSSendDriver or you can pay for a SMS driver. Some examples of values for the driver are:</li>
189
    <ul>
190
        <li>SMS::Send::Us::Ipipi</li>
191
        <li>SMS::Send::US::TMobile</li>
192
        <li>SMS::Send::US::Verizon</li>
193
        <li>SMS::Send::IN::Unicel</li>
194
        <li>Additional values can be found here: <a href="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&amp;mode=all</a></li>
195
    </ul>
196
    <li style="color: #990000;">Important: Only drivers available as Perl modules will work in this preference, so make sure a Perl module is available before choosing an SMS service. Once a driver is entered in the preference an option will appear in the staff client and the OPAC on the patron messaging form to choose to receive messages as SMS</li>
197
    <li style="color: #990000;">Important: You must allow <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#EnhancedMessagingPreferences">EnhancedMessagingPreferences</a> for this to work.</li>
198
</ul></p>
199
200
<p><strong>StatisticsFields</strong>
201
<ul>
202
    <li>Default: location|itype|ccode</li>
203
    <li>Asks: Show the following fields from the items database table as columns on the statistics tab on the patron record: ___</li>
204
    <li style="color: #990000;">Important Enter the values separated by bars (|)</li>
205
    <li>Description: This preference lets you set which fields will show on the patron record on the Statistics tab.</li>
206
</ul></p>
207
208
<p><strong>TalkingTechItivaPhoneNotification</strong>
209
<ul>
210
    <li>Default: Disable</li>
211
    <li>Asks: ___ patron phone notifications using Talking Tech i-tiva (overdues, predues and holds notices currently supported).</li>
212
    <li>Description: To learn more about setting up this third party product view the <a href="http://manual.koha-community.org/[% helpVersion %]/en/talkingtechappendix.html">Talking Tech Appendix</a>.</li>
213
    <li style="color: #990000;">Important: Requires that you have <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#EnhancedMessagingPreferences">EnhancedMessagingPreferences</a> set to Allow to use.</li>
214
</ul></p>
215
216
<p><strong>uppercasesurnames</strong>
217
<ul>
218
    <li>Default: Don't</li>
219
    <li>Asks: ___ store and display surnames (last names) in upper case.</li>
220
</ul></p>
221
222
<p><strong>useDischarge</strong>
223
<ul>
224
    <li>Default: Don't allow</li>
225
    <li>Asks: ___ librarians to discharge borrowers and borrowers to request a discharge.</li>
226
    <li>Description: A discharge is a certificate that says the patron has no current checkouts, no holds and owe no money.</li>
227
    <li>Note: In France a "quitus" ("discharge") is needed if you want to register for an account in a library or a university).</li>
228
    <li>Note: Academic libraries often require that you have a clear record at the library before you can graduate.</li>
229
</ul></p>
230
231
<h3>Norwegian patron database</h3>
232
233
<p><strong>NorwegianPatronDBEnable & NorwegianPatronDBEndpoint</strong>
234
<ul>
235
    <li>NorwegianPatronDBEnable Default: Disable</li>
236
    <li>Asks: ___ the ability to communicate with the Norwegian national patron database via the ___ endpoint.</li>
237
</ul></p>
238
239
<p><strong>NorwegianPatronDBSearchNLAfterLocalHit</strong>
240
<ul>
241
    <li>Default: Don't</li>
242
    <li>Asks: ___ search the Norwegian national patron database after a local search result was found.</li>
243
</ul></p>
244
245
<p><strong>NorwegianPatronDBUsername & NorwegianPatronDBPassword</strong>
246
<ul>
247
    <li>Asks: Communicate with the Norwegian national patron database using the username ___ and the password ___.</li>
248
    <li>Description: You can get these from "Base Bibliotek", which is maintained by the Norwegian National Library.</li>
249
</ul></p>
250
251
<p><strong>See the full documentation for Patrons System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#patronprefs">manual</a> (online).</strong></p>
252
253
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_searching.tt (+221 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Searching System Preferences</h1>
4
5
<h3>Features</h3>
6
7
<p><strong>EnableSearchHistory</strong>
8
<ul>
9
    <li>Default: Don't keep</li>
10
    <li>Asks: ___ patron search history in the staff client.</li>
11
    <li>Description: This preference controls whether the staff client keeps search history for logged in users. Search history will be accessible under the link to your account in the top right of the staff client.</li>
12
</ul></p>
13
14
<p><strong>IncludeSeeFromInSearches</strong>
15
<ul>
16
    <li>Default: Don't include</li>
17
    <li>Asks: ___ see from (non-preferred form) headings in bibliographic searches.</li>
18
    <li>Description: When this preference is set to include the search engine indexer will insert see from headings from authority records into bibliographic records when indexing, so that a search on an obsolete term will turn up relevant records. For example when you search for cookery (the old term) you get titles with the heading of cooking (the new term).</li>
19
    <li style="color: #990000">Important: You will need to reindex your bibliographic database when changing this preference.</li>
20
</ul></p>
21
22
<p><strong>OpacGroupResults</strong>
23
<ul>
24
    <li>Default: Don't use</li>
25
    <li>Asks: ___ PazPar2 to group similar results on the OPAC.</li>
26
    <li style="color: #990000;">Important: This requires that <a href="http://www.indexdata.com/pazpar2">PazPar2</a> is set up and running.</li>
27
</ul></p>
28
29
<p><strong>QueryAutoTruncate</strong>
30
<ul>
31
    <li>Default: automatically</li>
32
    <li>Asks: Perform wildcard searching (where, for example, Har would match Harry and harp) ___ (The * character would be used like so: Har* or *logging.)</li>
33
    <li>Description: This setting allows for searches to be automatically truncated or for additional characters to be added to the end of a search string. When set to "automatically" the search string automatically ends with a wildcard function. For example, a search for the word "invent" with auto truncation enabled will also retrieve results for inventor, invention, inventory, etc. If you don't want this to happen automatically you can still be perform wildcard searches manually by adding an asterisk (*). Typing "invent*" even with auto truncation disabled will retrieve the same inventor, invention, inventory results. Auto truncation bypasses the necessity to type long search strings in their entirety.</li>
34
</ul></p>
35
36
<p><strong>QueryFuzzy</strong>
37
<ul>
38
    <li>Default: Try</li>
39
    <li>Asks: ___ to match similarly spelled words in a search (for example, a search for flang would also match flange and fang)</li>
40
    <li>Description: This preference enables "fuzzy" searching, in which the search engine returns results that are similar to, but not exactly matching, the word or words entered by the user. This preference enables the search function to compensate for slightly misspelled names or phrases.</li>
41
    <li style="color: #990000;">Important: Requires that <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#UseICU">UseICU</a> set to 'Not using'</li>
42
</ul></p>
43
44
<p><strong>QueryStemming</strong>
45
<ul>
46
    <li>Default: Try</li>
47
    <li>Asks: ___ to match words of the same base in a search</li>
48
    <li>Description: This preference enables word stemming. Stemming allows the search function to return multiple versions of the same word, as well as related terms (i.e., both fish and fishing would be returned).</li>
49
</ul></p>
50
51
<p><strong>QueryWeightFields</strong>
52
<ul>
53
    <li>Default: Enable</li>
54
    <li>Asks: ___ ranking of search results by relevance</li>
55
</ul></p>
56
57
<p><strong>TraceCompleteSubfields</strong>
58
<ul>
59
    <li>Default: Force</li>
60
    <li>Asks: ___ subject tracings in the OPAC and Staff Client to search only for complete-subfield matches.</li>
61
    <li>Description: When TraceCompleteSubfields is set to "force," clicking on links in non-authority controlled subject tracings will only find other records where the entire subfields match. Leaving it at "don't force" does a keyword search of the subject indexes.</li>
62
    <li style="color: #990000;">Important: This preference assumes that you're using XSLT stylesheets as set in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</a> preference.</li>
63
</ul></p>
64
65
<p><strong>TraceSubjectSubdivisions</strong>
66
<ul>
67
    <li>Default: Include</li>
68
    <li>Asks: ___ subdivisions for searches generated by clicking on subject tracings.</li>
69
    <li>Description: When TraceSubjectSubdivisions is set to "Include," if you click on a subject with subdivisions (subfields other than 'a') they will be searched along with the subject heading (subfield 'a'). To have only the subject heading (subfield 'a') searched, set this preference to "Don't include."</li>
70
    <li style="color: #990000;">Important: This preference assumes that you're using XSLT stylesheets as set in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</a> preference.</li>
71
</ul></p>
72
73
<p><strong>UseICU</strong>
74
<ul>
75
    <li>Default: Not using</li>
76
    <li>Asks: ___ ICU Zebra indexing.</li>
77
    <li>Description: ICU is a set of code libraries providing Unicode and Globalization support for software applications. What this means is ICU Zebra indexing is only necessary if you use non-roman characters in your cataloging. If using ICU Zebra indexing you will want to not use <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#QueryFuzzy">QueryFuzzy</a>.</li>
78
    <li style="color: #990000;">Important: This setting will not affect Zebra indexing, it should only be used to tell Koha that you have activated ICU indexing if you have actually done so, since there is no way for Koha to figure this out on its own.</li>
79
    <li style="color: #990000;">Important: Talk to your system administrator when changing this preference to make sure that your system is set up properly for this to work.</li>
80
</ul></p>
81
82
<p><strong>UseQueryParser</strong>
83
<ul>
84
    <li>Default: Do not try</li>
85
    <li>Asks: ___ to use the QueryParser module for parsing queries.</li>
86
    <li>Note: Enabling this will have no impact if you do not have QueryParser installed, and everything will continue to work as usual.</li>
87
    <li>Description: This preference enables an experimental new query parser which opens the door for a more expressive and more-effective search syntax.</li>
88
</ul></p>
89
90
<h3>Results Display</h3>
91
92
<p><strong>defaultSortField & defaultSortOrder</strong>
93
<ul>
94
    <li>defaultSortField Default: author</li>
95
    <li>defaultSortOrder Default: ascending</li>
96
    <li>Asks: By default, sort search results in the staff client by ___, ____</li>
97
    <li>Description: These preferences set the default sort field and sort order for searches on the staff side. Regardless of your choice, the other sort options are still available in the drop down list on the advanced search page.</li>
98
</ul></p>
99
100
<p><strong>displayFacetCount</strong>
101
<ul>
102
    <li>Default: Don't show</li>
103
    <li>Asks: ___ facet counts.</li>
104
    <li>Description: This preference lets you decide if you show how many times a facet is used in your search results in the OPAC and the staff client. The relevance of these numbers highly depends on the value of the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#maxRecordsForFacets">maxRecordsForFacets</a> preference. Showing these numbers can potentially effect the performance of your searching, so test your system with different values for this preference to see what works best.</li>
105
</ul></p>
106
107
<p><strong>DisplayLibraryFacets</strong>
108
<ul>
109
    <li>Default: holding library</li>
110
    <li>Asks: Show facets for ___</li>
111
    <li>Description: This preferenc controls the libraries facet that displays on search results in the staff and opac. The value selected here will determin which library(s) show in the facets when a search is run.</li>
112
</ul></p>
113
114
<p><strong>FacetLabelTruncationLength</strong>
115
<ul>
116
    <li>Default: 20</li>
117
    <li>Asks: Truncate facets length to ___ characters, in OPAC/staff interface.</li>
118
    <li>Description: In the OPAC and the staff client your facets are cut off at 20 characters by default. Depending on your layout this may be too many or two few letters, this preference lets you decide what number is best for your library's design.</li>
119
</ul></p>
120
121
<p><strong>FacetMaxCount</strong>
122
<ul>
123
    <li>Default: 20</li>
124
    <li>Asks: Show up ___ to facets for each category.</li>
125
    <li>Description: This preference allows you to control how many possible limits show under each heading (Author, Series, Topics, etc) on the facets in the OPAC.</li>
126
</ul></p>
127
128
<p><strong>maxItemsInSearchResults</strong>
129
<ul>
130
    <li>Default: 20</li>
131
    <li>Asks: Show up to ___ items per biblio in the search results</li>
132
    <li>Description: This preference will let you set how many results display by default when a search is run on the Staff Client.</li>
133
</ul></p>
134
135
<p><strong>maxRecordsForFacets</strong>
136
<ul>
137
    <li>Default: 20</li>
138
    <li>Asks: Build facets based on ___ records from the search results.</li>
139
    <li>Description: By default Koha only bases facets on the first page of results (usually 20 results). This preference lets you tell Koha to based the facet descriptions and numbers on any number of search results returned. The higher this number the longer it will take for your search results to return, so test with various different values to find the best balance for your library.</li>
140
</ul></p>
141
142
<p><strong>MaxSearchResultsItemsPerRecordStatusCheck</strong>
143
<ul>
144
    <li>Default: 20</li>
145
    <li>Asks: For records with many items, only check the availability status for the first ___ items.</li>
146
    <li>Description: Availability statuses may show incorrectly in search results if a record has more items than the limit set. Statuses will display correctly in the record details. Leave empty for no limit.</li>
147
</ul></p>
148
149
<p><strong>numSearchResults</strong>
150
<ul>
151
    <li>Default: 20</li>
152
    <li>Asks: By default, show ___ results per page in the staff client.</li>
153
</ul></p>
154
155
<p><strong>OPACdefaultSortField & OPACdefaultSortOrder</strong>
156
<ul>
157
    <li>OPACdefaultSortField Default: relevance</li>
158
    <li>OPACdefaultSortOrder Default: ascending</li>
159
    <li>Asks: By default, sort search results in the OPAC by ___, ___</li>
160
    <li>Description: These preferences set the default sort field and sort order for searches on the OPAC. Regardless of your choice, the other sort options are still available in the drop down list on the advanced search page.</li>
161
</ul></p>
162
163
<p><strong>OPACItemsResultsDisplay</strong>
164
<ul>
165
    <li>Default: Don't show</li>
166
    <li>Asks: ___ an item's branch, location and call number in OPAC search results.</li>
167
    <li>Description: This setting selects the information about an item that will display in the search results page of the OPAC. The results can display the status of an item and/or full details including branch, location, and call number. While the 'Show' option allows for more information to be displayed on the search results page, the information can be overwhelming for large collections with multiple branches.</li>
168
</ul></p>
169
170
<p><strong>OPACnumSearchResults</strong>
171
<ul>
172
    <li>Default: 20</li>
173
    <li>Asks: By default, show ___ results per page in the OPAC.</li>
174
</ul></p>
175
176
<p><strong>SearchWithISBNVariations</strong>
177
<ul>
178
    <li>Default: don't search</li>
179
    <li>Asks: When searching on the ISBN index, ___ on all variations of the ISBN.</li>
180
    <li>Description: With this preference set to search you'll be able to search for ISBNs even if there are dashes or spaces in the field. So if you search for 9781843345855 but the ISBN was cataloged as 978-1843345855 you'll still be able to find it if this preference is set to 'search'.</li>
181
    <li style="color: #990000;">Important: This preference has no effect if <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#UseQueryParser">UseQueryParser</a> is on</li>
182
</ul></p>
183
184
<h3>Search Form</h3>
185
186
<p><strong>AdvancedSearchLanguages</strong>
187
<ul>
188
    <li>Asks: Limit the languages listed in the advanced search drop-down to the ___ ISO 639-2 language codes (separate values with | or ,).</li>
189
    <li>Description: This preference will allow you to decide what languages show in the pull down menu on the advanced search page in the OPAC and the staff client. If this preference is left blank, all languages will show. To limit the languages that are shown enter their <a href="http://www.loc.gov/standards/iso639-2/php/code_list.php">ISO 639-2 language codes</a> separated by comma ( , ) or bar ( | ). For example to limit listing to French and Italian, enter ita|fre. </li>
190
</ul></p>
191
192
<p><strong>AdvancedSearchTypes</strong>
193
<ul>
194
    <li>Default: itemtype</li>
195
    <li>Asks: Show tabs in OPAC and staff-side advanced search for limiting searches on the ___ fields (separate values with |).</li>
196
    <li>Description: On the advanced search page you can choose to allow filters on one or all of the following: Item types (itemtypes), Collection Codes (ccode) and Shelving Location (loc). If you would like to be able to limit searches on item type and shelving location for example you would enter itemtypes|loc in the preference input box. The order of these fields will determine the order of the tabs in the OPAC and staff client advanced search screens. Values within the search type are OR'ed together, while each different search type is AND'ed together in the query limits. The current stored values are supported without any required modification.Each set of advanced search fields are displayed in tabs in both the OPAC and staff client. The first value in the AdvancedSearchTypes syspref is the selected tab; if no values are present, "itemtypes" is used. For non-itemtype values, the value in AdvancedSearchTypes must match the Authorised Value name, and must be indexed with 'mc-' prefixing that name.</li>
197
</ul></p>
198
199
<p><strong>expandedSearchOption</strong>
200
<ul>
201
    <li>Default: don't show</li>
202
    <li>Asks: By default, ___ "More options" on the OPAC and staff advanced search pages.</li>
203
</ul></p>
204
205
<p><strong>IntranetNumbersPreferPhrase</strong>
206
<ul>
207
    <li>Default: don't use</li>
208
    <li>Asks: By default, ___ the operator "phr" in the callnumber and standard number staff client searches</li>
209
    <li>Description: When searching by call number and standard number (biblionumber) in Koha Staff Client you can choose to force the search to be a phrase search by setting this preference to 'use.' This will allow for more accurate results over doing a general keyword field search.</li>
210
</ul></p>
211
212
<p><strong>OPACNumbersPreferPhrase</strong>
213
<ul>
214
    <li>Default: don't use</li>
215
    <li>Asks: By default, ___ the operator "phr" in the callnumber and standard number OPAC searches</li>
216
    <li>Description: When searching by call number and standard number (biblionumber) in the Koha OPAC you can choose to force the search to be a phrase search by setting this preference to 'use.' This will allow for more accurate results over doing a general keyword field search.</li>
217
</ul></p>
218
219
<p><strong>See the full documentation for Searching System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#searchingprefs">manual</a> (online).</strong></p>
220
221
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_serials.tt (+66 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Serials System Preferences</h1>
4
5
<p><strong>opacSerialDefaultTab</strong>
6
<ul>
7
    <li>Default: Subscriptions tab</li>
8
    <li>Asks: Show ___ as default tab for serials in OPAC.</li>
9
</ul></p>
10
11
<p><strong>OPACSerialIssueDisplayCount</strong>
12
<ul>
13
    <li>Default: 3</li>
14
    <li>Asks: Show the ___ previous issues of a serial on the OPAC.</li>
15
    <li>Description: This preference allows the administrator to select the number of recent issues for each serial which appear in the OPAC when the serial is accessed. This is just the default value, patrons can always click to see a full list of serials.</li>
16
</ul></p>
17
18
<p><strong>RenewSerialAddsSuggestion</strong>
19
<ul>
20
    <li>Default: Don't add</li>
21
    <li>Asks: ___ a suggestion for a biblio when its attached serial is renewed.</li>
22
    <li>Description: If set to "Add", this preference will automatically add a serial to the Acquisitions Purchase Suggestions menu when clicking the 'renew' option. If you don't use the Acquisitions module to manage serials purchases it's best to leave this set as 'Don't add.'</li>
23
</ul></p>
24
25
<p><strong>RoutingListAddReserves</strong>
26
<ul>
27
    <li>Default: Place</li>
28
    <li>Asks: ___ received serials on hold if they are on a routing list.</li>
29
</ul></p>
30
31
<p><strong>RoutingListNote</strong>
32
<ul>
33
    <li>Asks: Include following note on all routing lists</li>
34
    <li>Description: Text entered in this box will appear below the routing list information.</li>
35
</ul></p>
36
37
<p><strong>RoutingSerials</strong>
38
<ul>
39
    <li>Default: Don't add</li>
40
    <li>Asks: ___ received serials to the routing list.</li>
41
    <li>Description: This preference determines if serials routing lists are enabled or disabled for the library. When set to "Add", serials routing is enabled and a serial can be directed through a list of people by identifying who should receive it next. The list of people can be established for each serial to be passed using the Serials module. This preference can be used to ensure each person who needs to see a serial when it arrives at the library will get it. Learn more in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/routinglist.html">routing list</a> section of this manual.</li>
42
</ul></p>
43
44
<p><strong>StaffSerialIssueDisplayCount</strong>
45
<ul>
46
    <li>Default: 3</li>
47
    <li>Asks: Show the ___ previous issues of a serial on the staff client.</li>
48
    <li>Description: This preference allows the administrator to select the number of recent issues for each serial which appear in the Staff Client when the serial is accessed. This is just the default value, staff members can always click to see a full list of serials.</li>
49
</ul></p>
50
51
<p><strong>SubscriptionDuplicateDroppedInput</strong>
52
<ul>
53
    <li>Asks: List of fields which must not be rewritten when a subscription is duplicated (Separated by pipe |) ___</li>
54
    <li>Description: When duplicating a subscription sometimes you don't want all of the fields duplicated, using this preference you can list the fields that you don't want to be duplicated. These field names come from the subscription table in the Koha database. Learn what fields are in that table on the <a href="http://schema.koha-community.org/[% helpVersion.replace('\.','_') %]/tables/subscription.html">Koha DB Schema site</a>.</li>
55
</ul></p>
56
57
<p><strong>SubscriptionHistory</strong>
58
<ul>
59
    <li>Default: full history</li>
60
    <li>sks: When showing the subscription information for a bibliographic record, preselect ___ view of serial issues.</li>
61
    <li>Description: This preference determines what information appears in the OPAC when the user clicks the More Details option. The 'brief' option displays a one-line summary of the volume and issue numbers of all issues of that serial held by the library. The 'full' option displays a more detailed breakdown of issues per year, including information such as the issue date and the status of each issue.</li>
62
</ul></p>
63
64
<p><strong>See the full documentation for Serials System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#serialsprefs">manual</a> (online).</strong></p>
65
66
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_staff_client.tt (+173 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Staff Client System Preferences</h1>
4
5
<h3>Appearance</h3>
6
7
<p><strong>Display856uAsImage</strong>
8
<ul>
9
    <li>Default: Neither details or results page</li>
10
    <li>Asks: Display the URI in the 856u field as an image on: ___</li>
11
    <li>Description: In addition to this option being set, the corresponding XSLT option must be turned on. Also, the corresponding 856q field must have a valid MIME image extension (e.g., "jpg") or MIME image type (i.e. starting with "image/"), or the generic indicator "img" entered in the field. When all of the requirements are met, an image file will be displayed instead of the standard link text. Clicking on the image will open it in the same way as clicking on the link text. When you click on the image it should open to full size, in the current window or in a new window depending on the value in the system pref <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</a>.</li>
12
</ul></p>
13
14
<p><strong>DisplayIconsXSLT</strong>
15
<ul>
16
    <li>Default: Show</li>
17
    <li>Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and detail pages in the staff client.</li>
18
    <li style="color: #990000;">Important: <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#SXLTResultsDisplay">XSLTResultsDisplay</a> and/or <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#XSLTDetailtsDisplay">XSLTDetailsDisplay</a> must be set to use an XSLT stylesheet (default or custom) for these icons to show.</li>
19
    <li>Note: See the <a href="http://manual.koha-community.org/[% helpVersion %]/en/XSLTiTypes.html">XSLT Icon Guide</a> for more information on these icons.</li>
20
</ul></p>
21
22
<p><strong>intranet_includes</strong>
23
<ul>
24
    <li>Default: includes</li>
25
    <li>Asks: Use include files from the ___ directory in the template directory, instead of includes/. (Leave blank to disable)</li>
26
</ul></p>
27
28
<p><strong>IntranetCirculationHomeHTML</strong>
29
<ul>
30
    <li>Asks: Show the following HTML in its own div on the bottom of the home page of the circulation module:</li>
31
</ul></p>
32
33
<p><strong>intranetcolorstylesheet</strong>
34
<ul>
35
    <li>Asks: Include the additional CSS stylesheet ___ to override specified settings from the default stylesheet</li>
36
    <li>Description: This preference is used to set the background color and style of the Staff Client. The value is a .css file. The system administrator should determine which file is appropriate. Enter just a filename, a full local path or a complete URL starting with http:// (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.</li>
37
    <li style="color: #990000;">Important: Leave this field blank to disable.</li>
38
</ul></p>
39
40
<p><strong>IntranetFavicon</strong>
41
<ul>
42
    <li>Asks: Use the image at ___ for the Staff Client's favicon.</li>
43
    <li style="color: #990000;">Important: This should be a complete URL, starting with http://</li>
44
    <li>Note: Turn your logo into a favicon with the <a href="http://www.antifavicon.com">Favicon Generator</a>.</li>
45
    <li>Description: The favicon is the little icon that appears next to the URL in the address bar in most browsers. The default value for this field (if left blank) is the small 'K' in the Koha logo.</li>
46
</ul></p>
47
48
<p><strong>IntranetmainUserblock</strong>
49
<ul>
50
    <li>Asks: Show the following HTML in its own column on the main page of the staff client</li>
51
</ul></p>
52
53
<p><strong>IntranetNav</strong>
54
<ul>
55
    <li>Asks: Show the following HTML in the More menu at the top of each page on the staff client (should be a list of links or blank)</li>
56
</ul></p>
57
58
<p><strong>IntranetReportsHomeHTML</strong>
59
<ul>
60
    <li>Asks: Show the following HTML in its own div on the bottom of the home page of the reports module:</li>
61
</ul></p>
62
63
<p><strong>IntranetSlipPrinterJS</strong>
64
<ul>
65
    <li>Asks: Use the following JavaScript for printing slips.</li>
66
    <li>Description: The most logical use of this preference is in conjunction with the <a href="http://www.jsprintsetup.mozdev.org">jsPrintSetup</a> Firefox add-on. Learn more about this preference and the add-on setup on the Koha wiki at <a href="https://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently">http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently</a>.</li>
67
</ul></p>
68
69
<p><strong>intranetstylesheet</strong>
70
<ul>
71
    <li>Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of the default css (used when leaving this field blank).</li>
72
    <li>Description: The Intranetstylesheet preference is a layout and design feature for the intranet or staff client. This preference allows a library to customize the appearance of the Staff Client. Enter just a filename, a full local path or a complete URL starting with http:// (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.</li>
73
</ul></p>
74
75
<p><strong>IntranetUserCSS</strong>
76
<ul>
77
    <li>Asks: Include the following CSS on all pages in the staff client</li>
78
</ul></p>
79
80
<p><strong>IntranetUserJS</strong>
81
<ul>
82
    <li>Asks: Include the following JavaScript on all pages in the staff interface</li>
83
    <li>Description: This preference allows the administrator to enter JavaScript or JQuery that will be embedded across all pages of the Staff Client. Administrators may use this preference to customize some of the interactive sections of Koha, customizing the text for the login prompts, for example. Sample JQuery scripts used by Koha libraries can be found on the wiki: <a href="https://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</a>.</li>
84
</ul></p>
85
86
<p><strong>SlipCSS</strong>
87
<ul>
88
    <li>Asks: Include the stylesheet at ___ on Issue and Reserve Slips.</li>
89
    <li style="color: #990000;">Important: This should be a complete URL, starting with http://</li>
90
    <li>Description: If you would like to style your receipts or slips with a consistent set of fonts and colors you can use this preference to point Koha to a stylesheet specifically for your slips.</li>
91
</ul></p>
92
93
<p><strong>StaffAuthorisedValueImages</strong>
94
<ul>
95
    <li>Default: Show</li>
96
    <li>Asks: ___ images for authorized values (such as lost statuses and locations) in search results.</li>
97
</ul></p>
98
99
<p><strong>staffClientBaseURL</strong>
100
<ul>
101
    <li>Asks: The staff client is located at http:// ___</li>
102
</ul></p>
103
104
<p><strong>template</strong>
105
<ul>
106
    <li>Default: prog</li>
107
    <li>Asks: Use the ___ theme on the staff interface.</li>
108
    <li style="color: #990000;">Important: Do not include a trailing slash in the URL this will break links created using this URL. (example: www.google.com not www.google.com/)</li>
109
</ul></p>
110
111
<p><strong>XSLTDetailsDisplay</strong>
112
<ul>
113
    <li>Default: default</li>
114
    <li>Asks: Display details in the staff client using XSLT stylesheet at ___</li>
115
    <li>Description: XSLT stylesheets allow for the customization of the details shows on the screen when viewing a bib record. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.</li>
116
</ul></p>
117
118
<p><strong>XSLTResultsDisplay</strong>
119
<ul>
120
    <li>Default: default</li>
121
    <li>Asks: Display results in the staff client using XSLT stylesheet at ___</li>
122
    <li>Description: XSLT stylesheets allow for the customization of the details shows on the screen when viewing the search results. This preference will allow you either use the default look that comes with Koha or design your own stylesheet.</li>
123
</ul></p>
124
125
<h3>Options</h3>
126
127
<p><strong>HidePatronName</strong>
128
<ul>
129
    <li>Default: Show</li>
130
    <li>Asks: ___ the names of patrons that have items checked out or on hold on detail pages or the "Place Hold" screen.</li>
131
</ul></p>
132
133
<p><strong>intranetbookbag</strong>
134
<ul>
135
    <li>Default: Show</li>
136
    <li>Asks: ___ the cart option in the staff client.</li>
137
</ul></p>
138
139
<p><strong>StaffDetailItemSelection</strong>
140
<ul>
141
    <li>Default: Enable</li>
142
    <li>Asks: ___ item selection in record detail page.</li>
143
    <li>Description: This preference lets you choose to show (or not show) checkboxes to the left of every item in the holdings tab on the detail display of a record in the staff client. Showing these checkboxes allows the staff members to select multiple items to edit or delete at once.</li>
144
</ul></p>
145
146
<p><strong>UseWYSIWYGinSystemPreferences</strong>
147
<ul>
148
    <li>Default: Don't show</li>
149
    <li>Asks: ___ WYSIWYG editor when editing certain HTML system preferences.</li>
150
    <li>Description: This preference allows you to chang system preferences with HTML in them to WYSIWYG editors instead of plain text boxes.</li>
151
</ul></p>
152
153
<p><strong>viewISBD</strong>
154
<ul>
155
    <li>Default: Allow</li>
156
    <li>Asks: ___ staff to view records in ISBD form on the staff client.</li>
157
</ul></p>
158
159
<p><strong>viewLabeledMARC</strong>
160
<ul>
161
    <li>Default: Allow</li>
162
    <li>Asks: ___ staff to view records in labeled MARC form on the staff client.</li>
163
</ul></p>
164
165
<p><strong>viewMARC</strong>
166
<ul>
167
    <li>Default: Allow</li>
168
    <li>Asks: ___ staff to view records in plain MARC form on the staff client.</li>
169
</ul></p>
170
171
<p><strong>See the full documentation for Staff Client System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#staffprefs">manual</a> (online).</strong></p>
172
173
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_tools.tt (+33 lines)
Line 0 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Tools System Preferences</h1>
4
5
<h3>Batch Item Modification</h3>
6
<p>These preferences are in reference to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catalogtools.html#batchmodifyitems">Batch Item Modification tool</a>.</p>
7
8
<p><strong>MaxItemsForBatch</strong>
9
<ul>
10
    <li>Default: 1000</li>
11
    <li>Asks: Process up to ___ items in a single modification or deletion batch.</li>
12
    <li>Description: In the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catalogtools.html#batchdeleteitems">batch item delete tool</a> this will prevent the display of more than the items you entered in this preference, but you will be able to delete more than the number you enter here. In the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catalogtools.html#batchmodifyitems">batch item modification tool</a> this preference will prevent the editing of more than the number entered here.</li>
13
</ul></p>
14
15
<h3>News</h3>
16
17
<p><strong>NewsAuthorDisplay</strong>
18
<ul>
19
    <li>Default: not at all</li>
20
    <li>Asks: Show the author for news items: ___</li>
21
</ul></p>
22
23
<h3>Patron Cards</h3>
24
<p>These preferences are in reference to the <a href="http://manual.koha-community.org/[% helpVersion %]/en/tools.html#patroncardcreator">Patron Card Creator tool</a>.</p>
25
26
<p><strong>ImageLimit</strong>
27
<ul>
28
    <li>Asks: Limit the number of creator images stored in the database to ___ images.</li>
29
</ul></p>
30
31
<p><strong>See the full documentation for Tools System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#toolsprefs">manual</a> (online).</strong></p>
32
33
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences_web_services.tt (-1 / +79 lines)
Line 0 Link Here
0
- 
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Web Services System Preferences</h1>
4
5
<p><strong>IdRef</strong>
6
<ul>
7
    <li>Default: Disable</li>
8
    <li>Asks: ___ the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.</li>
9
    <li>Description: IdRef is a French service for Sudoc autorities. Using the <a href="http://www.sudoc.abes.fr/?COOKIE=U10178,Klecteurweb,I250,B341720009+,SY,NLECTEUR+WEBOPC,D2.1,E7b26f8a2-3fa,A,H,R202.78.240.7,FY">Sudoc database</a>, it allows to request / modify / add authorities. If a record comes from the Sudoc (so 009 is filled with an integer), at the OPAC you will see "Author: Idref" if a 7..$3 (unimarc author) if filled with a ppn. On clicking on the Idref link, a popup will display. The Idref webservice is requested and all records (by roles) for this author will be displayed. There is 1 line / record and 2 links at the end. 1 will request Koha (cgi-bin/koha/opac-search.pl?q=ident:003381862), the other one will redirect to the sudoc page (http://www.sudoc.fr/003381862).</li>
10
    <li style="color: #990000;">Important: Please note that this feature is available only for libraries using UNIMARC.</li>
11
    <li>Note: The French Sudoc database should not be confused with the US Superintendent of Documents (SuDocs) Classification Scheme.</li>
12
</ul></p>
13
14
<h3>ILS-DI</h3>
15
16
<p><strong>ILS-DI</strong>
17
<ul>
18
    <li>Default: Disable</li>
19
    <li>Asks: ___ ILS-DI services for OPAC users</li>
20
</ul></p>
21
22
<p><strong>ILS-DI:AuthorizedIPs</strong>
23
<ul>
24
    <li>Asks: ___ allowed IPs to use the ILS-DI services</li>
25
</ul></p>
26
27
<h3>OAI-PMH</h3>
28
29
<p><strong>OAI-PMH</strong>
30
<ul>
31
    <li>Default: Disable</li>
32
    <li>Asks: ___ Koha's OAI-PMH server.</li>
33
    <li>Description: Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl to see your file. For the Open Archives Initiative-Protocol for Metadata Harvesting (OAI-PMH) there are two groups of 'participants': Data Providers and Service Providers. Data Providers (open archives, repositories) provide free access to metadata, and may, but do not necessarily, offer free access to full texts or other resources. OAI-PMH provides an easy to implement, low barrier solution for Data Providers. Service Providers use the OAI interfaces of the Data Providers to harvest and store metadata. Note that this means that there are no live search requests to the Data Providers; rather, services are based on the harvested data via OAI-PMH. Koha at present can only act as a Data Provider. It can not harvest from other repositories. The biggest stumbling block to having Koha harvest from other repositories is that MARC is the only metadata format that Koha indexes natively. Visit <a href="http://www.oaforum.org/tutorial/english/page3.htm">http://www.oaforum.org/tutorial/english/page3.htm</a> for diagrams of how OAI-PMH works.</li>
34
    <li>Learn more about OAI-PMH at: <a href="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</a></li>
35
</ul></p>
36
37
<p><strong>OAI-PMH:archiveID</strong>
38
<ul>
39
    <li>Default: KOHA-OAI-TEST</li>
40
    <li>Asks: Identify records at this site with the prefix ___ :</li>
41
</ul></p>
42
43
<p><strong>OAI-PMH:AutoUpdateSets</strong>
44
<ul>
45
    <li>Default: Disable</li>
46
    <li>Asks: ___ automatic update of OAI-PMH sets when a bibliographic record is created or updated.</li>
47
</ul></p>
48
49
<p><strong>OAI-PMH:ConfFile</strong>
50
<ul>
51
    <li>If this preference is left empty, Koha's OAI Server operates in normal mode, otherwise it operates in extended mode. In extended mode, it's possible to parameter other formats than marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML configuration file which list available metadata formats and XSL file used to create them from marcxml records.</li>
52
    <li>For more information, see the <a href="http://manual.koha-community.org/[% helpVersion %]/en/webservices.html#oaiconfsample">sample conf file</a> in the appendix.</li>
53
</ul></p>
54
55
<p><strong>OAI-PMH:DeletedRecord</strong>
56
<ul>
57
    <li>Default: will never be emptied or truncated (persistent)</li>
58
    <li>Asks: Koha's deletedbiblio table ___</li>
59
</ul></p>
60
61
<p><strong>OAI-PMH:MaxCount</strong>
62
<ul>
63
    <li>Default: 50</li>
64
    <li>Asks: Only return ___ records at a time in response to a ListRecords or ListIdentifiers query.</li>
65
    <li>Description: This is the maximum number of records that would be returned based on ListRecord or ListIdentifier queries from harvesters. ListRecords harvest the entire records while the ListIdentifier is an abbreviated form of ListRecords, retrieving only headers rather than records.</li>
66
</ul></p>
67
68
<h3>Reporting</h3>
69
70
<p><strong>SvcMaxReportRows</strong>
71
<ul>
72
    <li>Default: 10</li>
73
    <li>Asks: Only return ___ rows of a report requested via the reports web service.</li>
74
    <li>Description: This value will be used to limit the number of results returned by <a href="http://manual.koha-community.org/[% helpVersion %]/en/reports.html#publicreport">public reports</a>.</li>
75
</ul></p>
76
77
<p><strong>See the full documentation for Web Services System Preferences in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/administration.html#webserviceprefs">manual</a> (online).</strong></p>
78
79
[% INCLUDE 'help-bottom.inc' %]

Return to bug 2326