1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- This document is maintained with oXygen. -->
3 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
7 <title>Koha 3.10 Manual (en)</title>
9 <author id="manualauthor">
10 <firstname>Nicole C.</firstname>
12 <surname>Engard</surname>
15 <orgname>ByWater Solutions/BibLibre</orgname>
19 <copyright id="manualcopy">
22 <holder>Nicole C. Engard/ByWater Solutions/BibLibre</holder>
25 <legalnotice id="manuallegal">
26 <para>This manual is licensed under the <ulink
27 url="http://www.gnu.org/licenses/gpl.html">GNU General Public License,
28 version 3</ulink> or later</para>
30 <para>Learn more about this license in the <link linkend="gpl">GPL3
31 Appendix</link></para>
34 <pubdate id="manualpubdate">Published: 2012</pubdate>
36 <chapter id="introchapter">
37 <title>Introduction</title>
39 <title id="introbasics">Basics</title>
40 <para>Koha is the first free and open source software library automation package (ILS).
41 Development is sponsored by libraries of varying types and sizes, volunteers, and support
42 companies from around the world.</para>
43 <para>Learn more about Koha by visiting the official Koha website: <ulink
44 url="http://koha-community.org">http://koha-community.org</ulink></para>
46 <section id="introrecommend">
47 <title>Recommendations</title>
48 <para>Full system recommendations can be found on the official Koha wiki along with the
49 developer documentation: <ulink url="http://wiki.koha-community.org">
50 http://wiki.koha-community.org</ulink></para>
51 <para>When working in the Koha staff client it is strongly recommended that you use the
52 Firefox browser. Koha's staff client is not supported in Internet Explorer and has not yet
53 been fully optimized for Google Chrome.</para>
57 <chapter id="administration">
58 <title>Administration</title>
60 <section id="globalsysprefs">
61 <title>Global System Preferences</title>
63 <para>Global system preferences control the way your Koha system works
64 in general. Set these preferences before anything else in Koha.</para>
68 <para><emphasis>Get there:</emphasis> More > Administration > Global System
74 <screeninfo>Global System Preferences Link and Search</screeninfo>
78 <imagedata fileref="images/admin/globalprefs/prefsearch.png"/>
83 <para>System preferences can be searched (using any part of the
84 preference name or description) using the search box on the
85 'Administration' page or the search box at the top of each system
86 preferences page.</para>
89 <screeninfo>Preferences search at the top of System Preference
94 <imagedata fileref="images/admin/globalprefs/prefsearch1.png"/>
99 <para>When editing preferences a '(modified)' tag will appear next to
100 items you change until you click the 'Save All' button:</para>
103 <screeninfo>After editing TagsModeration the '(modified)' label
108 <imagedata fileref="images/admin/globalprefs/saveallprefs.png"/>
113 <para>After saving your preferences you'll get a confirmation message
114 telling you what preferences were saved:</para>
117 <screeninfo>Preference save confirmation message</screeninfo>
121 <imagedata fileref="images/admin/globalprefs/saveconfirmation.png"/>
126 <para>Each section of preferences can be sorted alphabetically by
127 clicking the small down arrow to the right of the word 'Preference' in
128 the header column</para>
131 <screeninfo>Sort option at the top right of each section of
132 preferences</screeninfo>
136 <imagedata fileref="images/admin/globalprefs/sortprefs.png"/>
141 <para>If the preference refers to monetary values (like <link
142 linkend="maxoutstanding">maxoutstanding</link>) the currency displayed
143 will be the default you set in your <link
144 linkend="currexchangeadmin">Currency and Exchange Rate</link>
145 administration area. In the examples to follow they will all read USD
146 for U.S. Dollars.</para>
148 <section id="acqprefs">
149 <title>Acquisitions</title>
151 <para><emphasis>Get there:</emphasis> More > Administration >
152 Global System Preferences > Acquisitions</para>
154 <section id="acqprefspolicy">
155 <title>Policy</title>
157 <section id="AcqCreateItem">
158 <title>AcqCreateItem</title>
160 <para>Default: placing an order</para>
162 <para>Asks: Create an item when ___.</para>
168 <para>cataloging a record</para>
172 <para>placing an order</para>
176 <para>receiving an order</para>
180 <para>Description:</para>
184 <para>This preference lets you decide when you'd like to
185 create an item record in Koha. If you choose to add an item
186 record when 'placing an order' then you will enter item
187 information in as you place records in your basket. If you
188 choose to add the item when 'receiving an order' you will be
189 asked for item record information when you're receiving orders
190 in acquisitions. If you choose to add the item when
191 'cataloging a record' then item records will not be created in
192 acquisitions at all, you will need to go to the cataloging
193 module to add the items.</para>
198 <section id="AcqViewBaskets">
199 <title>AcqViewBaskets</title>
201 <para>Default: created by staff member</para>
203 <para>Asks: Show baskets ___</para>
209 <para>created by staff member</para>
213 <para>from staff member's branch</para>
217 <para>in system, regardless of owner</para>
221 <para>Description:</para>
225 <para>When in acquisitions this preference allows you to
226 control whose baskets you can see when looking at a vendor.
227 The default value of 'created by staff member' makes it so
228 that you only see the baskets you created. Choosing to see
229 baskets 'from staff member's branch' will show you the baskets
230 created by anyone at the branch you're logged in at. Finally,
231 you can choose to set this preference to show you all baskets
232 regardless of who created it ('in system, regardless of
233 owner). Regardless of which value you choose for this
234 preference, superlibrarians can see all baskets created in the
240 <section id="BasketConfirmations">
241 <title>BasketConfirmations</title>
243 <para>Default: always ask for confirmation</para>
245 <para>Asks: When closing or reopening a basket, ___.</para>
251 <para>always ask for confirmation</para>
255 <para>do not ask for confirmation</para>
259 <para>Descriptions:</para>
263 <para>This preference adds the option to skip confirmations on
264 closing and reopening a basket. If you skip the confirmation,
265 you do not create a new basket group.</para>
270 <section id="CurrencyFormat">
271 <title>CurrencyFormat</title>
273 <para>Default: 360,000.00 (US)</para>
275 <para>Asks: Display currencies using the following format
282 <para>360,000.00 (US)</para>
286 <para>360 000,00 (FR)</para>
294 <para>Default: 0</para>
296 <para>Asks: The default tax rate is ___</para>
298 <para>Description:</para>
302 <para>This preference will allow the library to define a
303 default Goods and Services Tax rate. The default of value of 0
304 will disable this preference.</para>
309 <para>Enter this value as a number (.06) versus a percent
314 <section id="UniqueItemFields">
315 <title>UniqueItemFields</title>
317 <para>Default: barcode</para>
319 <para>Asks:___ (space-separated list of fields that should be
320 unique for items, must be valid SQL fields of <ulink
321 url="http://schema.koha-community.org/tables/items.html">items</ulink>
324 <para>Description:</para>
328 <para>If this preference is left blank when adding items in
329 acquisitions there will be no check for uniqueness. This means
330 that a duplicate barcode can be created in acquisitions which
331 will cause errors later when checking items in and out.</para>
337 <section id="acqprefsprinting">
338 <title>Printing</title>
340 <section id="OrderPdfFormat">
341 <title>OrderPdfFormat</title>
343 <para>Default: pdfformat::layout2pages</para>
345 <para>Asks: Use ___ when printing basket groups.</para>
350 <section id="adminprefs">
351 <title>Administration</title>
353 <para>These preferences are general settings for your system.</para>
355 <para><emphasis>Get there:</emphasis> More > Administration >
356 Global System Preferences > Administration</para>
358 <section id="casauthentication">
359 <title>CAS Authentication</title>
361 <para>The Central Authentication Service (CAS) is a single sign-on
362 protocol for the web. If you don't know what this is, leave these
363 preferences set to their defaults.</para>
365 <section id="AllowPKIAuth">
366 <title>AllowPKIAuth</title>
368 <para>Default: no</para>
370 <para>Asks: Use ___ field for SSL client certificate
371 authentication</para>
381 <para>the common name</para>
385 <para>the email address</para>
390 <section id="casAuthentication">
391 <title>casAuthentication</title>
393 <para>Default: Don't use</para>
395 <para>Asks: ___ CAS for login authentication.</para>
398 <section id="casLogout">
399 <title>casLogout</title>
401 <para>Default: Don't logout</para>
403 <para>Asks: ___ of CAS when logging out of Koha.</para>
406 <section id="casServerUrl">
407 <title>casServerUrl</title>
409 <para>Asks: The CAS Authentication Server can be found at
414 <section id="adminprefsinterface">
415 <title>Interface options</title>
417 <para>These preference are related to your Koha interface</para>
419 <section id="DebugLevel">
420 <title>DebugLevel</title>
422 <para>Default: lots of</para>
424 <para>Asks: Show ___ debugging information in the browser when an
425 internal error occurs.</para>
431 <para>lots of - will show as much information as
436 <para>no - will only show basic error messages</para>
440 <para>some - will show only some of the information
445 <para>Description:</para>
449 <para>This preference determines how much information will be
450 sent to the user's screen when the system encounters an error.
451 The most detail will be sent when the value level is set at 2,
452 some detail will be sent when the value is set at 1, and only
453 a basic error message will display when the value is set at 0.
454 This setting is especially important when a system is new and
455 the administration is interested in working out the bugs
456 (errors or problems) quickly. Having detailed error messages
457 makes quick fixes more likely in problem areas.</para>
462 <section id="delimiter">
463 <title>delimiter</title>
465 <para>Default: semicolons</para>
467 <para>Asks: Separate columns in an exported report file with ___
478 <para>backslashes</para>
486 <para>semicolons</para>
498 <para>Description:</para>
502 <para>This preference determines how reports exported from
503 Koha will separate data. In many cases you will be able to
504 change this option when exporting if you'd like.</para>
509 <section id="KohaAdminEmailAddress">
510 <title>KohaAdminEmailAddress</title>
512 <para>This is the default 'From' address for emails unless there
513 is one for the particular branch, and is referred to when an
514 internal error occurs.</para>
516 <para>Asks: Use ___ as the email address for the administrator of
519 <para>Description:</para>
523 <para>This preference allows one email address to be used in
524 warning messages set to the OPAC. If no email address is set
525 for the branch this address will receive messages from patrons
526 regarding modification requests, purchase suggestions, and
527 questions or information regarding overdue notices. It is
528 recommended that a email address that can be accessed by
529 multiple staff members be used for this purpose so that if one
530 librarian is out the others can address these requests. This
531 email address can be changed when needed.</para>
536 <section id="noItemTypeImages">
537 <title>noItemTypeImages</title>
539 <para>Default: Show</para>
541 <para>Asks: ___ itemtype icons in the catalog.</para>
551 <para>Don't show</para>
555 <para>Description:</para>
559 <para>This preference allows the system administrator to
560 determine if users will be able to set and see an <link
561 linkend="itemtypeadmin">item type icon</link> the catalog on
562 both the OPAC and the Staff Client. The images will display in
563 both the OPAC and the Staff Client/Intranet. If images of item
564 types are disabled, text labels for item types will still
565 appear in the OPAC and Staff Client.</para>
570 <section id="virtualshelves">
571 <title>virtualshelves</title>
573 <para>Default: Allow</para>
575 <para>Asks: ___ staff and patrons to create and view saved lists
586 <para>Don't Allow</para>
590 <para>Description:</para>
594 <para>This preference controls whether the lists functionality
595 will be available in the staff client and OPAC. If this is set
596 to "Don't allow" then no one will be able to save items to
597 public or private lists.</para>
603 <section id="adminprefslogin">
604 <title>Login options</title>
606 <para>These preferences are related to logging into your Koha
609 <section id="AutoLocation">
610 <title>AutoLocation</title>
612 <para>Default: Don't require</para>
614 <para>Asks: ___ staff to log in from a computer in the IP address
615 range specified by their library (if any).</para>
619 <para>Set IP address range in the library administration
624 <para><emphasis>Get there:</emphasis> More >
625 Administration > Basic Parameters > <link
626 linkend="libsgroups">Libraries & Groups</link></para>
636 <para>Don't require</para>
644 <para>Description:</para>
648 <para>This preference protects the system by blocking
649 unauthorized users from accessing the staff client program and
650 settings. Authorized and unauthorized users are determined by
651 their computer's IP addresses. When the preference is set to
652 'Require', IP authorization is in effect and unauthorized IP
653 addresses will be blocked. This means that staff cannot work
654 from home unless their IP address has been authorized. When
655 set to 'Don't require', anyone with a staff client login will
656 have access no matter which IP address they are using.</para>
661 <section id="IndependantBranches">
662 <title>IndependantBranches</title>
664 <para>Default: Don't prevent</para>
666 <para>Asks: ___ staff (but not superlibrarians) from modifying
667 objects (holds, items, patrons, etc.) belonging to other
674 <para>Don't prevent</para>
682 <para>Description:</para>
686 <para>This preference should only be used by library systems
687 which are sharing a single Koha installation among multiple
688 branches but are considered independent organizations, meaning
689 they do not share material or patrons with other branches and
690 do not plan to change that in the future. If set to 'Prevent'
691 it increases the security between library branches by:
692 prohibiting staff users from logging into another branch from
693 within the staff client, filtering out patrons from patron
694 searches who are not a part of the login branch conducting the
695 search, limiting the location choices to the login branch when
696 adding or modifying an item record, preventing users from
697 other branch locations from placing holds or checking out
698 materials from library branches other than their own, and
699 preventing staff from editing item records which belong to
700 other library branches. All of these security safeguards can
701 be overridden only by the superlibrarian, the highest level of
707 <para>It is important that this value be set before going live
708 and that it NOT be changed</para>
712 <section id="insecure">
713 <title>insecure</title>
715 <para>Default: Don't allow</para>
717 <para>Asks: ___ staff to access the staff client without logging
728 <para>Don't allow</para>
732 <para>Description:</para>
736 <para>This preference controls whether or not authentication
737 (user login) will be required to gain access to the staff
738 client. If set to 'Allow', all authentication is bypassed. If
739 set to 'Don't allow' authentication (login) on the staff
740 client is required.</para>
745 <para>Setting this to 'Allow' is dangerous, and should not be
746 done in production environments.</para>
750 <section id="SessionStorage">
751 <title>SessionStorage</title>
753 <para>Default: in the MySQL database</para>
755 <para>Asks: Store login session information ___</para>
761 <para>as temporary files</para>
765 <para>in the MySQL database</para>
769 <para>in the PostgreSQL database</para>
774 <para>PostgreSQL is not yet supported</para>
781 <para>Description:</para>
785 <para>This preference allows administrators to choose what
786 format session data is stored in during web sessions.</para>
791 <section id="timeout">
792 <title>timeout</title>
794 <para>Default: 12000000</para>
796 <para>Asks: Automatically log out users after ___ seconds of inactivity.</para>
798 <para>Description:</para>
802 <para>This preference sets the length of time the Staff Client
803 or OPAC accounts can be left inactive before re-logging in is
804 necessary. The value of this preference is in seconds. At this
805 time, the amount of time before a session times out must be
806 the same for both the Staff Client and the OPAC.</para>
811 <section id="searchengineprefs">
812 <title>Search Engine</title>
813 <section id="SearchEngine">
814 <title>SearchEngine</title>
816 <para>This preference is highly experimental and should not be changed from the
817 default value in a production environment.</para>
819 <para>Default: Zebra</para>
820 <para>Asks: ___ is the search engine used. </para>
821 <para>Values:<itemizedlist>
828 </itemizedlist></para>
829 <para>Description:<itemizedlist>
831 <para>This preference will be used to control which search engine Koha uses for
832 catalog searches in the OPAC and the staff client.</para>
834 </itemizedlist></para>
839 <section id="authprefs">
840 <title>Authorities</title>
842 <para><emphasis>Get there:</emphasis> More > Administration >
843 Global System Preferences > Authorities</para>
845 <section id="generalauthorities">
846 <title>General</title>
848 <section id="AuthDisplayHierarchy">
849 <title>AuthDisplayHierarchy</title>
851 <para>Default: Don't display</para>
853 <para>Asks: ___ broader term/narrower term hierarchies when
854 viewing authorities.</para>
863 <screeninfo>AuthDisplayHierarchy</screeninfo>
867 <imagedata fileref="images/admin/globalprefs/AuthDisplayHierarchy.png"/>
874 <para>Don't display</para>
878 <para>Description:</para>
882 <para>If your authority records includes 5xx fields with
883 linked references to broader and/or narrower see also
884 references this preference will turn on a display of those
885 authorities at the top of the record.</para>
890 <section id="AutoCreateAuthorities">
891 <title>AutoCreateAuthorities</title>
893 <para>Default: do not generate</para>
895 <para>Asks: When editing records, ___ authority records that are
902 <para>do not generate</para>
906 <para>generate</para>
912 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
913 must be set to "allow" for this to have any effect</para>
916 <para>Description:</para>
920 <para>When this and <link
921 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
922 are both turned on, automatically create authority records for
923 headings that don't have any authority link when cataloging.
924 When BiblioAddsAuthorities is on and AutoCreateAuthorities is
925 turned off, do not automatically generate authority records,
926 but allow the user to enter headings that don't match an
927 existing authority. When BiblioAddsAuthorities is off, this
928 has no effect.</para>
933 <section id="BiblioAddsAuthorities">
934 <title>BiblioAddsAuthorities</title>
936 <para>Default: allow</para>
938 <para>Asks: When editing records, ___ them to automatically create
939 new authority records if needed, rather than having to reference
940 existing authorities.</para>
950 <para>This setting allows you to type values in the fields
951 controlled by authorities and then adds a new authority if
952 one does not exist</para>
958 <para>don't allow</para>
962 <para>This setting will lock the authority controlled
963 fields, forcing you to search for an authority versus
964 allowing you to type the information in yourself.</para>
971 <section id="dontmerge">
972 <title>dontmerge</title>
974 <para>Default: Don't</para>
976 <para>Asks: ___ automatically update attached biblios when
977 changing an authority record.</para>
991 <para>Description:</para>
995 <para>This preference tells Koha how to handle changes to your
996 Authority records. If you edit an authority record and this
997 preference is set to 'Do' Koha will update all of the bib
998 records linked to the authority with the new authority
999 record's data. If this is set to "Don't" then Koha won't edit
1000 bib records when changes are made to authorities.</para>
1005 <para>If this is set to merge you will need to ask your
1006 administrator to enable the <link
1007 linkend="mergeauthcron">merge_authorities.pl
1008 cronjob</link>.</para>
1012 <section id="MARCAuthorityControlField008">
1013 <title>MARCAuthorityControlField008</title>
1015 <para>Default: || aca||aabn | a|a d</para>
1017 <para>Asks: Use the following text for the contents of MARC
1018 authority control field 008 position 06-39 (fixed length data
1022 <para>Do not include the date (position 00-05) in this
1023 preference, Koha will calculate automatically and put that in
1024 before the values in this preference.</para>
1025 </important>Description:</para>
1029 <para>This preference controls the default value in the 008
1030 field on Authority records. It does not effect bibliographic
1036 <section id="UseAuthoritiesForTracings">
1037 <title>UseAuthoritiesForTracings</title>
1039 <para>Default: Don't use</para>
1041 <para>Asks: ___ authority record numbers instead of text strings
1042 for searches from subject tracings.</para>
1044 <para>Values:</para>
1048 <para>Don't use</para>
1052 <para>Search links look for subject/author keywords
1053 (example: opac-search.pl?q=su:Business%20networks)</para>
1063 <para>Search links look for an authority record (example:
1064 opac-search.pl?q=an:354)</para>
1070 <para>Description:</para>
1074 <para>For libraries that have authority files, they may want
1075 to make it so that when a link to an authorized subject or
1076 author is clicked on the OPAC or staff client it takes the
1077 searcher only to a list of results with that authority record.
1078 Most libraries do not have complete authority files and so
1079 setting this preference to 'Don't use' will allow searchers to
1080 click on links to authors and subject headings and perform a
1081 keyword search against those fields, finding all possible
1082 relevant results instead.</para>
1088 <section id="linkerauthorities">
1089 <title>Linker</title>
1091 <para>These preference will control how Koha links bibliographic
1092 records to authority records. All bibliographic records added to
1093 Koha after these preferences are set will link automatically to
1094 authority records, for records added before these preferences are
1095 set there is a script (misc/link_bibs_to_authorities.pl) that your
1096 system administrator can run to link records together.</para>
1098 <section id="CatalogModuleRelink">
1099 <title>CatalogModuleRelink</title>
1101 <para>Default: Do not</para>
1103 <para>Asks: ___ automatically relink headings that have previously
1104 been linked when saving records in the cataloging module.</para>
1106 <para>Values:</para>
1118 <para>Description:</para>
1122 <para>Longtime users of Koha don't expect the authority and
1123 bib records to link consistently. This preference makes it
1124 possible to disable authority relinking in the cataloging
1125 module only (i.e. relinking is still possible if
1126 link_bibs_to_authorities.pl is run). Note that though the
1127 default behavior matches the previous behavior of Koha
1128 (retaining links to outdated authority records), it does not
1129 match the intended behavior (updating biblio/authority link
1130 after bibliographic record is edited). Libraries that want the
1131 intended behavior of authority control rather than the way
1132 Koha used to handle linking should set CatalogModuleRelink to
1133 'Do'. Once setting this to 'Do' the following preferences can
1139 <section id="LinkerKeepStale">
1140 <title>LinkerKeepStale</title>
1142 <para>Default: Do not</para>
1144 <para>Asks: ___ keep existing links to authority records for
1145 headings where the linker is unable to find a match.</para>
1147 <para>Values:</para>
1159 <para>Description:</para>
1163 <para>When set to 'Do', the linker will never remove a link to
1164 an authority record, though, depending on the value of <link
1165 linkend="LinkerRelink">LinkerRelink</link>, it may change the
1171 <section id="LinkerModule">
1172 <title>LinkerModule</title>
1174 <para>Default: Default</para>
1176 <para>Asks: Use the ___ linker module for matching headings to
1177 authority records.</para>
1179 <para>Values:</para>
1183 <para>Default</para>
1187 <para>Retains Koha's previous behavior of only creating
1188 links when there is an exact match to one and only one
1189 authority record; if the <link
1190 linkend="LinkerOptions">LinkerOptions</link> preference is
1191 set to 'broader_headings', it will try to link headings to
1192 authority records for broader headings by removing
1193 subfields from the end of the heading</para>
1199 <para>First match</para>
1203 <para>Creates a link to the first authority record that
1204 matches a given heading, even if there is more than one
1205 authority record that matches</para>
1211 <para>Last match</para>
1215 <para>Creates a link to the last authority record that
1216 matches a given heading, even if there is more than one
1217 record that matches</para>
1223 <para>Description:</para>
1227 <para>This preference tells Koha which match to use when
1228 searching for authority matches when saving a record.</para>
1233 <section id="LinkerOptions">
1234 <title>LinkerOptions</title>
1236 <para>Asks: Set the following options for the authority linker
1238 <para>This feature is experimental and shouldn't be used in a
1239 production environment until further expanded upon.</para>
1242 <para>Description:</para>
1246 <para>This is a pipe separated (|) list of options. At the
1247 moment, the only option available is "broader_headings." With
1248 this option set to "broader_headings", the linker will try to
1249 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1251 <para>First: Camins-Esakov, Jared--Coin
1252 collections--Catalogs--Early works to 1800</para>
1254 <para>Next: Camins-Esakov, Jared--Coin
1255 collections--Catalogs</para>
1257 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1259 <para>Next: Camins-Esakov, Jared (matches! if a previous
1260 attempt had matched, it would not have tried this)</para>
1265 <section id="LinkerRelink">
1266 <title>LinkerRelink</title>
1268 <para>Default: Do</para>
1270 <para>Asks: ___ relink headings that have previously been linked
1271 to authority records.</para>
1273 <para>Values:</para>
1285 <para>Description:</para>
1289 <para>When set to 'Do', the linker will confirm the links for
1290 headings that have previously been linked to an authority
1291 record when it runs, correcting any incorrect links it may
1292 find. When set to 'Do not', any heading with an existing link
1293 will be ignored, even if the existing link is invalid or
1301 <section id="catprefs">
1302 <title>Cataloging</title>
1304 <para><emphasis>Get there:</emphasis> More > Administration >
1305 Global System Preferences > Cataloging</para>
1307 <section id="catdisplayprefs">
1308 <title>Display</title>
1312 <section id="authoritysep">
1313 <title>authoritysep</title>
1315 <para>Default: --</para>
1317 <para>Asks: Separate multiple displayed authors, series or
1318 subjects with ___.</para>
1321 <section id="hide_marc">
1322 <title>hide_marc</title>
1324 <para>Default: Display</para>
1326 <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1329 <para>Values:</para>
1333 <para>Display -- shows the tag numbers on the cataloging
1337 <screeninfo>MARC editor with tags showing</screeninfo>
1341 <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1348 <para>Don't display -- shows just descriptive text when
1352 <screeninfo>MARC editor without tags showing</screeninfo>
1356 <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1364 <section id="IntranetBiblioDefaultView">
1365 <title>IntranetBiblioDefaultView</title>
1367 <para>Default: ISBD form</para>
1369 <para>Asks: By default, display biblio records in ___</para>
1371 <para>Values:</para>
1375 <para>ISBD form -- displays records in the staff client in the
1376 old card catalog format</para>
1380 <para>See <link linkend="isbdpref">ISBD</link> preference
1381 for more information</para>
1387 <para>Labelled MARC form -- displays records in the staff
1388 client in MARC with text labels to explain the different
1393 <para>MARC form -- displays records in the staff client in
1398 <para>normal form -- visual display in the staff client (for
1399 the average person)</para>
1403 <para>Description:</para>
1407 <para>This setting determines the bibliographic record display
1408 when searching the catalog on the staff client. This setting
1409 does not affect the display in the OPAC which is changed using
1410 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1411 preference under the OPAC preference tab. This setting changes
1412 the look of the record when first displayed. The MARC and ISBD
1413 views can still be seen by clicking in the sidebar.</para>
1418 <section id="isbdpref">
1421 <para>Default: <link linkend="isbddefault">MARC21 Default
1422 Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1423 Appendix</link></para>
1425 <para>Asks: Use the following as the ISBD template:</para>
1427 <para>Description:</para>
1431 <para>This determines how the ISBD information will display.
1432 Elements in the list can be reordered to produce a different
1433 ISBD view. ISBD, the International Standard Bibliographic
1434 Description, was first introduced by IFLA (International
1435 Federation of Library Associations) in 1969 in order to
1436 provide guidelines for descriptive cataloging. The purpose of
1437 ISBD is to aid the international exchange of bibliographic
1438 records for a variety of materials.</para>
1443 <section id="LabelMARCView">
1444 <title>LabelMARCView</title>
1446 <para>Default: Don't</para>
1448 <para>Asks: ___ collapse repeated tags of the same type into one
1451 <para>Values:</para>
1455 <para>Do -- will combine all identical tag numbers under one
1456 heading in the MARC view in the OPAC and Staff Client</para>
1459 <screeninfo>MARC View in the Staff Client with LabelMARCView
1460 set to Do</screeninfo>
1464 <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
1471 <para>Don't -- will list all of the tags individually in the
1472 MARC view in the OPAC and Staff Client</para>
1475 <screeninfo>MARC View in the Staff Client with LabelMARCView
1476 set to Don't</screeninfo>
1480 <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
1488 <section id="OpacSuppression">
1489 <title>OpacSuppression and OpacSuppressionByIPRange</title>
1490 <para>OpacSuppression Default: Don't hide</para>
1492 <para>Asks: ___ items marked as suppressed from OPAC search
1493 results. Restrict the suppression to IP adresses outside of the IP
1496 <para>OpacSuppression Values:</para>
1500 <para>Don't hide</para>
1504 <para>Will show items in OPAC search results if they are
1505 marked suppressed</para>
1515 <para>Will not show items in OPAC search results if
1516 they're marked as suppressed</para>
1522 <para>Description:</para>
1526 <para>These preferences control hiding of bib records from
1527 display in the OPAC. Each bib record you want to hide from the
1528 OPAC simply needs to have the 942$n field set to 1. The
1529 indexer then hides it from display in OPAC but will still
1530 display it in the Staff Client. If you want to further control
1531 suppression you can set an IP address range to still show
1532 suppressed items to. Define a range like 192.168.. If you
1533 don't want to limit suppression in this way, leave the IP
1535 <para>An <link linkend="authorizedvalues">authorized
1536 value</link> for 942$n field should be set to eliminate
1537 errors. One example would be to create an authorized value
1538 titled SUPPRESS with a value of 0 for don't suppress and 1
1539 for suppress.</para>
1545 <para>If this preference is set to 'hide' and you have the 942n
1546 field set to 1, it will hide the entire bib record - not just an
1547 individual item.</para>
1551 <para>You must have the Suppress index set up in Zebra and at
1552 least one suppressed item, or your searches will be
1557 <section id="URLLinkText">
1558 <title>URLLinkText</title>
1560 <para>Default: Online Resource</para>
1562 <para>Asks: Show ___ as the text of links embedded in MARC
1565 <para>Description:</para>
1569 <para>If the 856 field does not have a subfield 3 or y
1570 defined, the OPAC will say 'Click here to access online.' If
1571 you would like the field to say something else enter that in
1577 <section id="UseControlNumber">
1578 <title>UseControlNumber</title>
1580 <para>Default: Don't use</para>
1582 <para>Asks: ___ record control number ($w subfields) and control
1583 number (001) for linking of bibliographic records.</para>
1585 <para>Values:</para>
1589 <para>Don't use</para>
1593 <para>When clicking on links to titles that appear next to
1594 'Continues' and 'Continued by' in the detail display Koha
1595 will perform a title search</para>
1605 <para>When clicking on links to titles that appear next to
1606 'Continues' and 'Continued by' in the detail display Koha
1607 will perform a control number (MARC field 001)
1615 <para>Unless you are going in and manually changing 773$w to
1616 match your rigorously-defined bibliographic relationships, you
1617 should set this preference to "Don't use" and instead set <link
1618 linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
1622 <para>Description:</para>
1626 <para>If you have a serial called "Journal of Interesting
1627 Things" which has a separate record from when it was called
1628 "Transactions of the Interesting Stuff Society," you could add
1629 linking fields to indicate the relationship between the two
1630 records. UseControlNumber allows you to use your local
1631 accession numbers for those links. In MARC21, the relevant
1632 sections of the two records might look like
1633 this:<programlisting> =001 12345
1634 =110 2_$aInteresting Stuff Society.
1635 =245 10$aTransactions of the Interesting Stuff Society.
1636 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1639 =110 2_$aInteresting Stuff Society.
1640 =245 10$aJournal of Interesting Things.
1641 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
1643 <para>With UseControlNumber set to 'Use', the 78x links will
1644 use the Control Numbers is subfield $w, instead of doing a
1645 title search on "Journal of Interesting Things" and
1646 "Transactions of the Interesting Stuff Society"
1647 respectively.</para>
1653 <section id="catinterfaceprefs">
1654 <title>Interface</title>
1658 <section id="advancedMARCeditor">
1659 <title>advancedMARCeditor</title>
1661 <para>Default: Don't display</para>
1663 <para>Asks: ___ descriptions of fields and subfields in the MARC
1666 <para>Description:</para>
1670 <para>This preference determines whether or not MARC field
1671 names will be present when editing or creating MARC
1676 <para>Values:</para>
1680 <para>Display</para>
1683 <screeninfo>MARC editor with text labels</screeninfo>
1687 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
1694 <para>Don't display</para>
1697 <screeninfo>MARC editor without text labels</screeninfo>
1701 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
1709 <section id="DefaultClassificationSource">
1710 <title>DefaultClassificationSource</title>
1712 <para>Default: Dewey Decimal System</para>
1714 <para>Asks: Use ___ as the default classification source.</para>
1716 <para>Values:</para>
1720 <para>ANSCR (Sound Recordings)</para>
1724 <para>Dewey Decimal Classification</para>
1728 <para>Library of Congress Classification</para>
1732 <para>Other/Generic Classification Scheme</para>
1736 <para>SuDoc Classification (U.S. GPO)</para>
1740 <para>Universal Decimal Classification</para>
1745 <section id="EasyAnalyticalRecords">
1748 <firstname id="analyticsauthor">Linda</firstname>
1750 <surname>Culberson</surname>
1753 <orgname>Ms. Dept. of Archives and History</orgname>
1757 <pubdate id="analyticspubdate">October 2011</pubdate>
1759 <othercredit id="analyticseditor" role="copyeditor">
1760 <firstname>Nicole C.</firstname>
1762 <surname>Engard</surname>
1764 <contrib id="analyticscredit">Fixed typos, changed content
1765 where necessary and added new screenshots.</contrib>
1769 <title>EasyAnalyticalRecords</title>
1770 <para>Default: Don't Display</para>
1772 <para>Asks: ___ easy ways to create analytical record
1773 relationships</para>
1775 <para>Values:</para>
1779 <para>Display</para>
1783 <para>Don't Display</para>
1788 <para>If you decide to use this feature you'll want to make sure
1790 linkend="UseControlNumber">UseControlNumber</link> preference is
1791 set to "Don't use" or else the "Show analytics" links in the
1792 staff client and the OPAC will be broken.</para>
1795 <para>Description:</para>
1799 <para>An analytic entry in a catalog is one that describes a
1800 part of a larger work that is also described in the catalog.
1801 In bibliographic cataloging, analytic entries may be made for
1802 chapters in books or special issues of articles in
1803 periodicals. In archival cataloging, analytic entries may be
1804 made for series or items within a collection. This feature in
1805 Koha allows for an easy way of linking analytic entries to the
1806 host records, and this system preference adds several new menu
1807 options to the staff cataloging detail pages to allow that to
1814 <section id="catrecordprefs">
1815 <title>Record Structure</title>
1819 <section id="AlternateHoldingsField">
1820 <title>AlternateHoldingsField &
1821 AlternateHoldingsSeparator</title>
1823 <para>Asks: Display MARC subfield ___ as holdings information for
1824 records that do not have items, with the subfields separated by
1827 <para>Description:</para>
1831 <para>Sometimes libraries migrate to Koha with their holding
1832 info in the 852 field (OCLC holdings information field) and
1833 choose not to transfer that information into the 952 (Koha
1834 holdings information field) because they don't plan on
1835 circulating those items. For those libraries or other
1836 libraries that have data in the 852 fields of their records
1837 that they want to display, these preferences let you choose to
1838 display holdings info from a field other than the 952 field.
1839 The AlternateHoldingsField preference can contain multiple
1840 subfields to look in; for instance 852abhi would look in 852
1841 subfields a, b, h, and i.</para>
1845 <para>With AlternateHoldingsField set to 852abhi and
1846 AlternateHoldingsSeparator set to a space the holdings would
1847 look like the following:</para>
1850 <screeninfo>Alternate Holdings Display</screeninfo>
1854 <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
1862 <section id="autoBarcode">
1863 <title>autoBarcode</title>
1865 <para>Default: generated in the form
1866 <branchcode>yymm0001</para>
1868 <para>Asks: Barcodes are ___</para>
1870 <para>Values:</para>
1874 <para>generated in the form <branchcode>yymm0001</para>
1878 <para>generated in the form <year>-0001, <year>-0002</para>
1882 <para>generated in the form 1, 2, 3</para>
1886 <para>incremental EAN-13 barcodes</para>
1890 <para>not generated automatically</para>
1894 <para>Description:</para>
1898 <para>This setting is for libraries wishing to generate
1899 barcodes from within Koha (as opposed to scanning in
1900 pre-printed barcodes or manually assigning them). The default
1901 behavior makes it so that when you click in the barcode field
1902 (952$p in MARC21) it will populate with the automatic barcode
1903 you have chosen. If you would rather it only enter an
1904 automatic barcode when you click on the plugin (the ... to the
1905 right of the field) you can change the plugin used for that
1906 field in the framework. Set the plugin for 952$p (if using
1907 MARC21 or equivalent field mapped to items.barcode in your
1908 local MARC format) for your frameworks to barcode_manual.pl
1909 instead of barcode.pl. Learn more about editing frameworks
1910 under the <link linkend="marcbibframeworks">MARC Bibliographic
1911 Frameworks</link> section of this manual.</para>
1916 <section id="DefaultLanguageField008">
1917 <title>DefaultLanguageField008</title>
1919 <para>Asks: Fill in the default language for field 008 Range 35-37
1922 <para>Description:</para>
1926 <para>This preference will allow you to set the language for
1927 your 008 field by default. If this is left empty it will
1928 default to English (eng). See the <ulink
1929 url="http://www.loc.gov/marc/languages/language_code.html">MARC
1930 Code List for Languages</ulink> for additional values for this
1936 <section id="item-level_itypes">
1937 <title>item-level_itypes</title>
1939 <para>Default: specific item</para>
1941 <para>Asks: Use the item type of the ___ as the authoritative item
1942 type (for determining circulation and fines rules, etc).</para>
1944 <para>Values:</para>
1948 <para>biblio record</para>
1952 <para>specific item</para>
1956 <para>Description:</para>
1960 <para>This preference determines whether the item type Koha
1961 uses for issuing rules will be an attribute of the
1962 bibliographic record or the item record. Most libraries refer
1963 to the item record for item types. It also determines if the
1964 item type icon appears on the OPAC search results. If you have
1965 the preference set to 'biblio record' then Koha displays the
1966 item type icon on the search results to the left of the result
1970 <screeninfo>Item Type Icons to the Left of Result
1971 Information</screeninfo>
1975 <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
1983 <section id="itemcallnumber">
1984 <title>itemcallnumber</title>
1986 <para>Default: 082ab</para>
1988 <para>Asks: Map the MARC subfield to an item's callnumber.</para>
1991 <para>This can contain multiple subfields to look in; for
1992 instance 082ab would look in 082 subfields a and b.</para>
1995 <para>Description:</para>
1999 <para>This setting determines which MARC field will be used to
2000 determine the call number that will be entered into item
2001 records automatically (952$o). The value is set by providing
2002 the MARC field code (050, 082, 090, 852 are all common) and
2003 the subfield codes without the delimiters ($a, $b would be
2008 <para>Examples:</para>
2012 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
2013 item record: 852hi</para>
2018 <section id="marcflavour">
2019 <title>marcflavour</title>
2021 <para>Default: MARC21</para>
2023 <para>Asks: Interpret and store MARC records in the ___
2026 <para>Description:</para>
2030 <para>This preference defines global MARC style (MARC21 or
2031 UNIMARC) used for encoding. MARC21 is the standard style for
2032 the US, Canada and Britain. UNIMARC is a variation of MARC21
2033 that is used in France, Italy, Russia, and many other
2038 <para>Values:</para>
2046 <para>UNIMARC</para>
2051 <section id="MARCOrgCode">
2052 <title>MARCOrgCode</title>
2054 <para>Default: OSt</para>
2056 <para>Asks: Fill in the MARC organization code ___ by default in
2057 new MARC records (leave blank to disable).</para>
2059 <para>Description:</para>
2063 <para>The MARC Organization Code is used to identify libraries
2064 with holdings of titles and more.</para>
2068 <para>Learn more and find your library's code on the <ulink
2069 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC
2070 Code list for Organizations</ulink> or in Canada on the <ulink
2071 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
2072 Symbols Directory</ulink>.</para>
2075 <section id="NewItemsDefaultLocation">
2076 <title>NewItemsDefaultLocation</title>
2078 <para>Asks: When items are created, give them the temporary
2079 location of ___ (should be a location code, or blank to
2082 <section id="PrefillItem">
2083 <title>PrefillItem</title>
2084 <para>Default: the new item is not prefilled with last created item values.</para>
2085 <para>Asks: When a new item is added ___</para>
2086 <para>Values:<itemizedlist>
2088 <para>the new item is not prefilled with last created item values.</para>
2091 <para>the new item is prefilled with last created item values.</para>
2093 </itemizedlist></para>
2094 <para>Description:<itemizedlist>
2096 <para>This preference controls the behavior used when adding new items. Using the
2097 options here you can choose to have your next new item prefill with the values
2098 used in the last item was added to save time typing values or to have the item
2099 form appear completely blank. Using <link linkend="SubfieldsToUseWhenPrefill"
2100 >SubfieldsToUseWhenPrefill</link> you can control specifically which fields
2101 are prefilled.</para>
2103 </itemizedlist></para>
2105 <section id="SubfieldsToUseWhenPrefill">
2106 <title>SubfieldsToUseWhenPrefill</title>
2107 <para>Asks: Define a list of subfields to use when prefilling items ___<important>
2108 <para>Separate values with a space.</para>
2110 <para>Description:<itemizedlist>
2112 <para>When the <link linkend="PrefillItem">PrefillItem</link> preference is set to
2113 prefill item values with those from the last added item, this preference can
2114 control which fields are prefilled (and which are not). Enter a space separated
2115 list of fields that you would like to prefill when adding a new item.</para>
2117 </itemizedlist></para>
2120 <section id="z3950NormalizeAuthor">
2121 <title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
2123 <para>Defaults: Don't copy & 701,702,700</para>
2125 <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
2126 commas) to the correct author tags when importing a record using
2129 <para>Description for z3950NormalizeAuthor:</para>
2133 <para>This preference allows for 'Personal Name Authorities'
2134 to replace authors as the bibliographic authority. This
2135 preference should only be considered by libraries using
2140 <para>Values for z3950NormalizeAuthor:</para>
2148 <para>Don't copy</para>
2152 <para>Description for z3950AuthorAuthFields:</para>
2156 <para>This preference defines which MARC fields will be used
2157 for 'Personal Name Authorities' to replace authors as the
2158 bibliographic authorities. This preference only applies to
2159 those using UNIMARC encoding. The MARC fields selected here
2160 will only be used if 'z3950NormalizeAuthor' is set to "Copy".
2161 The default field are 700, 701, and 702.</para>
2167 <section id="catspineprefs">
2168 <title>Spine Labels</title>
2172 <section id="SpineLabelAutoPrint">
2173 <title>SpineLabelAutoPrint</title>
2175 <para>Default: don't</para>
2177 <para>Asks: When using the quick spine label printer, ___
2178 automatically pop up a print dialog.</para>
2180 <para>Values:</para>
2193 <section id="SpineLabelFormat">
2194 <title>SpineLabelFormat</title>
2196 <para>Default: <itemcallnumber><copynumber></para>
2198 <para>Asks: Include the following fields on a quick-printed spine
2199 label: (Enter in columns from the biblio, biblioitems or items
2200 tables, surrounded by < and >.)</para>
2203 <section id="SpineLabelShowPrintOnBibDetails">
2204 <title>SpineLabelShowPrintOnBibDetails</title>
2206 <para>Default: Don't display</para>
2208 <para>Asks: ___ buttons on the bib details page to print item
2209 spine labels.</para>
2211 <para>Values:</para>
2215 <para>Display</para>
2218 <screeninfo>'Print Label' link appears on bibliographic
2219 record in the staff client</screeninfo>
2223 <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2230 <para>Don't display</para>
2237 <section id="circprefs">
2238 <title>Circulation</title>
2240 <para><emphasis>Get there:</emphasis> More > Administration >
2241 Global System Preferences > Circulation</para>
2242 <section id="checkinpolicyprefs">
2243 <title>Checkin Policy</title>
2245 <section id="BlockReturnOfWithdrawnItems">
2246 <title>BlockReturnOfWithdrawnItems</title>
2247 <para>Default: Block</para>
2248 <para>Asks: ___ returning of items that have been withdrawn. </para>
2249 <para>Values:<itemizedlist>
2254 <para>Don't block</para>
2256 </itemizedlist>Description:<itemizedlist>
2258 <para>This preference controls whether and item with a withdrawn status (952$0 in
2259 MARC21) can be checked in or not.</para>
2261 </itemizedlist></para>
2265 <section id="circcheckoutpolicy">
2266 <title>Checkout Policy</title>
2270 <section id="AgeRestrictionMarker">
2271 <title>AgeRestrictionMarker</title>
2273 <para>Asks: Restrict patrons with the following target audience
2274 values from checking out inappropriate materials: ___</para>
2276 <para>Description:</para>
2280 <para>This preference defines certain keywords that will
2281 trigger Koha to restrict checkout based on age. These
2282 restrictions can be overridden by the <link
2283 linkend="AgeRestrictionOverride">AgeRestrictionOverride</link>
2284 preference. Enter in this field a series of keywords separated
2285 by bar (|) with no spaces. For example PG|R|E|EC|Age| will
2286 look for PG followed by an age number, R folllowed by an age
2287 number, Age followed by an age number, and so on. These values
2288 can appear in any MARC field, but Library of Congress
2289 recommends the 521$a (Target Audience Note). Whatever field
2290 you decide to use you must map the word agerestriction in the
2291 biblioitems table to that field in the <link
2292 linkend="kohamarcmapping">Koha to MARC Mapping</link>. When
2293 cataloging you can enter values like PG 13 or E 10 in the
2294 521$a and Koha will then notify circulation librarians that
2295 the material may not be recommended for the patron based on
2296 their age.<important>
2297 <para>You must map the word agerestriction in the biblioitems table to the MARC
2298 field where this information will appear via the <link
2299 linkend="kohamarcmapping">Koha to MARC Mapping</link> administration
2306 <section id="AgeRestrictionOverride">
2307 <title>AgeRestrictionOverride</title>
2309 <para>Default: Don't allow</para>
2311 <para>Asks: ___ staff to check out an item with age
2314 <para>Values:</para>
2321 <screeninfo>Allow age restriction override</screeninfo>
2325 <imagedata fileref="images/admin/globalprefs/AgeRestrictionOverride.png"/>
2332 <para>Don't allow</para>
2335 <screeninfo>Don't allow age restriction
2336 override</screeninfo>
2340 <imagedata fileref="images/admin/globalprefs/AgeRestrictionMarker.png"/>
2347 <para>Description:</para>
2351 <para>When the <link
2352 linkend="AgeRestrictionMarker">AgeRestrictionMarker</link>
2353 preference is set, Koha will try to warn circulation
2354 librarians before checking out an item that might have an age
2355 restriction listed in the MARC record. This preference asks if
2356 you would like the staff to be able to still check out these
2357 items to patrons under the age limit.</para>
2362 <section id="AllFinesNeedOverride">
2363 <title>AllFinesNeedOverride</title>
2365 <para>Default: Require</para>
2367 <para>Asks: ___ staff to manually override all fines, even fines
2369 linkend="noissuescharge">noissuescharge</link>.</para>
2371 <para>Values:</para>
2375 <para>Don't require</para>
2379 <para>Require</para>
2383 <para>Description:</para>
2387 <para>This preference let's you decide if you want to always
2388 be warned that the patron has fines when checking out. If you
2389 have it set to 'Require' then no matter how much money the
2390 patron owes a message will pop up warning you that the patron
2396 <section id="AllowFineOverride">
2397 <title>AllowFineOverride</title>
2399 <para>Default: Don't allow</para>
2401 <para>Asks: ___ staff to manually override and check out items to
2402 patrons who have more than <link
2403 linkend="noissuescharge">noissuescharge</link> in fines.</para>
2405 <para>Values:</para>
2413 <para>Don't allow</para>
2417 <para>Description:</para>
2421 <para>This preference lets you decide if you staff can check
2422 out to patrons who owe more money than you usually let them
2423 carry on their account. If set to 'Allow' staff will be warned
2424 that the patrons owes money, but it won't stop the staff from
2425 checking out to the patron.</para>
2430 <section id="AllowItemsOnHoldCheckout">
2431 <title>AllowItemsOnHoldCheckout</title>
2433 <para>Default: Don't allow</para>
2435 <para>Asks: ___ checkouts of items reserved to someone else. If
2436 allowed do not generate RESERVE_WAITING and RESERVED warning. This
2437 allows self checkouts for those items.</para>
2439 <para>Values:</para>
2447 <para>Don't allow</para>
2452 <para>This system preference relates only to SIP based self
2453 checkout, not Koha's web based self checkout.</para>
2456 <para>Description:</para>
2460 <para>When this preference is set to 'Allow' patrons will be
2461 able to use your external self check machine to check out a
2462 book to themselves even if it's on hold for someone else. If
2463 you would like Koha to prevent people from checking out books
2464 that are on hold for someone else set this preference to
2465 "Don't allow."</para>
2470 <section id="AllowNotForLoanOverride">
2471 <title>AllowNotForLoanOverride</title>
2473 <para>Default: Allow</para>
2475 <para>Asks: ___ staff to override and check out items that are
2476 marked as not for loan.</para>
2478 <para>Values:</para>
2486 <para>Don't allow</para>
2490 <para>Description:</para>
2494 <para>This parameter is a binary setting which controls the
2495 ability of staff (patrons will always be prevented from
2496 checking these items out) to check out items that are marked
2497 as "not for loan". Setting it to "Allow" would allow such
2498 items to be checked out, setting it to "Don't allow" would
2499 prevent this. This setting determines whether items meant to
2500 stay in the library, such as reference materials, and other
2501 library resources can be checked out by patrons.</para>
2506 <section id="AllowRenewalLimitOverride">
2507 <title>AllowRenewalLimitOverride</title>
2509 <para>Default: Allow</para>
2511 <para>Asks: ___ staff to manually override the renewal limit and
2512 renew a checkout when it would go over the renewal limit.</para>
2514 <para>Values:</para>
2522 <para>Don't allow</para>
2526 <para>Description:</para>
2530 <para>This preference is a binary setting which controls the
2531 ability of staff to override the limits placed on the number
2532 of times an item can be renewed. Setting it to "Allow" would
2533 allow such limits to be overridden, setting it to "Don't
2534 allow" would prevent this. This is a preference in which if it
2535 is set to "allow" it would allow the library staff to use
2536 their judgment for overriding the renew limit for special
2537 cases, setting it to "Don't allow" prevents an opportunity for
2538 abuse by the library staff.</para>
2543 <section id="AllowReturnToBranch">
2544 <title>AllowReturnToBranch</title>
2546 <para>Default: to any library</para>
2548 <para>Asks: Allow materials to be returned to ___</para>
2550 <para>Values:</para>
2554 <para>either the library the item is from or the library it
2555 was checked out from.</para>
2559 <para>only the library the item is from.</para>
2563 <para>only the library the item was checked out from.</para>
2567 <para>to any library.</para>
2571 <para>Description:</para>
2575 <para>This preference lets the library system decide how they
2576 will accept returns. Some systems allow for items to be
2577 returned to any library in the system (the default value of
2578 this preference) others want to limit item returns to only
2579 specific branches. This preference will allow you to limit
2580 item returns (checkins) to the branch(es) set in the
2586 <section id="AutomaticItemReturn">
2587 <title>AutomaticItemReturn</title>
2589 <para>Default: Do</para>
2591 <para>Asks: ___ automatically transfer items to their home branch
2592 when they are returned.</para>
2594 <para>Values:</para>
2606 <para>Description:</para>
2610 <para>This preference is a binary setting which determines
2611 whether an item is returned to its home branch automatically
2612 or not. If set to "Don't", the staff member checking an item
2613 in at a location other than the item's home branch will be
2614 asked whether the item will remain at the non-home branch (in
2615 which case the new location will be marked as a holding
2616 location) or returned. Setting it to "Do" will ensure that
2617 items checked in at a branch other than their home branch will
2618 be sent to that home branch.</para>
2623 <section id="CircControl">
2624 <title>CircControl</title>
2626 <para>Default: the library the item is from</para>
2628 <para>Asks: Use the checkout and fines rules of ___</para>
2630 <para>Values:</para>
2634 <para>the library the item is from</para>
2638 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2639 will be determined by the library that owns the item</para>
2645 <para>the library the patron is from</para>
2649 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2650 will be determined the patron's home library</para>
2656 <para>the library you are logged in at</para>
2660 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2661 will be determined by the library that checked the item out to the
2669 <section id="HomeOrHoldingBranch">
2670 <title>HomeOrHoldingBranch</title>
2672 <para>Default: the library the item was checked out from</para>
2674 <para>Asks: Use the checkout and fines rules of ___</para>
2676 <para>Values:</para>
2680 <para>the library the item is from</para>
2684 <para>the library the item was checked out from</para>
2689 <para>It is not recommend that this setting be changed after initial setup of Koha
2690 because it will change the behavior of items already checked out.</para>
2692 <para>Description:</para>
2695 <para>If <link linkend="IndependantBranches">IndependantBranches</link> is set to
2696 'Prevent' and <link linkend="CircControl">CircControl</link> is set to 'the
2697 library the item is from' this preference decides whether the library holding the
2698 item (holding library on the item record) may check the item out to its own patron
2699 or if it must immediately send the item back to the owning location (home library
2700 on the item record).</para>
2704 <para>This preference does nothing unless the <link linkend="IndependantBranches"
2705 >IndependantBranches</link> preference is set to 'Prevent'.</para>
2708 <section id="HomeOrHoldingBranchReturn">
2709 <title>HomeOrHoldingBranchReturn</title>
2710 <para>Default: the library the item is from</para>
2711 <para>Asks: On checkin route the returned item to ___</para>
2712 <para>Values:<itemizedlist>
2714 <para>the library the item is from</para>
2717 <para>the library item was checked out from</para>
2719 </itemizedlist></para>
2720 <para>Description:<itemizedlist>
2722 <para>This preference will control where Koha prompts you to return the checked in
2723 item to. The value in this preference is overridden by any values you have
2724 related to item returns and floating collections in the <link
2725 linkend="circfinerules">Circulation and Fine Rules</link>.</para>
2727 </itemizedlist></para>
2730 <section id="InProcessingToShelvingCart">
2731 <title>InProcessingToShelvingCart</title>
2733 <para>Default: Don't move</para>
2735 <para>Asks: ___ items that have the location PROC to the location
2736 CART when they are checked in.</para>
2738 <para>Values:</para>
2742 <para>Don't move</para>
2751 <section id="IssuingInProcess">
2752 <title>IssuingInProcess</title>
2754 <para>Default: Don't prevent</para>
2756 <para>Asks: ___ patrons from checking out an item whose rental
2757 charge would take them over the limit.</para>
2759 <para>Values:</para>
2763 <para>Don't prevent</para>
2767 <para>Prevent</para>
2771 <para>Description:</para>
2775 <para>This preference determines if a patron can check items
2776 out if there is an overdue fine on the account and any of the
2777 materials the patron wishes to check out will potentially tip
2778 the account balance over the maximum fines policy the library
2779 has in place.</para>
2783 <para>Example: Your library has a $5 limit set for 'fines' (ie,
2784 after incurring $5 in fines, a patron can no longer check out
2785 items). A patron comes to the desk with 5 items to check out (4
2786 books and a video) The patron has $4 in charges already on their
2787 account. One of the videos has a rental charge of $1, therefore
2788 making the total fines on the patron's account suddenly $5 (the
2792 <section id="IssueLostItem">
2793 <title>IssueLostItem</title>
2795 <para>Default: display a message</para>
2797 <para>Asks: When issuing an item that has been marked as lost,
2800 <para>Values:</para>
2804 <para>display a message</para>
2807 <screeninfo>Lost message when checking out</screeninfo>
2811 <imagedata fileref="images/admin/globalprefs/IssueLostItem-msg.png"/>
2818 <para>do nothing</para>
2822 <para>This option will just check the item out without
2823 notifying you that the item was marked lost.</para>
2829 <para>require confirmation</para>
2832 <screeninfo>Confirm checkout of lost item</screeninfo>
2836 <imagedata fileref="images/admin/globalprefs/IssueLostItem-confirm.png"/>
2843 <para>Description:</para>
2847 <para>This preference lets you define how library staff are
2848 notified that an item with a lost status is being checked out.
2849 This will help staff mark items as 'available' if you choose
2850 to 'display a message' or 'require confirmation.' If you
2851 choose to 'do nothing,' there will be no notification that the
2852 item being checked out is marked as 'lost.'</para>
2857 <section id="maxoutstanding">
2858 <title>maxoutstanding</title>
2860 <para>Default: 5</para>
2862 <para>Asks: Prevent patrons from making holds on the OPAC if they
2863 owe more than ___ USD in fines.</para>
2866 <section id="noissuescharge">
2867 <title>noissuescharge</title>
2869 <para>Default: 5</para>
2871 <para>Asks: Prevent patrons from checking out books if they have
2872 more than ___ USD in fines.</para>
2874 <para>Description:</para>
2878 <para>This preference is the maximum amount of money owed to
2879 the library before the user is banned from borrowing more
2880 items. This also coincides with <link
2881 linkend="maxoutstanding">maxoutstanding</link> that limits
2882 patrons from placing holds when the maximum amount is owed to
2888 <section id="OverduesBlockCirc">
2889 <title>OverduesBlockCirc</title>
2891 <para>Default: Ask for confirmation</para>
2893 <para>Asks: ___ when checking out to a borrower that has overdues
2896 <para>Values:</para>
2900 <para>Ask for confirmation</para>
2904 <para>Will not let you check an item out to patrons with
2905 overdues until a librarian confirms that it is okay</para>
2915 <para>Block all patrons with overdue items from being able
2922 <para>Don't block</para>
2926 <para>Allow all patrons with overdue items to continue to
2934 <section id="OverdueNoticeBcc">
2935 <title>OverdueNoticeBcc</title>
2937 <para>Asks: Send all notices as a BCC to this email address
2940 <para>This preference makes it so that a librarian can get a copy of every notice sent
2941 out to patrons.<tip>
2942 <para>If you'd like more than one person to receive the blind copy you can simply
2943 enter in multiple email addresses separated by commas.</para>
2945 <para>The name of this preference is misleading, it does not only send overdues, but
2946 all notices to the BCC address.</para>
2950 <section id="PrintNoticesMaxLines">
2951 <title>PrintNoticesMaxLines</title>
2953 <para>Asks: Include up to ___ item lines in a printed overdue
2957 <para>If the number of items is greater than this number, the
2958 notice will end with a warning asking the borrower to check
2959 their online account for a full list of overdue items.</para>
2963 <para>Set to 0 to include all overdue items in the notice, no
2964 matter how many there are.</para>
2968 <para>This preference only refers to the print notices, not
2969 those sent via email.</para>
2973 <section id="RenewalPeriodBase">
2974 <title>RenewalPeriodBase</title>
2976 <para>Default: the old due date of the checkout</para>
2978 <para>Asks: When renewing checkouts, base the new due date on
2981 <para>Values:</para>
2985 <para>the old due date of the checkout</para>
2989 <para>the current date</para>
2994 <section id="ReturnBeforeExpiry">
2995 <title>ReturnBeforeExpiry</title>
2997 <para>Default: Don't require</para>
2999 <para>Asks: ___ patrons to return books before their accounts
3000 expire (by restricting due dates to before the patron's expiration
3003 <para>Values:</para>
3007 <para>Don't require</para>
3011 <para>Require</para>
3015 <para>Description:</para>
3019 <para>This is preference may prevent a patron from having
3020 items checked out after their library card has expired. If
3021 this is set to "Require", then a due date of any checked out
3022 item can not be set for a date which falls after the patron's
3023 card expiration. If the setting is left "Don't require" then
3024 item check out dates may exceed the expiration date for the
3025 patron's library card.</para>
3030 <section id="ReturnToShelvingCart">
3031 <title>ReturnToShelvingCart</title>
3033 <para>Default: Don't move</para>
3035 <para>Asks: ___ all items to the location CART when they are
3038 <para>Values:</para>
3042 <para>Don't move</para>
3051 <section id="TransfersMaxDaysWarning">
3052 <title>TransfersMaxDaysWarning</title>
3054 <para>Default: 3</para>
3056 <para>Asks: Show a warning on the "Transfers to Receive" screen if
3057 the transfer has not been received ___ days after it is
3060 <para>Description:</para>
3064 <para>The TransferMaxDaysWarning preference is set at a
3065 default number of days. This preference allows for a warning
3066 to appear after a set amount of time if an item being
3067 transferred between library branches has not been received.
3068 The warning will appear in the <link
3069 linkend="transferstoreceive">Transfers to Receive</link>
3075 <section id="UseBranchTransferLimits">
3076 <title>UseBranchTransferLimits &
3077 BranchTransferLimitsType</title>
3079 <para>Defaults: Don't enforce & collection code</para>
3081 <para>Asks: ___ branch transfer limits based on ___</para>
3083 <para>UseBranchTransferLimits Values:</para>
3087 <para>Don't enforce</para>
3091 <para>Enforce</para>
3095 <para>BranchTransferLimitsType Values:</para>
3099 <para>collection code</para>
3103 <para>item type</para>
3107 <para>BranchTransferLimitsType Description:</para>
3111 <para>This parameter is a binary setting which determines
3112 whether items are transferred according to item type or
3113 collection code. This value determines how the library manager
3114 is able to restrict what items can be transferred between the
3120 <section id="useDaysMode">
3121 <title>useDaysMode</title>
3123 <para>Default: Don't include</para>
3125 <para>Asks: Calculate the due date using ___.</para>
3127 <para>Values:</para>
3131 <para>circulation rules only.</para>
3135 <para>the calendar to push the due date to the next open
3140 <para>the calendar to skip all days the library is
3145 <para>Description:</para>
3149 <para>This preference controls how scheduled library closures
3150 affect the due date of a material. The 'the calendar to skip
3151 all days the library is closed' setting allows for a scheduled
3152 closure not to count as a day in the loan period, the
3153 'circulation rules only' setting would not consider the
3154 scheduled closure at all, and 'the calendar to push the due
3155 date to the next open day' would only effect the due date if
3156 the day the item is due would fall specifically on the day of
3161 <para>Example:</para>
3165 <para>The library has put December 24th and 25th in as
3166 closures on the calendar. A book checked out by a patron has a
3167 due date of December 25th according to the circulation and
3168 fine rules. If this preference is set to 'circulation rules
3169 only' then the item will remain due on the 25th. If the
3170 preference is set to 'the calendar to push the due date to the
3171 next open day' then the due date will be December 26th. If the
3172 preference is set to 'the calendar to skip all days the
3173 library is closed' then the due date will be pushed to the
3174 27th of December to accommodate for the two closed
3179 <para>The calendar is defined on a branch by branch basis. To
3180 learn more about the calendar, check out the '<link
3181 linkend="calholidays">Calendar & Holidays</link>' section of
3184 <section id="UseTransportCostMatrix">
3185 <title>UseTransportCostMatrix</title>
3186 <para>Default: Don't use</para>
3187 <para>Asks: ___ Transport Cost Matrix for calculating optimal holds filling between
3189 <para>Values:<itemizedlist>
3191 <para>Don't use</para>
3196 </itemizedlist></para>
3197 <para>Description:<itemizedlist>
3199 <para>If the system is configured to use the <link linkend="transportcostmatrix"
3200 >Transport cost matrix</link> for filling holds, then when attempting to fill
3201 a hold, the system will search for the lowest cost branch, and attempt to fill
3202 the hold with an item from that branch first. Branches of equal cost will be
3203 selected from randomly. The branch or branches of the next highest cost shall be
3204 selected from only if all the branches in the previous group are unable to fill
3206 <para>The system will use the item's current holding branch when determining
3207 whether the item can fulfill a hold using the Transport Cost Matrix. This
3208 behaviour will be overruled if the <link linkend="AutomaticItemReturn"
3209 >AutomaticItemReturn</link> system preference is enabled.</para>
3211 </itemizedlist></para>
3215 <section id="circfinespolicy">
3216 <title>Fines Policy</title>
3220 <section id="finesCalendar">
3221 <title>finesCalendar</title>
3223 <para>Default: not including the days the library is closed</para>
3225 <para>Asks: Calculate fines based on days overdue ___</para>
3227 <para>Values:</para>
3231 <para>directly</para>
3235 <para>not including the days the library is closed</para>
3239 <para>Description:</para>
3243 <para>This preference will determine whether or not fines will
3244 be accrued during instances when the library is closed.
3245 Examples include holidays, library in-service days, etc.
3246 Choosing "not including the days the library is closed"
3247 setting will enable Koha to access its <link linkend="calholidays">Calendar</link> module and be
3248 considerate of dates when the library is closed. To make use
3249 of this setting the administrator must first access Koha's
3250 calendar and mark certain days as "holidays" ahead of
3255 <para>The calendar is defined on a branch by branch basis. To
3256 learn more about the calendar, check out the '<link
3257 linkend="calholidays">Calendar & Holidays</link>' section of
3261 <section id="finesMode">
3262 <title>finesMode</title>
3264 <para>Default: Calculate (but only for mailing to the
3267 <para>Asks: ___ fines</para>
3269 <para>Values:</para>
3273 <para>Calculate (but only for mailing to the admin)</para>
3277 <para>Calculate and charge</para>
3281 <para>Don't calculate</para>
3286 <para>Requires that you have the fines cron job running
3287 (misc/cronjobs/fines.pl)</para>
3292 <section id="circholdspolicy">
3293 <title>Holds Policy</title>
3297 <section id="AllowHoldDateInFuture">
3298 <title>AllowHoldDateInFuture</title>
3300 <para>Default: Allow</para>
3302 <para>Asks: ___ hold requests to be placed that do not enter the
3303 waiting list until a certain future date.</para>
3305 <para>Values:</para>
3313 <para>Don't allow</para>
3318 <section id="AllowHoldsOnDamagedItems">
3319 <title>AllowHoldsOnDamagedItems</title>
3321 <para>Default: Allow</para>
3323 <para>Asks: ___ hold requests to be placed on damaged
3326 <para>Values:</para>
3334 <para>Don't allow</para>
3338 <para>Description:</para>
3342 <para>This parameter is a binary setting which controls
3343 whether or not hold requests can be placed on items that are
3344 marked as "damaged" (items are marked as damaged by editing
3345 subfield 4 on the item record). Setting this value to "Don't
3346 allow" will prevent anyone from placing a hold on such items,
3347 setting it to "Allow" will allow it. This preference is
3348 important because it determines whether or not a patron can
3349 place a request for an item that might be in the process of
3350 being repaired or not in good condition. The library may wish
3351 to set this to "Don't allow" if they were concerned about
3352 their patrons not receiving the item in a timely manner or at
3353 all (if it is determined that the item is beyond repair).
3354 Setting it to "Allow" would allow a patron to place a hold on
3355 an item and therefore receive it as soon as it becomes
3361 <section id="AllowHoldPolicyOverride">
3362 <title>AllowHoldPolicyOverride</title>
3364 <para>Default: Allow</para>
3366 <para>Asks: ___ staff to override hold policies when placing
3369 <para>Values:</para>
3377 <para>Don't allow</para>
3381 <para>Description:</para>
3385 <para>This preference is a binary setting which controls
3386 whether or not the library staff can override the circulation
3387 and fines rules as they pertain to the placement of holds.
3388 Setting this value to "Don't allow" will prevent anyone from
3389 overriding, setting it to "Allow" will allow it. This setting
3390 is important because it determines how strict the libraries
3391 rules for placing holds are. If this is set to "Allow",
3392 exceptions can be made for patrons who are otherwise normally
3393 in good standing with the library, but there is opportunity
3394 for the staff to abuse this function. If it is set to "Don't
3395 allow", no abuse of the system is possible, but it makes the
3396 system entirely inflexible in respect to holds.</para>
3401 <section id="AllowOnShelfHolds">
3402 <title>AllowOnShelfHolds</title>
3404 <para>Default: Allow</para>
3406 <para>Asks: ___ hold requests to be placed on items that are not
3409 <para>Values:</para>
3417 <para>Don't Allow</para>
3421 <para>Description:</para>
3425 <para>This preference is a binary setting which controls the
3426 ability of patrons to place holds on items that are not
3427 currently checked out. Setting it to "Don't allow" allows
3428 borrowers to place holds on items that are checked out but not
3429 on items that are on the shelf (or assumed available in the
3430 library), setting it to "Allow" allows borrowers to place
3431 holds on any item that is available for loan whether it is
3432 checked out or not. This setting might be set to "Allow" if
3433 the library system is a multi branch system and patrons used
3434 the hold system to request items from other libraries, or if
3435 the library wanted to allow users to place holds on items from
3436 home through the OPAC. Setting it to "Don't allow" would
3437 enforce a first come, first served standard.</para>
3442 <section id="AutoResumeSuspendedHolds">
3443 <title>AutoResumeSuspendedHolds</title>
3445 <para>Default: Allow</para>
3447 <para>Asks: ___ suspended holds to be automatically resumed by a
3450 <para>Values:</para>
3458 <para>Don't allow</para>
3462 <para>Description:</para>
3466 <para>If this preference is set to 'Allow' then all suspended holds will be able to
3467 have a date at after which they automatically become unsuspended. If you have this
3468 preference set to 'Allow' you will also need the <link linkend="unsuspendholdcron"
3469 >Unsuspend Holds</link> cron job running.</para>
3473 <para>The holds will become unsuspended the date after that entered by the
3478 <section id="canreservefromotherbranches">
3479 <title>canreservefromotherbranches</title>
3481 <para>Default: Allow</para>
3483 <para>Asks: ___ a user from one library to place a hold on an item
3484 from another library</para>
3486 <para>Description:</para>
3490 <para>This preference is a binary setting which determines
3491 whether patrons can place holds on items from other branches.
3492 If the preference is set to "Allow" patrons can place such
3493 holds, if it is set to "Don't allow" they cannot. This is an
3494 important setting because it determines if users can use Koha
3495 to request items from another branch. If the library is
3496 sharing an installation of Koha with other independent
3497 libraries which do not wish to allow interlibrary borrowing it
3498 is recommended that this parameter be set to "Don't
3503 <para>Values:</para>
3511 <para>Don't allow (with <link
3512 linkend="IndependantBranches">independent
3513 branches</link>)</para>
3517 <section id="decreaseLoanHighHolds">
3518 <title>decreaseLoanHighHolds, decreaseLoanHighHoldsDuration and
3519 decreaseLoanHighHoldsValue</title>
3520 <para>Asks: ___ the reduction of loan period to ___ days for items with more than ___
3522 <para>decreaseLoanHighHolds default: Don't enable</para>
3523 <para>decreaseLoanHighHolds values:<itemizedlist>
3524 <para>Don't enable</para>
3528 </itemizedlist>Description:<itemizedlist>
3530 <para>These preferences let you change the loan length for items that have many
3531 holds on them. This will not effect items that are already checked out, but
3532 items that are checked out after the decreaseLoanHighHoldsValue is met will only
3533 be checked out for the number of days entered in the
3534 decreaseLoanHighHoldsDuration preference.</para>
3536 <screeninfo>Warning on checkout</screeninfo>
3540 fileref="images/admin/globalprefs/decreaseLoanHighHoldsDuration.png"/>
3545 </itemizedlist></para>
3548 <section id="DisplayMultiPlaceHold">
3549 <title>DisplayMultiPlaceHold</title>
3551 <para>Default: Don't enable</para>
3553 <para>Asks: ___ the ability to place holds on multiple biblio from
3554 the search results</para>
3556 <para>Values:</para>
3560 <para>Don't enable</para>
3569 <section id="emailLibrarianWhenHoldIsPlaced">
3570 <title>emailLibrarianWhenHoldIsPlaced</title>
3572 <para>Default: Don't enable</para>
3574 <para>Asks: ___ sending an email to the Koha administrator email
3575 address whenever a hold request is placed.</para>
3577 <para>Values:</para>
3581 <para>Don't enable</para>
3589 <para>Description:</para>
3593 <para>This preference enables Koha to email the library staff
3594 whenever a patron requests an item to be held. While this
3595 function will immediately alert the librarian to the patron's
3596 need, it is extremely impractical in most library settings. In
3597 most libraries the hold lists are monitored and maintained
3598 from a separate interface. That said, many libraries that
3599 allow on shelf holds prefer to have this preference turned on
3600 so that they are alerted to pull an item from the
3606 <para>In order for this email to send you must have a <link
3607 linkend="notices">notice</link> template with the code of
3612 <para>This notice will only be sent if the <link
3613 linkend="msgqueuecron">process_message_queue.pl cronjob</link>
3614 being run periodically to send the messages.</para>
3618 <section id="ExpireReservesMaxPickUpDelay">
3619 <title>ExpireReservesMaxPickUpDelay</title>
3621 <para>Default: Don't allow</para>
3623 <para>Asks: ___ holds to expire automatically if they have not
3624 been picked by within the time period specified in <link
3625 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
3627 <para>Values:</para>
3635 <para>Don't allow</para>
3639 <para>Description:</para>
3643 <para>If set to 'allow' this will cancel holds that have been
3644 waiting for longer than the number of days specified in the
3646 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
3647 system preference. Holds will only be cancelled if the <link
3648 linkend="expiredholdscron">Expire Holds cron job</link> is
3654 <section id="ExpireReservesMaxPickUpDelayCharge">
3655 <title>ExpireReservesMaxPickUpDelayCharge</title>
3657 <para>Default: 0</para>
3659 <para>Asks: If using <link
3660 linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
3661 charge a borrower who allows his or her waiting hold to expire a
3662 fee of ___ USD</para>
3664 <para>Description:</para>
3668 <para>If you are expiring holds that have been waiting too
3669 long you can use this preference to charge the patron for not
3670 picking up their hold. If you don't charge patrons for items
3671 that aren't picked up you can leave this set to the default
3672 which is 0. Holds will only be cancelled and charged if the
3673 <link linkend="expiredholdscron">Expire Holds cron job</link>
3679 <section id="maxreserves">
3680 <title>maxreserves</title>
3682 <para>Default: 50</para>
3684 <para>Asks: Patrons can only have ___ holds at once.</para>
3687 <section id="OPACAllowHoldDateInFuture">
3688 <title>OPACAllowHoldDateInFuture</title>
3690 <para>Default: Allow</para>
3692 <para>Asks: ___ patrons to place holds that don't enter the
3693 waiting list until a certain future date.</para>
3695 <para>Values:</para>
3704 linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
3705 must also be enabled for this to work</para>
3711 <para>Don't allow</para>
3716 <section id="OPACAllowUserToChooseBranch">
3717 <title>OPACAllowUserToChooseBranch</title>
3719 <para>Default: Allow</para>
3721 <para>Asks: ___ a user to choose the branch to pick up a hold
3724 <para>Values:</para>
3732 <para>Don't allow</para>
3736 <para>Description:</para>
3740 <para>Changing this preference will not prevent staff from
3741 being able to transfer titles from one branch to another to
3742 fill a hold, it will only prevent patrons from saying they
3743 plan on picking a book up at a branch other than their home
3749 <section id="ReservesControlBranch">
3750 <title>ReservesControlBranch</title>
3752 <para>Default: item's home library</para>
3754 <para>Asks: Check the ___ to see if the patron can place a hold on
3757 <para>Values:</para>
3761 <para>item's home library.</para>
3765 <para>patron's home library.</para>
3770 <section id="ReservesMaxPickUpDelay">
3771 <title>ReservesMaxPickUpDelay</title>
3773 <para>Default: 7</para>
3775 <para>Asks: Mark a hold as problematic if it has been waiting for
3776 more than ___ days.</para>
3778 <para>Description:</para>
3782 <para>This preference (based on calendar days, not the <link
3783 linkend="calholidays">Koha holiday calendar</link>) puts an
3784 expiration date on an item a patron has on hold. After this
3785 expiration date the staff will have the option to release the
3786 unclaimed hold which then may be returned to the library shelf
3787 or issued to the next patron on the item's hold list. Items
3788 that are 'expired' by this preference are moved to the 'Holds
3789 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
3790 Pickup</link>' report.</para>
3795 <section id="ReservesNeedReturns">
3796 <title>ReservesNeedReturns</title>
3798 <para>Default: Don't automatically</para>
3800 <para>Asks: ___ mark holds as found and waiting when a hold is
3801 placed specifically on them and they are already checked
3804 <para>Values:</para>
3808 <para>Automatically</para>
3812 <para>Don't automatically</para>
3816 <para>Description:</para>
3820 <para>This preference refers to 'item specific' holds where
3821 the item is currently on the library shelf. This preference
3822 allows a library to decide whether an 'item specific' hold is
3823 marked as "Waiting" at the time the hold is placed or if the
3824 item will be marked as "Waiting" after the item is checked in.
3825 This preference will tell the patron that their item is
3826 'Waiting' for them at their library and ready for check
3832 <section id="holdqueueweight">
3833 <title>StaticHoldsQueueWeight &
3834 RandomizeHoldsQueueWeight</title>
3836 <para>StaticHoldsQueueWeight Default: 0</para>
3838 <para>RandomizeHoldsQueueWeight Default: in that order</para>
3840 <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
3841 separated by commas; if empty, uses all libraries) ___</para>
3843 <para>RandomizeHoldsQueueWeight Values:</para>
3847 <para>in random order</para>
3851 <para>If StaticHoldsQueueWeight is left at the default
3852 Koha will randomize all libraries, otherwise it will
3853 randomize the libraries listed.</para>
3859 <para>in that order</para>
3863 <para>If StaticHoldsQueueWeight is left at the default
3864 then this will use all of your branches in alphabetical
3865 order, otherwise it will use the branches in the order
3866 that you entered them in the StaticHoldsQueueWeight
3873 <para>Descriptions:</para>
3877 <para>These preferences control how the <link
3878 linkend="holdsqueue">Holds Queue report</link> is generated
3879 using <link linkend="buildholdscron">a cron job</link>.</para>
3881 <para>If you do not want all of your libraries to participate
3882 in the on-shelf holds fulfillment process, you should list the
3883 the libraries that *do* participate in the process here by
3884 inputting all the participating library's branchcodes,
3885 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
3887 <para>By default, the holds queue will be generated such that
3888 the system will first attempt to hold fulfillment using items
3889 already at the pickup library if possible. If there are no
3890 items available at the pickup library to fill a hold,
3891 build_holds_queue.pl will then use the list of libraries
3892 defined in StaticHoldsQueueWeight. If
3893 RandomizeHoldsQueueWeight is disabled ( which it is by default
3894 ), the script will assign fulfillment requests in the order
3895 the branches are placed in the StaticHoldsQueueWeight system
3898 <para>For example, if your system has three libraries, of
3899 varying sizes ( small, medium and large ) and you want the
3900 burden of holds fulfillment to be on larger libraries before
3901 smaller libraries, you would want StaticHoldsQueueWeight to
3902 look something like "LRG,MED,SML".</para>
3904 <para>If you want the burden of holds fulfillment to be spread
3905 out equally throughout your library system, simply enable
3906 RandomizeHoldsQueueWeight. When this system preference is
3907 enabled, the order in which libraries will be requested to
3908 fulfill an on-shelf hold will be randomized each time the list
3909 is regenerated.</para>
3911 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
3912 at this time. Doing so will cause the build_holds_queue script
3913 to ignore RandomizeHoldsQueueWeight, causing the script to
3914 request hold fulfillment not randomly, but by alphabetical
3919 <para>The <link linkend="transportcostmatrix">Transport Cost Matrix</link> takes
3920 precedence in controlling where holds are filled from, if the matrix is not used
3921 then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix
3922 simply set your <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link>
3923 preference to 'Use'</para>
3927 <section id="SuspendHoldsIntranet">
3928 <title>SuspendHoldsIntranet</title>
3930 <para>Default: Allow</para>
3932 <para>Asks: ___ holds to be suspended from the intranet.</para>
3934 <para>Values:</para>
3942 <para>Don't allow</para>
3946 <para>Description:</para>
3950 <para>The holds suspension feature can be turned on and off in
3951 the staff client by altering this system preference. If this
3952 is set to 'allow' you will want to set the <link
3953 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
3954 system preference.</para>
3959 <section id="SuspendHoldsOpac">
3960 <title>SuspendHoldsOpac</title>
3962 <para>Default: Allow</para>
3964 <para>Asks: ___ holds to be suspended from the OPAC.</para>
3966 <para>Values:</para>
3974 <para>Don't allow</para>
3978 <para>Description:</para>
3982 <para>The holds suspension feature can be turned on and off in
3983 the OPAC by altering this system preference. If this is set to
3984 'allow' you will want to set the <link
3985 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
3986 system preference.</para>
3992 <section id="circinterfaceprefs">
3993 <title>Interface</title>
3997 <section id="AllowAllMessageDeletion">
3998 <title>AllowAllMessageDeletion</title>
4000 <para>Default: Don't allow</para>
4002 <para>Asks: ___ staff to delete messages added from other
4005 <para>Values:</para>
4013 <para>Don't allow</para>
4018 <section id="CircAutocompl">
4019 <title>CircAutocompl</title>
4021 <para>Default: Try</para>
4023 <para>Asks: ___ to automatically fill in the member when entering
4024 a patron search on the circulation screen.</para>
4026 <para>Description:</para>
4030 <para>This preference is a binary setting which determines
4031 whether auto-completion of fields is enabled or disabled for
4032 the circulation input field. Setting it to "Try" would enable
4033 a staff member to begin typing a name or other value into the
4034 field and have a menu pop up with suggestions for completing
4035 it. Setting it to "Don't try" would disable this feature. This
4036 preference can make staff members' jobs easier or it could
4037 potentially slow down the page loading process.</para>
4041 <para>Values:</para>
4045 <para>Don't try</para>
4052 <screeninfo>When CircAutocompl is turned on search results
4053 will appear below the search box</screeninfo>
4057 <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
4065 <section id="CircAutoPrintQuickSlip">
4066 <title>CircAutoPrintQuickSlip</title>
4068 <para>Default: open a print quick slip window</para>
4070 <para>Asks: When an empty barcode field is submitted in
4071 circulation ___</para>
4073 <para>Values:</para>
4077 <para>clear the screen</para>
4081 <para>open a print quick slip window</para>
4085 <para>Description:</para>
4089 <para>If this preference is set to open a quick slip for
4090 printing it will eliminate the need for the librarian to click
4091 the print button to generate a checkout receipt for the patron
4092 they're checking out to. If the preference is set to clear the
4093 screen then "checking out" an empty barcode will clear the
4094 screen of the patron you were last working with.</para>
4099 <section id="FilterBeforeOverdueReport">
4100 <title>FilterBeforeOverdueReport</title>
4102 <para>Default: Don't require</para>
4104 <para>Asks: ___ staff to choose which checkouts to show before
4105 running the overdues report.</para>
4107 <para>Description:</para>
4111 <para>Koha's overdue report shows you all of the overdue items
4112 in your library system. If you have a large library system
4113 you'll want to set this preference to 'Require' to force those
4114 running the report to first limit the data generated to a
4115 branch, date range, patron category or other such filter.
4116 Requiring that the report be filtered before it's run prevents
4117 your staff from running a system heavy report and slowing down
4118 other operations in the system.</para>
4121 <screeninfo>Overdue Report Filters</screeninfo>
4125 <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
4132 <para>Values:</para>
4136 <para>Don't require</para>
4140 <para>Require</para>
4145 <section id="FineNotifyAtCheckin">
4146 <title>FineNotifyAtCheckin</title>
4148 <para>Default: Don't notify</para>
4150 <para>Asks: ___ librarians of overdue fines on the items they are
4153 <para>Values:</para>
4157 <para>Don't notify</para>
4165 <para>Description:</para>
4169 <para>With this preference set to 'Notify' all books that have
4170 overdue fines owed on them will pop up a warning when checking
4171 them in. This warning will need to acknowledged before you can
4172 continue checking items in. With this preference set to 'Don't
4173 notify,' you will still see fines owed on the patron record,
4174 you just won't have an additional notification at check
4178 <screeninfo>Fine notification at checkin</screeninfo>
4182 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
4190 <section id="DisplayClearScreenButton">
4191 <title>DisplayClearScreenButton</title>
4193 <para>Default: Show</para>
4195 <para>Asks: ___ a button to clear the current patron from the
4196 screen on the circulation screen.</para>
4198 <para>Values:</para>
4202 <para>Don't show</para>
4205 <screeninfo>No X in the top right</screeninfo>
4209 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
4219 <screeninfo>X in the top right will clear the
4224 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
4231 <section id="ExportRemoveFields">
4232 <title>ExportRemoveFields</title>
4233 <para>Asks: The following fields should be excluded from the patron checkout history CSV
4234 or iso2709 export ___ </para>
4235 <para>Description:<itemizedlist>
4237 <para>This space separated list of fields (e.g. 100a 245b) will automatically be
4238 excluded when exporting the patron's current checkout history.</para>
4240 <screeninfo>ExportRemoveFields</screeninfo>
4243 <imagedata fileref="images/admin/globalprefs/ExportRemoveFields.png"/>
4248 </itemizedlist></para>
4250 <section id="ExportWithCsvProfile">
4251 <title>ExportWithCsvProfile</title>
4252 <para>Asks: Use the ___ CSV profile when exporting patron checkout history</para>
4253 <para>Description:<itemizedlist>
4255 <para>Use this preference to define which <link linkend="csvprofiles">CSV
4256 profile</link> should be used when exporting patron's current checkout data.
4257 Enter the CSV Profile name as the value for this preference. If this preference
4258 is left blank you will not be able to export the patron's current checkout
4261 <screeninfo>ExportWithCsvProfile</screeninfo>
4264 <imagedata fileref="images/admin/globalprefs/ExportWithCsvProfile.png"/>
4269 </itemizedlist></para>
4271 <section id="HoldsToPullStartDate">
4272 <title>HoldsToPullStartDate</title>
4273 <para>Default: 2</para>
4274 <para>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago. </para>
4275 <para>Description:<itemizedlist>
4277 <para>The <link linkend="holdspull">Holds to Pull</link> report in circulation
4278 defaults to filtering holds placed 2 days ago. This preference allows you to set
4279 this default filter to any number of days.</para>
4281 </itemizedlist></para>
4284 <section id="itemBarcodeInputFilter">
4285 <title>itemBarcodeInputFilter</title>
4287 <para>Default: Don't filter</para>
4289 <para>Asks: ___ scanned item barcodes.</para>
4291 <para>Values:</para>
4295 <para>Convert from CueCat format</para>
4299 <para>Convert from Libsuite8 form</para>
4303 <para>Don't filter</para>
4307 <para>EAN-13 or zero-padded UPC-A from</para>
4311 <para>Remove spaces from</para>
4315 <para>Remove the first number from T-prefix style</para>
4319 <para>This format is common among those libraries
4320 migrating from Follett systems</para>
4327 <section id="NoticeCSS">
4328 <title>NoticeCSS</title>
4330 <para>Asks: Include the stylesheet at ___ on Notices.<important>
4331 <para>This should be a complete URL, starting with
4335 <para>Description:</para>
4339 <para>If you would like to style your notices with a
4340 consistent set of fonts and colors you can use this preference
4341 to point Koha to a stylesheet specifically for your
4347 <section id="numReturnedItemsToShow">
4348 <title>numReturnedItemsToShow</title>
4350 <para>Default: 20</para>
4352 <para>Asks : Show the ___ last returned items on the checkin
4356 <section id="previousIssuesDefaultSortOrder">
4357 <title>previousIssuesDefaultSortOrder</title>
4359 <para>Default: earliest to latest</para>
4361 <para>Asks: Sort previous checkouts on the circulation page from
4362 ___ due date.</para>
4364 <para>Values:</para>
4368 <para>earliest to latest</para>
4372 <para>latest to earliest</para>
4377 <section id="RecordLocalUseOnReturn">
4378 <title>RecordLocalUseOnReturn</title>
4380 <para>Default: Don't record</para>
4382 <para>Asks: ___ local use when an unissued item is checked
4385 <para>Values:</para>
4389 <para>Don't record</para>
4397 <para>Description:</para>
4401 <para>When this preference is set to "Don't record" you can
4402 record local use of items by checking items out to the
4403 statistical patron. With this preference set to "Record" you
4404 can record local use by checking out to the statistical patron
4405 and/or by checking in a book that is not currently checked
4411 <section id="soundon">
4412 <title>soundon</title>
4414 <para>Default: Don't enable</para>
4416 <para>Asks: ___ circulation sounds during checkin and checkout in
4417 the staff interface.</para>
4419 <para>Values:</para>
4423 <para>Don't enable</para>
4432 <para>This feature is not supported by all browsers. Requires
4433 an HTML5 compliant browser.</para>
4437 <section id="SpecifyDueDate">
4438 <title>SpecifyDueDate</title>
4440 <para>Default: Allow</para>
4442 <para>Asks: ___ staff to specify a due date for a checkout.</para>
4444 <para>Due dates are calculated using your circulation and fines
4445 rules, but staff can override that if you allow them to specify a
4446 due date at checkout.</para>
4448 <para>Description:</para>
4452 <para>This preference allows for circulation staff to change a
4453 due date from the automatic due date to another calendar date.
4454 This option would be used for circumstances in which the due
4455 date may need to be decreased or extended in a specific
4456 circumstance. The "Allow" setting would allow for this option
4457 to be utilized by staff, the "Don't allow" setting would bar
4458 staff from changing the due date on materials.</para>
4462 <para>Values:</para>
4469 <screeninfo>Specify Due Date Box Shows</screeninfo>
4473 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
4480 <para>Don't allow</para>
4483 <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
4487 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
4495 <section id="todaysIssuesDefaultSortOrder">
4496 <title>todaysIssuesDefaultSortOrder</title>
4498 <para>Default: latest to earliest</para>
4500 <para>Asks: Sort today's checkouts on the circulation page from
4501 ___ due date.</para>
4503 <para>Values:</para>
4507 <para>earliest to latest</para>
4511 <para>latest to earliest</para>
4516 <section id="UpdateTotalIssuesOnCirc">
4517 <title>UpdateTotalIssuesOnCirc</title>
4519 <para>Default: Do not</para>
4521 <para>Asks: ___ update a bibliographic record's total issues count
4522 whenever an item is issued</para>
4524 <para>Values:</para>
4529 <para>This increases server load significantly; if
4530 performance is a concern, use the <link
4531 linkend="updateissuescron">cron job</link> to update the
4532 total issues count instead.</para>
4541 <para>Description:</para>
4545 <para>Koha can track the number of times and item is checked
4546 out and store that on the item record in the database. This
4547 information is not stored by default. Setting this preference
4548 to 'Do' will tell Koha to track that info everytime the item
4549 is checked out in real time. Otherwise you could use the <link
4550 linkend="updateissuescron">cron job</link> to have Koha update
4551 that field nightly.</para>
4556 <section id="UseTablesortForCirc">
4557 <title>UseTablesortForCirc</title>
4559 <para>Default: Don't enable</para>
4561 <para>Asks: ___ the sorting of current patron checkouts on the
4562 circulation screen.</para>
4564 <para>Values:</para>
4568 <para>Don't enable</para>
4577 <para>Enabling this function may slow down circulation time for
4578 patrons with many checkouts.</para>
4582 <section id="WaitingNotifyAtCheckin">
4583 <title>WaitingNotifyAtCheckin</title>
4585 <para>Default: Don't notify</para>
4587 <para>Asks: ___ librarians of waiting holds for the patron whose
4588 items they are checking in.</para>
4590 <para>Values:</para>
4594 <para>Don't notify</para>
4601 <screeninfo>Notification that a hold is waiting</screeninfo>
4605 <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
4612 <para>Description:</para>
4616 <para>When checking in books you can choose whether or not to
4617 have a notice pop up if the patron who returned the book has a
4618 hold waiting for pick up. If you choose 'Notify' for
4619 WaitingNotifyAtCheckin then every time a hold is found for the
4620 patron who had the book out last a message will appear on your
4621 check in screen.</para>
4627 <section id="circscoprefs">
4628 <title>Self Checkout</title>
4632 <section id="AllowSelfCheckReturns">
4633 <title>AllowSelfCheckReturns</title>
4635 <para>Default: Don't allow</para>
4637 <para>Asks: ___ patrons to return items through web-based self
4638 checkout system.</para>
4640 <para>Values:</para>
4648 <para>Don't allow</para>
4652 <para>Description:</para>
4656 <para>This preference is used to determine if you want patrons
4657 to be allowed to return items through your self check
4658 machines. By default Koha's self check interface is simply for
4659 checking items out.</para>
4664 <section id="AutoSelfCheckAllowed">
4665 <title>AutoSelfCheckAllowed, AutoSelfCheckID &
4666 AutoSelfCheckPass</title>
4669 <para>Most libraries will want to leave this set to 'Don't
4670 allow.' This preference turns off the requirement to log into
4671 the self checkout machine with a staff username and password by
4672 storing the username and password for automatic login.</para>
4675 <para>AutoSelfCheckAllowed Default: Don't allow</para>
4677 <para>Asks: ___ the web-based self checkout system to
4678 automatically login with this staff login ___ and this password
4681 <para>AutoSelfCheckAllowed Values:</para>
4689 <para>Don't allow</para>
4693 <para>AutoSelfCheckID Value:<itemizedlist>
4695 <para>The username of a staff patron with 'circulate' <link
4696 linkend="patronpermissions">permissions</link>.</para>
4698 </itemizedlist></para>
4700 <para>AutoSelfCheckPass Value:<itemizedlist>
4702 <para>The password of a staff patron with 'circulate' <link
4703 linkend="patronpermissions">permissions</link>.</para>
4705 </itemizedlist></para>
4708 <section id="SelfCheckHelpMessage">
4709 <title>SelfCheckHelpMessage</title>
4711 <para>Asks: Include the following HTML in the Help page of the
4712 web-based self checkout system</para>
4714 <para>Description:</para>
4718 <para>Clicking the 'Help' link in the top right of the self
4719 checkout interface opens up a three step process for using the
4720 self check interface. Adding HTML to this system preference
4721 will print that additional help text above what's already
4727 <section id="SelfCheckoutByLogin">
4728 <title>SelfCheckoutByLogin</title>
4730 <para>Default: Barcode</para>
4732 <para>Asks: Have patrons login into the web-based self checkout
4733 system with their ___</para>
4735 <para>Values:</para>
4739 <para>Barcode</para>
4742 <screeninfo>Self Checkout Patron Card Number</screeninfo>
4746 <imagedata fileref="images/circ/selfcheckout.png"/>
4753 <para>Username and password</para>
4756 <screeninfo>Shelf checkout by login</screeninfo>
4760 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
4767 <para>Description:</para>
4771 <para>This preference lets you decide how your patrons will
4772 log in to the self checkout machine. Barcode is the patron's
4773 card number and their username and password is set using the
4774 opac/staff username and password fields on the patron
4780 <section id="SelfCheckTimeout">
4781 <title>SelfCheckTimeout</title>
4783 <para>Default: 120</para>
4785 <para>Asks: Time out the current patron's web-based self checkout
4786 system login after ___ seconds.</para>
4788 <para>Description:</para>
4792 <para>After the machine is idle for the time entered in this
4793 preference the self check out system will log out the current
4794 patron and return to the starting screen.</para>
4799 <section id="ShowPatronImageInWebBasedSelfCheck">
4800 <title>ShowPatronImageInWebBasedSelfCheck</title>
4802 <para>Default: Don't show</para>
4804 <para>Asks: ___ the patron's picture (if one has been added) when
4805 they use the web-based self checkout.</para>
4807 <para>Values:</para>
4811 <para>Don't show</para>
4820 <section id="WebBasedSelfCheck">
4821 <title>WebBasedSelfCheck</title>
4823 <para>Default: Don't enable</para>
4825 <para>Asks: ___ the web-based self checkout system.</para>
4827 <para>Values:</para>
4831 <para>Don't enable</para>
4839 <para>Enabling this preference will allow access to the <link
4840 linkend="selfcheckout">self checkout</link> module in Koha.</para>
4845 <section id="creatorprefs">
4846 <title>Creators</title>
4848 <para>These preferences have to do with creating content.</para>
4850 <para><emphasis>Get there:</emphasis> More > Administration >
4851 Global System Preferences > Creators</para>
4853 <section id="creatorpatcardprefs">
4854 <title>Patron Cards</title>
4856 <para>These preferences are in reference to the <link
4857 linkend="patroncardcreator">Patron Card Creator</link> tool.</para>
4859 <section id="ImageLimit">
4860 <title>ImageLimit</title>
4862 <para>Asks: Limit the number of creator images stored in the
4863 database to ___ images.</para>
4868 <section id="enhancedcontent">
4869 <title>Enhanced Content</title>
4871 <para><emphasis>Get there:</emphasis> More > Administration >
4872 Global System Preferences > Enhanced Content</para>
4875 <para>Always read the terms of service associated with external data
4876 sources to be sure that you are using the products within the
4877 allowed limits.</para>
4881 <para>You cannot have more than one service for cover images
4882 (including local cover images) set up. If you set up more than one
4883 you will get multiple cover images. Instead choose only one source
4884 for cover images.</para>
4887 <section id="frbrenhancedprefs">
4892 <section id="FRBRizeEditions">
4893 <title>FRBRizeEditions</title>
4895 <para>Default: Don't show</para>
4897 <para>Asks: ___ other editions of an item on the staff
4900 <para>Values:</para>
4904 <para>Don't show</para>
4911 <screeninfo>Editions tab in staff client</screeninfo>
4915 <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
4922 <para>Description:</para>
4926 <para>Using the rules set forth in the Functional Requirements for Bibliographic
4927 records, this option, when enabled, pulls all editions of the same title available
4928 in your collection regardless of material type. Items will appear under an
4929 'Editions' tab on the detail page for the title in question.. According to
4930 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
4931 Science</emphasis> (<ulink url="http://lu.com/odlis/"
4932 >http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
4933 records of similar materials. FRBRization brings together entities (sets of Works,
4934 Expressions, or Manifestations), rather than just sets of Items. It can aid
4935 patrons in selecting related items, expressions, and manifestations that will
4936 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
4937 web services for associated ISBNs and display an Editions tab on the details
4938 pages. Once this preference is enabled, the library must select one of the ISBN
4939 options (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN"
4940 >XISBN</link>). This option is only for the Staff Client; the <link
4941 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> option must be enabled
4942 to have the Editions tab appear on the OPAC.</para>
4947 <para>Requires that you turn on one or more of the ISBN services (<link
4948 linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN"
4949 >XISBN</link>)</para>
4953 <section id="OPACFRBRizeEditions">
4954 <title>OPACFRBRizeEditions</title>
4956 <para>Default: Don't show</para>
4958 <para>Asks: ___ other editions of an item on the OPAC.</para>
4960 <para>Description:</para>
4964 <para>Using the rules set forth in the Functional Requirements for Bibliographic
4965 records, this option, when enabled, pulls all editions of the same title available
4966 in your collection regardless of material type. Items will appear under an
4967 'Editions' tab on the detail page for the title in question.. According to
4968 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
4969 Science</emphasis> (<ulink url="http://lu.com/odlis/"
4970 >http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
4971 records of similar materials. FRBRization brings together entities (sets of Works,
4972 Expressions, or Manifestations), rather than just sets of Items. It can aid
4973 patrons in selecting related items, expressions, and manifestations that will
4974 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
4975 web services for associated ISBNs and display an Editions tab on the details
4976 pages. Once this preference is enabled, the library must select one of the ISBN
4977 options (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>). This option is only for the OPAC; the <link linkend="FRBRizeEditions">FRBRizeEditions</link> option must be turned "On" to
4978 have the Editions tab appear on the Staff Client.</para>
4982 <para>Values:</para>
4986 <para>Don't show</para>
4993 <screeninfo>Editions tab in the OPAC</screeninfo>
4997 <imagedata fileref="images/admin/globalprefs/editions.png"/>
5004 <para>This preference pulls all editions of the same title
5005 available in your collection regardless of material type. Items
5006 will appear under an 'Editions' tab on the detail page for the
5007 title in question.</para>
5010 <para>Requires that you turn on one or more of the ISBN services (<link
5011 linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN"
5012 >XISBN</link>)</para>
5017 <section id="amazonprefs">
5018 <title>Amazon</title>
5022 <section id="AmazonAssocTag">
5023 <title>AmazonAssocTag</title>
5025 <para>Asks: Put the associate tag ___ on links to Amazon.</para>
5028 <para>This can net your library referral fees if a patron
5029 decides to buy an item after clicking through to Amazon from
5033 <para>Description:</para>
5037 <para>An Amazon Associates Tag allows a library to earn a
5038 percentage of all purchases made on Amazon when a patron
5039 accesses Amazon's site via links on the library's website.
5040 More information about the Amazon Associates program is
5041 available at Amazon's Affiliate Program's website, <ulink
5042 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
5043 Before a tag can be obtained, however, the library must first
5044 apply for an Amazon Web Services (AWS) account. Applications
5045 are free of charge and can be made at <ulink
5046 url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
5047 Once an AWS account has been established, the library can then
5048 obtain the Amazon Associates Tag.</para>
5052 <para>Sign up at: <ulink
5053 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
5056 <section id="AmazonCoverImages">
5057 <title>AmazonCoverImages</title>
5059 <para>Default: Don't show</para>
5061 <para>Asks: ___ cover images from Amazon on search results and
5062 item detail pages on the staff interface.</para>
5064 <para>Values:</para>
5068 <para>Don't show</para>
5076 <para>Description:</para>
5080 <para>This preference makes it possible to either allow or
5081 prevent Amazon cover images from being displayed in the Staff
5082 Client. Cover images are retrieved by Amazon, which pulls the
5083 content based on the first ISBN number in the item's MARC
5084 record. Amazon offers this service free of charge. If the
5085 value for this preference is set to "Show", the cover images
5086 will appear in the Staff Client, and if it is set to "Don't
5087 show", the images will not appear. Finally, if you're using
5088 Amazon cover images, all other cover image services must be
5089 disabled. If they are not disabled, they will prevent
5090 AmazonCoverImages from functioning properly.</para>
5095 <section id="AmazonLocale">
5096 <title>AmazonLocale</title>
5098 <para>Default: American</para>
5100 <para>Asks: Use Amazon data from its ___ website.</para>
5106 <para>American</para>
5110 <para>British</para>
5114 <para>Canadian</para>
5126 <para>Japanese</para>
5131 <section id="OPACAmazonCoverImages">
5132 <title>OPACAmazonCoverImages</title>
5134 <para>Default: Don't show</para>
5136 <para>Asks: ___ cover images from Amazon on search results and
5137 item detail pages on the OPAC.</para>
5139 <para>Values:</para>
5143 <para>Don't show</para>
5151 <para>Description:</para>
5155 <para>This preference makes it possible to either allow or
5156 prevent Amazon cover images from being displayed in the OPAC.
5157 Cover images are retrieved by Amazon, which pulls the content
5158 based on the first ISBN number in the item's MARC record.
5159 Amazon offers this service free of charge. If the value for
5160 this preference is set to "Show", the cover images will appear
5161 in the OPAC, and if it is set to "Don't show", the images will
5162 not appear. Finally, if you're using Amazon cover images, all
5163 other cover image services must be disabled. If they are not
5164 disabled, they will prevent AmazonCoverImages from functioning
5171 <section id="Babelthequeprefs">
5172 <title>Babelthèque</title>
5176 <section id="Babeltheque">
5177 <title>Babeltheque</title>
5179 <para>Default: Don't</para>
5181 <para>Asks: ___ include information (such as reviews and
5182 citations) from Babelthèque in item detail pages on the
5185 <para>Description:</para>
5189 <para>This preference makes it possible to display a
5190 Babeltheque tab in the OPAC, allowing patrons to access tags,
5191 reviews, and additional title information provided by
5192 Babeltheque. The information which Babeltheque supplies is
5193 drawn from the French language-based <ulink
5194 url="http://www.babelio.com/">Babelio.com</ulink>, a French
5195 service similar to LibraryThing for Libraries. More
5196 information about Babeltheque is available through its
5198 url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
5199 Libraries that wish to allow access to this information must
5200 first register for the service at <ulink
5201 url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
5202 Please note that this information is only provided in
5207 <para>Values:</para>
5214 <screeninfo>Data from Babelthèque on the bib
5219 <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
5231 <section id="Babeltheque_url_js">
5232 <title>Babeltheque_url_js</title>
5234 <para>Asks: ___ Defined the url for the Babeltheque javascript
5235 file (eg. http://www.babeltheque.com/bw_XX.js)</para>
5238 <section id="Babeltheque_url_update">
5239 <title>Babeltheque_url_update</title>
5241 <para>Asks: ___ Defined the url for the Babeltheque update
5243 http://www.babeltheque.com/.../file.csv.bz2).</para>
5247 <section id="btcontentprefs">
5248 <title>Baker & Taylor</title>
5251 <para>This is a pay service, you must contact Baker & Taylor
5252 to subscribe to this service before setting these options.</para>
5255 <section id="BakerTaylorEnabled">
5256 <title>BakerTaylorEnabled</title>
5258 <para>Default: Don't add</para>
5260 <para>Asks: ___ Baker and Taylor links and cover images to the
5261 OPAC and staff client. This requires that you have entered in a
5262 username and password (which can be seen in image links).</para>
5264 <para>Values:</para>
5272 <para>Don't add</para>
5276 <para>Description:</para>
5280 <para>This preference makes it possible to display Baker &
5281 Taylor content (book reviews, descriptions, cover images,
5282 etc.) in both the Staff Client and the OPAC. Libraries that
5283 wish to display Baker & Taylor content must first register
5284 and pay for this service with Baker & Taylor (<ulink
5285 url="http://www.btol.com">http://www.btol.com</ulink>). If
5286 Baker & Taylor content is enabled be sure to turn off
5287 other cover and review services to prevent
5288 interference.</para>
5293 <para>To use this you will need to also set the <link
5294 linkend="btuserpass">BakerTaylorUsername &
5295 BakerTaylorPassword</link> system preferences</para>
5299 <section id="BakerTaylorBookstoreURL">
5300 <title>BakerTaylorBookstoreURL</title>
5302 <para>Asks: Baker and Taylor "My Library Bookstore" links should
5303 be accessed at https:// ___ isbn</para>
5305 <para>Description:</para>
5309 <para>Some libraries generate additional funding for the
5310 library by selling books and other materials that are
5311 purchased from or have been previously leased from Baker &
5312 Taylor. These materials can be accessed via a link on the
5313 library's website. This service is often referred to as "My
5314 Library Bookstore." In order to participate in this program,
5315 the library must first register and pay for the service with
5316 Baker & Taylor. Additional information about this and
5317 other services provided by Baker & Taylor is available at
5318 the Baker & Taylor website, <ulink
5319 url="http://www.btol.com">http://www.btol.com</ulink>. The
5320 BakerTaylorBookstoreURL preference establishes the URL in
5321 order to link to the library's Baker & Taylor-backed
5322 online bookstore, if such a bookstore has been established.
5323 The default for this field is left blank; if no value is
5324 entered, the links to My Library Bookstore will remain
5325 inactive. If enabling this preference, enter the library's
5326 Hostname and Parent Number in the appropriate location within
5327 the URL. The "key" value (key=) should be appended to the URL,
5328 and https:// should be prepended.</para>
5332 <para>This should be filled in with something like
5333 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
5336 <para>Leave it blank to disable these links.</para>
5340 <para>Be sure to get this information from Baker & Taylor
5341 when subscribing.</para>
5345 <section id="btuserpass">
5346 <title>BakerTaylorUsername & BakerTaylorPassword</title>
5348 <para>Asks: Access Baker and Taylor using username ___ and
5351 <para>Descriptions:</para>
5355 <para>This setting in only applicable if the library has a
5356 paid subscription to the external Content Café service from
5357 Baker & Taylor. Use the box provided to enter in the
5358 library's Content Café username and password. Also, ensure
5360 linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
5362 linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
5363 settings are properly set. The Content Café service is a feed
5364 of enhanced content such as cover art, professional reviews,
5365 and summaries that is displayed along with Staff Client/OPAC
5366 search results. For more information on this service please
5367 see the Baker & Taylor website: <ulink
5368 url="http://www.btol.com">http://www.btol.com</ulink></para>
5373 <para>Be sure to get this information from Baker & Taylor
5374 when subscribing.</para>
5379 <section id="googleprefs">
5380 <title>Google</title>
5384 <section id="GoogleJackets">
5385 <title>GoogleJackets</title>
5387 <para>Default: Don't add</para>
5389 <para>Asks: ___ cover images from Google Books to search results
5390 and item detail pages on the OPAC.</para>
5392 <para>Values:</para>
5400 <para>Don't add</para>
5404 <para>Description:</para>
5408 <para>This setting controls the display of applicable cover
5409 art from the free Google Books database, via the Google Books
5410 API. Please note that to use this feature, all other cover
5411 services should be turned off.</para>
5417 <section id="librarythingprefs">
5418 <title>LibraryThing</title>
5420 <para>LibraryThing for Libraries is a pay service. You must first
5421 contact LibraryThing directly for pricing and subscription
5422 information. Learn more at <ulink
5423 url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
5424 Also, for further configuration instructions please see the
5425 LibraryThing Wiki: <ulink
5426 url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
5428 <section id="LibraryThingForLibrariesEnabled">
5429 <title>LibraryThingForLibrariesEnabled</title>
5431 <para>Default: Don't show</para>
5433 <para>Asks: ___ reviews, similar items, and tags from Library
5434 Thing for Libraries on item detail pages on the OPAC.</para>
5436 <para>Values:</para>
5440 <para>Don't show</para>
5448 <para>Description:</para>
5452 <para>This setting is only applicable if the library has a
5453 paid subscription to the external LibraryThing for Libraries
5454 service. This service can provide patrons with the display of
5455 expanded information on catalog items such as book
5456 recommendations. It also can offer advanced features like
5457 tagged browsing, patron written reviews, and a virtual library
5458 display accessed from the details tab.</para>
5463 <para>If this is set to 'show' you will need to enter a value in
5465 linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
5466 system preference.</para>
5470 <section id="LibraryThingForLibrariesID">
5471 <title>LibraryThingForLibrariesID</title>
5473 <para>Asks: Access Library Thing for Libraries using the customer
5476 <para>Description:</para>
5480 <para>This setting is only applicable if the library has a
5481 paid subscription to the external LibraryThing for Libraries
5482 service. Use the box provided to enter in the library's
5483 LibraryThing for Libraries ID as provided to the library by
5484 LibraryThing. The ID number is a series of numbers in the form
5485 ###-#########, and can be found on the library's account page
5486 at LibraryThing for Libraries. This service can provide
5487 patrons with the display of expanded information on catalog
5488 items such as book recommendations and cover art. It also can
5489 offer advanced features like tagged browsing, patron written
5490 reviews, and a virtual library display accessed from the
5496 <section id="LibraryThingForLibrariesTabbedView">
5497 <title>LibraryThingForLibrariesTabbedView</title>
5499 <para>Default: in line with bibliographic information</para>
5501 <para>Asks: Show Library Thing for Libraries content ___</para>
5503 <para>Values:</para>
5507 <para>in line with bibliographic information</para>
5511 <para>in tabs</para>
5515 <para>Description:</para>
5519 <para>This setting is only applicable if the library has a
5520 paid subscription to the external LibraryThing for Libraries
5521 service. This service can provide patrons with the display of
5522 expanded information on catalog items such as book
5523 recommendations and cover art. It also can offer advanced
5524 features like tagged browsing, patron written reviews, and a
5525 virtual library display accessed from the details tab.</para>
5529 <section id="ThingISBN">
5530 <title>ThingISBN</title>
5531 <para>Default: Don't use</para>
5532 <para>Asks: ___ the ThingISBN service to show other editions of a title</para>
5533 <para>Values:</para>
5536 <para>Don't use</para>
5542 <para>Description:</para>
5545 <para>Set to 'Use' to display an "Editions" tab on the item's detail page. Editions
5546 are listed, complete with cover art (if you have one of the cover services
5547 enabled) and bibliographic information. The feed comes from LibraryThing's
5548 ThingISBN web service. This is a free service to non-commercial sites with fewer
5549 than 1,000 requests per day.</para>
5553 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5554 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to 'show'</para>
5557 <para>This is separate from Library Thing for Libraries and does not have a cost
5558 associated with it.</para>
5563 <section id="localimages">
5564 <title>Local Cover Images</title>
5568 <section id="AllowMultipleCovers">
5569 <title>AllowMultipleCovers</title>
5571 <para>Default: Don't allow</para>
5573 <para>Asks: ___ multiple images to be attached to each
5574 bibliographic record.</para>
5576 <para>Values:</para>
5584 <para>Don't allow</para>
5588 <para>Description:</para>
5592 <para>If this preference is set to 'Allow' then you can upload
5593 multiple images that will appear in the images tab on the bib
5594 record in the OPAC and the staff client. This preference
5595 requires that either one or both <link
5596 linkend="LocalCoverImages">LocalCoverImages</link> and <link
5597 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
5598 set to 'Display.'</para>
5601 <screeninfo>Multiple cover images</screeninfo>
5605 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
5613 <section id="LocalCoverImages">
5614 <title>LocalCoverImages</title>
5616 <para>Default: Don't display</para>
5618 <para>Asks: ___ local cover images on intranet search and details
5621 <para>Values:</para>
5625 <para>Display</para>
5629 <para>Don't display</para>
5633 <para>Description:</para>
5637 <para>Setting this preference to 'Display' allows you to
5638 upload your own cover images to bib records and display them
5639 on the detail page in the staff client. At this time the cover
5640 will only show under the 'Images' tab on the holdings table on
5641 the detail display, not next to the title at the top left or
5642 on the search results.</para>
5647 <section id="OPACLocalCoverImages">
5648 <title>OPACLocalCoverImages</title>
5650 <para>Default: Don't display</para>
5652 <para>Asks: ___ local cover images on OPAC search and details
5655 <para>Values:</para>
5659 <para>Display</para>
5663 <para>Don't display</para>
5667 <para>Description:</para>
5671 <para>Setting this preference to 'Display' allows you to
5672 upload your own cover images to bib records and display them
5673 on the detail page and search results in the OPAC.</para>
5679 <section id="novelistselect">
5680 <title>Novelist Select</title>
5682 <para>Novelist Select is not a free service. Contact your Ebsco
5683 representitive to get your log in information to embed this content
5684 in the OPAC.<important>
5685 <para>Novelist Select does not include cover images for the search results and
5686 bibliographic detail pages. You can choose any other cover image service for this
5687 content or you can contract with Ebsco to get access to the <link
5688 linkend="btcontentprefs">Baker & Taylor Content Cafe</link> for an added
5692 <section id="NovelistSelectEnabled">
5693 <title>NovelistSelectEnabled</title>
5695 <para>Default: Don't add</para>
5697 <para>Asks: ___ Novelist Select content to the OPAC.</para>
5699 <para>Values:</para>
5707 <para>Don't add</para>
5712 <para>Enabling this requires that you have entered in a user
5713 profile and password in the <link
5714 linkend="NovelistSelectProfile">NovelistSelectProfile &
5715 NovelistSelectPassword</link> preferences</para>
5716 </important>Description:</para>
5720 <para>Novelist Select from Ebsco is a subscription service
5721 that can provide additional content in the OPAC.</para>
5726 <section id="NovelistSelectProfile">
5727 <title>NovelistSelectProfile & NovelistSelectPassword</title>
5729 <para>Asks: Access Novelist Select using user profile ___ and
5730 password ___.</para>
5733 <para>This information will be visible if someone views the
5734 source code on your OPAC.</para>
5737 <para>Description:</para>
5741 <para>Novelist Select from Ebsco is a subscription service
5742 that can provide additional content in the OPAC.</para>
5747 <section id="NovelistSelectView">
5748 <title>NovelistSelectView</title>
5750 <para>Default: in an OPAC tab</para>
5752 <para>Asks: Display Novelist Select content ___</para>
5754 <para>Description:</para>
5758 <para>Novelist Select provides a lot of content, for that
5759 reason you have four choices of where to display this content.
5760 The default view is in a tab in the holdings table.</para>
5763 <screeninfo>Novelist Select in a tab</screeninfo>
5767 <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
5772 <para>The content is the same if you choose to show it above
5773 the holdings table or below it. If shown in the right column
5774 of the page it's the same content, but displays a bit
5775 differently since space is limited.</para>
5778 <screeninfo>Novelist Select on the side</screeninfo>
5782 <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
5789 <para>Values:</para>
5793 <para>above the holdings table</para>
5797 <para>below the holdings table</para>
5801 <para>in an OPAC tab</para>
5805 <para>under the Save Record dropdown on the right</para>
5811 <section id="oclcprefs">
5816 <section id="XISBN">
5817 <title>XISBN</title>
5819 <para>Default: Don't use</para>
5821 <para>Asks: ___ the OCLC xISBN service to show other editions of a
5824 <para>Description:</para>
5828 <para>Set to 'Use' to display an "Editions" tab on the item's
5829 detail page. Editions are listed, complete with cover art and
5830 bibliographic information. The feed comes from OCLC's xISBN
5831 web service. The feed limit for non-commercial sites is 1000
5832 requests per day.</para>
5836 <para>Values:</para>
5840 <para>Don't use</para>
5849 <para>Requires <link
5850 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5851 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
5856 <section id="OCLCAffiliateID">
5857 <title>OCLCAffiliateID</title>
5859 <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
5862 <para>Description:</para>
5866 <para>This setting is only applicable if the library has an
5867 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
5868 via the XISBN programming interface. Simply enter the
5869 library's OCLC Affiliate ID in the box provided. Please note
5870 that using this data is only necessary if <link
5871 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5872 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
5873 <link linkend="XISBN">XISBN</link> settings are enabled. For
5874 more information on this service please visit the OCLC
5876 url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
5881 <para>Unless you have signed up for an ID with OCLC, you are
5882 limited to 1000 requests per day. Available at: <ulink
5883 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
5887 <section id="XISBNDailyLimit">
5888 <title>XISBNDailyLimit</title>
5890 <para>Default: 999</para>
5892 <para>Asks: Only use the xISBN service ___ times a day.</para>
5895 <para>Unless you have signed up for an ID with OCLC, you are
5896 limited to 1000 requests per day. Available at: <ulink
5897 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
5902 <section id="OpenLibraryPrefs">
5903 <title>Open Library</title>
5905 <section id="OpenLibraryCovers">
5906 <title>OpenLibraryCovers</title>
5908 <para>Default: Don't add</para>
5910 <para>Asks: ___ cover images from Open Library to search results
5911 and item detail pages on the OPAC.</para>
5913 <para>Values:</para>
5921 <para>Don't add</para>
5925 <para>Description:</para>
5929 <para>This setting controls the display of applicable cover
5930 art from the free Open Library database, via the Open Library
5931 API. Please note that to use this feature, all other cover
5932 services should be turned off.</para>
5938 <section id="Syndeticsprefs">
5939 <title>Syndetics</title>
5941 <para>Syndetics is a pay service. You must first contact Syndetics
5942 directly for pricing and subscription information.</para>
5944 <section id="SyndeticsEnabled">
5945 <title>SyndeticsEnabled</title>
5947 <para>Default: Don't use</para>
5949 <para>Asks: ___ content from Syndetics.</para>
5951 <para>Values:</para>
5955 <para>Don't use</para>
5963 <para>Description:</para>
5967 <para>When this option is enabled any of the Syndetics options
5973 <para>Requires that you enter your <link
5974 linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
5975 this content will appear.</para>
5979 <section id="SyndeticsClientCode">
5980 <title>SyndeticsClientCode</title>
5982 <para>Asks: Use the client code ___ to access Syndetics.</para>
5984 <para>Description:</para>
5988 <para>Once the library signs up for Syndetics' services,
5989 Syndetics will provide the library with an access code. (Visit
5990 the Syndetics homepage at <ulink
5991 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
5992 for more information.) This is the code that must be entered
5993 to access Syndetics' subscription services. Syndetics is a
5994 paid subscription service. This value must be entered before
5995 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
5996 be enabled. If the code is lost, corrupted, or forgotten, a
5997 new one can be obtained from <ulink
5998 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
6003 <para>You will need to get your client code directly from
6008 <section id="SyndeticsCoverImages">
6009 <title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
6011 <para>SyndeticsCoverImages Default: Don't show</para>
6013 <para>SyndeticsCoverImageSize Default: medium</para>
6015 <para>Asks: ___ cover images from Syndetics on search results and
6016 item detail pages on the OPAC in a ___ size.</para>
6018 <para>Descriptions:</para>
6022 <para>When enabled, SyndeticsCoverImages, allows libraries to
6023 display Syndetics' collection of full-color cover images for
6024 books, videos, DVDs and CDs on their OPAC. For each book or
6025 item that comes up during a user search, the cover image for
6026 that title will be displayed. Since these cover images come in
6027 three sizes, the optimum size must be selected using the
6028 SyndeticsCoverImageSize preference after SyndeticsCoverImages
6029 are enabled. Syndetics cover images come in two sizes:
6030 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
6031 Syndetics is a paid subscription service. The <link
6032 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6033 be entered and the <link
6034 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6035 be activated before this service can be used. Other cover
6036 image preferences should also be disabled to avoid
6037 interference.</para>
6041 <para>SyndeticsCoverImages Values:</para>
6045 <para>Don't show</para>
6053 <para>SyndeticsCoverImageSize Values:</para>
6066 <section id="SyndeticsAuthorNotes">
6067 <title>SyndeticsAuthorNotes</title>
6069 <para>Default: Don't show</para>
6071 <para>Asks: ___ notes about the author of a title from Syndetics
6072 on item detail pages on the OPAC.</para>
6074 <para>Values:</para>
6078 <para>Don't show</para>
6086 <para>Description:</para>
6090 <para>When this option is set to "Show", Syndetics provides
6091 notes and short author biographies for more that 300,000
6092 authors, in both fiction and nonfiction. With this option
6093 enabled the library can display Syndetics Author Notes on the
6094 OPAC. According to the Syndetics Solutions website (<ulink
6095 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
6096 Author Notes include lists of contributors for many
6097 multi-author texts and compilations. The <link
6098 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6099 be entered and the <link
6100 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6101 be activated before this service can be used.</para>
6106 <section id="SyndeticsAwards">
6107 <title>SyndeticsAwards</title>
6109 <para>Default: Don't show</para>
6111 <para>Asks: ___ information from Syndetics about the awards a
6112 title has won on item detail pages on the OPAC.</para>
6114 <para>Values:</para>
6118 <para>Don't show</para>
6126 <para>Description:</para>
6130 <para>When this option is set to "Show", Syndetics provides
6131 its clients with a list of awards that any title has won. With
6132 this service enabled the library can display those awards for
6133 each book on its website. For each book or item that comes up
6134 during a user search, the list of awards for that title will
6135 be displayed. When a user clicks on a given award, information
6136 about that award is presented along with a list of the other
6137 titles that have won that award. If the user clicks on any
6138 title in the list, they will see holdings information about
6139 that title in their region. This option is a paid subscription
6141 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6142 be entered and the <link
6143 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6144 be activated before this service can be used.</para>
6149 <section id="SyndeticsEditions">
6150 <title>SyndeticsEditions</title>
6152 <para>Default: Don't show</para>
6154 <para>Asks: ___ information about other editions of a title from
6155 Syndetics on item detail pages on the OPAC</para>
6157 <para>Description:</para>
6161 <para>When enabled this option shows information on other
6162 editions of a title from Syndetics on the item detail pages of
6163 the OPAC. Syndetics is a paid subscription service. The <link
6164 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6165 be entered and the <link
6166 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6167 be activated before this service can be used.</para>
6171 <para>Values:</para>
6175 <para>Don't show</para>
6184 <para>Requires <link
6185 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
6190 <section id="SyndeticsExcerpt">
6191 <title>SyndeticsExcerpt</title>
6193 <para>Default: Don't show</para>
6195 <para>Asks: ___ excerpts from of a title from Syndetics on item
6196 detail pages on the OPAC.</para>
6198 <para>Values:</para>
6202 <para>Don't show</para>
6210 <para>Description:</para>
6214 <para>This preference allows Syndetics to display excerpts
6215 given to them from selected publishers. The excerpts are
6216 available from prominently reviewed new titles, both fiction
6217 and non-fiction. The excerpts include poems, essays, recipes,
6218 forwards and prefaces. Automatic links provided by the ISBNs
6219 within local MARC records are required to integrate Syndetics
6220 secured, high-speed Internet servers to the library OPACs. For
6221 more information see (<ulink
6222 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6227 <section id="SyndeticsReviews">
6228 <title>SyndeticsReviews</title>
6230 <para>Default: Don't show</para>
6232 <para>Asks: ___ reviews of a title from Syndetics on item detail
6233 pages on the OPAC.</para>
6235 <para>Values:</para>
6239 <para>Don't show</para>
6247 <para>Description:</para>
6251 <para>Syndetics Reviews is an accumulation of book reviews
6252 available from a variety of journals and serials. The reviews
6253 page displays colored images of reviewed books dust jackets,
6254 partnered with the names of the journal or serial providing
6255 the review. Clicking on an icon opens a window revealing the
6256 book title, author's name, book cover icon and the critic's
6257 opinion of the book. Automatic links provided by the ISBNs
6258 within local MARC records are required to integrate Syndetics
6259 secured, high-speed Internet servers to the library OPACs. For
6260 more information see (<ulink
6261 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6266 <section id="SyndeticsSeries">
6267 <title>SyndeticsSeries</title>
6269 <para>Default: Don't show</para>
6271 <para>Asks: ___ information on other books in a title's series
6272 from Syndetics on item detail pages on the OPAC.</para>
6274 <para>Values:</para>
6278 <para>Don't show</para>
6286 <para>Description:</para>
6290 <para>Each fiction title within a series is linked to the
6291 complete series record. The record displays each title in
6292 reading order and also displays the publication order, if
6293 different. Alternate series titles are also displayed.
6294 Automatic links provided by the ISBNs within local MARC
6295 records are required to integrate Syndetics secured, high-
6296 speed Internet servers to the library OPACs. For more
6297 information see (<ulink
6298 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6303 <section id="SyndeticsSummary">
6304 <title>SyndeticsSummary</title>
6306 <para>Default: Don't show</para>
6308 <para>Asks: ___ a summary of a title from Syndetics on item detail
6309 pages on the OPAC.</para>
6311 <para>Values:</para>
6315 <para>Don't show</para>
6323 <para>Description:</para>
6327 <para>Providing more than 5.6 million summaries and
6328 annotations derived from book jackets, edited publisher copy,
6329 or independently written annotations from Book News, Inc.
6330 Covering fiction and non-fiction, this summaries option
6331 provides annotations on both trade and scholarly titles. For
6332 more information see (<ulink
6333 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6338 <section id="SyndeticsTOC">
6339 <title>SyndeticsTOC</title>
6341 <para>Default: Don't show</para>
6343 <para>Asks: ___ the table of contents of a title from Syndetics on
6344 item detail pages on the OPAC.</para>
6346 <para>Values:</para>
6350 <para>Don't show</para>
6358 <para>Description:</para>
6362 <para>This preference allows staff and patrons to review the
6363 Table of Contents from a wide variety of publications from
6364 popular self-help books to conference proceedings. Specific
6365 Information access is the main purpose for this option,
6366 allowing patrons guidance to their preferred section of the
6367 book. Special arrangements with selected book services is used
6368 to obtain the table of contents for new publications each
6369 year. Automatic links provided by the ISBNs within local MARC
6370 records are required to integrate Syndetics secured,
6371 high-speed Internet servers to the library OPACs. For more
6372 information see (<ulink
6373 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6379 <section id="taggingprefs">
6380 <title>Tagging</title>
6382 <section id="TagsEnabled">
6383 <title>TagsEnabled</title>
6385 <para>Default: Allow</para>
6387 <para>Asks: ___ patrons and staff to put tags on items.</para>
6389 <para>Values:</para>
6397 <para>Don't allow</para>
6401 <para>Description:</para>
6405 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
6406 added to identify an item. Tags allow patrons to classify
6407 materials on their own. TagsEnabled is the main switch that
6408 permits the tagging features. TagsEnable must be set to
6409 'Allow' to allow for other tagging features.</para>
6414 <section id="TagsModeration">
6415 <title>TagsModeration</title>
6417 <para>Default: Don't require</para>
6419 <para>Asks: ___ that tags submitted by patrons be reviewed by a
6420 staff member before being shown.</para>
6422 <para>Values:</para>
6426 <para>Don't require</para>
6430 <para>Require</para>
6434 <para>Description:</para>
6438 <para>When set to 'Require,' all tags to be first filtered by
6439 the tag moderator. Only approved tags will be visible to
6440 patrons. When set to 'Don't require' tags will bypass the tag
6441 moderator and patrons' tags to be immediately visible. When
6442 this preference is enabled the moderator, a staff member,
6443 would approve the tag in the Staff Client. The moderator will
6444 have the option to approve or reject each pending tag
6449 <para>When moderation is required all tags go through the tag
6450 moderation tool before becoming visible.</para>
6454 <para><emphasis>Get there:</emphasis> More > Tools >
6455 <link linkend="tagsmoderation">Tags</link></para>
6460 <section id="TagsShowOnList">
6461 <title>TagsShowOnList</title>
6463 <para>Default: 6</para>
6465 <para>Asks: Show ___ tags on search results on the OPAC.</para>
6468 <para>Set the value to 0 (zero) to turn this feature off.</para>
6472 <section id="TagsInputOnList">
6473 <title>TagsInputOnList</title>
6475 <para>Default: Allow</para>
6477 <para>Asks: ___ patrons to input tags on search results on the
6480 <para>Values:</para>
6487 <screeninfo>Tags on Search Results</screeninfo>
6491 <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
6498 <para>Don't allow</para>
6503 <section id="TagsShowOnDetail">
6504 <title>TagsShowOnDetail</title>
6506 <para>Default: 10</para>
6508 <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
6511 <para>Set the value to 0 (zero) to turn this feature off.</para>
6515 <section id="TagsInputOnDetail">
6516 <title>TagsInputOnDetail</title>
6518 <para>Default: Allow</para>
6520 <para>Asks: ___ patrons to input tags on item detail pages on the
6523 <para>Values:</para>
6530 <screeninfo>Add Tags on Detail</screeninfo>
6534 <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
6541 <para>Don't allow</para>
6546 <section id="TagsExternalDictionary">
6547 <title>TagsExternalDictionary</title>
6549 <para>Asks: Allow tags in the dictionary of the ispell executable
6550 ___ on the server to be approved without moderation.</para>
6552 <para>Description:</para>
6556 <para>The dictionary includes a list of accepted and rejected
6557 tags. The accepted list includes all the tags that have been
6558 pre-allowed. The rejected list includes tags that are not
6559 allowed. This preference identifies the "accepted" dictionary
6560 used. Ispell is an open source dictionary which can be used as
6561 a list of accepted terms. Since the dictionary allows for
6562 accurately spelled obscenities, the libraries policy may
6563 dictate that modifications are made to the Ispell dictionary
6564 if this preference is use. For more information about Ispell
6566 url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
6567 Enter the path on your server to a local ispell executable,
6568 used to set $Lingua::Ispell::path.</para>
6575 <section id="l18nprefs">
6576 <title>I18N/L10N</title>
6578 <para><emphasis> <emphasis>These preferences control your
6579 Internationalization and Localization settings.</emphasis>
6582 <para><emphasis>Get there:</emphasis> More > Administration >
6583 Global System Preferences > I18N/L10N</para>
6585 <section id="CalendarFirstDayOfWeek">
6586 <title>CalendarFirstDayOfWeek</title>
6588 <para>Default: Sunday</para>
6590 <para>Asks: Use ___ as the first day of week in the calendar.</para>
6592 <para>Values:</para>
6604 <para>Description:</para>
6608 <para>Using this preference you can control what day shows as
6609 the first day of the week in the calendar pop ups throughout
6610 Koha and on the Calendar tool. If you change this preference and
6611 don't see a change in your browser try clearing your cache since
6612 it makes changes to the Javascript on these pages.</para>
6617 <section id="dateformat">
6618 <title>dateformat</title>
6620 <para>Default: mm/dd/yyyy</para>
6622 <para>Asks: Format dates like ___</para>
6624 <para>Values:</para>
6628 <para>dd/mm/yyyy</para>
6632 <para>mm/dd/yyyy</para>
6636 <para>yyyy/mm/dd</para>
6640 <para>Description:</para>
6644 <para>This preference controls how the date is displayed. The
6645 options are the United States method, mm/dd/yyyy (04/24/2010),
6646 the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
6647 International Standard of Organization, yyyy/mm/dd (2010/04/24).
6648 The International Standard of Organization would primarily be
6649 used by libraries with locations in multiple nations that may
6650 use different date formats, to have a single display type, or if
6651 the library would be in a region that does not use the United
6652 States or metric method. More information regarding the ISO date
6653 format can be found at <ulink
6654 url="http://www.iso.org/iso/iso_catalogue.htm">http://www.iso.org/iso/iso_catalogue.htm</ulink>.</para>
6659 <section id="languagepref">
6660 <title>language</title>
6662 <para>Default: English</para>
6664 <para>Asks: Enable the following languages on the staff
6667 <para>Values:</para>
6671 <para>English</para>
6675 <para>To install additional languages you need to run
6676 misc/translation/install-code.pl. For example, to install French you
6677 would run the following command <emphasis>install-code.pl
6678 fr-FR</emphasis> to make the templates, once they exist and are in
6679 the right place then they will show up as an option in this
6683 <section id="opaclanguages">
6684 <title>opaclanguages</title>
6686 <para>Default: English</para>
6688 <para>Asks: Enable the following languages on the OPAC</para>
6690 <para>Values:</para>
6694 <para>English</para>
6698 <para>To install additional languages you need to run
6699 misc/translation/install-code.pl. For example, to install French you
6700 would run the following command <emphasis>install-code.pl
6701 fr-FR</emphasis> to make the templates, once they exist and are in
6702 the right place then they will show up as an option in this
6706 <section id="opaclanguagesdisplay">
6707 <title>opaclanguagesdisplay</title>
6709 <para>Default: Don't allow</para>
6711 <para>Asks: ___ patrons to select their language on the OPAC.</para>
6713 <para>Values:</para>
6720 <screeninfo>When this preference is on, patrons can choose
6721 their language from a list at the bottom of the
6726 <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
6733 <para>Don't allow</para>
6739 <section id="localprefs">
6740 <title>Local Use</title>
6742 <para><emphasis> <emphasis>These preferences are defined
6743 locally.</emphasis> </emphasis></para>
6745 <para><emphasis>Get there:</emphasis> More > Administration >
6746 Global System Preferences > Local Use<tip>
6747 <para>Sometimes preferences which are either new or outdated will
6748 appear in this tab, if you didn't add any preferences to this tab
6749 then it's best to ignore preferences listed here.</para>
6756 <para>Logs keep track of transaction on the system. You can decide
6757 which actions you want to log and which you don't using these
6760 <para><emphasis>Get there:</emphasis> More > Administration >
6761 Global System Preferences > Logs</para>
6763 <section id="AuthoritiesLog">
6764 <title>AuthoritiesLog</title>
6766 <para>Default: Don't log</para>
6768 <para>Asks: ___ changes to authority records.</para>
6770 <para>Values:</para>
6774 <para>Don't log</para>
6783 <section id="BorrowersLog">
6784 <title>BorrowersLog</title>
6786 <para>Default: Log</para>
6788 <para>Asks: ___ changes to patron records.</para>
6790 <para>Values:</para>
6794 <para>Don't log</para>
6803 <section id="CataloguingLog">
6804 <title>CataloguingLog</title>
6806 <para>Default: Don't log</para>
6808 <para>Asks: ___ any changes to bibliographic or item records.</para>
6810 <para>Values:</para>
6814 <para>Don't log</para>
6823 <para>Since this occurs whenever a book is cataloged, edited, or
6824 checked in or out it can be very resource intensive - slowing down
6829 <section id="FinesLog">
6830 <title>FinesLog</title>
6832 <para>Default: Log</para>
6834 <para>Asks: ___ when overdue fines are charged or automatically
6837 <para>Values:</para>
6841 <para>Don't log</para>
6850 <section id="IssueLog">
6851 <title>IssueLog</title>
6853 <para>Default: Log</para>
6855 <para>Asks: ___ when items are checked out.</para>
6857 <para>Values:</para>
6861 <para>Don't log</para>
6870 <section id="LetterLog">
6871 <title>LetterLog</title>
6873 <para>Default: Log</para>
6875 <para>Asks: ___ when an automatic claim notice is sent.</para>
6877 <para>Values:</para>
6881 <para>Don't log</para>
6890 <para>This log tracks all notices that go to patrons including the
6891 overdue notices.</para>
6895 <section id="ReturnLog">
6896 <title>ReturnLog</title>
6898 <para>Default: Log</para>
6900 <para>Asks: ___ when items are returned.</para>
6902 <para>Values:</para>
6906 <para>Don't log</para>
6915 <section id="SubscriptionLog">
6916 <title>SubscriptionLog</title>
6918 <para>Default: Log</para>
6920 <para>Asks: ___ when serials are added, deleted or changed.</para>
6922 <para>Values:</para>
6926 <para>Don't log</para>
6936 <section id="opacprefs">
6939 <para><emphasis>Get there:</emphasis> More > Administration >
6940 Global System Preferences > OPAC</para>
6942 <section id="opacappearanceprefs">
6943 <title>Appearance</title>
6945 <para>These preferences control how things appear in the
6948 <section id="AuthorisedValueImages">
6949 <title>AuthorisedValueImages</title>
6951 <para>Default: Don't show</para>
6953 <para>Asks: ___ images for authorized values (such as lost
6954 statuses and locations) in search results and item detail pages on
6957 <para>Values:</para>
6961 <para>Don't show</para>
6969 <para><emphasis>Get there:</emphasis> More > Administration
6970 > <link linkend="authorizedvalues">Authorized
6971 Values</link></para>
6974 <section id="BiblioDefaultView">
6975 <title>BiblioDefaultView</title>
6977 <para>Default: in simple form</para>
6979 <para>Asks: By default, show bib records ___</para>
6981 <para>Values:</para>
6985 <para>as specified in the ISBD template.</para>
6989 <para>See <link linkend="isbdpref">ISBD</link> preference
6990 for more information</para>
6996 <para>in simple form.</para>
7000 <para>in their MARC format.</para>
7004 <para>Description:</para>
7008 <para>This preference determines the level of bibliographic
7009 detail that the patron will see on the OPAC detail page. The
7010 simple form displays the graphical interface; MARC format
7011 displays the MARC21 cataloging view; ISBD displays the ISBD
7012 (International Standard Bibliographic Description, AACR2)
7018 <section id="COinSinOPACResults">
7019 <title>COinSinOPACResults</title>
7021 <para>Default: Include</para>
7023 <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
7026 <para>Values:</para>
7030 <para>Don't include</para>
7034 <para>If you choose not to include COinS on the search
7035 results, it will still be loaded on the individual
7036 bibliographic records.</para>
7042 <para>Include</para>
7046 <para>Enabling this feature will slow OPAC search response
7053 <para>Description:</para>
7057 <para>COinS stands for ContextObjects in Spans. COinS is a
7058 method to embed bibliographic metadata in the HTML code of web
7059 pages. This allows bibliographic software to publish
7060 machine-readable bibliographic items and client reference
7061 management software (such as Zotero) to retrieve bibliographic
7062 metadata. The metadata can also be sent to an OpenURL
7063 resolver. This allows, for instance, searching for a copy of a
7064 book in one's own library.</para>
7069 <section id="DisplayOPACiconsXSLT">
7070 <title>DisplayOPACiconsXSLT</title>
7072 <para>Default: Don't show</para>
7074 <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
7075 ___ icons for itemtype and authorized values.<important>
7077 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
7079 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
7080 must be set to use an XSLT stylesheet for this to show
7081 (default or custom)</para>
7084 <para>Values:</para>
7088 <para>Don't show</para>
7095 <screeninfo>DisplayOPACiconsXSLT</screeninfo>
7099 <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
7107 <para>See the <link linkend="XSLTiTypes">XSLT Icon
7108 Guide</link> for more information on these icons.</para>
7112 <section id="hidelostitems">
7113 <title>hidelostitems</title>
7115 <para>Default: Don't show</para>
7117 <para>Asks: ___ lost items on search and detail pages.</para>
7119 <para>Description:</para>
7123 <para>Items that are marked lost by the library can either be
7124 shown or not shown on the OPAC. By setting the value to "Don't
7125 show," the lost item is not shown on the OPAC. By setting the
7126 value "Show," the lost item is shown on the OPAC for patrons
7127 to view with a status of 'lost.'</para>
7131 <para>Values:</para>
7135 <para>Don't show</para>
7142 <screeninfo>Lost item showing in the OPAC</screeninfo>
7146 <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
7154 <section id="LibraryName">
7155 <title>LibraryName</title>
7157 <para>Asks: Show ___ as the name of the library on the
7161 <para>This value will appear in the title bar of the
7166 <para>Edit '<link linkend="opacheader">opacheader</link>' if
7167 you'd like to add a library name above your search box on the
7172 <screeninfo>Browser title and address bar</screeninfo>
7176 <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
7182 <section id="OpacAddMastheadLibraryPulldown">
7183 <title>OpacAddMastheadLibraryPulldown</title>
7185 <para>Default: Don't add</para>
7187 <para>Asks: ___ a library select pulldown menu on the OPAC
7190 <para>Values:</para>
7197 <screeninfo>Library select box on Koha OPAC</screeninfo>
7201 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
7208 <para>Don't Add</para>
7211 <screeninfo>No library select box on Koha OPAC</screeninfo>
7215 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
7223 <section id="OPACBaseURL">
7224 <title>OPACBaseURL</title>
7226 <para>Asks: The OPAC is located at http:// ___</para>
7227 <para>Description:<itemizedlist>
7229 <para>This preference is looking for the URL of your public catalog (OPAC). Once
7230 it is filled in Koha will use it to generate permanent links in your RSS feeds,
7231 for your social network share buttons and in your staff client when generating
7232 links to bib records in the OPAC.</para>
7234 </itemizedlist></para>
7236 <para>Do not include a trailing slash in the URL this will break links created using
7237 this URL. (example: www.google.com not www.google.com/)</para>
7241 <para>This must be filled in with the URL of your public catalog for RSS, unAPI, and
7242 search plugins to work.</para>
7246 <para>This must be filled in with the URL of your public catalog to show 'OPAC View'
7247 links from bib records in the staff client:</para>
7251 <screeninfo>With OPACBaseURL set, links to the OPAC will appear
7252 on each individual bib record in the staff client</screeninfo>
7256 <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
7262 <section id="opaccolorstylesheet">
7263 <title>opaccolorstylesheet</title>
7265 <para>Asks: Include the additional CSS stylesheet ___ to override
7266 specified settings from the default stylesheet.</para>
7268 <para>Description:</para>
7272 <para>The preference can look for stylesheets in the template
7273 directory for your OPAC language, for instance:
7274 /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file,
7275 opac-mystyles.css to this directory, you can specify it by
7276 entering opac-mystyles.css in your opaccolorstylesheet system
7277 preference. This adds your custom stylesheet as a linked
7278 stylesheet alongside the OPAC's default CSS files. This method
7279 is preferable because linked stylesheets are cached by the
7280 user's browser, meaning upon repeat visits to your site the
7281 user's browser will not have to re-download the stylesheet,
7282 instead using the copy in the browser's cache.</para>
7286 <para>If you would rather, you can upload your CSS to another
7287 server and enter the full URL pointing to it's location
7288 remember to begin the URL with http://</para>
7293 <para>Leave this field blank to disable it</para>
7297 <para>This file will add a linked CSS, not replace the
7298 existing default CSS.</para>
7301 <para>If using the <link linkend="opacthemes">CCSR theme</link>, this preference must
7302 be set to color.css and any user generated CSS must be appended to the default
7303 color.css file.</para>
7307 <section id="opaccredits">
7308 <title>opaccredits</title>
7310 <para>Asks: Include the following HTML in the footer of all pages
7314 <para>Click the 'Click to edit; link to enter HTML to appear at
7315 the bottom of every page in the OPAC</para>
7319 <screeninfo>HTML version of a footer for your OPAC</screeninfo>
7323 <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
7329 <screeninfo>A sample of what can appear in your OPAC
7330 credits/footer</screeninfo>
7334 <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
7339 <para>Description:</para>
7343 <para>This setting is for credits that will appear at the
7344 bottom of your OPAC pages. Credits traditionally encompass
7345 copyright information, last date updated, hyperlinks or other
7346 information represented in an HTML format. This is static
7347 information and any updates must be entered manually.</para>
7351 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7352 Regions</link> section.</para>
7355 <section id="OPACDisplay856uAsImage">
7356 <title>OPACDisplay856uAsImage</title>
7358 <para>Default: Neither details or results page</para>
7360 <para>Asks: Display the URI in the 856u field as an image on:
7363 <para>Values:</para>
7367 <para>Both results and details pages</para>
7372 <para>Not implemented yet</para>
7379 <para>Detail page only</para>
7385 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
7386 needs to have a value in it for this preference to work.</para>
7393 <screeninfo>Showing the 856u as an image</screeninfo>
7397 <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
7404 <para>Neither details or results page</para>
7408 <para>Results page only</para>
7413 <para>Not yet implemented</para>
7420 <para>Description:</para>
7424 <para>In addition to this option being set, the corresponding
7425 XSLT option must be turned on. Also, the corresponding 856q
7426 field must have a valid MIME image extension (e.g., "jpg") or
7427 MIME image type (i.e. starting with "image/"), or the generic
7428 indicator "img" entered in the field. When all of the
7429 requirements are met, an image file will be displayed instead
7430 of the standard link text. Clicking on the image will open it
7431 in the same way as clicking on the link text. When you click
7432 on the image it should open to full size, in the current
7433 window or in a new window depending on the value in the system
7435 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
7438 <screeninfo>Sample 856 in MARC Record</screeninfo>
7442 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
7450 <section id="OpacExportOptions">
7451 <title>OpacExportOptions</title>
7454 bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
7456 <para>Asks: List export options that should be available from OPAC
7457 detail page separated by |: ___</para>
7459 <para>Description:</para>
7463 <para>In the OPAC on the right of each bib record there is a
7464 menu that allows for saving the record in various formats.
7465 This patch will allow you to define which options are in the
7466 pull down menu. Available options are: BIBTEX (bibtex), Dublin
7467 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
7468 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
7469 without local use -9xx, x9x, xx9- fields and subfields
7470 (marcstd), MODS (mods), and RIS (ris).</para>
7475 <section id="OpacFavicon">
7476 <title>OpacFavicon</title>
7478 <para>Asks: Use the image at ___ for the OPAC's favicon.
7480 <para>This should be a complete URL, starting with
7485 <para>Turn your logo into a favicon with the <ulink
7486 url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
7489 <para>Description:</para>
7493 <para>The favicon is the little icon that appears next to the
7494 URL in the address bar in most browsers. The default value for
7495 this field (if left blank) is the small 'K' in the Koha
7499 <screeninfo>Default Koha Favicon</screeninfo>
7503 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
7511 <section id="opacheader">
7512 <title>opacheader</title>
7514 <para>Asks: Include the following HTML in the header of all pages
7518 <screeninfo>Sample HTML to be displayed at the top of my
7523 <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
7529 <para>This value will appear above the main content of your
7534 <screeninfo>OPAC display of the value from
7535 'opacheader'</screeninfo>
7539 <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
7545 <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
7546 you'd like to edit the contents of the <title> tag</para>
7549 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7550 Regions</link> section.</para>
7553 <section id="OpacHighlightedWords">
7554 <title>OpacHighlightedWords</title>
7556 <para>Default: Don't highlight</para>
7558 <para>Asks: ___ words the patron searched for in their search
7561 <para>Values:</para>
7565 <para>Don't highlight</para>
7569 <para>Highlight</para>
7574 <section id="OpacKohaUrl">
7575 <title>OpacKohaUrl</title>
7577 <para>Default: Don't show</para>
7579 <para>Values:</para>
7583 <para>Don't show</para>
7591 <para>Description:</para>
7595 <para>When this preference is set to 'Show' text will appear
7596 in the bottom right of the OPAC footer stating 'Powered by
7597 Koha' and linking to the official Koha website.</para>
7600 <screeninfo>Powered by Koha</screeninfo>
7604 <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
7612 <section id="opaclayoutstylesheet">
7613 <title>opaclayoutstylesheet</title>
7615 <para>Default: opac.css</para>
7617 <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
7618 OPAC, instead of the default</para>
7620 <para>Description:</para>
7624 <para>This setting's function is to point to the *.css file
7625 used to define the OPAC layout. A *.css file is a cascading
7626 stylesheet which is used in conjunction with HTML to set how
7627 the HTML page is formatted and will look on the OPAC. There
7628 are two stylesheets that come with the system; opac.css and
7629 opac2.css. A custom stylesheet may also be used. The
7630 stylesheets listed in the opaclayoutstylesheet preference are
7631 held on the Koha server.</para>
7636 <para>Leave this field blank to disable it and let Koha use the
7637 default file instead</para>
7640 <para>Using a custom value in this preference causes Koha to completely ignore the
7641 default layout stylesheet.</para>
7645 <section id="OpacMaintenance">
7646 <title>OpacMaintenance</title>
7648 <para>Default: Don't show</para>
7650 <para>Asks: ___ a warning that the OPAC is under maintenance,
7651 instead of the OPAC itself. <note>
7652 <para>this shows the same warning as when the database needs
7653 to be upgraded, but unconditionally.</para>
7656 <para>Description:</para>
7660 <para>This preference allows the system administrator to turn
7661 off the OPAC during maintenance and display a message to
7662 users. When this preference is switched to "Show" the OPAC is
7663 not usable. The text of this message is not editable at this
7668 <para>Values:</para>
7672 <para>Don't show</para>
7680 <para>When this preference is set to show the maintenance
7681 message the ability to search the OPAC is disabled and a
7682 message appears</para>
7685 <screeninfo>OPAC Maintenance Message</screeninfo>
7689 <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
7699 <section id="OpacMainUserBlock">
7700 <title>OpacMainUserBlock</title>
7702 <para>Default: Welcome to Koha... <hr></para>
7704 <para>Asks: Show the following HTML in its own column on the main
7705 page of the OPAC</para>
7707 <para>Description: </para>
7710 <para>HTML entered in this field will appear in the center of the main page of your
7716 <screeninfo>Sample OpacMainUserBlock appears below the search
7721 <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
7726 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7727 Regions</link> section.</para>
7729 <section id="OpacMainUserBlockMobile">
7730 <title>OpacMainUserBlockMobile</title>
7731 <para>Asks: Show the following HTML in its own column on the main page of the OPAC
7732 (mobile version)</para>
7733 <para>Description:</para>
7736 <para>This content will display below the search boxes when viewing the OPAC on a
7737 mobile device as long as the <link linkend="opacthemes">theme</link> you're using
7738 has a mobile version.</para>
7742 <section id="OPACMobileUserCSS">
7743 <title>OPACMobileUserCSS</title>
7744 <para>Asks: Include the following CSS for the mobile view on all pages in the
7746 <para>Description:<itemizedlist>
7748 <para>This CSS will be used when your OPAC is viewed on a mobile device as long as
7749 the <link linkend="opacthemes">theme</link> you're using has a mobile
7752 </itemizedlist></para>
7755 <section id="OPACMySummaryHTML">
7756 <title>OPACMySummaryHTML</title>
7758 <para>Asks: Include a "Links" column on the "my summary" tab when
7759 a user is logged in to the OPAC, with the following HTML (leave
7760 blank to disable).</para>
7762 <para>Description:</para>
7766 <para>In this preference you can enter HTML that will appear
7767 on the 'Checked Out' tab on the 'My Summary' section when
7768 logged in to the OPAC. The placeholders {BIBLIONUMBER},
7769 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
7770 from the displayed record. This can be used to enter in
7771 'share' links for social networks or generate searches against
7772 other library catalogs.</para>
7775 <screeninfo>Example of 'Links' column with a value in the
7776 OPACMySummaryHTML preference</screeninfo>
7780 <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
7787 <para>Sample Data:<programlisting><p><a href="http://www.facebook.com/sharer.php?u=http://YOUROPAC.ORG/cgi-bin/koha/opac-detail.pl?biblionumber={BIBLIONUMBER}">Share on Facebook</a>
7788 <br />TITLE: {TITLE}
7789 <br />AUTHOR: {AUTHOR}
7790 <br />ISBN: {ISBN}
7791 <br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
7794 <section id="OpacNav">
7795 <title>OpacNav</title>
7797 <para>Default: Important links here.</para>
7799 <para>Asks: Show the following HTML on the left hand column of the
7800 main page and patron account on the OPAC (generally navigation
7804 <screeninfo>Sample navigation links</screeninfo>
7808 <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
7813 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7814 Regions</link> section.</para>
7817 <section id="OpacNavBottom">
7818 <title>OpacNavBottom</title>
7820 <para>Asks: Show the following HTML on the left hand column of the
7821 main page and patron account on the OPAC, after <link
7822 linkend="OpacNav">OpacNav</link>, and before patron account links
7823 if available:</para>
7825 <para>Description: When a patron is logged in to their account
7826 they see a series of tabs to access their account information.
7827 <link linkend="OpacNav">OpacNav</link> appears above this list of
7828 tabs and OpacNavBottom will appear below them. When not on the
7829 patron account pages the HTML in OpacNavBottom will just appear
7830 right below <link linkend="OpacNav">OpacNav</link>.</para>
7833 <screeninfo>OpacNav and OpacNavBottom on Patron
7834 Account</screeninfo>
7838 <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
7844 <section id="OpacNavRight">
7845 <title>OpacNavRight</title>
7847 <para>Asks: Show the following HTML in the right hand column of
7848 the main page under the main login form.</para>
7850 <para>Description: HTML entered in this preference will appear on
7851 the right hand side of the OPAC under the log in form. If the log
7852 in form is not visible this content will move up on the right
7856 <screeninfo>OpacNavRight</screeninfo>
7860 <imagedata fileref="images/admin/globalprefs/OpacNavRight.png"/>
7866 <section id="OPACNoResultsFound">
7867 <title>OPACNoResultsFound</title>
7869 <para>No Default</para>
7871 <para>Asks: Display this HTML when no results are found for a
7872 search in the OPAC</para>
7874 <para>This HTML will display below the existing notice that no
7875 results were found for your search.</para>
7878 <screeninfo>HTML in OPACNoResultsFound will appear below lines
7879 that look like this</screeninfo>
7883 <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
7889 <section id="OpacPublic">
7890 <title>OpacPublic</title>
7892 <para>Default: Enable</para>
7894 <para>Asks: ___ Koha OPAC as public. Private OPAC requires
7895 authentication before accessing the OPAC.</para>
7897 <para>Values:</para>
7901 <para>Don't enable</para>
7909 <para>Description:</para>
7913 <para>This preference determines if your OPAC is accessible
7914 and searchable by anyone or only by members of the library. If
7915 set to 'Don't enable' only members who are logged into the
7916 OPAC can search. Most libraries will leave this setting at its
7917 default of 'Enable' to allow their OPAC to be searched by
7918 anyone and only require login for access to personalized
7924 <section id="OPACResultsSidebar">
7925 <title>OPACResultsSidebar</title>
7927 <para>Asks: Include the following HTML under the facets in OPAC
7928 search results</para>
7930 <para>Description:</para>
7934 <para>The HTML entered in this preference will appear on the
7935 search results pages below the list of facets on the left side
7936 of the screen.</para>
7941 <section id="OPACSearchForTitleIn">
7942 <title>OPACSearchForTitleIn</title>
7944 <para>Default: <li><a
7945 href="http://worldcat.org/search?q={TITLE}"
7946 target="_blank">Other Libraries (WorldCat)</a></li>
7948 href="http://www.scholar.google.com/scholar?q={TITLE}"
7949 target="_blank">Other Databases (Google
7950 Scholar)</a></li> <li><a
7951 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
7952 target="_blank">Online Stores
7953 (Bookfinder.com)</a></li></para>
7955 <para>Asks: Include a "More Searches" box on the detail pages of
7956 items on the OPAC, with the following HTML (leave blank to
7960 <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
7961 {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
7962 from the displayed record.</para>
7966 <para>You can use this field to add social networking share
7967 links by using code similar to this</para>
7969 <programlisting></ul></div></div><div class="detailtagcell">
7971 src="http://connect.facebook.net/en_US/all.js#xfbml=1"></script><fb:like
7972 href="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}" show_faces="true"
7973 width="450" font=""></fb:like>
7974 <div><a href="http://twitter.com/share" class="twitter-share-button"
7975 data-url="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}" data-text="I'm reading
7976 this" data-count="horizontal">Tweet</a><script type="text/javascript"
7977 src="http://platform.twitter.com/widgets.js"></script></div></div><div><div><ul></programlisting>
7979 <para>The starting </ul> is necessary to break out of the
7980 'Search for this Title In' pull down menu</para>
7983 <screeninfo>OPACSearchForTitleIn with Social Networking
7988 <imagedata fileref="images/admin/globalprefs/OPACSearchForTitleIn.png"/>
7995 <section id="OPACShowBarcode">
7996 <title>OPACShowBarcode</title>
7998 <para>Default: Don't show</para>
8000 <para>Asks: ___ the item's barcode on the holdings tab.</para>
8002 <para>Values:</para>
8006 <para>Don't show</para>
8009 <screeninfo>Barcode not shown in the OPAC</screeninfo>
8013 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-noshow.png"/>
8023 <screeninfo>Barcode shown in the OPAC</screeninfo>
8027 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-show.png"/>
8034 <para>Description:</para>
8038 <para>This preference allows you to control whether patrons
8039 can see items' barcodes in the OPAC.</para>
8044 <section id="OPACShowCheckoutName">
8045 <title>OPACShowCheckoutName</title>
8047 <para>Default: Don't show</para>
8049 <para>Asks: ___ the name of the patron that has an item checked
8050 out on item detail pages on the OPAC.</para>
8052 <para>Values:</para>
8056 <para>Don't show</para>
8064 <para>Description:</para>
8068 <para>This preference allows all patrons to see who has the
8069 item checked out if it is checked out. In small corporate
8070 libraries (where the OPAC is behind a firewall and not
8071 publicly available) this can be helpful so coworkers can just
8072 contact the patron with the book themselves. In larger public
8073 and academic libraries setting this to 'Show' would pose
8074 serious privacy issues.</para>
8078 <section id="OpacShowFiltersPulldownMobile">
8079 <title>OpacShowFiltersPulldownMobile</title>
8080 <para>Default: Show</para>
8081 <para>Asks: ___ the search filters pulldown on the mobile version of the OPAC. </para>
8082 <para>Values:<itemizedlist>
8084 <para>Don't show</para>
8089 </itemizedlist>Description:<itemizedlist>
8091 <para>This preference controls whether patrons can choose a search type when
8092 viewing the OPAC on mobile devices. If this is set to 'Don't show' then all
8093 searches will be keyword searches. This preference assumes that you're using a
8094 <link linkend="opacthemes">theme</link> with a mobile version.</para>
8096 </itemizedlist></para>
8099 <section id="OPACShowHoldQueueDetails">
8100 <title>OPACShowHoldQueueDetails</title>
8102 <para>Default: Don't show any hold details</para>
8104 <para>Asks: ___ to patrons in the OPAC.</para>
8106 <para>Values:</para>
8110 <para>Don't show any hold details</para>
8114 <para>Show holds</para>
8117 <screeninfo>The holdings table on the bibliographic record
8118 will show the number of holds</screeninfo>
8122 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-showholds.png"/>
8129 <para>Show holds and priority level</para>
8133 <para>Show priority level</para>
8136 <screeninfo>Patron record in the OPAC shows where in line
8137 the patron waits for their hold.</screeninfo>
8141 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-priority.png"/>
8148 <para><link linkend="opacuserlogin">opacuserlogin</link>
8149 needs to be set to 'allow'</para>
8155 <section id="OpacShowLibrariesPulldownMobile">
8156 <title>OpacShowLibrariesPulldownMobile</title>
8157 <para>Default: Show</para>
8158 <para>Asks: ___ the libraries pulldown on the mobile version of the OPAC. </para>
8159 <para>Values:<itemizedlist>
8161 <para>Don't show</para>
8166 </itemizedlist>Description:<itemizedlist>
8168 <para>This preference controls whether the library selector pull down shows when
8169 viewing the OPAC on a mobile device as long as the <link linkend="opacthemes"
8170 >theme</link> you're using has a mobile version.</para>
8172 </itemizedlist></para>
8175 <section id="OpacShowRecentComments">
8176 <title>OpacShowRecentComments</title>
8178 <para>Default: Don't show</para>
8180 <para>Asks: ___ a link to recent comments in the OPAC
8183 <para>Values:</para>
8187 <para>Don't show</para>
8195 <para>Description:</para>
8199 <para>If you have chosen to allow comments in your OPAC by
8200 setting <link linkend="reviewson">reviewson</link> to 'Allow'
8201 you can include a link to the recent comments under the search
8202 box at the top of your OPAC with this preference.</para>
8205 <screeninfo>Recent Comments link on OPAC</screeninfo>
8209 <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
8217 <section id="OPACShowUnusedAuthorities">
8218 <title>OPACShowUnusedAuthorities</title>
8220 <para>Default: Show</para>
8222 <para>Asks: ___ unused authorities in the OPAC authority
8225 <para>Values:</para>
8229 <para>Do not show</para>
8238 <para>Requires that the <link
8239 linkend="OpacAuthorities">OpacAuthorities</link>
8240 preference is set to 'Allow'</para>
8247 <para>Description:</para>
8251 <para>When patrons search your authority file via the OPAC
8252 they will see all authorities in your system even if you don't
8253 have them linked to any bibliographic records. This preference
8254 lets you determine what the default behavior is when searching
8255 authorities via the OPAC. If you choose 'Do not show' it will
8256 only show patrons authority records that are linked to bib
8257 records in the search results. Otherwise the system will show
8258 all authority records even if they aren't linked to
8264 <section id="opacsmallimage">
8265 <title>opacsmallimage</title>
8267 <para>Asks: Use the image at ___ in the OPAC header, instead of
8268 the Koha logo. If this image is a different size than the Koha
8269 logo, you will need to customize the CSS.</para>
8271 <para>Description:</para>
8275 <para>The opacsmallimage system pref is a little tricky to
8276 deal with because you really have to tweak some CSS at the
8277 same time. The default CSS defines a region just large enough
8278 to display the Koha logo, and if your logo doesn't match the
8279 Koha logo's dimensions (120 pixels wide by 38 pixels high), it
8280 won't display correctly.</para>
8285 <para>This should be a complete URL, starting with
8290 <section id="OpacStarRatings">
8291 <title>OpacStarRatings</title>
8293 <para>Default: no</para>
8295 <para>Asks: Show star-ratings on ___ pages.</para>
8297 <para>Values:</para>
8305 <para>only details</para>
8308 <screeninfo>Star Ratings on the Details Page</screeninfo>
8312 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
8319 <para>results and details</para>
8322 <screeninfo>OPAC Star Ratings on the Search
8323 Results</screeninfo>
8327 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
8334 <para>Description:</para>
8338 <para>Star ratings are a way for your patrons to leave ratings
8339 without having to leave a full review. Patrons who are not
8340 logged in will only be able to see the stars, once logged in
8341 patrons can click on the stars on the details page to leave
8342 their own rating. Clicking on the stars on the search results
8343 will not submit a rating.</para>
8348 <section id="opacthemes">
8349 <title>opacthemes</title>
8351 <para>Default: prog</para>
8353 <para>Asks: Use the ___ theme on the OPAC.</para>
8355 <para>Values:</para>
8362 <screeninfo>CCSR Theme</screeninfo>
8365 <imagedata fileref="images/admin/globalprefs/opacthemes-ccsr.png"/>
8370 <para>This theme comes with a mobile version.</para>
8376 <screeninfo>PROG Theme</screeninfo>
8379 <imagedata fileref="images/admin/globalprefs/opacthemes-prog.png"/>
8384 <para>This is the original Koha 3.x theme and does not come with a mobile
8390 <section id="OPACURLOpenInNewWindow">
8391 <title>OPACURLOpenInNewWindow</title>
8393 <para>Default: don't</para>
8395 <para>Asks: When patrons click on a link to another website from
8396 your OPAC (like Amazon or OCLC), ___ open the website in a new
8399 <para>Values:</para>
8411 <para>Description:</para>
8415 <para>This preference determines if URLs in the OPAC will open
8416 in a new window or not. When clicking on a link in the OPAC, a
8417 patron does not need to worry about navigating away from their
8418 search results.</para>
8423 <section id="OPACUserCSS">
8424 <title>OPACUserCSS</title>
8426 <para>Asks: Include the following CSS on all pages in the
8429 <para>Description:</para>
8433 <para>OPACUserCSS allows the administrator to enter styles
8434 that will overwrite the OPAC's default CSS as defined in
8435 'opaclayoutstylesheet' or 'opacstylesheet'. Styles may be
8436 entered for any of the selectors found in the default style
8437 sheet. The default stylesheet will likely be found at
8438 http://your_koha_address/opac-tmpl/prog/en/css/opac.css.
8440 linkend="opaccolorstylesheet">opaccolorstylesheet</link> and
8442 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link>
8443 this preference will embed the CSS directly on your OPAC
8449 <section id="opacuserjs">
8450 <title>opacuserjs</title>
8452 <para>Asks: Include the following JavaScript on all pages in the
8456 <screeninfo>OPAC login box before opacuserjs edit</screeninfo>
8460 <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
8466 <screeninfo>JavaScript in opacuserjs to change the OPAC login
8471 <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
8477 <screeninfo>New OPAC login box after editing
8478 opacuserjs</screeninfo>
8482 <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
8487 <para>Description:</para>
8491 <para>This preference allows the administrator to enter
8492 JavaScript or JQuery that will be embedded across all pages of
8493 the OPAC. Administrators may use this preference to customize
8494 some of the interactive sections of Koha, customizing the text
8495 for the login prompts, for example. Sample JQuery scripts used
8496 by Koha libraries can be found on the wiki: <ulink
8497 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
8502 <section id="OPACXSLTDetailsDisplay">
8503 <title>OPACXSLTDetailsDisplay</title>
8505 <para>Default: default</para>
8507 <para>Asks: Display OPAC details using XSLT stylesheet at
8510 <para>Values:</para>
8514 <para>leave empty to not use the XSLT stylesheet</para>
8518 <para>In previous versions of Koha this was the setting
8519 that read 'normally'</para>
8525 <para>enter "default" for the default one</para>
8529 <para>put a path to define a XSLT file</para>
8533 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
8537 <para>If in a multi-language system you can enter
8538 {langcode} in the path to tell Koha to look in the right
8539 language folder</para>
8544 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
8549 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
8557 <para>put an URL for an external specific stylesheet</para>
8561 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
8567 <para>Description:</para>
8571 <para>XSLT stylesheets allow for the customization of the
8572 details shows on the screen when viewing a bib record. This
8573 preference will allow you either use the default look that
8574 comes with Koha or design your own stylesheet.</para>
8579 <section id="OPACXSLTResultsDisplay">
8580 <title>OPACXSLTResultsDisplay</title>
8582 <para>Default: default</para>
8584 <para>Asks: Display OPAC results using XSLT stylesheet at
8587 <para>Values:</para>
8591 <para>leave empty to not use the XSLT stylesheet</para>
8595 <para>In previous versions of Koha this was the setting
8596 that read 'normally'</para>
8602 <para>enter "default" for the default one</para>
8606 <para>put a path to define a XSLT file</para>
8610 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
8614 <para>If in a multi-language system you can enter
8615 {langcode} in the path to tell Koha to look in the right
8616 language folder</para>
8621 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
8626 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
8634 <para>put an URL for an external specific stylesheet</para>
8638 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
8644 <para>Description:</para>
8648 <para>XSLT stylesheets allow for the customization of the
8649 details shows on the screen when viewing the search results.
8650 This preference will allow you either use the default look
8651 that comes with Koha or design your own stylesheet.</para>
8657 <section id="opacfeaturesprefs">
8658 <title>Features</title>
8662 <section id="numSearchRSSResults">
8663 <title>numSearchRSSResults</title>
8665 <para>Default: 50</para>
8667 <para>Asks: Display ___ search results in the RSS feed.</para>
8669 <para>Description:</para>
8673 <para>By default the RSS feed that is automatically generated
8674 for every search results page will list 50 items. This can
8675 sometimes be too much for some RSS feed readers and for some
8676 people this isn't enough. This preference allows you to adjust
8677 this number to show the best number of results for your
8683 <section id="OpacAuthorities">
8684 <title>OpacAuthorities</title>
8686 <para>Default: Allow</para>
8688 <para>Asks: ___ patrons to search your authority records.</para>
8690 <para>Description:</para>
8694 <para>This preference displays the link on the OPAC for the
8695 authority search (titled 'Browse by Subject'). By setting the
8696 preference to "Allow" patrons can use this search link of the
8702 <para>While labeled 'Browse' it is important to note that this
8703 is in fact an authority search, not an authority browse.</para>
8706 <screeninfo>Authority Search in the OPAC</screeninfo>
8710 <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
8716 <para>Values:</para>
8724 <para>A link labeled 'Browse by Subject' will appear at
8725 the top of your OPAC under the search box</para>
8728 <screeninfo>'Browse by Subject' link under search box on
8733 <imagedata fileref="images/admin/globalprefs/OpacAuthorities.png"/>
8742 <para>Don't allow</para>
8747 <section id="opacbookbag">
8748 <title>opacbookbag</title>
8750 <para>Default: Allow</para>
8752 <para>Asks: ___ patrons to store items in a temporary "Cart" on
8755 <para>Values:</para>
8763 <para>Don't allow</para>
8767 <para>Description:</para>
8771 <para>This preference allows the user to temporarily save a
8772 list of items found on the catalog. By using the Book Bag, or
8773 Cart, the user can print out or email a list of items found.
8774 The user does not need to be logged in. This list is temporary
8775 and will be emptied, or cleared, at the end of the
8781 <section id="OpacBrowser">
8782 <title>OpacBrowser</title>
8785 <para>This preference only applies to French systems at this
8789 <para>Default: Don't allow</para>
8791 <para>Asks: ___ patrons to browse subject authorities on
8794 <para>Values:</para>
8802 <para>Don't allow</para>
8807 <para>run the <link linkend="authbrowsercron">Authorities
8808 Browser Cron Job</link> to create the browser list</para>
8812 <section id="OpacBrowseResults">
8813 <title>OpacBrowseResults</title>
8815 <para>Default: enable</para>
8817 <para>Asks: ___ browsing and paging search results from the OPAC
8820 <para>Values:</para>
8824 <para>disable</para>
8831 <screeninfo>Browsing and Paging Search Results</screeninfo>
8835 <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
8842 <para>Description:</para>
8846 <para>This preference will control the option to return to
8847 your results and/or browse them from the detail page in the
8852 <section id="OpacCloud">
8853 <title>OpacCloud</title>
8855 <para>This preference only applies to French systems at this time.</para>
8856 </important>Default: Don't show</para>
8857 <para>Asks: ___ a subject cloud on OPAC</para>
8858 <para>Values:<itemizedlist>
8860 <para>Don't show</para>
8865 </itemizedlist></para>
8868 <para>run the <link linkend="authbrowsercron">Authorities Browser Cron Job</link> to
8869 create the browser list</para>
8874 <section id="OPACFinesTab">
8875 <title>OPACFinesTab</title>
8877 <para>Default: Allow</para>
8879 <para>Asks: ___ patrons to access the Fines tab on the My Account
8880 page on the OPAC.</para>
8882 <para>Values:</para>
8890 <para><link linkend="opacuserlogin">opacuserlogin</link>
8891 needs to be set to 'allow'</para>
8897 <para>Don't allow</para>
8902 <section id="OpacPasswordChange">
8903 <title>OpacPasswordChange</title>
8905 <para>Default: Allow</para>
8907 <para>Asks: ___ patrons to change their own password on the
8910 <para>Values:</para>
8918 <para><link linkend="opacuserlogin">opacuserlogin</link>
8919 needs to be set to 'allow'</para>
8925 <para>Don't allow</para>
8930 <para>Enabling this will break LDAP authentication.</para>
8934 <section id="OPACPatronDetails">
8935 <title>OPACPatronDetails</title>
8937 <para>Default: Allow</para>
8939 <para>Asks: ___ patrons to notify the library of changes to their
8940 contact information from the OPAC.</para>
8942 <para>Values:</para>
8950 <para><link linkend="opacuserlogin">opacuserlogin</link>
8951 needs to be set to 'allow'</para>
8957 <para>Don't allow</para>
8961 <para>Description:</para>
8965 <para>If patrons are allowed to notify the library of changes
8966 an email will be sent to the library administration email
8967 address with the changes. Lines that start with the field name
8968 in all caps are the lines that the patron made changes
8974 <section id="OPACpatronimage">
8975 <title>OPACpatronimage</title>
8977 <para>Default: Don't show</para>
8979 <para>Asks: ___ patron images on the patron information page in
8982 <para>Values:</para>
8986 <para>Don't show</para>
8994 <para>Description:</para>
8998 <para>If <link linkend="patronimages">patronimages</link> is
8999 set to allow the upload of patron images via the staff client,
9000 then setting this preference to 'show' will show the patron
9001 what image you have on file for them when they view their
9002 personal information on their account in the OPAC.</para>
9007 <section id="OpacTopissue">
9008 <title>OpacTopissue</title>
9010 <para>Default: Don't allow</para>
9012 <para>Asks: ___ patrons to access a list of the most checked out
9013 items on the OPAC.</para>
9015 <para>Values:</para>
9023 <para>A link to 'Most Popular' will appear at the top of
9027 <screeninfo>'Most Popular' link under the search
9032 <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
9041 <para>Don't allow</para>
9045 <para>Description:</para>
9049 <para>This preference allows the administrator to choose to
9050 show the "Most Popular" link at the top of the OPAC under the
9051 search box. The "Most Popular" page shows the top circulated
9052 items in the library, as determined by the number of times a
9053 title has been circulated. This allows users to see what
9054 titles are popular in their community. It is recommended that
9055 you leave this preference set to 'Don't allow' until you have
9056 been live on Koha for a couple of months, otherwise the data
9057 that it shows will not be an accurate portrayal of what's
9058 popular in your library.</para>
9061 <screeninfo>Sample top issues page</screeninfo>
9065 <imagedata fileref="images/admin/globalprefs/topissues.png"/>
9073 <section id="opacuserlogin">
9074 <title>opacuserlogin</title>
9076 <para>Default: Allow</para>
9078 <para>Asks: ___ patrons to log in to their accounts on the
9081 <para>Values:</para>
9089 <para>Don't allow</para>
9093 <para>The OPAC will still be searchable if patrons can't
9094 log in, this just disables the patron account access via
9102 <section id="QuoteOfTheDay">
9103 <title>QuoteOfTheDay</title>
9105 <para>Default: Disable</para>
9107 <para>Asks: ___ Quote of the Day display on OPAC home page</para>
9109 <para>Values:</para>
9113 <para>Disable</para>
9121 <para>Description:</para>
9125 <para>This feature will allow you to enter a series of quotes
9126 that will then show on the OPAC homepage in random order. To
9127 add/edit quotes, visit the <link linkend="QOTDEditor">Quote of
9128 the Day Editor</link> under Tools.</para>
9133 <section id="RequestOnOpac">
9134 <title>RequestOnOpac</title>
9136 <para>Default: Allow</para>
9138 <para>Asks: ___ patrons to place holds on items from the
9141 <para>Values:</para>
9149 <para><link linkend="opacuserlogin">opacuserlogin</link>
9150 needs to be set to 'allow'</para>
9156 <para>Don't allow</para>
9161 <section id="reviewson">
9162 <title>reviewson</title>
9164 <para>Default: Allow</para>
9166 <para>Asks: ___ patrons to make comments on items on the
9169 <para>Values:</para>
9177 <para>Patrons comments/reviews all require moderation
9178 before they appear in the OPAC</para>
9182 <para><link linkend="opacuserlogin">opacuserlogin</link>
9183 needs to be set to 'Allow'</para>
9189 <para>Don't allow</para>
9193 <para>Description:</para>
9197 <para>This button allows the patrons to submit comments on
9198 books they have read via the OPAC. If this preference is set
9199 to "Allow" reviews are first sent to the staff client for
9200 staff approval before the review is displayed in the OPAC. The
9201 staff member who reviews and approves comments may find the
9202 pending comments on the <link
9203 linkend="comments">Comments</link> tool. The staff member can
9204 then choose to approve or delete the comments.</para>
9209 <section id="ShowReviewer">
9210 <title>ShowReviewer</title>
9212 <para>Default: full name</para>
9214 <para>Asks: Show ___ of commenter with comments in OPAC.</para>
9216 <para>Values:</para>
9220 <para>first name</para>
9224 <para>first name and last initial</para>
9228 <para>full name</para>
9232 <para>last name</para>
9236 <para>no name</para>
9240 <para>username</para>
9244 <para>Description:</para>
9248 <para>If you would like to protect your patron's privacy in
9249 the OPAC you can choose to hide their names or parts of their
9250 names from any of the comments they leave on bib records in
9251 your system. <link linkend="reviewson">reviewson</link> needs
9252 to be set to 'Allow' for this to preference to come in to
9258 <section id="ShowReviewerPhoto">
9259 <title>ShowReviewerPhoto</title>
9261 <para>Default: Show</para>
9263 <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
9265 <para>Values:</para>
9277 <para><link linkend="reviewson">reviewson</link> needs to
9278 be set to 'Allow' and <link
9279 linkend="ShowReviewer">ShowReviewer</link> needs to be set
9280 to 'Show' for this to preference to come in to play</para>
9283 <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
9287 <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
9296 <para>Description:</para>
9300 <para>This system preference allows libraries to show avatars
9301 next to patron's comments in the OPAC. These avatars are
9302 pulled from the <ulink
9303 url="https://www.libravatar.org">Libravatar</ulink> library,
9304 an open source powered product that allows Internet users to
9305 choose a small icon to display next to their name on various
9306 different websites. The library has no control over the images
9307 the patron chooses to display.</para>
9312 <section id="SocialNetworks">
9313 <title>SocialNetworks</title>
9315 <para>Default: Disable</para>
9317 <para>Asks: ___ social network links in opac detail pages</para>
9319 <para>Values:</para>
9323 <para>Disable</para>
9330 <screeninfo>Social Networks</screeninfo>
9334 <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
9341 <para>Description:</para>
9345 <para>This preference will enable a line of social network
9346 share buttons below the right hand column on the detail pages
9347 of records in the OPAC.</para>
9352 <para>In order for these share buttons to work when clicked you
9353 must have filled in your <link
9354 linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
9358 <section id="suggestionspref">
9359 <title>suggestion</title>
9361 <para>Default: Allow</para>
9363 <para>Asks: ___ patrons to make purchase suggestions on the
9366 <para>Values:</para>
9374 <para><link linkend="opacuserlogin">opacuserlogin</link>
9375 needs to be set to 'allow' unless <link
9376 linkend="AnonSuggestions">AnonSuggestions</link> is set to
9383 <para>Don't allow</para>
9389 <section id="opacpolicyprefs">
9390 <title>Policy</title>
9394 <section id="AllowPurchaseSuggestionBranchChoice">
9395 <title>AllowPurchaseSuggestionBranchChoice</title>
9397 <para>Default: Don't allow</para>
9399 <para>Asks: ___ patrons to select branch when making a purchase
9402 <para>Values:</para>
9410 <para>Don't allow</para>
9414 <para>Description:</para>
9418 <para>If your library system lets patrons make purchase
9419 suggestions for a specific branch you can set this preference
9420 to 'Allow' to add a branch selection option to the purchase
9421 suggestion form.</para>
9426 <section id="OpacAllowPublicListCreation">
9427 <title>OpacAllowPublicListCreation</title>
9429 <para>Default: Allow</para>
9431 <para>Asks: ___ opac users to create public lists</para>
9433 <para>Values:</para>
9441 <para>Don't allow</para>
9445 <para>Description:</para>
9449 <para>Public lists are visible to anyone who visits your OPAC.
9450 With this preference you can control whether or now patrons
9451 are allowed to create these public lists. If this is set to
9452 "Don't allow" then only staff will be able to create public
9458 <para>This preference will only be taken in to account if you
9459 have <link linkend="virtualshelves">virtualshelves</link> set to
9464 <section id="OpacAllowSharingPrivateLists">
9465 <title>OpacAllowSharingPrivateLists</title>
9468 <para>This feature is not active yet but will be released
9472 <para>Default: Don't allow</para>
9474 <para>Asks: ___ opac users to share private lists with other
9477 <para>Values:</para>
9485 <para>Don't allow</para>
9489 <para>Description:</para>
9493 <para>This feature will add the option for patrons to share
9494 their lists with other patrons.</para>
9499 <section id="OPACFineNoRenewals">
9500 <title>OPACFineNoRenewals</title>
9502 <para>Default: 99999</para>
9504 <para>Asks: Only allow patrons to renew their own books on the
9505 OPAC if they have less than ___ USD in fines</para>
9508 <para>Leave this field blank to disable</para>
9512 <para>To allow renewals in the OPAC, <link
9513 linkend="opacuserlogin">opacuserlogin</link> needs to be set to
9518 <section id="OpacHiddenItems">
9519 <title>OpacHiddenItems</title>
9521 <para>Asks: Allows to define custom rules for hiding specific
9522 items at opac. <tip>
9523 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
9524 directory for more information</para>
9527 <para>Description:</para>
9531 <para>In this field you can enter criteria for items you would
9532 like to hide from display in the OPAC. This field takes any
9533 combination of item fields (from the items table in the Koha
9534 database) for blocking. For example a value of:</para>
9536 <para><programlisting>itype: [07, 10]
9537 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
9538 07 or 10 as well as items that have a shelving location of
9539 STAFF or ISO.</para>
9541 <para>In items my items.itype 07 is defined in Item Types
9542 Administration as Staff Assigned My items.itype 10 in Item
9543 Types is Archival Copy The locations STAFF and ISO are in
9544 Authorized Values for category=LOC STAFF means it's assigned
9545 to the staff reading room and ISO means it is in the isolation
9551 <section id="OPACItemHolds">
9552 <title>OPACItemHolds</title>
9554 <para>Default: Allow</para>
9556 <para>Asks: ___ patrons to place holds on specific items in the
9559 <para>Values:</para>
9567 <para>Patrons can place holds on specific items as well as
9568 the next available item.</para>
9572 <para><link linkend="opacuserlogin">opacuserlogin</link>
9573 needs to be set to 'allow'</para>
9579 <para>Don't allow</para>
9583 <para>If this is disabled, users can only put a hold on
9584 the next available item.</para>
9591 <section id="OpacRenewalAllowed">
9592 <title>OpacRenewalAllowed</title>
9594 <para>Default: Don't allow</para>
9596 <para>Asks: ___ patrons to renew their own books on the
9599 <para>Values:</para>
9607 <para><link linkend="opacuserlogin">opacuserlogin</link>
9608 needs to be set to 'allow'</para>
9614 <para>Don't allow</para>
9618 <para>Staff will still be able to renew items for patrons
9619 via the staff client</para>
9625 <para>Description:</para>
9629 <para>This preference allows the administration to choose if
9630 patrons can renew their checked out materials via their
9631 checked out history in the OPAC. It allows patrons to renew
9632 their materials without having to contact the library or
9633 having to return to the library.</para>
9638 <section id="OpacRenewalBranch">
9639 <title>OpacRenewalBranch</title>
9641 <para>Default: the branch the item was checked out from</para>
9643 <para>Asks: Use ___ as branchcode to store in the statistics
9646 <para>Values:</para>
9654 <para>'OPACRenew'</para>
9658 <para>the item's home branch</para>
9662 <para>the patron's home branch</para>
9666 <para>the branch the item was checked out from</para>
9670 <para>Description:</para>
9674 <para>This value is used in the statistics table to help with
9675 reporting. The statistics table in Koha keeps track of all
9676 checkouts and renewals, this preference defines which branch
9677 is entered in to the table when a patron renews an item for
9678 themselves via the OPAC.</para>
9683 <section id="OPACViewOthersSuggestions">
9684 <title>OPACViewOthersSuggestions</title>
9686 <para>Default: Don't show</para>
9688 <para>Asks: ___ purchase suggestions from other patrons on the
9691 <para>Values:</para>
9695 <para>Don't show</para>
9703 <para><link linkend="opacuserlogin">opacuserlogin</link>
9704 needs to be set to 'allow'</para>
9711 <section id="SearchMyLibraryFirst">
9712 <title>SearchMyLibraryFirst</title>
9714 <para>Default: Don't limit</para>
9716 <para>Asks: ___ patrons' searches to the library they are
9717 registered at.</para>
9719 <para>Values:</para>
9723 <para>Don't limit</para>
9727 <para>Searching the OPAC will show results from all
9732 <para>If you're a one branch system, choose 'Don't
9743 <para>Patrons will still be able to search other libraries
9744 via the Advanced search page - but will be limited to
9745 searches for their library only from the basic search
9750 <para><link linkend="opacuserlogin">opacuserlogin</link>
9751 needs to be set to 'allow'</para>
9758 <section id="singleBranchMode">
9759 <title>singleBranchMode</title>
9761 <para>Default: Don't allow</para>
9763 <para>Asks: ___ patrons to select their branch on the OPAC.</para>
9765 <para>Values:</para>
9773 <para><link linkend="opacuserlogin">opacuserlogin</link>
9774 needs to be set to 'allow'</para>
9780 <para>Don't allow</para>
9784 <para>Description:</para>
9788 <para>This preference is for libraries that have branches but
9789 do not want to share their items among other branches within
9790 their system. If the preference is set to "Don't allow" then
9791 holdings will be shown for all branches within a system. On
9792 the "Home" screen of the OPAC users have the choice of
9793 narrowing down results by item location. Setting this
9794 preference to "Allow" will display only one branch's
9801 <section id="opacprivacyprefs">
9802 <title>Privacy</title>
9806 <section id="AnonSuggestions">
9807 <title>AnonSuggestions</title>
9809 <para>Default: Don't allow</para>
9811 <para>Asks: ___ patrons that aren't logged in to make purchase
9812 suggestions. <important>
9813 <para>If set to 'Allow', suggestions are connected to the
9814 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
9817 <para>Values:</para>
9825 <para>Don't allow</para>
9830 <section id="AnonymousPatron">
9831 <title>AnonymousPatron</title>
9833 <para>Default: 0</para>
9835 <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for
9836 anonymous suggestions and reading history) <tip>
9837 <para>Before setting this preference <link
9838 linkend="addnewpatron">create a patron</link> to be used for
9839 all anonymous suggestions and/or reading history items. This
9840 patron can be any type and should be named something to make
9841 it clear to you that they're anonymous (ex. Anonymous
9846 <section id="EnableOpacSearchHistory">
9847 <title>EnableOpacSearchHistory</title>
9849 <para>Default: Keep</para>
9851 <para>Asks: ___ patron search history in the OPAC.</para>
9853 <para>Values:</para>
9857 <para>Don't keep</para>
9866 <section id="OPACPrivacy">
9867 <title>OPACPrivacy</title>
9869 <para>Default: Don't allow</para>
9871 <para>Asks: ___ patrons to choose their own privacy settings for
9872 their reading history. <important>
9873 <para>This requires <link
9874 linkend="opacreadinghistory">opacreadinghistory</link> set to
9876 linkend="AnonymousPatron">AnonymousPatron</link> to be set to
9877 your anonymous patron's borrowernumber.</para>
9880 <para>Values:</para>
9888 <para>Don't allow</para>
9893 <section id="opacreadinghistory">
9894 <title>opacreadinghistory</title>
9896 <para>Default: Allow</para>
9898 <para>Asks: ___ patrons to see what books they have checked out in
9902 <para>Enabling this will make it so that patrons can view their
9903 circulation history in the OPAC unless you have OPACPrivacy set
9908 <para>This data is stored in the system regardless of your
9909 choice, unless your patrons have chosen to never have their
9910 reading history kept.</para>
9915 <section id="shelfbrowseprefs">
9916 <title>Shelf Browser</title>
9920 <section id="OPACShelfBrowser">
9921 <title>OPACShelfBrowser</title>
9923 <para>Default: Show</para>
9925 <para>Asks: ___ a shelf browser on item details pages, allowing
9926 patrons to see what's near that item on the shelf.</para>
9928 <para>Values:</para>
9932 <para>Don't show</para>
9939 <screeninfo>OPACShelfBrowser</screeninfo>
9943 <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
9950 <para>Description:</para>
9954 <para>This preference allows patrons to view what is located
9955 on the shelf near the item they looked up. The shelf browser
9956 option appears on the details page to the right of each items'
9957 call number. Clicking the 'Browse Shelf' link allows for a
9958 virtual shelf browsing experience via the OPAC and lets
9959 patrons see other books that may relate to their search and
9960 items that sit on the shelf near the item they are looking
9966 <para>This uses up a fairly large amount of resources on your
9967 server, and should be avoided if your collection has a large
9968 number of items.</para>
9972 <section id="ShelfBrowserUsesCcode">
9973 <title>ShelfBrowserUsesCcode</title>
9975 <para>Default: Don't use</para>
9977 <para>Asks: ___ the item collection code when finding items for
9978 the shelf browser.</para>
9980 <para>Values:</para>
9984 <para>Don't use</para>
9992 <para>Description:</para>
9996 <para>If your library uses collection codes then you might
9997 want the shelf browser to take into consideration what
9998 collection the books belong to when populating the virtual
9999 shelf browser.</para>
10004 <section id="ShelfBrowserUsesHomeBranch">
10005 <title>ShelfBrowserUsesHomeBranch</title>
10007 <para>Default: Use</para>
10009 <para>Asks: ___ the item home branch when finding items for the
10010 shelf browser.</para>
10012 <para>Values:</para>
10016 <para>Don't use</para>
10024 <para>Description:</para>
10028 <para>If you have a multiple branch system you may want to
10029 make sure that Koha takes into consideration what branch owns
10030 the books when populating the virtual shelf browser for
10036 <section id="ShelfBrowserUsesLocation">
10037 <title>ShelfBrowserUsesLocation</title>
10039 <para>Default: Use</para>
10041 <para>Asks: ___ the item location when finding items for the shelf
10044 <para>Values:</para>
10048 <para>Don't use</para>
10056 <para>Description:</para>
10060 <para>If your library uses shelving locations then you might
10061 want the shelf browser to take into consideration what
10062 shelving location the books belong to when populating the
10063 virtual shelf browser.</para>
10070 <section id="patronprefs">
10071 <title>Patrons</title>
10073 <para><emphasis>Get there:</emphasis> More > Administration >
10074 Global System Preferences > Patrons</para>
10076 <section id="AddPatronLists">
10077 <title>AddPatronLists</title>
10079 <para>Default: specific categories</para>
10081 <para>Asks: List ___ under the new patron menu.</para>
10083 <para>Values:</para>
10087 <para>general patron types</para>
10090 <screeninfo>Add patron options with AddPatronLists set to
10091 general patron types</screeninfo>
10095 <imagedata fileref="images/admin/globalprefs/AddPatronLists-category.png"/>
10102 <para>specific categories</para>
10105 <screeninfo>Add patron options with AddPatronLists set to
10106 specific categories</screeninfo>
10110 <imagedata fileref="images/admin/globalprefs/AddPatronLists-specific.png"/>
10118 <section id="AutoEmailOPACUser">
10119 <title>AutoEmailOpacUser</title>
10121 <para>Default: Don't send</para>
10123 <para>Asks: ___ an email to newly created patrons with their account
10126 <para>Description:</para>
10130 <para>AutoEmailOpacUser allows library users to be notified by
10131 email of their account details when a new account is opened at
10132 the email address specified in the <link
10133 linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
10134 preference. The email contains the username and password given
10135 to or chosen by the patron when signing up for their account and
10136 can be customized by editing the <link
10137 linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
10141 <para>Values:</para>
10145 <para>Don't send</para>
10154 <section id="AutoEmailPrimaryAddress">
10155 <title>AutoEmailPrimaryAddress</title>
10157 <para>Default: alternate</para>
10159 <para>Asks: Use ___ patron email address for sending out
10162 <para>Values:</para>
10166 <para>alternate</para>
10170 <para>first valid</para>
10182 <para>Description:</para>
10186 <para>If you choose 'first valid' as the value for
10187 AutoEmailPrimaryAddress the system will check the email fields
10188 in this order: home, work, then alternate. Otherwise the system
10189 will use the email address you specify.</para>
10194 <section id="autoMemberNum">
10195 <title>autoMemberNum</title>
10197 <para>Default: Do</para>
10199 <para>Asks: ___ default the card number field on the patron addition
10200 screen to the next available card number</para>
10202 <para>Values:</para>
10210 <para>If the largest currently used card number is
10211 26345000012941, then this field will default to
10212 26345000012942 for the next patron</para>
10222 <para>Description:</para>
10226 <para>This preference determines if the patron's barcode is
10227 automatically calculated. This prevents the person setting up
10228 the library card account from having to assign a number to the
10229 new card. If set to 'Do' the system will calculate a new patron
10230 barcode by adding 1 to the maximum barcode already present in
10231 the database.</para>
10236 <section id="BorrowerMandatoryField">
10237 <title>BorrowerMandatoryField</title>
10239 <para>Default: surname|cardnumber|barcode</para>
10241 <para>Asks: The following database columns must be filled in on the
10242 patron entry screen: ___</para>
10244 <para>Description:</para>
10248 <para>This preference enables the system administrator to choose
10249 which fields your library would like required for patron
10250 accounts. Enter field names separated by | (bar). This ensures
10251 that basic information is included in each patron record. If a
10252 patron leaves one of the required fields blank an error message
10253 will issue and the account will not be created.</para>
10258 <para>Separate columns with |</para>
10262 <para>For help with field names, ask your system administrator or
10264 url="http://schema.koha-community.org/tables/borrowers.html">view
10265 the database structure</ulink> associated with the borrowers
10270 <section id="borrowerRelationship">
10271 <title>borrowerRelationship</title>
10273 <para>Default: father|mother</para>
10275 <para>Asks: Guarantors can be the following of those they guarantee
10278 <para>Description:</para>
10282 <para>This preference enables the system administrator to define
10283 valid relationships between a guarantor (usually a parent) &
10284 a guarantee (usually a child). Defining values for this field
10285 does not make the guarantor field required when adding a
10286 guarantee type patron. This preference creates a drop down list
10287 identifying the relationship of the guarantor to the guarantee.
10288 To disable the ability to add children types in Koha you can
10289 leave this field blank.</para>
10294 <para>Input multiple choices separated by |</para>
10298 <section id="BorrowerRenewalPeriodBase">
10299 <title>BorrowerRenewalPeriodBase</title>
10301 <para>Default: current date</para>
10303 <para>Asks: When renewing borrowers, base the new expiry date on
10306 <para>Values:</para>
10310 <para>current date.</para>
10314 <para>current membership expiry date.</para>
10318 <para>Description:</para>
10322 <para>This preference controls what the patron's new expiration
10323 date will be when you renew their card. Using the 'current date'
10324 will add the subscription period to today's date when
10325 calculating the new expiration date. Using 'current membership
10326 expiry date' will add the subscription period to the old
10327 expiration date for the patron when renewing their
10333 <section id="BorrowersTitles">
10334 <title>BorrowersTitles</title>
10336 <para>Default: Mr|Mrs|Miss|Ms</para>
10338 <para>Asks: Borrowers can have the following titles ___</para>
10340 <para>Description:</para>
10344 <para>This preference allows the staff to choose the titles that
10345 can be assigned to patrons. The choices present as a drop down
10346 list when creating a patron record.</para>
10351 <para>Input multiple choices separated by |</para>
10355 <section id="BorrowerUnwantedField">
10356 <title>BorrowerUnwantedField</title>
10358 <para>Asks: The following database columns will not appear on the
10359 patron entry screen: ___</para>
10361 <para>Description:</para>
10365 <para>This preference enables the system administrator to choose
10366 which fields your library doesn't need to see on the patron
10367 entry form. Enter field names separated by | (bar).</para>
10372 <para>Separate columns with |</para>
10376 <para>For help with field names, ask your system administrator or
10378 url="http://schema.koha-community.org/tables/borrowers.html">view
10379 the database structure</ulink> associated with the borrowers
10384 <section id="checkdigit">
10385 <title>checkdigit</title>
10387 <para>Default: Don't</para>
10389 <para>Asks: ___ check and construct borrower card numbers in the
10390 Katipo style.</para>
10392 <para>Values:</para>
10405 <para>This overrides <link
10406 linkend="autoMemberNum">autoMemberNum</link> if on.</para>
10410 <section id="EnableBorrowerFiles">
10411 <title>EnableBorrowerFiles</title>
10413 <para>Default: Don't</para>
10415 <para>Asks: ___ enable the ability to upload and attach arbitrary
10416 files to a borrower record.</para>
10418 <para>Values:</para>
10430 <para>Description:</para>
10434 <para>When enabled this will add a 'Files' tab to the left of
10435 the patron detail page where you can view and upload files to
10436 the patron record.</para>
10441 <section id="EnhancedMessagingPreferences">
10442 <title>EnhancedMessagingPreferences</title>
10444 <para>Default: Allow</para>
10446 <para>Asks: ___ patrons to choose which notices they receive and
10447 when they receive them.</para>
10449 <para>Values:</para>
10457 <para>Don't allow</para>
10462 <para>This only applies to certain kinds of notices, overdue
10463 notices will be sent based on the library's rules, not the
10464 patron's choice.</para>
10467 <para>Description:</para>
10471 <para>These messages are in addition to the overdue notices that
10472 the library sends. The difference between these notices and
10473 overdues is that the patron can opt-in and out of these. Setting
10474 this preference to 'Allow' will allow patrons to choose to
10475 receive any one of the following messages:</para>
10479 <para>Item Checkout : A notice that lists all the of the
10480 items the patron has just checked out, this is an electronic
10481 form of the checkout receipt</para>
10485 <para>Item Due : A notice on the day and item is due back at
10490 <para>Hold Filled : A notice when you have confirmed the
10491 hold is waiting for the patron</para>
10495 <para>Item Checkin : A notice that lists all the of the
10496 items the patron has just checked in</para>
10500 <para>Advanced Notice : A notice in advance of the patron's
10501 items being due (The patron can choose the number of days in
10509 <section id="ExtendedPatronAttributes">
10510 <title>ExtendedPatronAttributes</title>
10512 <para>Default: Enable</para>
10514 <para>Asks: ___ searching, editing and display of custom attributes
10517 <para>Values:</para>
10521 <para>Don't enable</para>
10525 <para>Enable</para>
10529 <para>Define attributes in Koha administration</para>
10533 <para>Get there: More > Administration > <link
10534 linkend="patronattributetypes">Patron Attribute
10535 Types</link></para>
10541 <para>Description:</para>
10545 <para>Patron attributes are library-defined custom fields that
10546 can be applied to patron records.</para>
10551 <para>Use custom attributes for fields that the default patron
10552 record does not support such as driver's license number or student
10557 <section id="intranetreadinghistory">
10558 <title>intranetreadinghistory</title>
10560 <para>Default: Allow</para>
10562 <para>Asks: ___ staff to access a patron's checkout
10564 <para>If you have the <link
10565 linkend="OPACPrivacy">OPACPrivacy</link> preference set to
10566 'Allow' and the patron has decided to not have their history
10567 kept staff will only see currently checked out items.</para>
10568 </important></para>
10570 <para>Values:</para>
10578 <para>Don't allow</para>
10583 <para>This data is stored in the system regardless of your
10588 <section id="MaxFine">
10589 <title>MaxFine</title>
10591 <para>Default: 9999</para>
10593 <para>Asks: The late fine for all checkouts will only go up to ___
10596 <para>Description:</para>
10600 <para>This preference controls the default cap on fines accrued
10601 by the patron. Leaving this preference blank means that there is
10602 no cap on the amount of fines a patron can accrue. If you'd
10603 like, single item caps can be specified in the <link
10604 linkend="circfinerules">circulation rules matrix</link>.</para>
10609 <section id="memberofinstitution">
10610 <title>memberofinstitution</title>
10612 <para>Default: Don't</para>
10614 <para>Asks: ___ allow patrons to be linked to institutions</para>
10616 <para>Values:</para>
10629 <para>In order to allow this, the library must have Institution
10630 patrons to link members to</para>
10634 <section id="minPasswordLength">
10635 <title>minPasswordLength</title>
10637 <para>Default: 3</para>
10639 <para>Asks: Login passwords for staff and patrons must be at least
10640 ___ characters long.</para>
10643 <para>This applies to both the staff login and the patron OPAC
10648 <section id="NotifyBorrowerDeparture">
10649 <title>NotifyBorrowerDeparture</title>
10651 <para>Default: 30</para>
10653 <para>Asks: Show a notice that a patron is about to expire ___ days
10656 <para>Description:</para>
10660 <para>When the patron attempts to check out materials, a warning
10661 will appear in the check out window of the Staff Client telling
10662 the librarian that the patrons account is about to
10668 <para>This notice will appear on the patron's record in the staff
10673 <section id="patronimages">
10674 <title>patronimages</title>
10676 <para>Default: Allow</para>
10678 <para>Asks: ___ images to be uploaded and shown for patrons on the
10679 staff client.</para>
10681 <para>Values:</para>
10689 <para>Don't allow</para>
10694 <section id="PatronsPerPage">
10695 <title>PatronsPerPage</title>
10697 <para>Default: 20</para>
10699 <para>Asks: By default, show ___ results per page in the staff
10701 <para>Description:<itemizedlist>
10703 <para>This preference will let you define how many patrons to show on patron search
10704 results pages.</para>
10706 </itemizedlist></para>
10709 <section id="SMSSendDriver">
10710 <title>SMSSendDriver</title>
10712 <para>Asks: Use the SMS::Send:: ___ driver to send SMS
10715 <para>Some examples of values are:</para>
10719 <para>SMS::Send::Us::Ipipi</para>
10723 <para>SMS::Send::US::TMobile</para>
10727 <para>SMS::Send::US::Verizon</para>
10731 <para>Additional values can be found here: <ulink
10732 url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
10736 <para>Only drivers available as Perl modules will work in this
10737 preference, so make sure a Perl module is available before
10738 choosing an SMS service.</para>
10741 <para>Once a driver is entered in the preference an option will
10742 appear in the staff client and the OPAC on the patron messaging form
10743 to choose to receive messages as SMS</para>
10746 <screeninfo>SMSSendDriver Options</screeninfo>
10750 <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
10756 <para>You must allow <link
10757 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
10758 for this to work.</para>
10762 <section id="StatisticsFields">
10763 <title>StatisticsFields</title>
10765 <para>Default: location|itype|ccode</para>
10767 <para>Asks: Show the following fields from the items database table
10768 as columns on the statistics tab on the patron record: ___</para>
10771 <screeninfo>Statistics on Patron Record</screeninfo>
10775 <imagedata fileref="images/admin/globalprefs/StatisticsFields.png"/>
10781 <para>Enter the values separated by bars (|)</para>
10784 <para>Description:</para>
10788 <para>This preference lets you set which fields will show on the
10789 patron record on the Statistics tab.</para>
10794 <section id="TalkingTechItivaPhoneNotification">
10795 <title>TalkingTechItivaPhoneNotification</title>
10797 <para>Default: Disable</para>
10799 <para>Asks: ___ patron phone notifications using Talking Tech i-tiva
10800 (overdues, predues and holds notices currently supported).</para>
10802 <para>Values:</para>
10806 <para>Disable</para>
10810 <para>Enable</para>
10814 <para>Description:</para>
10818 <para>To learn more about setting up this third party product
10819 view the <link linkend="talkingtechappendix">Talking Tech
10820 Appendix</link>.</para>
10825 <para>Requires that you have <link
10826 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
10827 set to Allow to use.</para>
10831 <section id="uppercasesurnames">
10832 <title>uppercasesurnames</title>
10834 <para>Default: Don't</para>
10836 <para>Asks: ___ store and display surnames (last names) in upper
10839 <para>Values:</para>
10853 <section id="searchingprefs">
10854 <title>Searching</title>
10856 <para><emphasis>Get there:</emphasis> More > Administration >
10857 Global System Preferences > Searching</para>
10859 <section id="searchfeatureprefs">
10860 <title>Features</title>
10863 <section id="IncludeSeeFromInSearches">
10864 <title>IncludeSeeFromInSearches</title>
10865 <para>Default: Don't include</para>
10866 <para>Asks: ___ <emphasis role="italic">see from</emphasis> (non-preferred form)
10867 headings in bibliographic searches. </para>
10868 <para>Values:<itemizedlist>
10870 <para>Don't include</para>
10873 <para>Include</para>
10875 </itemizedlist></para>
10876 <para>Description: <itemizedlist>
10878 <para>When this preference is set to include the search engine indexer will insert
10879 <emphasis role="italic">see from</emphasis> headings from authority records
10880 into bibliographic records when indexing, so that a search on an obsolete term
10881 will turn up relevant records. For example when you search for cookery (the old
10882 term) you get titles with the heading of cooking (the new term).</para>
10884 </itemizedlist><important>
10885 <para>You will need to reindex your bibliographic database when changing this
10886 preference. </para>
10887 </important></para>
10890 <section id="OpacGroupResults">
10891 <title>OpacGroupResults</title>
10893 <para>Default: Don't use</para>
10895 <para>Asks: ___ PazPar2 to group similar results on the
10898 <para>Values:</para>
10902 <para>Don't use</para>
10911 <para>This requires that <ulink
10912 url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
10913 and running.</para>
10917 <section id="QueryAutoTruncate">
10918 <title>QueryAutoTruncate</title>
10920 <para>Default: automatically</para>
10922 <para>Asks: Perform wildcard searching (where, for example, Har
10923 would match Harry and harp) ___ (The * character would be used
10924 like so: Har* or *logging.)</para>
10926 <para>Values:</para>
10930 <para>automatically</para>
10934 <para>only if * is added</para>
10938 <para>Description:</para>
10942 <para>This setting allows for searches to be automatically
10943 truncated or for additional characters to be added to the end
10944 of a search string. When set to "automatically" the search
10945 string automatically ends with a wildcard function. For
10946 example, a search for the word "invent" with auto truncation
10947 enabled will also retrieve results for inventor, invention,
10948 inventory, etc. If you don't want this to happen automatically
10949 you can still be perform wildcard searches manually by adding
10950 an asterisk (*). Typing "invent*" even with auto truncation
10951 disabled will retrieve the same inventor, invention, inventory
10952 results. Auto truncation bypasses the necessity to type long
10953 search strings in their entirety.</para>
10958 <section id="QueryFuzzy">
10959 <title>QueryFuzzy</title>
10961 <para>Default: Try</para>
10963 <para>Asks: ___ to match similarly spelled words in a search (for
10964 example, a search for flang would also match flange and
10967 <para>Values:</para>
10971 <para>Don't try</para>
10979 <para>Description:</para>
10983 <para>This preference enables "fuzzy" searching, in which the
10984 search engine returns results that are similar to, but not
10985 exactly matching, the word or words entered by the user. This
10986 preference enables the search function to compensate for
10987 slightly misspelled names or phrases.</para>
10992 <para>Requires that <link linkend="UseICU">UseICU</link> set to 'Not using'</para>
10996 <section id="QueryStemming">
10997 <title>QueryStemming</title>
10999 <para>Default: Try</para>
11001 <para>Asks: ___ to match words of the same base in a search</para>
11003 <para>Values:</para>
11007 <para>Don't try</para>
11015 <para>A search for enabling would also match enable and
11022 <para>Description:</para>
11026 <para>This preference enables word stemming. Stemming allows
11027 the search function to return multiple versions of the same
11028 word, as well as related terms (i.e., both fish and fishing
11029 would be returned).</para>
11034 <section id="QueryWeightFields">
11035 <title>QueryWeightFields</title>
11037 <para>Default: Enable</para>
11039 <para>Asks: ___ ranking of search results by relevance</para>
11041 <para>Values:</para>
11045 <para>Disable</para>
11049 <para>Enable</para>
11054 <section id="TraceCompleteSubfields">
11055 <title>TraceCompleteSubfields</title>
11057 <para>Default: Force</para>
11059 <para>Asks: ___ subject tracings in the OPAC and Staff Client to
11060 search only for complete-subfield matches.</para>
11062 <para>Values:</para>
11066 <para>Don't force</para>
11070 <para>Searches for subject keywords (example:
11071 opac-search.pl?q=su:World%20Wide%20Web)</para>
11081 <para>Searches for complete subject fields (example:
11082 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
11088 <para>Description:</para>
11092 <para>When TraceCompleteSubfields is set to "force," clicking
11093 on links in non-authority controlled subject tracings will
11094 only find other records where the entire subfields match.
11095 Leaving it at "don't force" does a keyword search of the
11096 subject indexes.</para>
11101 <para>This preference assumes that you're using XSLT stylesheets
11102 as set in the <link
11103 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
11108 <section id="TraceSubjectSubdivisions">
11109 <title>TraceSubjectSubdivisions</title>
11111 <para>Default: Include</para>
11113 <para>Asks: ___ subdivisions for searches generated by clicking on
11114 subject tracings.</para>
11116 <para>Values:</para>
11120 <para>Don't include</para>
11124 <para>Searches for subject keywords (example:
11125 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
11131 <para>Include</para>
11135 <para>Searches for complete subject fields (example:
11136 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
11142 <para>Description:</para>
11146 <para>When TraceSubjectSubdivisions is set to "Include," if
11147 you click on a subject with subdivisions (subfields other than
11148 'a') they will be searched along with the subject heading
11149 (subfield 'a'). To have only the subject heading (subfield
11150 'a') searched, set this preference to "Don't include."</para>
11155 <para>This preference assumes that you're using XSLT stylesheets
11156 as set in the <link
11157 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
11162 <section id="UseICU">
11163 <title>UseICU</title>
11165 <para>Default: Not using</para>
11167 <para>Asks: ___ ICU Zebra indexing.</para>
11169 <para>Values:</para>
11173 <para>Not using</para>
11181 <para>Description:</para>
11185 <para>ICU is a set of code libraries providing Unicode and
11186 Globalization support for software applications. What this
11187 means is ICU Zebra indexing is only necessary if you use
11188 non-roman characters in your cataloging. If using ICU Zebra
11189 indexing you will want to not use <link
11190 linkend="QueryFuzzy">QueryFuzzy</link>.</para>
11195 <para>This setting will not affect Zebra indexing, it should
11196 only be used to tell Koha that you have activated ICU indexing
11197 if you have actually done so, since there is no way for Koha to
11198 figure this out on its own.</para>
11202 <para>Talk to your system administrator when changing this
11203 preference to make sure that your system is set up properly for
11204 this to work.</para>
11209 <section id="searchresultsprefs">
11210 <title>Results Display</title>
11214 <section id="defaultSortField">
11215 <title>defaultSortField & defaultSortOrder</title>
11217 <para>defaultSortField Default: author</para>
11219 <para>defaultSortOrder Default: ascending</para>
11221 <para>Asks: By default, sort search results in the staff client by
11224 <para>Description:</para>
11228 <para>These preferences set the default sort field and sort
11229 order for searches on the staff side. Regardless of your
11230 choice, the other sort options are still available in the drop
11231 down list on the advanced search page.</para>
11235 <para>defaultSortField Values:</para>
11239 <para>author</para>
11243 <para>call number</para>
11247 <para>date added</para>
11251 <para>date of publication</para>
11255 <para>relevance</para>
11263 <para>total number of checkouts</para>
11267 <para>defaultSortOrder Values:</para>
11271 <para>ascending</para>
11275 <para>descending</para>
11279 <para>from A to Z</para>
11283 <para>from Z to A</para>
11288 <section id="displayFacetCount">
11289 <title>displayFacetCount</title>
11291 <para>Default: Don't show</para>
11293 <para>Asks: ___ facet counts.</para>
11295 <para>Description:</para>
11299 <para>This preference lets you decide if you show how many
11300 times a facet is used in your search results in the OPAC and
11301 the staff client. The relevance of these numbers highly
11302 depends on the value of the <link
11303 linkend="maxRecordsForFacets">maxRecordsForFacets</link>
11304 preference. Showing these numbers can potentially effect the
11305 performance of your searching, so test your system with
11306 different values for this preference to see what works
11311 <para>Values:</para>
11315 <para>Don't show</para>
11322 <screeninfo>Number of times each Facet is found in
11323 results</screeninfo>
11327 <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
11335 <section id="FacetLabelTruncationLength">
11336 <title>FacetLabelTruncationLength</title>
11338 <para>Default: 20</para>
11340 <para>Asks: Truncate facets length to ___ characters, in
11341 OPAC/staff interface.</para>
11343 <para>Description:</para>
11347 <para>In the OPAC and the staff client your facets are cut off
11348 at 20 characters by default. Depending on your layout this may
11349 be too many or two few letters, this preference lets you
11350 decide what number is best for your library's design.</para>
11355 <section id="maxItemsInSearchResults">
11356 <title>maxItemsInSearchResults</title>
11358 <para>Default: 20</para>
11360 <para>Asks: Show up to ___ items per biblio in the search
11363 <para>Description:</para>
11367 <para>This preference will let you set how many results
11368 display by default when a search is run on the Staff
11374 <section id="maxRecordsForFacets">
11375 <title>maxRecordsForFacets</title>
11377 <para>Default: 20</para>
11379 <para>Asks: Build facets based on ___ records from the search
11382 <para>Description:</para>
11386 <para>By default Koha only bases facets on the first page of
11387 results (usually 20 results). This preference lets you tell
11388 Koha to based the facet descriptions and numbers on any number
11389 of search results returned. The higher this number the longer
11390 it will take for your search results to return, so test with
11391 various different values to find the best balance for your
11397 <section id="numSearchResults">
11398 <title>numSearchResults</title>
11400 <para>Default: 20</para>
11402 <para>Asks: By default, show ___ results per page in the staff
11406 <section id="opacdefaultsort">
11407 <title>OPACdefaultSortField & OPACdefaultSortOrder</title>
11409 <para>OPACdefaultSortField Default: relevance</para>
11411 <para>OPACdefaultSortOrder Default: ascending</para>
11413 <para>Asks: By default, sort search results in the OPAC by ___,
11416 <para>Description:</para>
11420 <para>These preferences set the default sort field and sort
11421 order for searches on the OPAC. Regardless of your choice, the
11422 other sort options are still available in the drop down list
11423 on the advanced search page.</para>
11427 <para>OPACdefaultSortField Values:</para>
11431 <para>author</para>
11435 <para>call number</para>
11439 <para>date added</para>
11443 <para>date of publication</para>
11447 <para>relevance</para>
11455 <para>total number of checkouts</para>
11459 <para>OPACdefaultSortOrder Values:</para>
11463 <para>ascending</para>
11467 <para>descending</para>
11471 <para>from A to Z</para>
11475 <para>from Z to A</para>
11482 <section id="OPACItemsResultsDisplay">
11483 <title>OPACItemsResultsDisplay</title>
11485 <para>Default: Don't show</para>
11487 <para>Asks: ___ an item's branch, location and call number in OPAC
11488 search results.</para>
11490 <para>Values:</para>
11494 <para>Don't show</para>
11502 <para>Description:</para>
11506 <para>This setting selects the information about an item that
11507 will display in the search results page of the OPAC. The
11508 results can display the status of an item and/or full details
11509 including branch, location, and call number. While the 'Show'
11510 option allows for more information to be displayed on the
11511 search results page, the information can be overwhelming for
11512 large collections with multiple branches.</para>
11517 <section id="OPACnumSearchResults">
11518 <title>OPACnumSearchResults</title>
11520 <para>Default: 20</para>
11522 <para>Asks: By default, show ___ results per page in the
11527 <section id="searchformprefs">
11528 <title>Search Form</title>
11530 <section id="AdvancedSearchTypes">
11531 <title>AdvancedSearchTypes</title>
11533 <para>Default: itemtype</para>
11535 <para>Asks: Show tabs in OPAC and staff-side advanced search for
11536 limiting searches on the ___ fields (separate values with
11539 <para>Description:</para>
11543 <para>On the advanced search page you can choose to allow
11544 filters on one or all of the following: Item types
11545 (itemtypes), Collection Codes (ccode) and Shelving Location
11546 (loc). If you would like to be able to limit searches on item
11547 type and shelving location for example you would enter
11548 itemtypes|loc in the preference input box. The order of these
11549 fields will determine the order of the tabs in the OPAC and
11550 staff client advanced search screens. Values within the search
11551 type are OR'ed together, while each different search type is
11552 AND'ed together in the query limits. The current stored values
11553 are supported without any required modification.Each set of
11554 advanced search fields are displayed in tabs in both the OPAC
11555 and staff client. The first value in the AdvancedSearchTypes
11556 syspref is the selected tab; if no values are present,
11557 "itemtypes" is used. For non-itemtype values, the value in
11558 AdvancedSearchTypes must match the Authorised Value name, and
11559 must be indexed with 'mc-' prefixing that name.</para>
11562 <screeninfo>Searching by Item Type and Shelving
11563 Location</screeninfo>
11567 <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
11575 <section id="expandedSearchOption">
11576 <title>expandedSearchOption</title>
11578 <para>Default: don't show</para>
11580 <para>Asks: By default, ___ "More options" on the OPAC and staff
11581 advanced search pages.</para>
11583 <para>Values:</para>
11587 <para>don't show</para>
11598 <section id="serialsprefs">
11599 <title>Serials</title>
11601 <para><emphasis>Get there:</emphasis> More > Administration >
11602 Global System Preferences > Serials</para>
11604 <section id="opacSerialDefaultTab">
11605 <title>opacSerialDefaultTab</title>
11607 <para>Default: Subscriptions tab</para>
11609 <para>Asks: Show ___ as default tab for serials in OPAC. </para>
11611 <para>Values:</para>
11615 <para>Holdings tab</para>
11619 <para>Serial Collection tab</para>
11621 <para>Please note that the Serial Collection tab is currently available only for
11622 systems using the UNIMARC standard.</para>
11625 <screeninfo>Serial Collection tab</screeninfo>
11628 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-colltab.png"/>
11635 <para>Subscriptions tab<screenshot>
11636 <screeninfo>Subscritions tab</screeninfo>
11639 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-subtab.png"
11643 </screenshot></para>
11648 <section id="OPACSerialIssueDisplayCount">
11649 <title>OPACSerialIssueDisplayCount</title>
11651 <para>Default: 3</para>
11653 <para>Asks: Show the ___ previous issues of a serial on the
11656 <para>Description:</para>
11660 <para>This preference allows the administrator to select the
11661 number of recent issues for each serial which appear in the OPAC
11662 when the serial is accessed. This is just the default value,
11663 patrons can always click to see a full list of serials.</para>
11668 <section id="RenewSerialAddsSuggestion">
11669 <title>RenewSerialAddsSuggestion</title>
11671 <para>Default: Don't add</para>
11673 <para>Asks: ___ a suggestion for a biblio when its attached serial
11676 <para>Values:</para>
11684 <para>Don't add</para>
11688 <para>Description:</para>
11692 <para>If set to "Add", this preference will automatically add a
11693 serial to the Acquisitions Purchase Suggestions menu when
11694 clicking the 'renew' option. If you don't use the Acquisitions
11695 module to manage serials purchases it's best to leave this set
11696 as 'Don't add.'</para>
11701 <section id="RoutingListAddReserves">
11702 <title>RoutingListAddReserves</title>
11704 <para>Default: Place</para>
11706 <para>Asks: ___ received serials on hold if they are on a routing
11709 <para>Values:</para>
11717 <para>Don't place</para>
11722 <section id="RoutingListNote">
11723 <title>RoutingListNote</title>
11725 <para>Asks: Include following note on all routing lists</para>
11727 <para>Description:</para>
11731 <para>Text entered in this box will appear below the routing
11732 list information.</para>
11737 <section id="RoutingSerials">
11738 <title>RoutingSerials</title>
11740 <para>Default: Don't add</para>
11742 <para>Asks: ___ received serials to the routing list.</para>
11744 <para>Description:</para>
11748 <para>This preference determines if serials routing lists are
11749 enabled or disabled for the library. When set to "Add", serials
11750 routing is enabled and a serial can be directed through a list
11751 of people by identifying who should receive it next. The list of
11752 people can be established for each serial to be passed using the
11753 Serials module. This preference can be used to ensure each
11754 person who needs to see a serial when it arrives at the library
11755 will get it. Learn more in the <link
11756 linkend="routinglist">routing list</link> section of this
11761 <para>Values:</para>
11769 <para>Don't add</para>
11774 <section id="StaffSerialIssueDisplayCount">
11775 <title>StaffSerialIssueDisplayCount</title>
11777 <para>Default: 3</para>
11779 <para>Asks: Show the ___ previous issues of a serial on the staff
11782 <para>Description:</para>
11786 <para>This preference allows the administrator to select the
11787 number of recent issues for each serial which appear in the
11788 Staff Client when the serial is accessed. This is just the
11789 default value, staff members can always click to see a full list
11795 <section id="SubscriptionDuplicateDroppedInput">
11796 <title>SubscriptionDuplicateDroppedInput</title>
11798 <para>Asks: List of fields which must not be rewritten when a
11799 subscription is duplicated (Separated by pipe |) ___</para>
11801 <para>Description:</para>
11805 <para>When duplicating a subscription sometimes you don't want
11806 all of the fields duplicated, using this preference you can list
11807 the fields that you don't want to be duplicated. These field
11808 names come from the subscription table in the Koha database.
11809 Learn what fields are in that table on the <ulink
11810 url="http://schema.koha-community.org/tables/subscription.html">Koha
11811 DB Schema</ulink> site.</para>
11816 <section id="SubscriptionHistory">
11817 <title>SubscriptionHistory</title>
11819 <para>Default: full history</para>
11821 <para>Asks: When showing the subscription information for a
11822 bibliographic record, preselect ___ view of serial issues.</para>
11824 <para>Values:</para>
11828 <para>brief history</para>
11831 <screeninfo>Brief History</screeninfo>
11835 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
11842 <para>full history</para>
11845 <screeninfo>Full History</screeninfo>
11849 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
11856 <para>Description:</para>
11860 <para>This preference determines what information appears in the
11861 OPAC when the user clicks the More Details option. The 'brief'
11862 option displays a one-line summary of the volume and issue
11863 numbers of all issues of that serial held by the library. The
11864 'full' option displays a more detailed breakdown of issues per
11865 year, including information such as the issue date and the
11866 status of each issue.</para>
11872 <section id="staffprefs">
11873 <title>Staff Client</title>
11875 <para><emphasis>Get there:</emphasis> More > Administration >
11876 Global System Preferences > Staff Client</para>
11878 <section id="staffappearprefs">
11879 <title>Appearance</title>
11883 <section id="Display856uAsImage">
11884 <title>Display856uAsImage</title>
11886 <para>Default: Neither details or results page</para>
11888 <para>Asks: Display the URI in the 856u field as an image on:
11891 <para>Values:</para>
11895 <para>Both results and details pages</para>
11900 <para>Not implemented yet</para>
11907 <para>Detail page only</para>
11913 linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
11914 needs to be on for this preference to work.</para>
11920 <screeninfo>Showing the 856u as an image</screeninfo>
11924 <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
11931 <para>Neither details or results page</para>
11935 <para>Results page only</para>
11940 <para>Not yet implemented</para>
11947 <para>Description:</para>
11951 <para>In addition to this option being set, the corresponding
11952 XSLT option must be turned on. Also, the corresponding 856q
11953 field must have a valid MIME image extension (e.g., "jpg") or
11954 MIME image type (i.e. starting with "image/"), or the generic
11955 indicator "img" entered in the field. When all of the
11956 requirements are met, an image file will be displayed instead
11957 of the standard link text. Clicking on the image will open it
11958 in the same way as clicking on the link text. When you click
11959 on the image it should open to full size, in the current
11960 window or in a new window depending on the value in the system
11962 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
11965 <screeninfo>Sample 856 Field</screeninfo>
11969 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
11977 <section id="intranet_includes">
11978 <title>intranet_includes</title>
11980 <para>Default: includes</para>
11982 <para>Asks: Use include files from the ___ directory in the
11983 template directory, instead of includes/. (Leave blank to
11987 <section id="intranetcolorstylesheet">
11988 <title>intranetcolorstylesheet</title>
11990 <para>Asks: Include the stylesheet /intranet-tmpl/prog/en/css/ ___
11991 on all pages in the staff interface.</para>
11993 <para>Description:</para>
11997 <para>This preference is used to set the background color and
11998 style of the Staff Client. The value is a .css file. The
11999 system administrator should determine which file is
12000 appropriate.</para>
12005 <para>Leave this field blank to disable.</para>
12009 <section id="IntranetFavicon">
12010 <title>IntranetFavicon</title>
12012 <para>Asks: Use the image at ___ for the Staff Client's favicon.
12014 <para>This should be a complete URL, starting with
12016 </important></para>
12019 <para>Turn your logo into a favicon with the <ulink
12020 url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
12023 <para>Description:</para>
12027 <para>The favicon is the little icon that appears next to the
12028 URL in the address bar in most browsers. The default value for
12029 this field (if left blank) is the small 'K' in the Koha
12033 <screeninfo>Default Koha Favicon</screeninfo>
12037 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
12045 <section id="IntranetmainUserblock">
12046 <title>IntranetmainUserblock</title>
12048 <para>Asks: Show the following HTML in its own column on the main
12049 page of the staff client</para>
12052 <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
12056 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
12062 <screeninfo>Message from IntranetmainUserblock as it appears on
12063 the Staff Client main page</screeninfo>
12067 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
12073 <section id="IntranetNav">
12074 <title>IntranetNav</title>
12076 <para>Asks: Show the following HTML in the More menu at the top of
12077 each page on the staff client (should be a list of links or
12081 <section id="IntranetSlipPrinterJS">
12082 <title>IntranetSlipPrinterJS</title>
12084 <para>Asks: Use the following JavaScript for printing
12087 <para>Description:</para>
12091 <para>The most logical use of this preference is in
12092 conjunction with the <ulink
12093 url="http://jsprintsetup.mozdev.org/">jsPrintSetup</ulink>
12094 Firefox add-on. Learn more about this preference and the
12095 add-on setup on the Koha wiki at <ulink
12096 url="http://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</ulink>.</para>
12101 <section id="intranetstylesheet">
12102 <title>intranetstylesheet</title>
12104 <para>Asks: Include the stylesheet at ___ on all pages in the
12105 staff interface, instead of the default.</para>
12107 <para>Description:</para>
12111 <para>The Intranetstylesheet preference is a layout and design
12112 feature for the intranet or staff client. To change the
12113 stylesheet from the original, place in this preference the
12114 file path to the style sheet - include the entire url starting
12115 with http://. This preference allows a library to customize
12116 the appearance of the Staff Client.</para>
12121 <para>This should be a complete URL, starting with
12126 <section id="IntranetUserCSS">
12127 <title>IntranetUserCSS</title>
12129 <para>Asks: Include the following CSS on all pages in the staff
12133 <section id="intranetuserjs">
12134 <title>intranetuserjs</title>
12136 <para>Asks: Include the following JavaScript on all pages in the
12137 staff interface</para>
12140 <screeninfo>Sample JavaScript to alter the staff client
12145 <imagedata fileref="images/admin/globalprefs/intranetuserjs-code.png"/>
12151 <screeninfo>Link to Self Checkout appears on staff client login
12152 because of JavaScript</screeninfo>
12156 <imagedata fileref="images/admin/globalprefs/intranetuserjs.png"/>
12161 <para>Description:</para>
12165 <para>This preference allows the administrator to enter
12166 JavaScript or JQuery that will be embedded across all pages of
12167 the Staff Client. Administrators may use this preference to
12168 customize some of the interactive sections of Koha,
12169 customizing the text for the login prompts, for example.
12170 Sample JQuery scripts used by Koha libraries can be found on
12172 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
12177 <section id="SlipCSS">
12178 <title>SlipCSS</title>
12180 <para>Asks: Include the stylesheet at ___ on Issue and Reserve
12182 <para>This should be a complete URL, starting with
12184 </important></para>
12186 <para>Description:</para>
12190 <para>If you would like to style your receipts or slips with a
12191 consistent set of fonts and colors you can use this preference
12192 to point Koha to a stylesheet specifically for your
12198 <section id="StaffAuthorisedValueImages">
12199 <title>StaffAuthorisedValueImages</title>
12201 <para>Default: Show</para>
12203 <para>Asks: ___ images for authorized values (such as lost
12204 statuses and locations) in search results.</para>
12206 <para>Values:</para>
12210 <para>Don't show</para>
12219 <section id="staffClientBaseURL">
12220 <title>staffClientBaseURL</title>
12222 <para>Asks: The staff client is located at http:// ___</para>
12225 <section id="template">
12226 <title>template</title>
12228 <para>Default: prog</para>
12230 <para>Asks: Use the ___ theme on the staff interface.</para>
12232 <para>Values:</para>
12240 <para>Do not include a trailing slash in the URL this will break links created using
12241 this URL. (example: www.google.com not www.google.com/)</para>
12245 <section id="XSLTDetailsDisplay">
12246 <title>XSLTDetailsDisplay</title>
12248 <para>Default: default</para>
12250 <para>Asks: Display details in the staff client using XSLT
12251 stylesheet at ___</para>
12253 <para>Values:</para>
12257 <para>leave empty to not use the XSLT stylesheet</para>
12261 <para>In previous versions of Koha this was the setting
12262 that read 'normally'</para>
12265 <screeninfo>Detail display without XSLT
12266 stylesheets</screeninfo>
12270 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
12279 <para>enter "default" for the default one</para>
12282 <screeninfo>Detail display using XSLT
12283 stylesheets</screeninfo>
12287 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
12294 <para>put a path to define a XSLT file</para>
12298 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
12302 <para>If in a multi-language system you can enter
12303 {langcode} in the path to tell Koha to look in the right
12304 language folder</para>
12309 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
12314 http://mykoha.org/{langcode}/stylesheet.xsl</para>
12322 <para>put an URL for an external specific stylesheet</para>
12326 <para>ex: http://mykoha.org/stylesheet.xsl</para>
12332 <para>Description:</para>
12336 <para>XSLT stylesheets allow for the customization of the
12337 details shows on the screen when viewing a bib record. This
12338 preference will allow you either use the default look that
12339 comes with Koha or design your own stylesheet.</para>
12344 <section id="XSLTResultsDisplay">
12345 <title>XSLTResultsDisplay</title>
12347 <para>Default: default</para>
12349 <para>Asks: Display results in the staff client using XSLT
12350 stylesheet at ___</para>
12352 <para>Values:</para>
12356 <para>leave empty to not use the XSLT stylesheet</para>
12360 <para>In previous versions of Koha this was the setting
12361 that read 'normally'</para>
12367 <para>enter "default" for the default one</para>
12371 <para>put a path to define a XSLT file</para>
12375 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
12379 <para>If in a multi-language system you can enter
12380 {langcode} in the path to tell Koha to look in the right
12381 language folder</para>
12386 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
12391 http://mykoha.org/{langcode}/stylesheet.xsl</para>
12399 <para>put an URL for an external specific stylesheet</para>
12403 <para>ex: http://mykoha.org/stylesheet.xsl</para>
12409 <para>Description:</para>
12413 <para>XSLT stylesheets allow for the customization of the
12414 details shows on the screen when viewing the search results.
12415 This preference will allow you either use the default look
12416 that comes with Koha or design your own stylesheet.</para>
12421 <section id="yuipath">
12422 <title>yuipath</title>
12424 <para>Default: included with Koha</para>
12426 <para>Asks: Use the Yahoo UI libraries ___</para>
12428 <para>Values:</para>
12432 <para>from Yahoo's servers</para>
12436 <para>With this option there is less demand on your
12437 servers, but if the Internet goes down there will be
12444 <para>included with Koha</para>
12448 <para>With this option calls are made faster, and they
12449 will still work if the Internet goes down</para>
12455 <para>Description:</para>
12459 <para>The yuipath preference allows for the user to define a
12460 local path or web URL to the Yahoo User Interface Library
12462 url="http://developer.yahoo.com/yui/2/">http://developer.yahoo.com/yui/2/</ulink>).
12463 This library is a resource of developer tools including
12464 JavaScript and style sheets.</para>
12470 <section id="staffoptsprefs">
12471 <title>Options</title>
12473 <section id="HidePatronName">
12474 <title>HidePatronName</title>
12476 <para>Default: Show</para>
12478 <para>Asks: ___ the names of patrons that have items checked out
12479 or on hold on detail pages or the "Place Hold" screen.</para>
12481 <para>Values:</para>
12485 <para>Don't show</para>
12494 <section id="intranetbookbag">
12495 <title>intranetbookbag</title>
12497 <para>Default: Show</para>
12499 <para>Asks: ___ the cart option in the staff client.</para>
12501 <para>Values:</para>
12505 <para>Don't show</para>
12514 <section id="viewISBD">
12515 <title>viewISBD</title>
12517 <para>Default: Allow</para>
12519 <para>Asks: ___ staff to view records in ISBD form on the staff
12522 <para>Values:</para>
12530 <para>Don't allow</para>
12535 <section id="viewLabeledMARC">
12536 <title>viewLabeledMARC</title>
12538 <para>Default: Allow</para>
12540 <para>Asks: ___ staff to view records in labeled MARC form on the
12541 staff client.</para>
12543 <para>Values:</para>
12551 <para>Don't allow</para>
12556 <section id="viewMARC">
12557 <title>viewMARC</title>
12559 <para>Default: Allow</para>
12561 <para>Asks: ___ staff to view records in plain MARC form on the
12562 staff client.</para>
12564 <para>Values:</para>
12572 <para>Don't allow</para>
12579 <section id="webserviceprefs">
12580 <title>Web Services</title>
12582 <para><emphasis>Get there:</emphasis> More > Administration >
12583 Global System Preferences > Web Services</para>
12585 <section id="ilsdiprefs">
12586 <title>ILS-DI</title>
12590 <section id="ILS-DI">
12591 <title>ILS-DI</title>
12593 <para>Default: Disable</para>
12595 <para>Asks: ___ ILS-DI services for OPAC users</para>
12597 <para>Values:</para>
12601 <para>Disable</para>
12605 <para>Enable</para>
12610 <section id="ILS-DIAuthorized_IPs">
12611 <title>ILS-DI:AuthorizedIPs</title>
12613 <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
12617 <section id="oaiprefs">
12618 <title>OAI-PMH</title>
12622 <section id="OAI-PMH">
12623 <title>OAI-PMH</title>
12625 <para>Default: Disable</para>
12627 <para>Asks: ___ Koha's OAI-PMH server.</para>
12629 <para>Values:</para>
12633 <para>Disable</para>
12637 <para>Enable</para>
12641 <para>Description:</para>
12645 <para>For the Open Archives Initiative-Protocol for Metadata
12646 Harvesting (OAI-PMH) there are two groups of 'participants':
12647 Data Providers and Service Providers. Data Providers (open
12648 archives, repositories) provide free access to metadata, and
12649 may, but do not necessarily, offer free access to full texts
12650 or other resources. OAI-PMH provides an easy to implement, low
12651 barrier solution for Data Providers. Service Providers use the
12652 OAI interfaces of the Data Providers to harvest and store
12653 metadata. Note that this means that there are no live search
12654 requests to the Data Providers; rather, services are based on
12655 the harvested data via OAI-PMH. Koha at present can only act
12656 as a Data Provider. It can not harvest from other
12657 repositories. The biggest stumbling block to having Koha
12658 harvest from other repositories is that MARC is the only
12659 metadata format that Koha indexes natively. Visit <ulink
12660 url="http://www.oaforum.org/tutorial/english/page3.htm">http://www.oaforum.org/tutorial/english/page3.htm</ulink>
12661 for diagrams of how OAI-PMH works.</para>
12665 <para>Learn more about OAI-PMH at: <ulink
12666 url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
12669 <section id="OAI-PMHarchiveID">
12670 <title>OAI-PMH:archiveID</title>
12672 <para>Default: KOHA-OAI-TEST</para>
12674 <para>Asks: Identify records at this site with the prefix ___
12678 <section id="OAI-PMHAutoUpdateSets">
12679 <title>OAI-PMH:AutoUpdateSets</title>
12681 <para>Default: Disable</para>
12683 <para>Asks: ___ automatic update of OAI-PMH sets when a
12684 bibliographic record is created or updated.</para>
12686 <para>Values:</para>
12690 <para>Disable</para>
12694 <para>Enable</para>
12699 <section id="OAI-PMHConfFile">
12700 <title>OAI-PMH:ConfFile</title>
12702 <para>If this preference is left empty, Koha's OAI Server operates
12703 in normal mode, otherwise it operates in extended mode. In
12704 extended mode, it's possible to parameter other formats than
12705 marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
12706 configuration file which list available metadata formats and XSL
12707 file used to create them from marcxml records.</para>
12709 <para>For more information, see the <link
12710 linkend="oaiconfsample">sample conf file</link> in the
12714 <section id="OAI-PMHMaxCount">
12715 <title>OAI-PMH:MaxCount</title>
12717 <para>Default: 50</para>
12719 <para>Asks: Only return ___ records at a time in response to a
12720 ListRecords or ListIdentifiers query.</para>
12722 <para>Description:</para>
12726 <para>This is the maximum number of records that would be
12727 returned based on ListRecord or ListIdentifier queries from
12728 harvesters. ListRecords harvest the entire records while the
12729 ListIdentifier is an abbreviated form of ListRecords,
12730 retrieving only headers rather than records.</para>
12735 <section id="reportingservice">
12736 <title>Reporting</title>
12737 <section id="SvcMaxReportRows">
12738 <title>SvcMaxReportRows</title>
12739 <para>Default: 10</para>
12740 <para>Asks: Only return ___ rows of a report requested via the reports web
12742 <para>Description:<itemizedlist>
12744 <para>This value will be used to limit the number of results returned by <link
12745 linkend="publicreport">public reports</link>.</para>
12747 </itemizedlist></para>
12753 <section id="basicparams">
12754 <title>Basic Parameters</title>
12756 <para><emphasis>Get there:</emphasis> More > Administration</para>
12759 <para>Configure all 'parameters' in the order they appear.</para>
12762 <section id="libsgroups">
12763 <title>Libraries & Groups</title>
12765 <para>When setting up your Koha system you will want to add
12766 information for every library that will be sharing your system. This
12767 data is used in several areas of Koha.</para>
12771 <para><emphasis>Get there:</emphasis> More > Administration
12772 > Basic Parameters > Libraries and Groups</para>
12776 <para>When visiting this page you are presented with a list of the
12777 libraries and groups that have already been added to the
12781 <screeninfo>Library List</screeninfo>
12785 <imagedata fileref="images/admin/basicparams/librarylist.png"/>
12791 <screeninfo>Group Lists</screeninfo>
12795 <imagedata fileref="images/admin/basicparams/grouplists.png"/>
12800 <section id="addingalibrary">
12801 <title>Adding a Library</title>
12803 <para>To add a new library:</para>
12807 <para>Click 'New Library'</para>
12811 <para>The top of the form asks for some basics about the
12815 <screeninfo>Basic Library Info</screeninfo>
12819 <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
12826 <para>The library code should not contain any spaces and be
12827 10 or fewer characters. This code will be used as a unique
12828 identifier in the database.</para>
12832 <para>The name will be displayed on the OPAC wherever the
12833 library name displays to the public and should be a name
12834 that makes sense to your patrons.</para>
12838 <para>If you have <link
12839 linkend="addinglibgroup">groups</link> set up you can choose
12840 what group this library belongs to after entering in the
12841 code and name</para>
12847 <para>Next you can enter basic contact info about the
12851 <screeninfo>Library Contact Info</screeninfo>
12855 <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
12862 <para>The address and contact fields can be used to make
12863 notices custom for each library</para>
12867 <para>The email address field is not required, but it should
12868 be filled for every library in your system</para>
12873 <para>Be sure to enter a library email address to make
12874 sure that notices are sent to and from the right
12882 <para>If the URL field is populated then the library name
12883 will be linked in the holdings table on the OPAC</para>
12886 <screeninfo>Linked Library Name</screeninfo>
12890 <imagedata fileref="images/admin/basicparams/librarylink.png"/>
12897 <para>The OPAC Info box is for you to put information about
12898 the library that will appear in the OPAC when the branch
12899 name is moused over in the holdings table</para>
12902 <screeninfo>OPAC Info</screeninfo>
12906 <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
12913 <para>IP Address does not have be filled in unless you plan
12914 on limiting access to your staff client to a specific IP
12920 <para>An IP address is required if you have enabled
12922 linkend="AutoLocation">AutoLocation</link></para>
12929 <para>Finally, if you have any notes you can put them here.
12930 These will not show in the OPAC</para>
12937 <para>Of the fields listed, only 'Library code' and 'Name' are
12944 <section id="editingalibrary">
12945 <title>Editing/Deleting a Library</title>
12947 <para>You will be unable to delete any library that has patrons or
12948 items attached to it.</para>
12951 <screeninfo>Staff will be presented with a warning when trying to
12952 delete a library that is being used</screeninfo>
12956 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
12961 <para>Each library will have an 'Edit' link to the right of it.
12962 Click this link to edit/alter details associated with the library in
12966 <para>You will be unable to edit the 'Library code'</para>
12970 <section id="addinglibgroup">
12971 <title>Adding a group</title>
12973 <para>To add a Search Domain or Library Property Group click the
12974 'New Group' button at the top of the screen</para>
12977 <screeninfo>Add group form</screeninfo>
12981 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
12986 <para>Of the fields on the group form, 'Category code' and 'Name'
12987 are the only required fields</para>
12989 <section id="searchdomaingroups">
12990 <title>Search Domain Groups</title>
12992 <para>Search Domain Groups allow you to search a group of
12993 libraries at the same time instead of searching just one library
12994 or all libraries.</para>
12997 <screeninfo>Search Domain Groups</screeninfo>
13001 <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
13006 <para>To see Search Domain Groups in action visit the staff client
13007 advanced search page in your Koha system:</para>
13010 <screeninfo>Library group search on staff client</screeninfo>
13014 <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
13020 <section id="libpropertygroups">
13021 <title>Library Property Groups</title>
13023 <para>You can assign specific categories to your libraries by
13024 adding groups for them</para>
13027 <screeninfo>Library Property Groups</screeninfo>
13031 <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
13036 <para>Properties are then applied to libraries via the add or edit
13037 library form</para>
13040 <screeninfo>Groups on the Add/Modify library form</screeninfo>
13044 <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
13052 <section id="itemtypeadmin">
13053 <title>Item Types</title>
13055 <para>Koha allows you to organize your collection by item types and
13056 collection codes.</para>
13060 <para><emphasis>Get there:</emphasis> More > Administration
13061 > Basic Parameters > Item Types</para>
13065 <para>Item types typically refer to the material type (book, cd, dvd,
13066 etc), but can be used in any way that works for your library.</para>
13069 <screeninfo>Item Types</screeninfo>
13073 <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
13078 <section id="additemtype">
13079 <title>Adding Item Types</title>
13081 <para>To add a new item type, simply click the 'New Item Type'
13082 button at the top of the Item Types page.</para>
13085 <screeninfo>Sample DVD Item Type</screeninfo>
13089 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
13096 <para>In the 'Item Type' field, enter a short code for your item
13101 <para>The description is the plain text definition of the item
13106 <para>You can choose to have an image associated with your item
13111 <para>You can choose from a series of image
13116 <para>You can link to a remote image</para>
13120 <para>Or you can just have no image associated with the item
13126 <para>To have your item type images appear in the OPAC you
13127 need to set noItemTypeImages to 'Show'</para>
13132 <para><emphasis>Get there: </emphasis>More >
13133 Administration > Global System Preferences > <link
13134 linkend="adminprefs">Admin</link></para>
13142 <para>For items that do not circulate, check the 'Not for loan'
13147 <para>Items marked 'Not for loan' will appear in the
13148 catalog, but cannot be checked out to patrons</para>
13154 <para id="rentalcharge">For items that you charge a rental fee
13155 for, enter the total fee you charge in the 'Rental charge'
13161 <para>Do not enter symbols in this field, only numbers and
13162 decimal points (ex. $5.00 should be entered as 5 or
13168 <para>This will charge the patron on checkout</para>
13174 <para>When finished, click 'Save Changes'</para>
13179 <para>All fields, with the exception of the 'Item Type'
13180 will be editable from the Item Types list</para>
13187 <para>Your new item type will now appear on the list</para>
13190 <screeninfo>New DVD Item Type</screeninfo>
13194 <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
13202 <section id="edititemtype">
13203 <title>Editing Item Types</title>
13205 <para>Each item type has an Edit button beside it. To edit an item
13206 simply click the 'Edit' link.</para>
13209 <para>You will not be able to edit the code you assigned as the
13210 'Item Type' but you will be able to edit the description for the
13215 <section id="deleteitemtype">
13216 <title>Deleting Item Types</title>
13218 <para>Each item has a Delete button beside it. To delete an item,
13219 simply click the 'Delete' link.</para>
13222 <para>You will not be able to delete item types that are being
13223 used by items within your system.</para>
13227 <screeninfo>Warning when you try to delete an item that is in
13232 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
13239 <section id="authorizedvalues">
13240 <title>Authorized Values</title>
13242 <para>Authorized values can be used in several areas of Koha. One
13243 reason you would add an authorized value category would be to control
13244 the values that can be entered into MARC fields by catalogers.</para>
13248 <para><emphasis>Get there:</emphasis> More > Administration
13249 > Basic Parameters > Authorized Values</para>
13253 <section id="existingauthvalues">
13254 <title>Existing Values</title>
13256 <para>Koha installs with pre-defined values that your library is
13257 likely to use, for instance 'Lost'.</para>
13260 <listitem id="asort1">
13261 <para>Asort1</para>
13264 <para>Used for acquisitions statistical purposes</para>
13269 <listitem id="asort2">
13270 <para>Asort2</para>
13273 <para>Used for acquisitions statistical purposes</para>
13278 <listitem id="bornotes">
13279 <para>BOR_NOTES</para>
13282 <para>Values for custom patron messages that appear on the circulation screen and
13283 the OPAC. The value in the Description field should be the message text and is
13284 limited to 200 characters.</para>
13286 <screeninfo>Borrower messages</screeninfo>
13289 <imagedata fileref="images/admin/basicparams/bor_notes.png"/>
13297 <listitem id="bsort1">
13298 <para>Bsort1</para>
13301 <para>Values that can be entered to fill in the patron's sort 1 field</para>
13306 <listitem id="bsort2">
13307 <para>Bsort2</para>
13310 <para>Values that can be entered to fill in the patron's sort 2 field</para>
13315 <listitem id="cartauth">
13319 <para>Is the shelving cart location, used by <link
13320 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> and
13321 <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
13326 <listitem id="ccode">
13330 <para>Collection codes (appears when cataloging and working with items)</para>
13335 <listitem id="damageauth">
13336 <para>DAMAGED</para>
13339 <para>Descriptions for items marked as damaged (appears when cataloging and
13340 working with items)</para>
13345 <listitem id="hingsas">
13346 <para>HINGS_AS</para>
13349 <para>General Holdings: Acquisition Status Designator :: This data element
13350 specifies acquisition status for the unit at the time of the holdings
13356 <listitem id="hingsc">
13357 <para>HINGS_C</para>
13360 <para>General Holdings: Completeness Designator</para>
13365 <listitem id="hingspf">
13366 <para>HINGS_PF</para>
13369 <para>Physical Form Designators</para>
13374 <listitem id="hingsrd">
13375 <para>HINGS_RD</para>
13378 <para>General Holdings: Retention Designator :: This data element specifies the
13379 retention policy for the unit at the time of the holdings report.</para>
13384 <listitem id="hingsut">
13385 <para>HINGS_UT</para>
13388 <para>General Holdings: Type of Unit Designator</para>
13393 <listitem id="shelvelocvals">
13397 <para>Shelving location (usually appears when adding or editing an item)</para>
13402 <listitem id="lost">
13406 <para>Descriptions for the items marked as lost (appears when adding or editing an
13411 <para>Values given to lost statuses should be numeric and not alphabetical in
13412 order for statuses to appear properly</para>
13418 <listitem id="manualinvvals">
13419 <para>MANUAL_INV</para>
13422 <para>Values for manual invoicing types</para>
13427 <para>The value set as the Authorized Value for the MANUAL_INV authorized
13428 value category will appear as the Description and the Authorized Value
13429 Description will be used as the amount. Enter monetary amounts in the
13430 description without currency symbols.</para>
13437 <listitem id="notforloan">
13438 <para>NOT_LOAN</para>
13441 <para>Reasons why a title is not for loan</para>
13445 <para>Values given to lost statuses should be numeric and not alphabetical in
13446 order for statuses to appear properly</para>
13451 <para>Negative number values will still allow holds (use for on order statuses
13452 for example) where as positive numbers will not allow holds or
13459 <listitem id="procauth">
13463 <para>The location to be used for <link linkend="NewItemsDefaultLocation"
13464 >NewItemsDefaultLocation</link> (change description as desired), also the
13465 location expected by <link linkend="InProcessingToShelvingCart"
13466 >InProcessingToShelvingCart</link>.</para>
13471 <listitem id="reportgroup">
13472 <para>REPORT_GROUP</para>
13475 <para>A way to sort and filter your reports, the default values in this category
13476 include the Koha modules (Accounts, Acquitisions, Catalog, Circulation,
13479 <screeninfo>Report Groups</screeninfo>
13482 <imagedata fileref="images/admin/basicparams/report_group.png"/>
13490 <listitem id="reportsubgroup">
13491 <para>REPORT_SUBGROUP</para>
13494 <para>Can be used to further sort and filter your reports. This category is empty
13495 by default. Values here need to include the authorized value code from
13496 REPORT_GROUP in the Description (OPAC) field to link the subgroup to the
13497 appropriate group.</para>
13499 <screeninfo>Report Subgroups</screeninfo>
13502 <imagedata fileref="images/admin/basicparams/report_subgroup.png"/>
13510 <listitem id="restricted">
13511 <para>RESTRICTED</para>
13514 <para>Restricted status of an item</para>
13519 <listitem id="suggestauthorized">
13520 <para>SUGGEST</para>
13523 <para>List of patron suggestion reject or accept reasons (appears when managing
13524 suggestions)</para>
13529 <listitem id="withdrawnauth">
13530 <para>WITHDRAWN</para>
13533 <para>Description of a withdrawn item (appears when adding or editing an
13539 <listitem id="yesnoauth">
13540 <para>YES_NO</para>
13543 <para>A generic authorized value field that can be used anywhere you need a simple
13544 yes/no pull down menu.</para>
13551 <section id="newauthvalcat">
13552 <title>Add new Authorized Value Category</title>
13554 <para>In addition to the existing categories that come by default
13555 with Koha, librarians can add their own authorized value categories
13556 to control data that is entered into the system. To add a new
13561 <para>Click 'New Category'</para>
13564 <screeninfo>New Authorized Category form</screeninfo>
13568 <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
13575 <para>Limit your Category to 10 characters (something short to
13576 make it clear what the category is for)</para>
13581 <para>Category cannot have spaces or special characters
13582 other than underscores and hyphens in it.</para>
13589 <para>When adding a new category you're asked to create at least
13590 one authorized value</para>
13594 <para>Enter a code for your Authorized Value into the
13595 'Authorized value' field</para>
13600 <para>Authorized value is limited to 80 characters and
13601 cannot have spaces or special characters other than
13602 underscores and hyphens in it.</para>
13609 <para>Use the Description field for the actual value that
13610 will be displayed. If you want something different to show
13611 in the OPAC, enter a 'Description (OPAC)'</para>
13615 <para>If you have <link
13616 linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
13618 linkend="AuthorisedValueImages">AuthorisedValueImages</link>
13619 set to show images for authorized values you can choose the
13620 image under 'Choose an icon'</para>
13626 <para>Click 'Save'</para>
13630 <para>Your new category and value will appear on the list of
13631 Authorized Values</para>
13634 <screeninfo>Custom Authorized Value on list of
13635 values</screeninfo>
13639 <imagedata fileref="images/admin/basicparams/authvallist.png"/>
13647 <section id="newauthval">
13648 <title>Add new Authorized Value</title>
13650 <para>New authorized values can be added to any existing or new
13651 category. To add a value:</para>
13655 <para>Click 'New authorized value for ...'</para>
13658 <screeninfo>New Authorized Value form</screeninfo>
13662 <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
13669 <para>Enter a code for your Authorized Value into the
13670 'Authorized value' field</para>
13675 <para>Authorized value is limited to 80 characters and
13676 cannot have spaces or special characters other than
13677 underscores and hyphens in it.</para>
13684 <para>Use the Description field for the actual value that will
13685 be displayed. If you want something different to show in the
13686 OPAC, enter a 'Description (OPAC)'</para>
13690 <para>If you have <link
13691 linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
13693 linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
13694 to show images for authorized values you can choose the image
13695 under 'Choose an icon'</para>
13699 <para>Click 'Save'</para>
13703 <para>The new value will appear in the list along with existing
13707 <screeninfo>List of authorized values in MARC504
13708 category</screeninfo>
13712 <imagedata fileref="images/admin/basicparams/authvals.png"/>
13722 <section id="patscirc">
13723 <title>Patrons & Circulation</title>
13725 <para>Settings for controlling circulation and patron
13726 information.</para>
13728 <section id="patcats">
13729 <title>Patron Categories</title>
13731 <para>Patron categories allow you to organize your patrons into
13732 different roles, age groups, and patron types.</para>
13736 <para><emphasis>Get there:</emphasis> More > Administration
13737 > Patrons & Circulation > Patron Categories</para>
13742 <screeninfo>Patron category list</screeninfo>
13746 <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
13751 <para>Patrons are assigned to one of six main categories:</para>
13759 <para>Most common patron type, usually used for a general
13760 'Patron' category.</para>
13770 <para>Children patrons can have a guardian to be attached to
13781 <para>Librarians (and library workers) should be assigned the
13782 staff category so that you can <link
13783 linkend="patronpermissions">set their permissions</link> and
13784 give them access to the staff client.</para>
13790 <para>Organizational</para>
13794 <para>Organizational patrons are organizations. Organizations
13795 can be used as guarantors for Professional patrons.</para>
13801 <para>Professional</para>
13805 <para>Professional patrons can be linked to Organizational
13812 <para>Statistical</para>
13816 <para>This patron type is used strictly for statistical
13817 purposes, such as in house use of items.</para>
13823 <section id="addingpatroncat">
13824 <title>Adding a patron category</title>
13826 <para>To add a new patron category click 'New Category' at the top
13830 <screeninfo>New patron category form</screeninfo>
13834 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
13841 <para>The 'Category Code' is an identifier for your new
13847 <para>The category code is limited to 10 characters
13848 (numbers and letters)</para>
13854 <para>This field is required in order to save your patron
13855 category. If left blank you will be presented with an
13859 <screeninfo>Missing fields error</screeninfo>
13863 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13873 <para>Enter a plain text version of the category in the
13874 'Description' field.</para>
13879 <para>This field is required in order to save your patron
13880 category. If left blank you will be presented with an
13884 <screeninfo>Missing fields error</screeninfo>
13888 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13898 <para>Enrollment period (in months) should be filled in if you
13899 have a limited enrollment period for your patrons (eg. Student
13900 cards expire after 9 months or until a specific date)</para>
13905 <para>You cannot enter both a month limit and a date
13906 until. Choose to enter either one or the other.</para>
13912 <para>This field is required in order to save your patron
13913 category. If left blank you will be presented with an
13917 <screeninfo>Missing fields error</screeninfo>
13921 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13931 <para>Some patron categories can have a minimum age (in years)
13932 requirement associated with them, enter this age in the 'Age
13938 <para>This value will only be checked if <link
13939 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
13940 defines the dateofbirth as a required field on the patron
13948 <para>Patron categories can also have a maximum age (in years)
13949 associated with them (such as children), enter this age in the
13950 'Upperage limit'</para>
13955 <para>This value will only be checked if <link
13956 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
13957 defines the dateofbirth as a required field on the patron
13965 <para>If you charge a membership fee for your patrons (such as
13966 those who live in another region) you can enter that in the
13967 'Enrollment fee' field.</para>
13972 <para>Only enter numbers and decimals in this field</para>
13979 <para>If you want your patron to receive overdue notices, set
13980 the 'Overdue notice required' to 'Yes'</para>
13984 <para>You can decide on a patron category basis if lost items
13985 are shown in the staff client by making a choice from the 'Lost
13986 items in staff client' pull down</para>
13989 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
13993 <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
14001 <para>Note that this is only applicable in the staff
14002 client, so changing this value on patron categories who do
14003 not have access to the staff client won't make any
14011 <para>If you charge patrons for placing holds on items, enter
14012 the fee amount in the 'Hold fee' field.</para>
14017 <para>Only enter numbers and decimals in this field</para>
14024 <para>In the 'Category type' field choose one of the six main
14025 parent categories</para>
14028 <screeninfo>Six main patron categories</screeninfo>
14032 <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
14040 <para>This field is required in order to save your patron
14041 category. If left blank you will be presented with an
14045 <screeninfo>Missing fields error</screeninfo>
14049 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
14059 <para>Finally you can assign advanced messaging preferences by
14060 default to a patron category</para>
14066 <para>Requires that you have <link linkend="EnhancedMessagingPreferences"
14067 >EnhancedMessagingPreferences</link> enabled</para>
14073 <para>These defaults will be applied to new patrons that are added to the system.
14074 They will not edit the preferences of the existing patrons. Also, these can be
14075 changed for individual patrons, this setting is just a default to make it easier
14076 to set up messages for an entire category.<itemizedlist>
14079 <para>After setting the default for the patron category you can force
14080 those changes to all existing patrons by running the <emphasis
14081 role="italic">borrowers-force-messaging-defaults</emphasis> script
14082 found in the <emphasis role="italic">misc/maintenance</emphasis> folder.
14083 Ask your system administrator for assistance with this script.</para>
14086 </itemizedlist></para>
14093 <section id="circfinerules">
14094 <title>Circulation and Fine Rules</title>
14095 <para>These rules define how your items are circulated, how/when fines are calculated and
14096 how holds are handled.</para>
14099 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
14100 Circulation > Circulation and fines rules</para>
14103 <para>The rules are applied from most specific to less specific, using the first found in
14107 <para>same library, same patron type, same item type</para>
14110 <para>same library, same patron type, all item type</para>
14113 <para>same library, all patron types, same item type</para>
14116 <para>same library, all patron types, all item types</para>
14119 <para>all libraries, same patron type, same item type</para>
14122 <para>all libraries, same patron type, all item types</para>
14125 <para>all libraries, all patron types, same item type</para>
14128 <para>all libraries, all patron types, all item types</para>
14132 <para>If you are a single library system choose your branch name before creating rules
14133 (sometimes having only rules for the 'all libraries' option can cause issues with
14138 <para>At the very least you will need to set a default circulation rule. This rule
14139 should be set for all item types, all libraries and all patron categories. That will
14140 catch all instances that do not match a specific rule. When checking out if you do not
14141 have a rule for all libraries, all item types and all patron types then you may see
14142 patrons getting blocked from placing holds. You will also want a rule for your
14143 specific library set for all item types and all patron types to avoid this holds
14144 issue. Koha needs to know what rule to fall back on.</para>
14147 <section id="defaultcircrules">
14148 <title>Default Circulation Rules</title>
14149 <para>Using the issuing rules matrix you can define rules that depend on patron/item type
14150 combos. To set your rules, choose a library from the pull down (or 'all libraries' if
14151 you want to apply these rules to all branches):</para>
14153 <screeninfo>Libraries to apply the rules to</screeninfo>
14156 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
14160 <para>From the matrix you can choose any combination of patron categories and item types
14161 to apply the rules to</para>
14163 <screeninfo>Setting issuing rules for your libraries</screeninfo>
14166 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
14172 <para>First choose which patron category you'd like the rule to be applied to. If you
14173 leave this to 'All' it will apply to all patron categories</para>
14176 <para>Choose the 'Item Type' you would like this rule to apply to. If you leave this
14177 to 'All' it will apply to all item types</para>
14180 <para>Limit the number of items a patron can have checked out at the same time by
14181 entering a number in the 'Current Checkouts Allowed' field</para>
14184 <para>Define the period of time an item can be checked out to a patron by entering the
14185 number of units (days or hours) in the 'Loan Period' box.</para>
14188 <para>Choose which unit of time, Days or Hours, that the loan period and fines will be
14189 calculate in</para>
14192 <para>You can also define a hard due date for a specific patron category and item
14193 type. A hard due date ignores your usual circulation rules and makes it so that all
14194 items of the type defined are due on, before or after the date you specify.</para>
14197 <para>'Fine Amount' should have the amount you would like to charge for overdue
14202 <para>Enter only numbers and decimal points (no currency symbols).</para>
14208 <para>Enter the 'Fine Charging Interval' in the unit you set (ex. charge fines every 1
14209 day, or every 2 hours)</para>
14212 <para>The 'Fine Grace Period' is the period of time an item can be overdue before you
14213 start charging fines.</para>
14217 <para>This can only be set for the Day unit, not in Hours</para>
14223 <para>The 'Overdue Fines Cap' is the maximum fine for this patron and item
14228 <para>If this field is left blank then Koha will not put a limit on the fines
14229 this item will accrue. A maximum fine amount can be set using the <link
14230 linkend="MaxFine">MaxFine</link> system preference.</para>
14236 <para>If your library 'fines' patrons by suspending their account you can enter the
14237 number of days their fine should be suspended in the 'Suspension in Days'
14242 <para>This can only be set for the Day unit, not in Hours</para>
14248 <para>Next decide if the patron can renew this item type and if so, enter how many
14249 times they can renew it in the 'Renewals Allowed' box</para>
14252 <para>If the patron can place holds on this item type, enter the total numbers of
14253 items (of this type) that can be put on hold in the 'Holds Allowed' field</para>
14256 <para>Finally, if you charge a <link linkend="rentalcharge">rental fee</link> for the
14257 item type and want to give a specific patron type a discount on that fee, enter the
14258 percentage discount (without the % symbol) in the 'Rental Discount' field</para>
14261 <para>When finished, click 'Add' to save your changes. To modify a rule, create a new one
14262 with the same patron type and item type. If you would like to delete your rule, simply
14263 click the 'Delete' link to the right of the rule.</para>
14264 <para>To save time you can clone rules from one library to another by choosing the clone
14265 option above the rules matrix.</para>
14267 <screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
14270 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
14274 <para>After choosing to clone you will be presented with a confirmation message.</para>
14276 <screeninfo>Circulation & Fine Rules Successfully Cloned Message</screeninfo>
14279 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
14284 <section id="defaultcheckoutpolicy">
14285 <title>Default Checkouts and Hold Policy</title>
14286 <para>You can set a default maximum number of checkouts and hold policy that will be used
14287 if none is defined below for a particular item type or category.</para>
14289 <screeninfo>Default Checkouts and Hold Policy</screeninfo>
14292 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
14296 <para>From this menu you can set a default to apply to all item types and patrons in the
14300 <para>In 'Total Current Checkouts Allowed' enter the total number of items patrons can
14301 have checked out at one time</para>
14304 <para>Control where patrons can place holds from using the 'Hold Policy' menu</para>
14307 <para>From Any Library: Patrons from any library may put this item on hold.
14308 (default if none is defined)</para>
14311 <para>From Home Library: Only patrons from the item's home library may put this
14312 book on hold.</para>
14315 <para>No Holds Allowed: No patron may put this book on hold.</para>
14320 <para>Control where the item returns to once it is checked in</para>
14323 <para>Item returns home</para>
14326 <para>Item returns to issuing branch</para>
14329 <para>Item floats</para>
14332 <para>When an item floats it stays where it was checked in and does not ever
14333 return 'home'</para>
14340 <para>Once your policy is set, you can unset it by clicking the 'Unset' link to the
14341 right of the rule</para>
14345 <section id="checkoutperpatron">
14346 <title>Checkouts Per Patron</title>
14347 <para>For this library, you can specify the maximum number of loans that a patron of a
14348 given category can make, regardless of the item type.</para>
14350 <screeninfo>Set default checkouts per patron category</screeninfo>
14353 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
14358 <para>If the total amount loanable for a given patron category is left blank, no limit
14359 applies, except possibly for a limit you define for a specific item type.</para>
14362 <section id="holdpolicies">
14363 <title>Item Hold Policies</title>
14364 <para>For this library, you can edit rules for given itemtypes, regardless of the patron's
14365 category. Currently, this means hold policies.</para>
14367 <screeninfo>Hold policies per item type</screeninfo>
14370 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
14374 <para>The various Hold Policies have the following effects:</para>
14377 <para>From Any Library: Patrons from any library may put this item on hold. (default
14378 if none is defined)</para>
14381 <para>From Home Library: Only patrons from the item's home library may put this book
14385 <para>No Holds Allowed: No patron may put this book on hold.</para>
14389 <para>Note that if the system preference <link linkend="AllowHoldPolicyOverride"
14390 >AllowHoldPolicyOverride</link> set to 'allow', these policies can be overridden by
14391 your circulation staff.</para>
14394 <para>These policies are based on the patron's home branch, not the branch that the
14395 reserving staff member is from.</para>
14397 <para>The various Return Policies have the following effects:</para>
14400 <para>Item returns home: The item will prompt the librarian to transfer the item to
14401 its home library</para>
14405 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
14406 preference is set to automatically transfer the items home, then a prompt will
14413 <para>Item returns to issuing branch: The item will prompt the librarian to transfer
14414 the item back to the library where it was checked out</para>
14418 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
14419 preference is set to automatically transfer the items home, then a prompt will
14426 <para>Item floats: The item will not be transferred from the branch it was checked in
14427 at, instead it will remain there until transferred manually or checked in at another
14433 <section id="patronattributetypes">
14434 <title>Patron Attribute Types</title>
14435 <para>Patron attributes can be used to define custom fields to associate with your patron
14436 records. In order to enable the use of custom fields you need to set the <link
14437 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link> system
14441 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
14442 Circulation > Patron attribute types</para>
14445 <para>A common use for this field would be for a student ID number or a Driver's license
14448 <screeninfo>List of Patron Attributes</screeninfo>
14451 <imagedata fileref="images/admin/patroncirc/attributes.png"/>
14455 <section id="addpatattributes">
14456 <title>Adding Patron Attributes</title>
14457 <para>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at
14458 the top of the page</para>
14460 <screeninfo>Add Patron Attribute Type form</screeninfo>
14463 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
14469 <para>In the 'Patron attribute type code', enter a short code to identify this
14474 <para>This field is limited to 10 characters (numbers and letters only)</para>
14479 <para>This setting cannot be changed after an attribute is defined</para>
14485 <para>In the 'Description' field, enter a longer (plain text) explanation of what this
14486 field will contain</para>
14489 <para>Check the box next to 'Repeatable' to let a patron record have multiple values
14490 of this attribute.</para>
14494 <para>This setting cannot be changed after an attribute is defined</para>
14500 <para>If 'Unique identifier' is checked, the attribute will be a unique identifier
14501 which means, if a value is given to a patron record, the same value cannot be given
14502 to a different record.</para>
14506 <para>This setting cannot be changed after an attribute is defined</para>
14512 <para>Check 'Allow password' to make it possible to associate a password with this
14516 <para>Check 'Display in OPAC' to display this attribute on a patron's details page in
14520 <para>Check 'Searchable' to make this attribute searchable in the staff patron
14524 <para>Check 'Display in check-out' to make this attribute visible in the patron's
14525 short detail display on the left of the checkout screen and other patron
14528 <screeninfo>Show attribute in patron detail on the left</screeninfo>
14531 <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
14537 <para>Authorized value category; if one is selected, the patron record input page will
14538 only allow values to be chosen from the authorized value list.</para>
14541 <para>You will first need to add an authorized value list for it to appear in this
14545 <para><emphasis>Get there: </emphasis>More > Administration > Basic
14546 Parameters > <link linkend="authorizedvalues">Authorized
14547 Values</link></para>
14553 <para>an authorized value list is not enforced during batch patron
14560 <para>If you'd like to only show this attribute on patrons of one type choose that
14561 patron type from the 'Category' pull down</para>
14564 <para>If you have a lot of attributes it might be handy to group them so that you can
14565 easily find them for editing. If you create an <link linkend="authorizedvalues"
14566 >Authorized Value</link> for PA_CLASS it will show in the 'Class' pull down and
14567 you can then change your attributes page to have sections of attributes</para>
14569 <screeninfo>Patron Attributes Sorted</screeninfo>
14572 <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
14578 <para>Click Save to save your new attribute</para>
14581 <para>Once added your attribute will appear on the list of attributes and also on the
14582 patron record add/edit form</para>
14584 <screeninfo>Patron Attributes list on the Patron add/edit form</screeninfo>
14587 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
14591 <para>If you have set up classes for organizing attributes they will appear that way on
14592 the add/edit patron form</para>
14594 <screeninfo>Grouped Attributes</screeninfo>
14597 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
14602 <section id="editpatattributes">
14603 <title>Editing/Deleting Patron Attributes</title>
14604 <para>Each patron attribute has an edit and a delete link beside it on the list of
14606 <para>Some fields in the attribute will not be editable once created:</para>
14609 <para>Patron attribute type code</para>
14612 <para>Repeatable</para>
14615 <para>Unique identifier</para>
14618 <para>You will be unable to delete an attribute if it's in use.</para>
14620 <screeninfo>Warning when trying to delete an attribute that is in use</screeninfo>
14623 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
14629 <section id="libtransferlimits">
14630 <title>Library Transfer Limits</title>
14631 <para>Limit the ability to transfer items between libraries based on the library sending,
14632 the library receiving, and the collection code involved.</para>
14635 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
14636 Circulation > Library Transfer Limits</para>
14639 <para>These rules only go into effect if the preference <link
14640 linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is set to
14642 <para>Before you begin you will want to choose which library you are setting these limits
14645 <screeninfo>Choose the library you're setting limits for</screeninfo>
14648 <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
14652 <para>Transfer limits are set based on the collections codes you have applied via the <link
14653 linkend="authorizedvalues">Authorized Value</link> administration area.</para>
14655 <screeninfo>Collection Code values assigned in the Authorized Value area</screeninfo>
14658 <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
14662 <para>Collection codes will appear as tabs above the checkboxes:</para>
14664 <screeninfo>Collection Code tabs</screeninfo>
14667 <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
14671 <para>Check the boxes for the libraries that you accept checkins from for the item type you
14672 have selected at the top (in the example below - FIC)</para>
14674 <screeninfo>Example transfer limits set up</screeninfo>
14677 <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
14681 <para>In the above example, Centerville library will allow patrons to return items from all
14682 libraries except Liberty and Franklin to their branch.</para>
14684 <section id="transportcostmatrix">
14685 <title>Transport cost matrix</title>
14686 <para>The Transport cost matrix lets a library system define relative costs to transport
14687 books to one another. In order for the system to use this matrix you must first set the
14688 <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link> preference to
14690 <para>The Transport cost matrix takes precedence in controlling where holds are filled
14691 from, if the matrix is not used then Koha checks the <link linkend="holdqueueweight"
14692 >StaticHoldsQueueWeight</link>.</para>
14693 </important></para>
14694 <para>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0
14695 which is the minimum (no) cost. For example, you could just use the distance between each
14696 library in miles as your 'cost', if that would accurately reflect the cost of transferring
14697 them. Perhaps post offices would be a better measure. Libraries sharing a post office
14698 would have a cost of 1, adjacent post offices would have a cost of 2, etc.</para>
14699 <para>To enter transport costs simply click in the cell you would like to alter, uncheck the
14700 'Disable' box and enter your 'cost'<screenshot>
14701 <screeninfo>Transport cost matrix</screeninfo>
14704 <imagedata fileref="images/admin/patroncirc/transportcostmatrix.png"/>
14707 </screenshot></para>
14708 <para>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button
14709 at the bottom of the matrix to save your changes.</para>
14711 <section id="itemcircalerts">
14712 <title>Item Circulation Alerts</title>
14713 <para>Libraries can decide if they want to have patrons automatically notified of
14714 circulation events (check ins and check outs).</para>
14717 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
14718 Circulation > Item Circulation Alerts</para>
14721 <para>These preferences are set based on patron types and item types.</para>
14723 <para>These preference can be overridden by changes in the individual patron's messaging
14724 preferences.</para>
14726 <para>To set up circulation alerts:</para>
14729 <para>Choose your library from the pull down at the top of the screen</para>
14731 <screeninfo>Libraries to set Circulation Alerts</screeninfo>
14734 <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
14740 <para>To set preferences for all libraries, keep the menu set to 'Default'</para>
14745 <para>By default all item types and all patrons are notified of check ins and check
14746 outs. To change this, click on the item/patron type combo that you would like to stop
14747 notices for.</para>
14749 <screeninfo>Circulation Alert Matrix</screeninfo>
14752 <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
14758 <para>In the above example, Juveniles and Kids will not receive check out
14766 <section id="citytowns">
14767 <title>Cities and Towns</title>
14769 <para>To standardize patron input you can define cities or towns
14770 within your region so that when new patrons are added librarians
14771 simply have to select the town from a list instead of having to type
14772 the town and zip (or postal) code information.</para>
14776 <para><emphasis>Get there:</emphasis> More > Administration
14777 > Patrons & Circulation > Cities and Towns</para>
14781 <section id="addingcity">
14782 <title>Adding a City</title>
14784 <para>To add a new city, click the 'New City' button at the top of
14785 the page and enter the city name, state, zip/postal code and
14789 <screeninfo>New city entry form</screeninfo>
14793 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
14798 <para>One you click Submit, your city will be saved and will be
14799 listed on the Cities and Towns page</para>
14802 <screeninfo>List of Cities</screeninfo>
14806 <imagedata fileref="images/admin/patroncirc/cities.png"/>
14811 <para>Cities can be edited or deleted at any time.</para>
14814 <section id="citiesonpatform">
14815 <title>Viewing Cities on Patron Add Form</title>
14817 <para>If you have defined local cities using the New city form, then
14818 when adding or editing a patron record you will see those cities in
14819 a pull down menu to make city selection easy.</para>
14822 <screeninfo>Cities pull down on the patron record</screeninfo>
14826 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
14831 <para>This will allow for easy entry of local cities into the patron
14832 record without risking the potential for typos or mistaken
14833 zip/postal codes.</para>
14837 <section id="roadtypes">
14838 <title>Road Types</title>
14840 <para>To standardize patron input you can define road types within
14841 your region so that when new patrons are added librarians simply have
14842 to select the road from a list instead of having to type it in.</para>
14845 <para>If you want your patrons to have their road types abbreviated
14846 all of the time then you can enter the appropriate abbreviations
14847 here, if you'd like the road types to always be spelled out you can
14848 do that here as well.</para>
14851 <section id="addroadtype">
14852 <title>Adding Road Types</title>
14854 <para>To add a road type, click 'New Road Type' and then enter the
14855 road type the way you'd like it displayed.</para>
14858 <screeninfo>New Road</screeninfo>
14862 <imagedata fileref="images/admin/patroncirc/newroad.png"/>
14867 <para>Once you submit the form, your new road type will be listed on
14868 the Road Types page</para>
14871 <screeninfo>Roads in Koha</screeninfo>
14875 <imagedata fileref="images/admin/patroncirc/roads.png"/>
14881 <section id="roadtypeonpatform">
14882 <title>Viewing Road Types on Patron Add form</title>
14884 <para>When adding or editing a patron, if you have road types
14885 defined, there will be a pull down to choose the road type
14889 <screeninfo>Road types on patron record</screeninfo>
14893 <imagedata fileref="images/admin/patroncirc/patronroad.png"/>
14901 <section id="catadmin">
14902 <title>Catalog Administration</title>
14904 <para>Set these controls before you start cataloging on your Koha
14909 <para><emphasis>Get there:</emphasis> More > Administration >
14914 <section id="marcbibframeworks">
14915 <title>MARC Bibliographic Frameworks</title>
14917 <para>Think of Frameworks as templates for creating new bibliographic
14918 records. Koha comes with some predefined frameworks that can be edited
14919 or deleted, and librarians can create their own frameworks for content
14920 specific to their libraries.</para>
14924 <para><emphasis>Get there:</emphasis> More > Administration
14925 > Catalog > MARC Bibliographic Frameworks</para>
14930 <screeninfo>Frameworks List</screeninfo>
14934 <imagedata fileref="images/admin/cataloging/frameworks.png"/>
14940 <para>Do not delete or edit the Default Framework since this will
14941 cause problems with your cataloging records - always create a new
14942 template based on the Default Framework, or alter the other
14946 <para>After clicking the 'MARC structure' link to the right of each
14947 framework you can decide how many fields you want to see on one screen
14948 by using the pagination options at the top of the table.</para>
14951 <screeninfo>Pagination options</screeninfo>
14955 <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
14960 <section id="addframework">
14961 <title>Add New Framework</title>
14963 <para>To add a new framework</para>
14967 <para>Click 'New Framework'</para>
14970 <screeninfo>Add Framework Form</screeninfo>
14974 <imagedata fileref="images/admin/cataloging/addframework.png"/>
14981 <para>Enter a code of 4 or fewer characters</para>
14985 <para>Use the Description field to enter a more detailed
14986 definition of your framework</para>
14992 <para>Click 'Submit'</para>
14996 <para>Once your Framework is added click 'MARC structure' to the
14997 right of it on the list of Frameworks</para>
15000 <screeninfo>Choose basis for new Framework</screeninfo>
15004 <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
15011 <para>You will be asked to choose a Framework to base your
15012 new Framework off of, this will make it easier than starting
15013 from scratch</para>
15019 <para>Once your Framework appears on the screen you can edit or
15020 delete each field by following the instructions for <link
15021 linkend="editsubfields">editing subfields</link></para>
15026 <section id="editframeworks">
15027 <title>Edit Existing Frameworks</title>
15029 <para>Clicking 'Edit' to the right of a Framework will only allow
15030 you to edit the Description for the Framework:</para>
15033 <screeninfo>Edit Framework</screeninfo>
15037 <imagedata fileref="images/admin/cataloging/editframework.png"/>
15042 <para>To make edits to the fields associated with the Framework you
15043 must first click 'MARC Structure' and then follow the instructions
15044 for <link linkend="editsubfields">editing subfields</link></para>
15047 <section id="addsubfieldsframework">
15048 <title>Add subfields to Frameworks</title>
15050 <para>To add a field to a Framework click the 'New Tag' button at
15051 the top of the Framework definition</para>
15054 <screeninfo>New Tag Button</screeninfo>
15058 <imagedata fileref="images/admin/cataloging/newtag.png"/>
15063 <para>This will open up a blank form for entering MARC field
15067 <screeninfo>Add a new tag to framework</screeninfo>
15071 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
15076 <para>Enter the information about your new tag:</para>
15080 <para>The 'Tag' is the MARC field number</para>
15084 <para>The 'Label for lib' is the text that will appear in the
15085 staff client when in the cataloging module</para>
15089 <para>The 'Label for OPAC' is the text that will appear in the
15090 OPAC when viewing the MARC version of the record</para>
15094 <para>If this field can be repeated, check the 'Repeatable'
15099 <para>If this field is mandatory, check the 'Mandatory'
15104 <para>If you want this field to be a pull down with limited
15105 possible answers, choose which 'Authorized value' list you want
15110 <para>When you're finished, click 'Save Changes' and you will be
15111 presented with your new field</para>
15114 <screeninfo>New tag and link to subfields</screeninfo>
15118 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
15123 <para>To the right of the new field is a link to 'Subfields,' you
15124 will need to add subfields before this tag will appear in your MARC
15125 editor. The process of entering the settings for the new subfield is
15126 the same as those found in the <link linkend="editsubfields">editing
15127 subfields in frameworks</link> section of this manual.</para>
15130 <section id="editsubfields">
15131 <title>Edit Framework Subfields</title>
15133 <para>Frameworks are made up of MARC fields and subfields. To make
15134 edits to most Frameworks you must edit the fields and subfields.
15135 Clicking 'Edit' to the right of each subfield will allow you to make
15136 changes to the text associated with the field</para>
15139 <screeninfo>Modify MARC Field</screeninfo>
15143 <imagedata fileref="images/admin/cataloging/editfield.png"/>
15150 <para>Each field has a tag (which is the MARC tag)</para>
15154 <para>The 'Label for lib' is what will show in the staff
15155 client if you have <link
15156 linkend="advancedMARCeditor">advancedMARCeditor</link> set
15157 to display labels</para>
15161 <para>The 'Label for OPAC' is what will show on the MARC
15162 view in the OPAC</para>
15166 <para>If you check 'Repeatable' then the field will have a
15167 plus sign next to it allowing you to add multiples of that
15172 <para>If you check 'Mandatory' the record will not be
15173 allowed to save unless you have a value assigned to this
15178 <para>'Authorized value' is where you define an <link
15179 linkend="authorizedvalues">authorized value</link> that your
15180 catalogers can choose from a pull down to fill this field
15187 <para>To edit the subfields associated with the tag, click
15188 'Subfields' to the right of the tag on the 'MARC Structure'
15193 <para>From the list of subfields you can click 'Delete' to the
15194 right of each to delete the subfields</para>
15198 <para>To edit the subfields click 'Edit Subfields'</para>
15201 <screeninfo>Editing the 504 Subfield</screeninfo>
15205 <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
15212 <para>For each subfield you can set the following values</para>
15216 <para>Text for librarian</para>
15220 <para>what appears before the subfield in the librarian
15227 <para>Text for OPAC</para>
15231 <para>what appears before the field in the OPAC.</para>
15235 <para>If left empty, the text for librarian is used
15244 <para>Repeatable</para>
15248 <para>the field will have a plus sign next to it
15249 allowing you to add multiples of that tag</para>
15255 <para>Mandatory</para>
15259 <para>the record will not be allowed to save unless you
15260 have a value assigned to this tag</para>
15266 <para>Managed in tab</para>
15270 <para>defines the tab where the subfield is shown. All
15271 subfields of a given field must be in the same tab or
15272 ignored. Ignore means that the subfield is not
15279 <para>Default value</para>
15283 <para>defines what you want to appear in the field by
15284 default, this will be editable, but it saves time if you
15285 use the same note over and over or the same value in a
15286 field often.</para>
15292 <para>hidden</para>
15296 <para>allows you to select from 19 possible visibility
15297 conditions, 17 of which are implemented. They are the
15302 <para>-9 => Future use</para>
15306 <para>-8 => Flag</para>
15310 <para>-7 => OPAC !Intranet !Editor
15315 <para>-6 => OPAC Intranet !Editor
15320 <para>-5 => OPAC Intranet !Editor
15325 <para>-4 => OPAC !Intranet !Editor
15330 <para>-3 => OPAC !Intranet Editor
15335 <para>-2 => OPAC !Intranet Editor
15340 <para>-1 => OPAC Intranet Editor Collapsed</para>
15344 <para>0 => OPAC Intranet Editor !Collapsed</para>
15348 <para>1 => !OPAC Intranet Editor Collapsed</para>
15352 <para>2 => !OPAC !Intranet Editor
15357 <para>3 => !OPAC !Intranet Editor
15362 <para>4 => !OPAC Intranet Editor
15367 <para>5 => !OPAC !Intranet !Editor
15372 <para>6 => !OPAC Intranet !Editor
15377 <para>7 => !OPAC Intranet !Editor
15382 <para>8 => !OPAC !Intranet !Editor
15387 <para>9 => Future use</para>
15393 <para>( ! means 'not visible' or in the case of
15394 Collapsed 'not Collapsed')</para>
15400 <para>Is a URL</para>
15404 <para>if checked, it means that the subfield is a URL
15405 and can be clicked</para>
15415 <para>If you enter a field/subfield here (200b), a link
15416 appears after the subfield in the MARC Detail view. This
15417 view is present only in the staff client, not the OPAC.
15418 If the librarian clicks on the link, a search is done on
15419 the database for the field/subfield with the same value.
15420 This can be used for 2 main topics :</para>
15424 <para>on a field like author (200f in UNIMARC), put
15425 200f here, you will be able to see all bib records
15426 with the same author.</para>
15430 <para>on a field that is a link (4xx) to reach
15431 another bib record. For example, put 011a in 464$x,
15432 will find the serials that are with this
15440 <para>This value should not change after data has been
15441 added to your catalog</para>
15448 <para>Koha link</para>
15452 <para>Koha is multi-MARC compliant. So, it does not know
15453 what the 245$a means, neither what 200$f (those 2 fields
15454 being both the title in MARC21 and UNIMARC). So, in this
15455 list you can "map" a MARC subfield to its meaning. Koha
15456 constantly maintains consistency between a subfield and
15457 its meaning. When the user want to search on "title",
15458 this link is used to find what is searched (245 if
15459 you're MARC21, 200 if you're UNIMARC).</para>
15465 <para>Authorized value</para>
15469 <para>means the value cannot by typed by the librarian,
15470 but must be chosen from a pull down generated by the
15471 <link linkend="authorizedvalues">authorized value</link>
15476 <para>In the example above, the 504a field will show the
15477 MARC504 Authorized Values when cataloging</para>
15480 <screeninfo>Example of an Authorized
15481 Subfield</screeninfo>
15485 <imagedata fileref="images/admin/cataloging/504auth.png"/>
15494 <para>Thesaurus</para>
15498 <para>means that the value is not free text, but must be
15499 searched in the authority/thesaurus of the selected
15506 <para>Plugin</para>
15510 <para>means the value is calculated or managed by a
15511 plugin. Plugins can do almost anything.</para>
15515 <para>For example, in UNIMARC there are plugins for
15516 every 1xx fields that are coded fields. The plugin is a
15517 huge help for cataloger ! There are also two plugins
15518 (unimarc_plugin_210c and unimarc_plugin_225a that can
15519 "magically" find the editor from an ISBN, and the
15520 collection list for the editor)</para>
15528 <para>To save your changes simply click the 'Save Changes'
15529 button at the top of the screen</para>
15536 <section id="importexportframeworks">
15537 <title>Import/Export Frameworks</title>
15539 <para>Next to each framework is a link to either import or export
15540 the framework.</para>
15542 <section id="exportframeworks">
15543 <title>Export Framework</title>
15545 <para>To export a framework simply click the 'Export' link to the
15546 right of framework title.</para>
15549 <screeninfo>Export link next to framework</screeninfo>
15553 <imagedata fileref="images/admin/cataloging/importexport.png"/>
15558 <para>When you click 'Export' you will be prompted to choose what
15559 format to export the file in.</para>
15562 <screeninfo>Export formats</screeninfo>
15566 <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
15571 <para>A framework exported this way can be imported into any other
15572 Koha installation using the import framework option.</para>
15575 <section id="importframeworks">
15576 <title>Import Framework</title>
15578 <para>An easy way to create a new framework is to import it from
15579 another Koha database. To import a framework you first need to
15580 create <link linkend="addframework">a new framework</link>. Once
15581 you have that framework, click 'Import' to the right of the new
15585 <screeninfo>Import link next to framework</screeninfo>
15589 <imagedata fileref="images/admin/cataloging/importexport.png"/>
15594 <para>You will be prompted to find a file on your computer to
15595 import into the framework.</para>
15598 <screeninfo>Choose a file to import</screeninfo>
15602 <imagedata fileref="images/admin/cataloging/importfile.png"/>
15607 <para>You will be asked to confirm your actions before the file is
15611 <screeninfo>Confirm your desire to import</screeninfo>
15615 <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
15620 <para>As your file is uploaded you will see an image that will
15621 confirm that the system is working.</para>
15624 <screeninfo>Import timer</screeninfo>
15628 <imagedata fileref="images/admin/cataloging/importtimer.png"/>
15633 <para>Once your import is complete you will be brought to the
15634 framework edit tool where you can make any changes you need to the
15635 framework you imported.</para>
15640 <section id="kohamarcmapping">
15641 <title>Koha to MARC Mapping</title>
15643 <para>While Koha stores the entire MARC record, it also stores common
15644 fields for easy access in various tables in the database. Koha to MARC
15645 Mapping is used to tell Koha where to find these values in the MARC
15646 record. In many cases you will not have to change the default values
15647 set by in this tool on installation, but it is important to know that
15648 the tool is here and can be used at any time.</para>
15652 <para><emphasis>Get there:</emphasis> More > Administration
15653 > Catalog > Koha to MARC Mapping</para>
15657 <para>The Koha to MARC Mapping page offers you the option of choosing
15658 from one of three tables in the database to assign values to.</para>
15661 <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
15665 <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
15670 <para>After choosing the table you would like to view, click 'OK.' To
15671 edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
15674 <screeninfo>Map MARC Field to Koha Field</screeninfo>
15678 <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
15683 <para>Choose which MARC field you would like to map to this Koha Field
15684 and click the 'OK' button. If you would like to clear all mappings,
15685 click the 'Click to "Unmap"' button.</para>
15688 <para>At this time you can map only 1 MARC field to 1 Koha field.
15689 This means that you won't be able to map both the 100a and the 700a
15690 to the author field, you need to choose one or the other.</para>
15696 <section id="keywordmapping">
15697 <title>Keywords to MARC Mapping</title>
15699 <para>This tool will allow you to map MARC fields to a set of
15700 predefined keywords.</para>
15704 <para><emphasis>Get there:</emphasis> More > Administration
15705 > Catalog > Keywords to MARC Mapping</para>
15710 <para>This tool only effects sites that are not using the XSLT
15711 Stylesheets.</para>
15714 <para>At this time the only keyword in use is 'subtitle.'</para>
15716 <para>Using this tool you can define what MARC field prints to the
15717 detail screen of the bibliographic record using keywords. The
15718 following example will use the subtitle field.</para>
15720 <para>Using the Framework pull down menu, choose the <link
15721 linkend="marcbibframeworks">Framework</link> you would like to apply
15722 this rule to. For example, the subtitle for books can be found in the
15723 245$b field.</para>
15726 <screeninfo>Assigning Book Subtitle</screeninfo>
15730 <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
15735 <para>However the subtitle for DVDs appears in 245$p</para>
15738 <screeninfo>Assigning DVD Subtitle</screeninfo>
15742 <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
15747 <para>Using this tool you can tell Koha to print the right field as
15748 the subtitle when viewing the bibliographic record in the OPAC.</para>
15751 <screeninfo>Subtitle display in the OPAC</screeninfo>
15755 <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
15760 <para>This tool can be used to chain together pieces of the record as
15761 well. If you want the series number to show in the title on your
15762 search results you simply have to map 490 $v to 'subtitle' along with
15764 <para>Chain together the fields you want to show after the item
15765 title in the order in which you want them to appear.</para>
15768 <para>Future developments will include additional keyword assigned
15772 <section id="marcbibframeworkstest">
15773 <title>MARC Bibliographic Framework Test</title>
15775 <para>Checks the MARC structure.</para>
15779 <para><emphasis>Get there:</emphasis> More > Administration
15780 > Catalog > MARC Bibliographic Framework Test</para>
15784 <para>If you change your MARC Bibliographic framework it's recommended
15785 that you run this tool to test for errors in your definition.</para>
15788 <screeninfo>Framework Test</screeninfo>
15792 <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
15798 <section id="authoritiesadmin">
15799 <title>Authority Types</title>
15801 <para>Authority Types are basically MARC Frameworks for Authority
15802 records and because of that they follow the same editing rules found
15803 in the <link linkend="marcbibframeworks">MARC Bibliographic
15804 Frameworks</link> section of this manual. Koha comes with many of the
15805 necessary Authority frameworks already installed. To learn how to add
15806 and edit Authority Types, simply review the <link
15807 linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
15808 section of this manual.</para>
15812 <para><emphasis>Get there:</emphasis> More > Administration
15813 > Catalog > Authority Types</para>
15818 <section id="classificationsources">
15822 <firstname>Savitra</firstname>
15823 <surname>Sirohi</surname>
15825 <orgname>Nucsoft OSS Labs</orgname>
15830 <firstname>Nicole C.</firstname>
15831 <surname>Engard</surname>
15832 <contrib>Fixed typos, changed content where
15833 necessary and added new screenshots.</contrib>
15837 <pubdate>2010</pubdate>
15840 <title>Classification Sources</title>
15842 <para>Source of classification or shelving scheme is an <link linkend="authorizedvalues"
15843 >Authorized Values</link> category that is mapped to field 952$2 in Koha's MARC
15844 Bibliographic frameworks and stored in the items.cn_source field in the database.</para>
15848 <para><emphasis>Get there:</emphasis> More > Administration
15849 > Catalog > Classification sources</para>
15854 <screeninfo>Classification Sources</screeninfo>
15858 <imagedata fileref="images/admin/cataloging/classsources.png"/>
15863 <para>Commonly used values of this field are:</para>
15867 <para>ddc - Dewey Decimal Classification</para>
15871 <para>lcc - Library of Congress Classification</para>
15875 <para>If you chose to install classification sources during Koha's
15876 installation, you would see other values too:</para>
15880 <para>ANSCR (sound recordings)</para>
15884 <para>SuDOC classification</para>
15888 <para>Universal Decimal Classification</para>
15892 <para>Other/Generic Classification</para>
15896 <section id="addingclasssource">
15897 <title>Adding/Editing Classification Sources</title>
15899 <para>You can add your own source of classification by using the New
15900 Classification Source button. To edit use the Edit link.</para>
15903 <screeninfo>Add classification source</screeninfo>
15907 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
15912 <para>When creating or editing:</para>
15916 <para>You will need to enter a code and a description.</para>
15920 <para>Check the 'Source in use?' checkbox if you want the value
15921 to appear in the drop down list for this category.</para>
15925 <para>Select the appropriate <link
15926 linkend="classfilingrules">filing rule</link> from the drop down
15934 <section id="classfilingrules">
15935 <title>Classification Filing Rules</title>
15937 <para>Filing rules determine the order in which items are placed on
15940 <para>Values that are pre-configured in Koha are:</para>
15952 <para>Generic</para>
15956 <para>Filing rules are mapped to <link
15957 linkend="addingclasssource">Classification sources</link>. You can
15958 setup new filing rules by using the New Filing Rule button. To edit
15959 use the Edit link.</para>
15961 <para>When creating or editing:</para>
15965 <para>Enter a code and a description</para>
15969 <para>Choose an appropriate filing routine - dewey, generic or
15976 <section id="recordmatchingrules">
15979 <firstname>Joy</firstname>
15981 <surname>Nelson</surname>
15985 <orgname>ByWater Solutions</orgname>
15988 <othercredit role="copyeditor">
15989 <firstname>Nicole C.</firstname>
15991 <surname>Engard</surname>
15993 <contrib>Changed/edited content where necessary.</contrib>
15996 <pubdate>2013</pubdate>
15998 <title>Record Matching Rules</title>
16000 <para>Record matching rules are used when importing MARC records into
16005 <para><emphasis>Get there:</emphasis> More > Administration
16006 > Catalog > Record Matching Rules</para>
16010 <para>The rules that you set up here will be referenced with you <link linkend="stagemarc">Stage MARC Records for Import</link>.</para>
16011 <para>It is important to understand the difference between Match Points and Match Checks
16012 before adding new matching rules to Koha.</para>
16014 <para>Match Points are the criteria that you enter that must be met in order for an incoming
16015 record to match an existing MARC record in your catalog. You can have multiple match
16016 points on an import rule each with its own score. An incoming record will be compared
16017 against your existing records (‘one record at a time’) and given a score for each match
16018 point. When the total score of the matchpoints matches or exceeds the threshold given for
16019 the matching rule, Koha assumes a good match and imports/overlays according your
16020 specifications in the import process. An area to watch out for here is the sum of the
16021 match points. Doublecheck that the matches you want will add up to a successful
16024 <para>Example: </para>
16025 <para>Threshold of 1000 </para>
16026 <para>Match Point on 020$a 1000 </para>
16027 <para>Match Point on 022$a 1000 </para>
16028 <para>Match Point on 245$a 500 </para>
16029 <para>Match Point on 100$a 100</para>
16031 <para>In the example above, a match on either the 020$a or the 022$a will result in a successful match. A match on 245$a title and 100$a author (and not on 020$a or 022$a) will only add up to 600 and not be a match. And a match on 020$a and 245$a will result in 1500 and while this is a successful match, the extra 500 point for the 245$a title match are superfluous. The incoming record successfully matched on the 020$a without the need for the 245$a match. However, if you assigned a score of 500 to the 100$a Match Point, a match on 245$a title and 100$a author will be considered a successful match (total of 1000) even if the 020$a is not a match.</para>
16033 <para>Match Checks are not commonly used in import rules. However, they can serve a couple of
16034 purposes in matching records. First, match checks can be used as the matching criteria
16035 instead of the match points if your indexes are stale and out of date. The match checks go
16036 right for the data instead of relying on the data in the indexes. (If you fear your
16037 indexes are out of date, a rebuild of your indexes would be a great idea and solve that
16038 situation!) The other use for a Match Check is as a “double check” or “veto” of your
16039 matching rule. For example, if you have a matching rule as below:</para>
16040 <para>Threshold of 1000 </para>
16041 <para>Match Point on 020$a 1000 </para>
16042 <para>Match Check on 245$a</para>
16044 <para>Koha will first look at the 020$a tag/subfield to see if the incoming record matches an existing record. If it does, it will then move on to the Match Check and look directly at the 245$a value in the incoming data and compare it to the 245$a in the existing ‘matched’ record in your catalog. If the 245$a matches, Koha continues on as if a match was successful. If the 245$a does not match, then Koha concludes that the two records are not a match after all. The Match Checks can be a really useful tool in confirming true matches.</para>
16046 <para>Match Points and Match Checks are powerful tools in the import process. Harness the power of these two matching criteria and make your data behave for you!</para>
16047 <section id="addrecordmatchrule">
16048 <title>Adding Matching Rules</title>
16049 <para>To create a new matching rule :</para>
16052 <para>Click 'New Record Matching Rule'</para>
16054 <screeninfo>Add record matching rule</screeninfo>
16057 <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
16063 <para>Choose a unique name and enter it in the 'Matching rule code' field</para>
16066 <para>'Description' can be anything you want to make it clear to you what rule
16067 you're picking</para>
16070 <para>'Match threshold' - The total number of 'points' a biblio must earn to be
16071 considered a 'match'</para>
16074 <para>Match points are set up to determine what fields to match on</para>
16077 <para>'Search index' can be found by looking at the ccl.properties file on your
16078 system which tells the zebra indexing what data to search for in the MARC
16082 <para>'Score' - The number of 'points' a match on this field is worth. If the sum
16083 of each score is greater than the match threshold, the incoming record is a
16084 match to the existing record</para>
16087 <para>Enter the MARC tag you want to match on in the 'Tag' field</para>
16090 <para>Enter the MARC tag subfield you want to match on in the 'Subfields'
16094 <para>'Offset' - For use with control fields, 001-009</para>
16097 <para>'Length' - For use with control fields, 001-009</para>
16100 <para>Koha only has one 'Normalization rule' that removes extra characters such as
16101 commas and semicolons. The value you enter in this field is irrelevant to the
16102 normalization process.</para>
16105 <para>'Required match checks' - ??</para>
16112 <section id="samplerecordmatch">
16113 <title>Sample Record Matching Rule: Control Number</title>
16116 <screeninfo>LOC Matching Rule</screeninfo>
16120 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
16127 <para>Match threshold: 100</para>
16131 <para>Matchpoints (just the one):</para>
16135 <para>Search index: Control-number</para>
16139 <para>Score: 101</para>
16143 <para>Tag: 001</para>
16148 <para>this field is for the control number assigned by the
16149 organization creating, using, or distributing the
16157 <para>Subfields: a</para>
16161 <para>Offset: 0</para>
16165 <para>Length: 0</para>
16169 <para>Normalization rule: Control-number</para>
16173 <para>Required Match checks: none (remove the blank one)</para>
16176 <screeninfo>Remove match check</screeninfo>
16180 <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
16189 <section id="oaisetsconfig">
16190 <title>OAI Sets Configuration</title>
16192 <para>On this page you can create, modify and delete OAI-PMH
16195 <section id="oaicreate">
16196 <title>Create a set</title>
16198 <para>To create a set:</para>
16202 <para>Click on the link 'Add a new set'</para>
16206 <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
16210 <para>Then you can add descriptions for this set. To do this
16211 click on 'Add description' and fill the newly created text box.
16212 You can add as many descriptions as you want.</para>
16216 <para>Click on 'Save' button'</para>
16221 <section id="oaimodify">
16222 <title>Modify/Delete a set</title>
16224 <para>To modify a set, just click on the link 'Modify' on the same
16225 line of the set you want to modify. A form similar to set creation
16226 form will appear and allow you to modify the setSpec, setName and
16227 descriptions.</para>
16229 <para>To delete a set, just click on the link 'Delete' on the same
16230 line of the set you want to delete.</para>
16233 <section id="oaimapping">
16234 <title>Define mappings</title>
16236 <para>Here you can define how a set will be build (what records will
16237 belong to this set) by defining mappings. Mappings are a list of
16238 conditions on record content. A record only need to match one
16239 condition to belong to the set.</para>
16243 <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
16244 example if you want to include in this set all records that have
16245 a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
16246 and 'Value' with XXX.</para>
16250 <para>If you want to add another condition, click on 'OR' button
16251 and repeat step 1.</para>
16255 <para>Click on 'Save'</para>
16259 <para>To delete a condition, just leave at least one of 'Field',
16260 'Subfield' or 'Value' empty and click on 'Save'.<note>
16261 <para>Actually, a condition is true if value in the
16262 corresponding subfield is strictly equal to what is defined if
16263 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
16264 set where condition is 999$9 = 'XXX'.</para>
16267 <para>And it is case sensitive : a record having 999$9 = 'xxx' will
16268 not belong to a set where condition is 999$9 = 'XXX'.</para>
16271 <section id="oaibuild">
16272 <title>Build sets</title>
16274 <para>Once you have configured all your sets, you have to build the
16275 sets. This is done by calling the script
16276 misc/migration_tools/build_oai_sets.pl.</para>
16281 <section id="acqadmin">
16282 <title>Acquisitions</title>
16284 <para>The Koha Acquisitions module provides a way for the library to
16285 record orders placed with vendors and manage purchase budgets.</para>
16287 <para>Before using the <link linkend="acqmodule">Acquisitions
16288 Module</link>, you will want to make sure that you have completed all of
16293 <para><emphasis>Get there:</emphasis> More > Administration >
16294 Acquisitions</para>
16298 <section id="currexchangeadmin">
16299 <title>Currencies and Exchange Rates</title>
16301 <para>If you place orders from more than one country you will want to
16302 input currency exchange rates so that your acquisitions module will
16303 properly calculate totals.</para>
16307 <para><emphasis>Get there:</emphasis> More > Administration
16308 > Acquisitions > Currencies and Exchange Rates</para>
16313 <screeninfo>Currencies</screeninfo>
16317 <imagedata fileref="images/admin/acquisitions/currencies.png"/>
16323 <para>This data is not automatically updated, so be sure to keep it
16324 up to date so that your accounting is kept correct.</para>
16327 <para>The active currency is the main currency you use in your
16328 library. Your active currency will have a check mark in the 'Active'
16329 column. If you don't have an active currency you will see an error
16330 message telling you to choose an active currency.</para>
16333 <screeninfo>No active currency warning</screeninfo>
16337 <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
16343 <section id="budgetplanning">
16344 <title>Budgets</title>
16346 <para>Budgets are used for tracking accounting values related to
16347 acquisitions. For example you could create a Budget for the current
16348 year (ex. 2012) and then break that into <link
16349 linkend="funds">Funds</link> for different areas of the library (ex.
16350 Books, Audio, etc).</para>
16354 <para><emphasis>Get there:</emphasis> More > Administration
16355 > Acquisitions > Budgets</para>
16359 <para>When visiting the main budget administration you will see two
16360 tabs, one for active and one for inactive budgets.</para>
16363 <screeninfo>Budgets List</screeninfo>
16367 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
16372 <section id="addbudget">
16373 <title>Add a budget</title>
16375 <para>Budgets can either be created from scratch or by duplicating
16376 the previous year's budget.</para>
16378 <para>To duplicate a budget from a previous year, click on the link
16379 for the budget name from the list of budgets</para>
16382 <screeninfo>Budgets List</screeninfo>
16386 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
16391 <para>On the screen listing the budget breakdown click the Edit
16392 button at the top and choose to Duplicate budget</para>
16395 <screeninfo>Duplicate Budget</screeninfo>
16399 <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
16404 <para>You will be presented with a form where you simply need to
16405 enter the new start and end date and save the budget.</para>
16408 <screeninfo>New Duplicate Budget</screeninfo>
16412 <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
16417 <para>This will not only duplicate your budget, but all of the funds
16418 associated with that budget so that you can reuse budgets and funds
16419 from year to year.</para>
16421 <para>If you haven't used Koha before for acquisitions then you'll
16422 need to start fresh with a new budget. To add a new budget click the
16423 'New Budget' button.</para>
16426 <screeninfo>New Budget Form</screeninfo>
16430 <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
16437 <para>Choose the time period this budget is for, whether it's an
16438 academic year, a fiscal year, a quarter, etc.</para>
16442 <para>The Description should be something that will help you
16443 identify the budget when ordering</para>
16447 <para>In the amount box do not use any symbols, simply enter the
16448 amount of the budget with numbers and decimals.</para>
16452 <para>Marking a budget active makes it usable when placing
16453 orders in the acquisitions module, even if the order is placed
16454 after the budget end date. This will allow you to record orders
16455 that were places in a previous budget period.</para>
16459 <para>Locking a budget means that Funds will not be able to be
16460 modified by librarians</para>
16464 <para>Once you have made your edits, click the 'Save Changes'
16465 button. You will be brought to a list of your existing
16469 <screeninfo>List of Budgets</screeninfo>
16473 <imagedata fileref="images/admin/acquisitions/budgetlist.png"/>
16480 <section id="funds">
16481 <title>Funds</title>
16485 <para><emphasis>Get there:</emphasis> More > Administration
16486 > Acquisitions > Funds</para>
16490 <section id="addbudgetfund">
16491 <title>Add a Fund</title>
16493 <para>A fund is added to a budget.</para>
16496 <para>A <link linkend="addbudget">budget</link> must be defined
16497 before a fund can be created.</para>
16498 </important>To add a new fund click the New button and then choose
16499 which Budget you would like to add the fund to.</para>
16502 <screeninfo>Choose which budget to add a fund to</screeninfo>
16506 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
16511 <para>In the form that appears you wan to enter the basics about
16515 <screeninfo>New Fund Form</screeninfo>
16519 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
16524 <para>The three first fields are required, the rest are
16529 <para>Fund Code is a unique identifier for your fund</para>
16533 <para>The Fund Name should be something that librarians will
16538 <para>Amount should be entered with only numbers and decimals,
16539 no other characters</para>
16543 <para>You can choose to assign this fund to a librarian. Doing
16544 so will make it so that only that librarian can make changes to
16549 <para>Choose which library will be using this fund</para>
16553 <para>You can restrict who can order from this fund by choosing
16554 either the owner or the library from the 'Restrict access to'
16558 <screeninfo>Restrict Fund Access</screeninfo>
16562 <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
16569 <para>Notes are simply for any descriptive notes you might want
16570 to add so that librarians know when to use this fund</para>
16574 <para>Planning categories are used for statistical purposes. To
16575 learn more about planning categories, check out the <link
16576 linkend="planningcatfaq">Planning Category FAQ</link>.</para>
16580 <para>When complete, click 'Submit' and you will be brought to a
16581 list of all of the funds for the budget.</para>
16584 <screeninfo>List of funds</screeninfo>
16588 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
16593 <para>To the right of each fund you will find the 'Edit,' 'Delete,' and 'Add Child Fund'
16595 <para>A child fund simply a sub-fund of the fund listed. An example would be to have a
16596 fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science
16597 Fiction.' It is an optional way to further organize your finances.</para>
16598 <para>Funds with children will show with a small arrow to the left. Clicking that will
16599 show you the children funds.<screenshot>
16600 <screeninfo>Chld funds</screeninfo>
16603 <imagedata fileref="images/admin/acquisitions/childfunds.png"/>
16606 </screenshot></para>
16609 <section id="fundsplanning">
16610 <title>Budget Planning</title>
16612 <para>When viewing the list of funds click the 'Planning' button and
16613 choose how you would like to plan to spend your budget.</para>
16616 <screeninfo>Planning pull down menu</screeninfo>
16620 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
16625 <para>If you choose 'Plan by MONTHS' you will see the budgeted
16626 amount broken down by months:</para>
16629 <screeninfo>Budget Planning Formula</screeninfo>
16633 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
16638 <para>To hide some of the columns you can click the 'hide' link to the right (or below as
16639 in the screenshot above) the dates. To add more columns you can click the 'Show a
16640 column' link found below the 'Fund Remaining' heading.</para>
16643 <screeninfo>Choose columns to add</screeninfo>
16647 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
16652 <para>From here you can plan your budget spending by manually
16653 entering values or by clicking the 'Auto-fill row' button. If you
16654 choose to auto-fill the form the system will try to divide the
16655 amount accordingly, you may have to make some edits to split things
16656 more accurately.</para>
16659 <screeninfo>Auto-filled columns</screeninfo>
16663 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
16668 <para>Once your changes are made, click the 'Save' button. If you
16669 would like to export your data as a CSV file you can do so by
16670 entering a file name in the 'Output to a file named' field and
16671 clicking the 'Output' button.</para>
16674 <screeninfo>Export planning as CSV</screeninfo>
16678 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
16686 <section id="additionaladmin">
16687 <title>Additional Parameters</title>
16691 <para><emphasis>Get there:</emphasis> More > Administration >
16692 Additional Parameters</para>
16696 <section id="z3950admin">
16697 <title>Z39.50 Servers</title>
16699 <para>Koha has a powerful copy cataloging tool. Using Koha you can
16700 connect to any Z39.50 target that is publicly available or that you
16701 have the log in information to.</para>
16705 <para><emphasis>Get there:</emphasis> More > Administration
16706 > Additional Parameters > Z39.50 Servers</para>
16710 <para>Koha comes with a default list of Z39.50 targets set up that you
16711 can add to, edit or delete</para>
16714 <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
16718 <imagedata fileref="images/admin/additional/z39list.png"/>
16723 <para>To find additional targets you use IndexData's IRSpy: <ulink
16724 url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink></para>
16726 <section id="addztarget">
16727 <title>Add a Z39.50 Target</title>
16731 <para>From the main Z39.50 page, click 'New Z39.50
16736 <para>Userid and Password are only required for servers that
16737 are password protected</para>
16742 <screeninfo>New Z39.50 Server Form</screeninfo>
16746 <imagedata fileref="images/admin/additional/newz39.png"/>
16754 <section id="suggestztarget">
16755 <title>Suggested Z39.50 Targets</title>
16757 <para>The following targets have been used successfully by other
16758 Koha libraries (in the Americas):</para>
16762 <para>ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC</para>
16765 <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
16770 <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
16774 <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
16779 <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
16783 <para>LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB</para>
16787 <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
16792 <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
16796 <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
16800 <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</para>
16803 <para>NHUPAC 199.192.6.130:211 nh_nhupac</para>
16806 <para>OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC</para>
16809 <para>OHIOLINK olc1.ohiolink.edu:210 INNOPAC</para>
16812 <para>PUBCAT prod890.dol.state.vt.us:2300 unicorn</para>
16815 <para>SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER</para>
16818 <para>SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON</para>
16822 <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
16827 <para>TRI-UNI 129.97.129.194:7090 voyager</para>
16831 <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
16836 <section id="didyoumean">
16837 <title>Did you mean?</title>
16838 <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters
16839 > Did you mean?</para>
16840 <para>Koha can offer 'Did you mean?' options on searches based on values in your <link linkend="catauthorities">authorities</link>. <important>
16841 <para>Did you mean? only works in the OPAC at this time. The Intranet options are here
16842 for future development.</para>
16843 </important></para>
16844 <para>Using this page you can control which options Koha gives patrons on their search results.<screenshot>
16845 <screeninfo>Did you mean?</screeninfo>
16848 <imagedata fileref="images/admin/additional/didyoumean.png"/>
16851 </screenshot></para>
16852 <para>To turn on the 'Did you mean?' bar on your search results you need to check the box
16853 next to each plugin you would like to use. The two plugins you have to choose from are:<itemizedlist>
16855 <para>The ExplodedTerms plugin suggests that the user try searching for
16856 broader/narrower/related terms for a given search (e.g. a user searching for "New
16857 York (State)" would click the link for narrower terms if they're also interested in
16858 "New York (City)"). This is only relevant for libraries with highly hierarchical
16859 authority data. </para>
16862 <para>The AuthorityFile plugin searches the authority file and suggests the user might
16863 be interested in bibs linked to the top 5 authorities</para>
16865 </itemizedlist></para>
16866 <para>If you want one plugin to take priority over another you simply drag it above the other.<screenshot>
16867 <screeninfo>Drag and drop options</screeninfo>
16870 <imagedata fileref="images/admin/additional/didyoumeandrag.png"/>
16873 </screenshot></para>
16874 <para>If you choose both plugins you will see several options at the top of your search results<screenshot>
16875 <screeninfo>Both plugins</screeninfo>
16878 <imagedata fileref="images/admin/additional/didyoumeanopacexplode.png"/>
16881 </screenshot></para>
16882 <para>If you choose just the AuthorityFile you'll see just authorities.<screenshot>
16883 <screeninfo>AuthorityFile</screeninfo>
16886 <imagedata fileref="images/admin/additional/didyoumeanopacauth.png"/>
16889 </screenshot></para>
16894 <chapter id="tools">
16895 <title>Tools</title>
16897 <para>Tools in Koha all perform some sort of action. Often many of the
16898 items listed under Tools in Koha are referred to as 'Reports' in other
16899 library management systems.</para>
16903 <para><emphasis>Get there:</emphasis> More > Tools</para>
16907 <section id="patrontools">
16908 <title>Patrons and Circulation</title>
16912 <section id="comments">
16913 <title>Comments</title>
16917 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16918 and Circulation > Comments</para>
16922 <para>All comments added by patrons via the OPAC to bibliographic
16923 records require moderation by the librarians. If there are comments
16924 awaiting moderation they will be listed on the main staff dashboard
16925 under the Tools label:</para>
16928 <screeninfo>Comments pending approval</screeninfo>
16932 <imagedata fileref="images/tools/comments/commentswaiting.png"/>
16937 <para>To moderate comments click on the notification on the main
16938 dashboard or go directly to the Comments Tool and click 'Approve' or
16939 'Delete' to the right of the comments awaiting moderation.</para>
16942 <screeninfo>Comment awaiting moderation</screeninfo>
16946 <imagedata fileref="images/tools/comments/commentmoderation.png"/>
16951 <para>If there are no comments to moderate you will see a message
16952 saying just that</para>
16955 <screeninfo>No comments to moderate</screeninfo>
16959 <imagedata fileref="images/tools/comments/nocomments.png"/>
16964 <para>You can also review and unapprove comments you have approved in
16965 the past by choosing the 'Approved comments' tab</para>
16968 <screeninfo>Approved comments</screeninfo>
16972 <imagedata fileref="images/tools/comments/commentapproved.png"/>
16978 <section id="patronimport">
16979 <title>Patron Import</title>
16983 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16984 and Circulation > Import Patrons</para>
16988 <para>The patron import tool can be used at any time to add patrons in
16989 bulk. It is commonly used in universities and schools when a new batch
16990 of students registers.</para>
16992 <section id="createpatronfile">
16993 <title>Creating Patron File</title>
16995 <para>Your Koha installation comes with a blank CSV file that you
16996 can use as a template for your patron records. If you would like to
16997 create the file yourself, make sure that your file has the following
16998 fields in this order as the header row:</para>
17000 <para>borrowernumber, cardnumber, surname, firstname, title,
17001 othernames, initials, streetnumber, streettype, address, address2,
17002 city, zipcode, country, email, phone, mobile, fax, emailpro,
17003 phonepro, B_streetnumber, B_streettype, B_address, B_address2,
17004 B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth,
17005 branchcode, categorycode, dateenrolled, dateexpiry, gonenoaddress,
17006 lost, debarred, contactname, contactfirstname, contacttitle,
17007 guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
17008 password, flags, userid, opacnote, contactnote, sort1, sort2,
17009 altcontactfirstname, altcontactsurname, altcontactaddress1,
17010 altcontactaddress2, altcontactaddress3, altcontactzipcode,
17011 altcontactcountry, altcontactphone, smsalertnumber,
17012 patron_attributes</para>
17015 <para>The 'password' value should be stored in plain text, and
17016 will be converted to a md5 hash (which is an encrypted version of
17017 the password).</para>
17021 <para>If your passwords are already encrypted, talk to your
17022 systems administrator about options</para>
17028 <para>Date formats should match your <link
17029 linkend="dateformat">system preference</link>, and must be
17030 zero-padded, e.g. '01/02/2008'.</para>
17034 <para>The fields 'branchcode' and 'categorycode' are required and
17035 must match valid entries in your database.</para>
17039 <para>If loading <link linkend="patronattributetypes">patron
17040 attributes</link>, the 'patron_attributes' field should contain a
17041 comma-separated list of attribute types and values.</para>
17045 <para>The attribute type code and a colon should precede each
17050 <para>For example: <emphasis
17051 role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis
17052 role="bold">STARTDATE:January 1
17053 2010,TRACK:Day</emphasis></para>
17057 <para>If an input record has more than one attribute, the
17058 fields should either be entered as an unquoted string
17059 (previous examples), or with each field wrapped in
17060 separate double quotes and delimited by a comma:</para>
17064 <para><emphasis role="bold">"STARTDATE:January 1,
17065 2010","TRACK:Day"</emphasis></para>
17069 <para>This syntax would be required if the data might
17070 have a comma in it, like a date string.</para>
17080 <section id="importpatrons">
17081 <title>Importing Patrons</title>
17083 <para>Once you have created your file, you can use the Patron Import
17084 Tool to bring the data into Koha.</para>
17087 <screeninfo>Import Patron Form</screeninfo>
17091 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
17098 <para>Choose your CSV file and choose to match on 'Cardnumber'
17099 to prevent adding of duplicate card numbers to the system</para>
17103 <para>Next you can choose default values to apply to all patrons
17104 you are importing</para>
17108 <para>ex. If you're importing patrons specific to one branch
17109 you can use the field on the Import form to apply the branch
17110 code to all those you are importing.</para>
17116 <para>Finally you need to decide on what data you want to
17117 replace if there are duplicates.</para>
17120 <screeninfo>Record matching options</screeninfo>
17124 <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
17131 <para>A matching record is found using the field you chose
17132 for matching criteria to prevent duplication</para>
17136 <para>If you included patron attributes in your file you can
17137 decide whether to add your values to existing values or
17138 erase existing values and enter only your new values.</para>
17146 <section id="notices">
17147 <title>Notices & Slips</title>
17151 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17152 and Circulation > Notices & Slips</para>
17156 <para>All notices and circulation receipts (or slips) generated by
17157 Koha can be customized using the Notices & Slips Tool. The system
17158 comes with several predefined templates that will appear when you
17159 first visit this tool.</para>
17162 <screeninfo>Notices & Slips Tool</screeninfo>
17166 <imagedata fileref="images/tools/notices/notices.png"/>
17171 <para>Each notice can be edited, but only a few can be deleted, this
17172 is to prevent system errors should a message try to send without a
17173 template. Each notice and slip can be edited on a per library basis,
17174 by default you will see the notices for all libraries.</para>
17176 <para>If you have a style you'd like applied to all slips you can
17177 point the <link linkend="SlipCSS">SlipCSS</link> preference to a
17178 stylesheet. The same is true for notices, using the <link
17179 linkend="NoticeCSS">NoticeCSS</link> preference to define a
17182 <section id="addnotices">
17183 <title>Adding Notices & Slips</title>
17185 <para>To add a new notice or slip</para>
17189 <para>Click 'New Notice'</para>
17192 <screeninfo>New Notice Form</screeninfo>
17196 <imagedata fileref="images/tools/notices/newnotice.png"/>
17203 <para>Choose which library this notice or slip is for</para>
17207 <para>Choose the module this notice is related to</para>
17211 <para>The Code is limited to 20 characters</para>
17216 <para>When working with the overdue notices you want each
17217 notice at each branch to have a unique code. Think about
17218 using the branch code in front of the notice code for each
17226 <para>Use the name field to expand on your Code</para>
17231 <para>With overdue notices, be sure to put your branch
17232 name in the description as well so that it will be visible
17233 when setting up your <link
17234 linkend="noticetriggers">triggers</link>.</para>
17241 <para>If you plan on writing the notice or slip in HTML check
17242 the 'HTML Message' box, otherwise the content will be generated
17243 as plain text</para>
17247 <para>Message Subject is what will appear in the subject line of
17252 <para>In the message body feel free to type whatever message you
17253 feel is best, use the fields on the left hand side to enter
17254 individualized data from the from database.</para>
17259 <para>Overdue notices can use
17260 <<items.content>> tags by themselves, or use
17261 <item></item> to span all of the tags. Learn
17262 more about the <link linkend="noticemarkup">Overdue Notice
17263 Markup</link></para>
17267 <para>On overdue notices make sure to use
17268 <<items.content>> tags to print out the
17269 data related to all items that are overdue.</para>
17275 <para>The other option, only for overdue notices, is
17276 to use the <item></item> tags to span the
17277 line so that it will print out multiple lines One
17278 example for the <item></item> tag option
17281 <para><item>"<<biblio.title>>" by
17282 <<biblio.author>>, <<items.itemcallnumber>>,
17283 Barcode: <<items.barcode>> , Checkout date:
17284 <<issues.issuedate>>, Due date:
17285 <<issues.date_due>> Fine: <<items.fine>> Due date:
17286 <<issues.date_due>> </item></para>
17294 <para>Only the overdue notices take advantage of the
17295 <item></item> tags, all other notices
17296 referencing items need to use
17297 <<items.content>></para>
17302 <para>To add today's date you can use the <<today>> syntax</para>
17309 <section id="noticemarkup">
17310 <title>Overdue Notice Markup</title>
17312 <para>When creating your overdue notices there are two tags in
17313 addition to the various database fields that you can use in your
17314 notices.<important>
17315 <para>These new tags only work on the overdue notices, not
17316 other circulation related notices at this time.</para>
17317 </important></para>
17321 <para><item></item> which should enclose all
17322 fields from the biblio, biblioitems, and items tables.</para>
17326 <para><fine></fine> which should be enclosed by
17327 the item tag and should enclose a currency identifier per ISO
17328 4217. If this tag is present with a proper identifier, the
17329 fine for that item will be displayed in the proper currency
17334 <para>Note: ISO 4217 changes from time to time therefore
17335 all currencies may not be supported. If you find one that
17336 is not supported, please file a bug with the
17337 Locale::Currency::Format author Tan D Nguyen <tnguyen
17338 at cpan doe org>.</para>
17344 <para>An example of using these two tags in a notice template
17345 might be like:</para>
17347 <programlisting> The following item(s) is/are currently overdue:
17349 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item></programlisting>
17351 <para>Which, assuming two items were overdue, would result in a
17352 notice like:<programlisting> The following item(s) is/are currently overdue:
17354 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
17355 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</programlisting></para>
17359 <section id="existingnotices">
17360 <title>Existing Notices & Slips</title>
17362 <para>Among the default notices are notices for several common
17363 actions within Koha. All of these notices can be customized by
17364 altering their text via the Notices & Slips tool and their style
17365 using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
17366 define a stylesheet. Here are some of what those notices do</para>
17370 <para id="ACCTDETAILS">ACCTDETAILS</para>
17374 <para>Sent to patrons when their account is set up if the
17375 <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
17376 preference is set to 'Send'</para>
17382 <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
17386 <para>Used in the claim acquisition module</para>
17390 <para><emphasis>Get there:</emphasis> More > Acquisitions
17391 > Late issues</para>
17397 <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
17401 <para>This notice is used if two criteria are met:</para>
17406 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
17407 is set to 'Allow'</para>
17411 <para>The patron has requested to receive this
17416 <para><emphasis>Get there: </emphasis>OPAC >
17417 Login > my messaging</para>
17421 <para><emphasis>Get there: </emphasis>Staff Client
17422 > Patron Record > <link
17423 linkend="patnotices">Notices</link></para>
17431 <para>When this notice references the branches table it is
17432 referring to the pickup branch information.</para>
17438 <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
17439 that a hold has been placed)</para>
17443 <para>This notice requires the <link
17444 linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
17445 system preference to be set to 'Enable'</para>
17449 <para>When this notice references the branches table it is
17450 referring to the pickup branch information.</para>
17456 <para id="HOLD_PRINT">HOLD_PRINT (Printed notice when hold
17457 available for pickup)</para>
17461 <para>This notice is used for hold confirmation notices that
17462 are sent out in print format. This will not effect what the
17463 email notice looks like.</para>
17467 <para>When this notice references the branches table it is
17468 referring to the pickup branch information.</para>
17474 <para id="ODUE">ODUE (Overdue Notice)</para>
17478 <para>This notice is used to send Overdue Notices to
17483 <para>See a <link linkend="samplenotice">Sample Overdue
17484 Notice</link></para>
17488 <para>Requires that you set <link
17489 linkend="noticetriggers">Overdue Notice/Status
17490 Triggers</link></para>
17496 <para id="RLIST">RLIST (Routing List)</para>
17500 <para>Used in the serials module to notify patrons/staff of
17501 new issues of a serial</para>
17505 <para><emphasis>Get there:</emphasis> More > Serials
17506 > <link linkend="newsubscription">New
17507 Subscription</link></para>
17513 <para>You have the option to select the 'Routing List'
17514 notice when creating a new subscription (Choose from the
17515 'Patron notification' drop down).</para>
17520 <para>Notice also that if you'd like to notify patrons of
17521 new serial issues, you can click on 'define a notice'
17522 which will take you to the 'Notices' tool</para>
17529 <para>There are also a set of predefined slips (or receipts) listed
17530 on this page. All of these slips can be customized by altering their
17531 text via the Notices & Slips tool and their style using the
17532 <link linkend="SlipCSS">SlipCSS</link> preference to define a
17533 stylesheet. Here is what those slips are used for:</para>
17537 <para>ISSUEQSLIP</para>
17541 <para>Used to print the quick slip in circulation</para>
17545 <para>The quick slip only includes items that were checked
17552 <para>ISSUESLIP</para>
17556 <para>Used to print a full slip in circulation</para>
17560 <para>The slip or receipt will show items checked out today
17561 as well as items that are still checked out</para>
17567 <para>RESERVESLIP</para>
17571 <para>Used to print a holds slip</para>
17575 <para>The holds slip is generated when a hold is
17582 <para>TRANSFERSLIP</para>
17586 <para>Used to print a transfer slip</para>
17590 <para>The transfer slip is printed when you confirm a
17591 transfer from one branch to another in your system</para>
17599 <section id="noticetriggers">
17600 <title>Overdue Notice/Status Triggers</title>
17604 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17605 and Circulation > Overdue Notice/Status Triggers</para>
17609 <para>In order to send the overdue notices that you defined using the
17610 <link linkend="notices">Notices</link> tool, you need to first set the
17611 triggers to have these messages.</para>
17614 <para>In order to have overdue notices sent to your patrons, you
17615 need to <link linkend="addingpatroncat">set that patron
17616 category</link> to require overdue notices.</para>
17619 <para>The Overdue Notice/Status Triggers tool gives the librarian the
17620 power to send up to three notices to each patron type notifying them
17621 of overdue items</para>
17624 <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
17628 <imagedata fileref="images/tools/triggers.png"/>
17635 <para>Delay is the number of days after an issue is due before an
17636 action is triggered.</para>
17641 <para>If you want Koha to trigger an action (send a letter
17642 or restrict member), a delay value is required.</para>
17649 <para>To send additional notices, click on the tabs for 'Second'
17650 and 'Third' notice</para>
17654 <para>If you would like to prevent a patron from checking items
17655 out because of their overdue items, check the 'Restrict' box, this
17656 will put a notice on the patron's record at checkout informing the
17657 librarian that the patron cannot check out due to overdue
17662 <para>See a <link linkend="samplenotice">Sample Overdue
17663 Notice</link></para>
17668 <section id="patroncardcreator">
17669 <title>Patron Card Creator</title>
17673 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17674 and Circulation > Patron Card Creator</para>
17678 <para>The Patron Card Creator allow you to use layouts and templates
17679 which you design to print a nearly unlimited variety of patron cards
17680 including barcodes. Here are some of the features of the Patron Card
17681 Creator module:</para>
17685 <para>Customize patron card layouts</para>
17689 <para>Design custom card templates for printed patron cards</para>
17693 <para>Build and manage batches of patron cards</para>
17697 <para>Export single or multiple batches</para>
17701 <para>Export single or multiple patron cards from within a
17706 <para>Export card data as a PDF readable by any standard PDF
17707 reader, making patron cards printable directly on a printer</para>
17711 <para>At the top of each screen within the Patron Card Creator, you
17712 will see a toolbar allowing quick access to relevant functions. The
17713 menu to the left of each screen also allows easy access to the
17714 different sections of the Patron Card Creator. The bread crumb trail
17715 near the top of each screen will give specific indication as to where
17716 you are within the Patron Card Creator module and allow quick
17717 navigation to previously traversed sections. And finally, you can find
17718 more detailed information on each section of the Patron Card Creator
17719 by clicking the online help link at the upper left-hand corner of
17722 <section id="patrontemplate">
17723 <title>Templates</title>
17727 <para><emphasis>Get there:</emphasis> More > Tools >
17728 Patron Card Creator > Templates</para>
17732 <para>A template is the label/card stock you are using. This might
17733 be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
17734 Avery 28371 for your patron cards, just to give a couple of
17735 examples. These labels will include all of the information you will
17736 need for setting up a Koha, this information may be on the
17737 packaging, and if not it can usually be found on the vendor's
17740 <section id="addcardtemplate">
17741 <title>Add a Template</title>
17743 <para>To add a new template, you want to click on the 'Templates'
17744 button at the top of your page and choose 'New Template'</para>
17747 <screeninfo>New Template Button</screeninfo>
17751 <imagedata fileref="images/tools/patroncards/newtemplate.png"/>
17756 <para>Using the form that appears you can define the template for
17757 your sheet of labels or cards.</para>
17760 <screeninfo>Add Patron Card Template</screeninfo>
17764 <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
17771 <para>Template ID will be automatically generated after saving
17772 your template, this is simply a system generated unique
17777 <para>Template Code should be something you can use to
17778 identify your template on a list of templates</para>
17782 <para>You can use the Template Description to add additional
17783 information about the template</para>
17787 <para>The Units pull down is used to define what measurement
17788 scale you're going to be using for the template. This should
17789 probably match the unit of measurement used on the template
17790 description provided by the product vendor.</para>
17793 <screeninfo>Measurement Units</screeninfo>
17797 <imagedata fileref="images/tools/patroncards/units.png"/>
17804 <para>The measurements can be found on the vendor product
17805 packaging or website.</para>
17809 <para>A profile is a set of "adjustments" applied to a given
17810 template just prior to printing which compensates for
17811 anomalies unique and peculiar to a given printer (to which the
17812 profile is assigned).</para>
17816 <para>Before picking a profile try printing some sample
17817 cards so that you can easily define a profile that is
17818 right for your printer/template combination.</para>
17822 <para>After finding any anomalies in the printed document,
17823 <link linkend="addcardprofile">create a profile</link> and
17824 assign it to the template.</para>
17830 <para>After saving, your templates will appear on the 'Manage
17831 Templates' page.</para>
17834 <screeninfo>Manage Templates</screeninfo>
17838 <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
17845 <section id="patronprofile">
17846 <title>Profiles</title>
17850 <para><emphasis>Get there:</emphasis> More > Tools >
17851 Patron Card Creator > Profiles</para>
17855 <para>A profile is a set of "adjustments" applied to a given <link
17856 linkend="patrontemplate">template</link> just prior to printing
17857 which compensates for anomalies unique and peculiar to a given
17858 printer (to which the profile is assigned). This means if you set a
17859 template up and then print a sample set of data and find that the
17860 items are not all aligned the same on each card, you need to set up
17861 a profile for each printer to make up for the differences in
17862 printing styles, such as the shifting of text to the left, right,
17863 top or bottom.</para>
17865 <para>If your cards are printing just the way you want, you will not
17866 need a profile.</para>
17868 <section id="addcardprofile">
17869 <title>Add a Profile</title>
17871 <para>To add a new profile, you want to click on the 'Profiles'
17872 button at the top of your page and choose 'New Profile'</para>
17875 <screeninfo>New Profile Button</screeninfo>
17879 <imagedata fileref="images/tools/patroncards/newprofile.png"/>
17884 <para>Using the form that appears you can create a profile to fix
17885 any problems with your template.</para>
17888 <screeninfo>Add Printer Profile</screeninfo>
17892 <imagedata fileref="images/tools/patroncards/addprofile.png"/>
17899 <para>The Printer Name and Paper Bin do not have to match your
17900 printer exactly, they are for your reference so you can
17901 remember what printer you have set the profile for. So if you
17902 want to use the Printer model number in printer name or you
17903 can call it 'the printer on my desk'</para>
17907 <para>Template will be filled in once you have chosen which
17908 template to apply the profile to on the <link
17909 linkend="addcardtemplate">template edit form</link></para>
17913 <para>The Units pull down is used to define what measurement
17914 scale you're going to be using for your profile.</para>
17917 <screeninfo>Units of Measurement</screeninfo>
17921 <imagedata fileref="images/tools/patroncards/units.png"/>
17928 <para>Offset describes what happens when the entire image is
17929 off center either vertically or horizontally and creep
17930 describes a condition where the distance between the labels
17931 changes across the page or up and down the page</para>
17935 <para>For these values, negative numbers move the error up
17936 and to the left and positive numbers move the error down
17937 and to the right</para>
17941 <para>Example: the text is .25" from the left edge of the
17942 first label, .28" from the left edge of the second label
17943 and .31" from the left edge of the third label. This means
17944 the horizontal creep should be set to .03" to make up for
17945 this difference.</para>
17951 <para>After saving, your profiles will appear on the 'Manage
17952 Profiles' page.</para>
17955 <screeninfo>Manage Profiles</screeninfo>
17959 <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
17964 <para>Once you have saved your new profile, you can return to the
17965 list of templates and choose to edit the template that this
17966 profile is for.</para>
17970 <section id="cardlayouts">
17971 <title>Layouts</title>
17975 <para><emphasis>Get there:</emphasis> More > Tools >
17976 Patron Card Creator > Layouts</para>
17980 <para>A layout defines the text and images that will be printed on
17981 to the card and where it will appear.</para>
17983 <section id="addcardlayout">
17984 <title>Add a Layout</title>
17986 <para>To add a new layout, you want to click on the 'Layouts'
17987 button at the top of your page and choose 'New Layout'</para>
17990 <screeninfo>New Layout Button</screeninfo>
17994 <imagedata fileref="images/tools/patroncards/newlayout.png"/>
17999 <para>Using the form that appears you can create a profile to fix
18000 any problems with your template.</para>
18003 <screeninfo>Add New Layout</screeninfo>
18007 <imagedata fileref="images/tools/patroncards/addlayout.png"/>
18014 <para>The name you assign to the layout is for your benefit,
18015 name it something that will be easy to identify at a later
18020 <para>The Units pull down is used to define what measurement
18021 scale you're going to be using for your layout.</para>
18024 <screeninfo>Units of Measurement</screeninfo>
18028 <imagedata fileref="images/tools/patroncards/units.png"/>
18035 <para>Next note if this layout is for the front or the back of
18036 the patron card</para>
18040 <para>You will need a layout for both the front and back
18041 of your card if you have 2-sided library cards</para>
18047 <para>You have the option of adding up to 3 lines of text to
18048 your card. Your text can be static text of your choosing
18049 and/or fields from the patron record. If you want to print
18050 fields from the patron record you want to put the field names
18051 in brackets like so - <firstname></para>
18055 <para>For each line of text, you can choose your font, font
18056 size and the location of the text on the card using the lower
18057 X and Y coordinates</para>
18061 <para>In order to show the barcode and the patron card number
18062 you will need to check the 'Print Card Number as Barcode'
18063 option. This will turn the patron card number into a barcode.
18064 If you want the number to print in human readable format you
18065 will need to check the 'Print Card Number as Text Under
18066 Barcode' option.</para>
18070 <para>Finally you can choose up to two images to print on the
18075 <para>One can be the <link
18076 linkend="uploadpatronimages">patron image</link> which you
18077 can resize to meet your needs.</para>
18081 <para>The other image can be something like a library logo
18082 or symbol that you uploaded using the '<link
18083 linkend="managecardimages">Manage Images</link>' module of
18084 the Patron Card Creator Tool.</para>
18090 <para>After saving, your layouts will appear on the 'Manage
18091 Layouts' page.</para>
18094 <screeninfo>Manage Layouts</screeninfo>
18098 <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
18105 <section id="patroncardbatches">
18106 <title>Batches</title>
18110 <para><emphasis>Get there:</emphasis> More > Tools >
18111 Patron Card Creator > Batches</para>
18115 <para>A batch is a collection of patrons for whom you want to
18116 generate cards.</para>
18118 <section id="addcardbatch">
18119 <title>Add a Batch</title>
18121 <para>To add a new batch, you want to click on the 'Batches'
18122 button at the top of your page and choose 'New Batch'</para>
18125 <screeninfo>New Batch Button</screeninfo>
18129 <imagedata fileref="images/tools/patroncards/newbatch.png"/>
18138 <section id="managecardimages">
18139 <title>Manage Images</title>
18143 <para><emphasis>Get there:</emphasis> More > Tools >
18144 Patron Card Creator > Manage Images</para>
18148 <para>Images uploaded using this tool will appear on the menu when
18149 creating <link linkend="cardlayouts">patron card layouts</link>. You
18150 are limited in how many images you can upload (not counting patron
18151 images) by the <link linkend="ImageLimit">ImageLimit</link> system
18155 <para>Images must be under 500k in size.</para>
18159 <para>Pictures uploaded with this tool should be at least 300dpi
18160 which is the minimum quality for a printable image.</para>
18163 <para>In the center of the screen is a simple upload form, simply
18164 browse for the file on your computer and give it a name you'll
18165 recognize later.</para>
18168 <screeninfo>Upload Images</screeninfo>
18172 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
18177 <para>Once the file is uploaded you will be presented with a
18178 confirmation message.</para>
18181 <screeninfo>Image Uploaded</screeninfo>
18185 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
18190 <para>And the image will be listed with all of your others on the
18191 right hand side of the page.</para>
18194 <screeninfo>Images</screeninfo>
18198 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
18203 <para>To delete one or multiple of these images, click the checkbox
18204 to the right of each image you want to delete and click the 'Delete'
18209 <section id="anonpatrons">
18210 <title>Patrons (anonymize, bulk-delete)</title>
18214 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18215 and Circulation > Patrons (anonymize, bulk-delete)</para>
18219 <para>This tool allows you to bulk anonymize circulation histories
18220 (this means that you keep records of how many times items were checked
18221 out - but not the patrons who checked the items out) or bulk delete
18222 patrons (remove them from the system completely).<important>
18223 <para>Patrons with outstanding fines or items checked out are not saved. They are not
18224 completely removed from the system (they are only moved to the delete_borrowers
18225 table), but this tool does not provide as many checks as one may desire.</para>
18226 </important></para>
18228 <para>The anonymization will fail quietly if <link linkend="AnonymousPatron"
18229 >AnonymousPatron</link> preference does not contain a valid value.</para>
18233 <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
18237 <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
18242 <para>To either delete or anonymize patrons</para>
18246 <para>Check the task you would like to perform (Delete or
18251 <para>Enter a date before which you want to alter the data</para>
18255 <para>Click 'Next'</para>
18259 <para>A confirmation will appear asking if you're sure this is
18260 what you want to happen</para>
18263 <screeninfo>Patron Anonymize/Bulk Delete
18264 Confirmation</screeninfo>
18268 <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
18275 <para>Clicking 'Finish' will delete or anonymize your data</para>
18278 <screeninfo>Completed Process</screeninfo>
18282 <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
18290 <section id="batchpatronmod">
18291 <title>Batch patron modifiction</title>
18295 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18296 and Circulation > Batch patron modification</para>
18300 <para>With this tool you can make edits to a batch of patron records.
18301 Simply load in a file of cardnumbers (one per line) or scan patron
18302 card numbers in to the box provided.</para>
18305 <screeninfo>Batch patron modification</screeninfo>
18309 <imagedata fileref="images/tools/batchpatron/batchmodify.png"/>
18314 <para>Once you have the file loaded or the barcodes scanned click
18315 'Continue.' You will be presented with a list of the patrons and the
18316 changes you can make.</para>
18319 <screeninfo>Patrons to modify</screeninfo>
18323 <imagedata fileref="images/tools/batchpatron/modifyform.png"/>
18328 <para>To the left of each text box there is a checkbox. Clicking that
18329 checkbox will clear our the field values. <important>
18330 <para>If the field is mandatory you will not be able to clear the
18331 value in it.</para>
18332 </important></para>
18334 <para>If you have multiple patron attributes you can change them all
18335 by using the plus (+) sign to the right of the text box. This will
18336 allow you to add another attribute value.</para>
18339 <screeninfo>Editing patron attributes</screeninfo>
18343 <imagedata fileref="images/tools/batchpatron/attributes.png"/>
18348 <para>Once you have made the changes you want, you can click 'Save'
18349 and Koha will present you with the changed patron records.</para>
18352 <section id="tagsmoderation">
18353 <title>Tag Moderation</title>
18357 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18358 and Circulation > Tags</para>
18362 <para>Depending on your <link linkend="taggingprefs">tagging system preferences</link>,
18363 librarians may need to approve tags before they are published on the OPAC. This is done
18364 via the Tag Moderation Tool. If there are tags awaiting moderation they will be listed on
18365 the main staff dashboard under the module labels:</para>
18368 <screeninfo>Tags pending approval</screeninfo>
18372 <imagedata fileref="images/tools/tagging/pendingtags.png"/>
18377 <para>To moderate the tags visit the Tags tool. When first visiting
18378 the tool, you will be presented with a list of tags that are pending
18379 approval or rejection by a librarian</para>
18382 <screeninfo>Tags pending moderation</screeninfo>
18386 <imagedata fileref="images/tools/tagging/tagpending.png"/>
18393 <para>To see all of the titles this tag was added to simply click on the term<screenshot>
18394 <screeninfo>Titles with a specific tag</screeninfo>
18397 <imagedata fileref="images/tools/tagging/taggedtitles.png"/>
18400 </screenshot></para>
18403 <para>To approve a tag, you can either click the 'Approve' button in line with the term,
18404 or check all terms you want to approve and click 'Approve' below the table.</para>
18408 <para>To reject a tag, you can either click the 'Reject' button in
18409 line with the term, or check all terms you want to approve and
18410 click 'Reject' below the table.</para>
18414 <para>Once a tag has been approved or rejected it will be moved to the
18415 appropriate list of tags. A summary of all tags will appear on the
18416 right of the screen.</para>
18419 <screeninfo>Summary of tags</screeninfo>
18423 <imagedata fileref="images/tools/tagging/tagsummary.png"/>
18428 <para>Even though a tag is approved or rejected, it can still be moved
18429 to another list. When viewing approved tags each tag has the option to
18433 <screeninfo>Approved Tags</screeninfo>
18437 <imagedata fileref="images/tools/tagging/tagapproved.png"/>
18442 <para>To check terms against the approved and rejected lists (and
18443 possibly against <link linkend="TagsExternalDictionary">the
18444 dictionary</link> you have assigned for tag moderation) simply enter
18445 the term into the search box on the bottom right of the screen to see
18446 the status of the term</para>
18449 <screeninfo>Sample Blacklist/Whitelist test search</screeninfo>
18453 <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
18459 <section id="uploadpatronimages">
18460 <title>Upload Patron Images</title>
18464 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18465 and Circulation > Upload Patron Images</para>
18469 <para>Patron images can be uploaded in bulk if you are <link
18470 linkend="patronimages">allowing patron images</link> to be attached to
18471 patron records. These images can also be used when creating <link
18472 linkend="patroncardcreator">patron cards</link>.</para>
18476 <para>Create a txt file and title it "DATALINK.TXT" or
18477 "IDLINK.TXT"</para>
18481 <para>On each line in the text file enter the patron's card number
18482 followed by comma (or tab) and then the image file name</para>
18485 <screeninfo>Sample file and image</screeninfo>
18489 <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
18496 <para>Make sure that your TXT file is a plain text document,
18503 <para>Zip up the text file and the image files</para>
18507 <para>Go to the Upload Patron Images Tool</para>
18510 <screeninfo>Upload Image Tool for Single Image</screeninfo>
18514 <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
18521 <para>For a single image, simply point to the image file and enter
18522 the patron card number</para>
18526 <para>For multiple images, choose to upload a zip file</para>
18530 <para>After uploading you will be presented with a
18531 confirmation</para>
18534 <screeninfo>Image Upload Confirmation</screeninfo>
18538 <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
18546 <para>There is a limit of 520K on the size of the picture uploaded
18547 and it is recommended that the image be 200x300 pixels, but smaller
18548 images will work as well.</para>
18553 <section id="catalogtools">
18554 <title>Catalog</title>
18558 <section id="batchmodifyitems">
18559 <title>Batch item modification</title>
18563 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18564 > Batch item modification</para>
18568 <para>This tool will allow you to modify a batch of item records in
18572 <screeninfo>Batch Modification Tool</screeninfo>
18576 <imagedata fileref="images/tools/batchmod/batchmod.png"/>
18581 <para>From the tool you can choose to upload a file of barcodes or
18582 item ids, or you can scan items one by one into the box below the
18583 upload tool. Once you have your file uploaded or the barcodes listed
18584 you can click 'Continue.'</para>
18587 <screeninfo>Batch Modify Summary</screeninfo>
18591 <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
18596 <para>You will be presented with a summary of the items you want to
18597 modify. From here you can uncheck the items you don't want to modify
18598 before making changes in the form below. You can also hide columns you
18599 don't need to see to prevent having to scroll from left to right to
18600 see the entire item form.</para>
18602 <para>Using the edit form you can choose which fields to make edits
18603 to. By checking the checkbox to the right of each field you can clear
18604 the values in that field for the records you are modifying.</para>
18607 <screeninfo>Choose fields you want to change in bulk</screeninfo>
18611 <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
18616 <para>Once you have made you changes you will be presented with the
18617 resulting items.</para>
18620 <screeninfo>Item results summary</screeninfo>
18624 <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
18630 <para>You can also edit items on one bib record in a batch by going
18631 to the bib record and clicking Edit > Edit items in batch</para>
18635 <screeninfo>Edit items in a batch</screeninfo>
18639 <imagedata fileref="images/tools/batchmod/editinbatch.png"/>
18645 <section id="batchdeleteitems">
18646 <title>Batch item deletion</title>
18650 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18651 > Batch item deletion</para>
18655 <para>This tool will allow you to delete a batch of item records from
18658 <para>From the tool you can choose to upload a file of barcodes or
18659 item ids, or you can scan items one by one into the box below the
18660 upload tool.</para>
18663 <screeninfo>Batch Deletion Tool</screeninfo>
18667 <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
18672 <para>Once you have your file uploaded or the barcodes scanned you can
18673 click 'Continue.'</para>
18675 <para>You will be presented with a confirmation screen. From here you
18676 can uncheck the items you don't want to delete and decide if Koha
18677 should delete the bib record if the last item is being deleted before
18678 clicking 'Delete selected items.'</para>
18681 <screeninfo>Confirm Deletion</screeninfo>
18685 <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
18690 <para>If your file (or list of scanned barcodes) has more than 1000
18691 barcodes, Koha will be unable to present you with a list of the items.
18692 You will still be able to delete them, but not able to choose which
18693 items specifically to delete or delete the biblio records.</para>
18696 <screeninfo>More than 1000 records in the file</screeninfo>
18700 <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
18705 <para>If the items are checked out you will be presented with an error
18706 after clicking 'Delete selected items' and the items will not be
18710 <screeninfo>Items not Deleted</screeninfo>
18714 <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
18719 <para>If the items can be deleted they will be and you will be
18720 presented with a confirmation of your deletion.</para>
18723 <screeninfo>Batch Deletion Confirmation</screeninfo>
18727 <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
18733 <section id="exportbibs">
18734 <title>Export Data (MARC & Authorities)</title>
18738 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18739 > Export Data</para>
18743 <para>Koha comes with a tool that will allow you to export your
18744 bibliographic, holdings and/or authority data in bulk. This can be
18745 used to send your records to fellow libraries, organizations or
18746 services; or simply for backup purposes.</para>
18748 <section id="exportmarc">
18749 <title>Export Bibliographic Records</title>
18751 <para>At the top of the screen you need to pick what data you're
18752 exporting. If you're exporting bibliographic records with or without
18753 the holdings information you want to click the 'Export bibliographic
18754 records' tab.</para>
18758 <para>Fill in the form in order to limit your export to a
18759 specific range (all fields are optional)</para>
18762 <screeninfo>Select Records to Export</screeninfo>
18766 <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
18773 <para>Choose to limit your export by any one or more of the
18774 following options</para>
18778 <para>Limit to a bib number range</para>
18782 <para>Limit to a specific item type</para>
18786 <para>Limit to a specific library</para>
18790 <para>Limit to a call number range</para>
18794 <para>Limit to an acquisition date range</para>
18800 <para>Next choose what to skip when exporting</para>
18803 <screeninfo>Export options</screeninfo>
18807 <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
18814 <para>By default items will be exported, if you would
18815 like to only export bibliographic data, check the 'Don't
18816 export items' box</para>
18820 <para>To limit your export only to items from the
18821 library you're logged in as (if you leave the 'Library'
18822 field set to 'All') or to the library you selected above
18823 check the 'Remove non-local items' box</para>
18827 <para>You can also choose what fields you don't want to
18828 export. This can be handy if you're sharing your data,
18829 you can remove all local fields before sending your data
18830 to another library</para>
18836 <para>Finally choose the file type and file name</para>
18839 <screeninfo>File export format</screeninfo>
18843 <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
18850 <para>Choose to export your data in marc or marcxml
18855 <para>Choose the name you want your file to save
18862 <para>Click 'Export bibliographic records'</para>
18869 <section id="exportauthority">
18870 <title>Export Authority Records</title>
18872 <para>At the top of the screen you need to pick what data you're
18873 exporting. If you're exporting authority records you want to click
18874 the 'Export authority records' tab.</para>
18878 <para>Fill in the form in order to limit your export to a
18879 specific range or type of authority record (all fields are
18883 <screeninfo>Export authorities</screeninfo>
18887 <imagedata fileref="images/tools/exportmarc/authexport-pt1.png"/>
18894 <para>Next choose fields that you would like to exclude from the
18895 export separated by a space (no commas)</para>
18898 <screeninfo>Authority export options</screeninfo>
18902 <imagedata fileref="images/tools/exportmarc/authexport-pt2.png"/>
18909 <para>If you'd like to exclude all subfields of the 200 for
18910 example just enter 200</para>
18914 <para>If you'd like to exclude a specific subfield enter it
18915 beside the field value 100a will exclude just the subfield
18916 'a' of the 100</para>
18922 <para>Finally choose the file type and file name</para>
18925 <screeninfo>Export format</screeninfo>
18929 <imagedata fileref="images/tools/exportmarc/authexport-pt3.png"/>
18936 <para>Choose to export your data in marc or marcxml
18941 <para>Choose the name you want your file to save as</para>
18947 <para>Click 'Export authority records'</para>
18953 <section id="inventory">
18954 <title>Inventory/Stocktaking</title>
18958 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18959 > Inventory/Stocktaking</para>
18963 <para>Koha's Inventory Tool can be used in one of two ways, the first
18964 is by printing out a shelf list that you can then mark items off on,
18965 or by uploading a text files of barcodes gathered by a portable
18968 <para>If you do not have the ability to use your barcode scanner on
18969 the floor of the library, the first option available to you is to
18970 generate a shelf list based on criteria you enter.</para>
18973 <screeninfo>Inventory & Stocktaking Tool</screeninfo>
18977 <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
18982 <para>Choose which library, shelving location, call number range, item
18983 status and when the item was last seen to generate a shelf list that
18984 you can then print to use while walking around the library checking
18985 your collection</para>
18988 <screeninfo>Shelf List</screeninfo>
18992 <imagedata fileref="images/tools/inventory/shelflist.png"/>
18997 <para>Alternatively you can export the list to a CSV file for altering
18998 in an application on your desktop. Simply check the box next to
18999 'Export to csv file' to generate this file.</para>
19001 <para>Once you have found the items on your shelves you can return to
19002 this list and check off the items you found to have the system update
19003 the last seen date to today.</para>
19005 <para>If you have a portable scanner (or a laptop and USB scanner) you
19006 can walk through the library with the scanner in hand and scan
19007 barcodes as you come across them. Once finished you can then upload
19008 the text file generated by the scanner to Koha</para>
19011 <screeninfo>Barcode Import for Inventory Tool</screeninfo>
19015 <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
19020 <para>Choose the text file and the date you want to mark all items as
19021 seen and click 'Submit.'</para>
19024 <section id="labelcreator">
19025 <title>Label Creator</title>
19029 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19030 > Label Creator</para>
19034 <para>The Label Creator allow you to use layouts and templates which
19035 you design to print a nearly unlimited variety of labels including
19036 barcodes. Here are some of the features of the Label Creator
19041 <para>Customize label layouts</para>
19045 <para>Design custom label templates for printed labels</para>
19049 <para>Build and manage batches of labels</para>
19053 <para>Export single or multiple batches</para>
19057 <para>Export single or multiple labels from within a batch</para>
19061 <para>Export label data in one of three formats:</para>
19065 <para>PDF - Readable by any standard PDF reader, making labels
19066 printable directly on a printer</para>
19070 <para>CSV - Export label data after your chosen layout is
19071 applied allowing labels to be imported in to a variety of
19072 applications</para>
19076 <para>XML - Included as an alternate export format</para>
19082 <para>At the top of each screen within the Label Creator, you will see
19083 a toolbar allowing quick access to relevant functions. The menu to the
19084 left of each screen also allows easy access to the different sections
19085 of the Label Creator. The bread crumb trail near the top of each
19086 screen will give specific indication as to where you are within the
19087 Label Creator module and allow quick navigation to previously
19088 traversed sections. And finally, you can find more detailed
19089 information on each section of the Label Creator by clicking the
19090 online help link at the upper left-hand corner of every page.</para>
19092 <section id="labeltemplates">
19093 <title>Templates</title>
19097 <para><emphasis>Get there:</emphasis> More > Tools > Label
19098 Creator > Templates</para>
19102 <para>A template is based on the label/card stock you are using.
19103 This might be Avery 5160 for address labels, Gaylord 47-284 for
19104 spine labels or Avery 28371 for your patron cards, just to give a
19105 couple of examples. These labels will include all of the information
19106 you will need for setting up a Koha, this information may be on the
19107 packaging, and if not it can usually be found on the vendor's
19110 <section id="addlabeltemplate">
19111 <title>Add a Template</title>
19113 <para>To add a new template, you want to click on the 'Templates'
19114 button at the top of your page and choose 'New Template'</para>
19117 <screeninfo>New Label Template Option</screeninfo>
19121 <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
19126 <para>Using the form that appears you can define the template for
19127 your sheet of labels or cards.</para>
19130 <screeninfo>Label Template Form</screeninfo>
19134 <imagedata fileref="images/tools/labelcreator/labelform.png"/>
19141 <para>Template ID will be automatically generated after saving
19142 your template, this is simply a system generated unique
19147 <para>Template Code should be something you can use to
19148 identify your template on a list of templates</para>
19152 <para>You can use the Template Description to add additional
19153 information about the template</para>
19157 <para>The Units pull down is used to define what measurement
19158 scale you're going to be using for the template. This should
19159 probably match the unit of measurement used on the template
19160 description provided by the product vendor.</para>
19163 <screeninfo>Measurement Units</screeninfo>
19167 <imagedata fileref="images/tools/patroncards/units.png"/>
19174 <para>The measurements, number of columns and number of rows
19175 can be found on the vendor product packaging or
19181 <para>If you do not supply a left text margin in the
19182 template, a 3/16" (13.5 point) left text margin will
19183 apply by default.</para>
19190 <para>A profile is a set of "adjustments" applied to a given
19191 template just prior to printing which compensates for
19192 anomalies unique and peculiar to a given printer (to which the
19193 profile is assigned).</para>
19197 <para>Before picking a profile try printing some sample
19198 labels so that you can easily define a profile that is
19199 right for your printer/template combination.</para>
19203 <para>After finding any anomalies in the printed document,
19204 <link linkend="addlabelprofile">create a profile</link>
19205 and assign it to the template.</para>
19211 <para>After saving, your templates will appear on the 'Manage
19212 Templates' page.</para>
19215 <screeninfo>List of label templates</screeninfo>
19219 <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
19226 <section id="labelprofiles">
19227 <title>Profiles</title>
19231 <para><emphasis>Get there:</emphasis> More > Tools > Label
19232 Creator > Profiles</para>
19236 <para>A profile is a set of "adjustments" applied to a given <link
19237 linkend="addlabeltemplate">template</link> just prior to printing
19238 which compensates for anomalies unique and peculiar to a given
19239 printer (to which the profile is assigned). This means if you set a
19240 template up and then print a sample set of data and find that the
19241 items are not all aligned the same on each label, you need to set up
19242 a profile for each printer to make up for the differences in
19243 printing styles, such as the shifting of text to the left, right,
19244 top or bottom.</para>
19246 <para>If your labels are printing just the way you want, you will
19247 not need a profile.</para>
19249 <section id="addlabelprofile">
19250 <title>Add a Profile</title>
19252 <para>To add a new profile, you want to click on the 'Profiles'
19253 button at the top of your page and choose 'New Profile'</para>
19256 <screeninfo>New Profile Button</screeninfo>
19260 <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
19265 <para>Using the form that appears you can create a profile to fix
19266 any problems with your template.</para>
19269 <screeninfo>Create a Printer Profile</screeninfo>
19273 <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
19280 <para>The Printer Name and Paper Bin do not have to match your
19281 printer exactly, they are for your reference so you can
19282 remember what printer you have set the profile for. So if you
19283 want to use the Printer model number in printer name or you
19284 can call it 'the printer on my desk'</para>
19288 <para>Template will be filled in once you have chosen which
19289 template to apply the profile to on the <link
19290 linkend="addlabeltemplate">template edit form</link></para>
19294 <para>The Units pull down is used to define what measurement
19295 scale you're going to be using for your profile.</para>
19298 <screeninfo>Units of Measurement</screeninfo>
19302 <imagedata fileref="images/tools/patroncards/units.png"/>
19309 <para>Offset describes what happens when the entire image is
19310 off center either vertically or horizontally and creep
19311 describes a condition where the distance between the labels
19312 changes across the page or up and down the page</para>
19316 <para>For these values, negative numbers move the error up
19317 and to the left and positive numbers move the error down
19318 and to the right</para>
19322 <para>Example: the text is .25" from the left edge of the
19323 first label, .28" from the left edge of the second label
19324 and .31" from the left edge of the third label. This means
19325 the horizontal creep should be set to .03" to make up for
19326 this difference.</para>
19332 <para>After saving, your profiles will appear on the 'Manage
19333 Profiles' page.</para>
19336 <screeninfo>List of Profiles</screeninfo>
19340 <imagedata fileref="images/tools/labelcreator/profiles.png"/>
19345 <para>Once you have saved your new profile, you can return to the
19346 list of templates and choose to edit the template that this
19347 profile is for.</para>
19351 <section id="labellayouts">
19352 <title>Layouts</title>
19356 <para><emphasis>Get there:</emphasis> More > Tools > Label
19357 Creator > Layouts</para>
19361 <para>A layout is used to define the fields you want to appear on
19362 your labels.</para>
19364 <section id="addlabellayout">
19365 <title>Add a Layout</title>
19367 <para>To add a new layout, you want to click on the 'Layouts'
19368 button at the top of your page and choose 'New Layout'</para>
19371 <screeninfo>New Layout Button</screeninfo>
19375 <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
19380 <para>Using the form that appears you can create a profile to fix
19381 any problems with your template.</para>
19384 <screeninfo>Add New Layout</screeninfo>
19388 <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
19395 <para>The name of your layout can be anything you'd like to
19396 help you identify it later.</para>
19400 <para>If this is a barcode label you'll want to choose the
19401 encoding (Code 39 is the most common)</para>
19405 <para>The layout type can be any combination of bibliographic
19406 information and/or barcode. For example a spine label would
19407 just be Biblio whereas a label for your circulation staff to
19408 use to checkout the book would probably be
19409 Biblio/Barcode.</para>
19413 <para>The Bibliographic Data to Print includes any of the data
19414 fields that may be mapped to your MARC frameworks. You can
19415 choose from the preset list of fields or you can click on
19416 'List Fields' and enter your own data. In 'List Fields', you
19417 can specify MARC subfields as a 4-character tag-subfield
19418 string: (ie. 254a for the title field), You can also enclose a
19419 whitespace-separated list of fields to concatenate on one line
19420 in double quotes. (ie. "099a 099b" or "itemcallnumber
19421 barcode"). The fields available are from the database tables
19422 list below. Finally you could add in static text strings in
19423 single-quote (ie. 'Some static text here.')</para>
19427 <para>You can use the schema viewer (<ulink
19428 url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
19429 with the following tables to find field names to
19434 <para>Currently all fields in the following tables are
19435 used: items, biblioitems, biblio, branches</para>
19438 <screeninfo>List fields</screeninfo>
19442 <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
19453 <para>Choose if the label maker should print out the
19454 guidelines around each label</para>
19458 <para>Choose if you'd like Koha to try to split your call
19459 numbers (usually used on Spine Labels)</para>
19463 <para>Finally choose your text settings such as alignment,
19464 font type and size.</para>
19468 <para>After saving, your layouts will appear on the 'Manage
19469 Layouts' page.</para>
19473 <section id="labelbatches">
19474 <title>Batches</title>
19478 <para><emphasis>Get there:</emphasis> More > Tools > Label
19479 Creator > Batches</para>
19483 <para>Batches are made up of the barcodes you would like to print.
19484 Once in this tool you can search for the item records you would like
19485 to print out labels for.</para>
19487 <section id="addlabelbatch">
19488 <title>Add a Batch</title>
19490 <para>Batches can be created in one of two ways. The first is to
19491 click the 'Create Label Batch' link on the '<link
19492 linkend="managestaged">Staged MARC Management</link>' page:</para>
19495 <screeninfo>Create Label Batch Link on Staged Records
19500 <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
19505 <para>The other is to choose to create a new batch from the label
19506 creator tool</para>
19509 <screeninfo>Create New Batch</screeninfo>
19513 <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
19518 <para>You will be brought to an empty batch with an 'Add item(s)'
19519 button at the top of the page and a box to scan barcodes in
19523 <screeninfo>Add Items</screeninfo>
19527 <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
19532 <para>You can either scan barcodes in to the box provided and
19533 click the 'Add item(s)' button or you can click the 'Add item(s)'
19534 button with the barcodes box empty. Clicking 'Add item(s)' with
19535 nothing in the barcodes box will open a search window for you to
19536 find the items you want to add to the batch.</para>
19539 <screeninfo>Search for items for a Batch</screeninfo>
19543 <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
19548 <para>From the search results, click the check box next to the
19549 items you want to add to the batch and click the 'Add checked'
19550 button. You can also add items one by one by clicking the 'Add'
19551 link to the left of each item.</para>
19554 <screeninfo>Batch search results</screeninfo>
19558 <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
19563 <para>Once you have added all of the items click the 'Done'
19564 button. The resulting page will list the items you have
19568 <screeninfo>List of items in the batch</screeninfo>
19572 <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
19577 <para>To print your labels, click the 'Export Batch' button. To
19578 print only some of the labels, click the 'Export Item(s)' button.
19579 Either way you will be presented with a confirmation screen where
19580 you can choose your template and layout.</para>
19583 <screeninfo>Start batch export</screeninfo>
19587 <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
19592 <para>You will then be presented with three download options: PDF,
19593 Excel, and CSV.</para>
19596 <screeninfo>Batch save options</screeninfo>
19600 <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
19605 <para>After saving your file, simply print to the blank labels you
19606 have in your library.</para>
19611 <section id="quicklabelcreator">
19612 <title>Quick Spine Label Creator</title>
19616 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19617 > Quick Spine Label Creator</para>
19622 <para>This tool does not use the label layouts or templates, it
19623 simply prints a spine label in the first spot on the label
19628 <para>Define the fields you want to print on the spine label in
19629 the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
19630 system preference</para>
19634 <para>Format your label printing by editing spinelabel.css found
19635 in koha-tmpl/intranet-tmpl/prog/en/css/</para>
19640 <para>To use this tool you simply need the barcode for the book you'd
19641 like to print the spine label for.</para>
19644 <screeninfo>Quick Spine Label Creator</screeninfo>
19648 <imagedata fileref="images/tools/quickspinelable.png"/>
19654 <section id="stagemarc">
19655 <title>Stage MARC Records for Import</title>
19659 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19660 > Stage MARC records for import</para>
19664 <para>This tool can be used to import both bibliographic and authority
19665 records that are saved in MARC format. Importing records into Koha
19666 includes two steps. The first is to stage records for import.</para>
19670 <para>First find the MARC file on your computer</para>
19673 <screeninfo>Stage MARC Records for Import</screeninfo>
19677 <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
19684 <para>Next you will be presented with options for record matching
19685 and item imports</para>
19688 <screeninfo>Upload options</screeninfo>
19692 <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
19699 <para>Enter 'Comments about this file' to identify your upload
19700 when going to the '<link linkend="managestaged">Manage Staged
19701 MARC Records</link>' tool</para>
19705 <para>Tell Koha which type of file this is, bibliographic or
19709 <screeninfo>Record type</screeninfo>
19713 <imagedata fileref="images/tools/marcimport/recordtype.png"/>
19720 <para>Choose the character encoding</para>
19723 <screeninfo>Chracter encoding</screeninfo>
19727 <imagedata fileref="images/tools/marcimport/encoding.png"/>
19734 <para>Choose whether or not you want to look for matching
19738 <screeninfo>Look for matches</screeninfo>
19742 <imagedata fileref="images/tools/marcimport/matches.png"/>
19749 <para>You can set up <link
19750 linkend="recordmatchingrules">record matching rules</link>
19751 through the administration area</para>
19754 <screeninfo>Matching rules</screeninfo>
19758 <imagedata fileref="images/tools/marcimport/matchrule.png"/>
19767 <para>Next choose what to do with matching records if they are
19772 <para>Finally choose what to do with records that are
19777 <para>Next you can choose whether or not to import the item
19778 data found in the MARC records (if the file you're loading is
19779 a bibliographic file)</para>
19782 <screeninfo>Import items</screeninfo>
19786 <imagedata fileref="images/tools/marcimport/checkitems.png"/>
19795 <para>Click 'Stage for import'</para>
19799 <para>You will be presented with a confirmation of your MARC
19803 <screeninfo>MARC Import Confirmation</screeninfo>
19807 <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
19814 <para>To complete the process continue to the <link
19815 linkend="managestaged">Managed Staged MARC Records
19821 <section id="managestaged">
19822 <title>Staged MARC Record Management</title>
19826 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19827 > Staged MARC Record Management</para>
19831 <para>Once you have <link linkend="stagemarc">staged</link> your
19832 records for import you can complete the import using this tool.</para>
19835 <screeninfo>List of Staged MARC Records</screeninfo>
19839 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
19846 <para>From the list of staged records, click on the file name that
19847 you want to finish importing</para>
19851 <para>You will note that records that have already been
19852 imported will say so under 'Status'</para>
19858 <para>A summary of your import will appear along with the option
19859 to change your matching rules</para>
19862 <screeninfo>Manage Staged Records Batch</screeninfo>
19866 <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
19873 <para>Below the summary is the option to import the batch of bib
19874 records using a specific framework</para>
19877 <screeninfo>Choose Framework to Import Into</screeninfo>
19881 <imagedata fileref="images/tools/marcimport/importframework.png"/>
19888 <para>Choosing a framework other than 'Default' isn't
19889 necessary, but it's helpful for running reports and having the
19890 right bib level item type selected on import.</para>
19896 <para>Below the framework selection there will be a list of the
19897 records that will be imported</para>
19900 <screeninfo>List of Staged Records</screeninfo>
19904 <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
19911 <para>Review your summary before completing your import to
19912 make sure that your matching rule worked and that the records
19913 appear as you expect them to</para>
19919 <para>Click 'Import into catalog' to complete the import</para>
19922 <screeninfo>Import summary</screeninfo>
19926 <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
19933 <para>Once your import is complete a link to the new bib records
19934 will appear to the right of each title that was imported</para>
19938 <para>You can also undo your import by clicking the 'Undo import
19939 into catalog' button</para>
19943 <para>Records imported using this tool remain in the 'reservoir' until
19944 they are cleaned. These items will appear when searching the catalog
19945 from the <link linkend="cataloging">Cataloging</link> tool:</para>
19948 <screeninfo>Reservoir Results</screeninfo>
19952 <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
19957 <para>To clean items out of the 'reservoir':</para>
19961 <para>Visit the main screen of the Manage Staged MARC Records
19965 <screeninfo>List of Staged MARC Records</screeninfo>
19969 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
19976 <para>To clean a batch, click the 'Clean' button to the
19981 <para>You will be presented with a confirmation message</para>
19984 <screeninfo>Clean MARC Records Confirmation</screeninfo>
19988 <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
19995 <para>Accept the deletion and the records will be removed from
19996 the reservoir and the status will be changed to
20004 <section id="uploadlocalimages">
20005 <title>Upload Local Cover Image</title>
20009 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20010 > Upload Local Cover Image</para>
20014 <para>This tool will allow you to upload cover images for the
20015 materials in your catalog. To access this tool, staff will need the
20016 <link linkend="toolspermissions">upload_local_cover_images
20017 permission</link>. In order for images to show in the staff client
20018 and/or OPAC you will need to set your <link
20019 linkend="LocalCoverImages">LocalCoverImages</link> and/or <link
20020 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> preferences
20021 to 'Display.' Images can be uploaded in batches or one by one.<tip>
20022 <para>Koha does not have a maximum file size limit for this tool,
20023 but Apache may limit the maximum size of uploads (talk to your sys
20027 <para>If uploading a single image:</para>
20031 <para>Visit the tool and click the 'Browse' button to browse to
20032 the image on your local machine.</para>
20035 <screeninfo>Upload single cover image</screeninfo>
20039 <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
20046 <para>Click 'Upload file'</para>
20050 <para>Choose 'Image file' under the 'File type' section</para>
20054 <para>Enter the biblionumber for the record you're attaching this
20055 image to. This is not the same as the barcode, this is the system
20056 generated number assigned by Koha.</para>
20060 <para>Find the biblionumber by looking at the end of the URL
20061 in the address bar when on the detail page</para>
20064 <screeninfo>Biblionumber in URL</screeninfo>
20068 <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
20075 <para>or by clicking on the MARC tab on the detail page in the
20076 staff client</para>
20079 <screeninfo>Biblionumber on MARC Record</screeninfo>
20083 <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
20092 <para>If you would like to replace any other cover images you may
20093 have uploaded in the past, check the 'Replace existing covers' box
20094 under the 'Options' section</para>
20098 <para>Click 'Process images'</para>
20102 <para>You will be presented with a summary of the upload and a
20103 link to the record you have just added the image to</para>
20107 <para>If uploading a batch of images at once you will need to prepare
20108 a ZIP file first.</para>
20112 <para>Enter in to the ZIP file all the images you are
20117 <para>Also include a text file (*.TXT) named either datalink.txt
20118 or idlink.txt listing the biblionumber followed by the image name
20119 for each image one per line</para>
20123 <para>ex. 4091,image4091.jpg</para>
20126 <screeninfo>ZIP File Contents</screeninfo>
20130 <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
20139 <para>Browse your local computer to the ZIP file</para>
20143 <para>Click 'Upload file'</para>
20147 <para>Choose 'Zip file' under the 'File type' section</para>
20151 <para>If you would like to replace any other cover images you may
20152 have uploaded in the past, check the 'Replace existing covers' box
20153 under the 'Options' section</para>
20157 <para>Click 'Process images'</para>
20161 <para>You will be presented with a summary of the upload</para>
20164 <screeninfo>Upload Summary</screeninfo>
20168 <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
20176 <para>The source image is used to generate a 140 x 200 px thumbnail image and a 600 x 800
20177 px full-size image. The original sized image uploaded will not be stored by Koha</para>
20180 <para>You will be able to see your cover images in the staff client on
20181 the detail page under the 'Image' tab in the holdings table at the
20185 <screeninfo>Cover images in the staff client</screeninfo>
20189 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
20194 <para>In the OPAC the cover images will also appear in the images tab,
20195 as well as next to the title and on the search results.</para>
20199 <section id="additionaltools">
20200 <title>Additional Tools</title>
20204 <section id="calholidays">
20205 <title>Calendar</title>
20209 <para><emphasis>Get there:</emphasis> More > Tools >
20210 Additional Tools > Calendar</para>
20214 <para>Libraries can define library closings and holidays to be used
20215 when calculating due dates. You can make use of the Calendar by
20216 turning on the proper system preferences:</para>
20220 <para><emphasis>Get there: </emphasis>More > Administration
20221 > Global System Preferences > Circulation > <link
20222 linkend="useDaysMode">useDaysMode</link></para>
20226 <para>Choose the method for calculating due date - either
20227 include days the library is closed in the calculation or don't
20228 include them.</para>
20234 <para><emphasis>Get there:</emphasis> More > Administration
20235 > Global System Preferences > Circulation > <link
20236 linkend="finesCalendar">finescalendar</link></para>
20240 <para>This will check the holiday calendar before charging
20248 <screeninfo>Calendar & Holidays Tools</screeninfo>
20252 <imagedata fileref="images/tools/calendar/calendar.png"/>
20257 <section id="addevents">
20258 <title>Adding Events</title>
20260 <para>Before adding events, choose the library you would like to
20261 apply the closings to. When adding events you will be asked if you
20262 would like to apply the event to one branch or all branches. To add
20263 events, simply</para>
20267 <para>Click on the date on the calendar that you would like to
20268 apply the closing to</para>
20271 <screeninfo>Calendar Add Form</screeninfo>
20275 <imagedata fileref="images/tools/calendar/calendaradd.png"/>
20282 <para>In the form that appears above the calendar, enter the
20283 closing information (for more info on each option click the
20284 question mark [?] to the right of the option)</para>
20288 <para>Library will be filled in automatically based on the
20289 library you chose from the pull down at the top of the
20294 <para>The day information will also be filled in
20295 automatically based on the date you clicked on the
20300 <para>In the description enter the reason the library is
20305 <para>Next you can choose if this event is a one time event
20306 or if it is repeatable.</para>
20310 <para>If this is a one day holiday choose 'Holiday only
20311 on this day'</para>
20315 <para>If this is a weekly closing (like a weekend day)
20316 then you can choose 'Holiday repeated every same day of
20321 <para>If this is an annual holiday closing choose
20322 'Holiday repeated yearly on the same date'</para>
20326 <para>If the library is going to be closed for the week
20327 or a range of time choose 'Holiday on a range' and enter
20328 a 'To Date' at the top</para>
20332 <para>If the library is going to be closed for a range
20333 of time each year (such as summer holidays for schools)
20334 choose 'Holiday repeated yearly on a range' and enter a
20335 'To Date' at the top</para>
20341 <para>Finally decide if this event should be applied to all
20342 libraries or just the one you have originally
20347 <para>If you'd rather enter all the holidays and then
20348 copy them all to another branch all at once you can use
20349 the copy menu below the calendar</para>
20352 <screeninfo>Copy holidays</screeninfo>
20356 <imagedata fileref="images/tools/calendar/copyholidays.png"/>
20367 <para>After saving you will see the event listed in the summary
20368 to the right the calendar</para>
20371 <screeninfo>Calendar Summary</screeninfo>
20375 <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
20383 <section id="editevents">
20384 <title>Editing Events</title>
20386 <para>To edit events</para>
20390 <para>Click on the event on the calendar that you want to change
20391 (do this by clicking on the date on the calendar, not the event
20392 listed in the summary)</para>
20395 <screeninfo>Edit holiday form</screeninfo>
20399 <imagedata fileref="images/tools/calendar/calendaredit.png"/>
20406 <para>From this form you can make edits to the holiday or delete the holiday
20407 completely. <itemizedlist>
20409 <para>All actions require that you click 'Save' before the change will be
20412 </itemizedlist></para>
20416 <para>Clicking on repeatable events will offer slightly
20417 different options</para>
20420 <screeninfo>Edit repeatable event</screeninfo>
20424 <imagedata fileref="images/tools/calendar/calendarexception.png"/>
20431 <para>In the form above you will note that there is now an option to 'Generate an
20432 exception for this repeated holiday,' choosing this option will allow you to
20433 make it so that this date is not closed even though the library is usually
20434 closed on this date.<itemizedlist>
20436 <para>All actions require that you click 'Save' before the change will be
20439 </itemizedlist></para>
20446 <section id="calendarhelp">
20447 <title>Additional Help</title>
20449 <para>When adding or editing events you can get additional help by
20450 clicking on the question mark next to various different options on
20454 <screeninfo>Additional Calendar Help Buttons</screeninfo>
20458 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
20465 <section id="csvprofiles">
20466 <title>CSV Profiles</title>
20470 <para><emphasis>Get there:</emphasis> More > Tools >
20471 Additional Tools > CSV Profiles</para>
20475 <para>CSV Profiles are created to define how you would like your cart
20476 or list to export.</para>
20478 <section id="addcsvprofile">
20479 <title>Add CSV Profiles</title>
20481 <para>To add a CSV Profile</para>
20485 <para>Click 'CSV Profiles' from the Tools menu</para>
20488 <screeninfo>Add CSV Profile</screeninfo>
20492 <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
20499 <para>The 'Profile name' will appear on the export pull down list when choosing
20500 'Download' from your cart or list<screenshot>
20501 <screeninfo>Download List</screeninfo>
20504 <imagedata fileref="images/tools/csvprofiles/downloadcsv.png"/>
20507 </screenshot></para>
20511 <para>The 'Profile description' is for your own benefit, but will also appear in
20512 the OPAC when patrons download content, so make sure it's clear to your patrons
20517 <para>The 'CSV separator' is the character used to separate values and value groups<tip>
20518 <para>The most common option here is comma because most spreadsheet
20519 applications know how to open files split by commas.</para>
20524 <para>The 'Field separator' is the character used to
20525 separate duplicate fields</para>
20529 <para>Example: You may have multiple 650 fields and this is the character that
20530 will appear in between each one in the column<screenshot>
20531 <screeninfo>Field separators in between multiple subjects</screeninfo>
20534 <imagedata fileref="images/tools/csvprofiles/csvfieldsep.png"/>
20537 </screenshot></para>
20543 <para>The 'Subfield separator' is the character used to
20544 separate duplicate subfields</para>
20548 <para>Example: You may have multiple $a subfields in a
20555 <para>The 'Encoding' field lets you define the encoding used
20556 when saving the file</para>
20560 <para>Finally format your CSV file using the 'Profile MARC fields' fields</para>
20564 <para>Define which fields or subfields you want to
20565 export, separated by pipes. Example :
20566 200|210$a|301</para>
20571 <para>You can also use your own headers (instead of the ones from Koha) by
20572 prefixing the field number with an header, followed by the equal sign.
20573 Example : Personal name=100|title=245$a|300</para>
20579 <para>When you have entered in all of the information for you profile, simply click
20580 'Submit' and you will be presented with a confirmation that your profile has been saved.<screenshot>
20581 <screeninfo>Confirmation of new CSV profile</screeninfo>
20584 <imagedata fileref="images/tools/csvprofiles/csvadded.png"/>
20587 </screenshot></para>
20592 <section id="editcsvprofile">
20593 <title>Modify CSV Profiles</title>
20595 <para>Once you have created at least one CSV Profile an 'Edit
20596 profile' tab will appear next to the 'New profile' button.</para>
20599 <screeninfo>Modify CSV Profiles</screeninfo>
20603 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
20610 <para>Choose the profile you would like to edit and alter the necessary fields.</para>
20613 <para>After submitting your changes you will be presented with a confirmation message
20614 at the top of the screen<screenshot>
20615 <screeninfo>Confirmation of CSV modification</screeninfo>
20618 <imagedata fileref="images/tools/csvprofiles/csvmodified.png"/>
20621 </screenshot></para>
20625 <para>To delete a profile, check the 'Delete selected profile'
20626 option before clicking 'Submit Query'</para>
20629 <screeninfo>Delete an existing CSV Profile</screeninfo>
20633 <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
20641 <section id="usecsvprofiles">
20642 <title>Using CSV Profiles</title>
20644 <para>Your CSV Profiles will appear on the export list or cart menu under the 'Download'
20645 button in both the staff client and the OPAC</para>
20648 <screeninfo>CSV Profiles on Download Menu in the Staff Client</screeninfo>
20652 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
20659 <section id="logviewer">
20660 <title>Log Viewer</title>
20664 <para><emphasis>Get there:</emphasis> More > Tools >
20665 Additional Tools > Log Viewer</para>
20669 <para>Actions within the Koha system are tracked in log files. Your
20670 <link linkend="logs">system preferences</link> can be changed to
20671 prevent the logging of different actions. These logs can be viewed
20672 using the Log Viewer Tool.</para>
20675 <screeninfo>Log Viewer</screeninfo>
20679 <imagedata fileref="images/tools/logs/logviewer.png"/>
20684 <para>Choosing different combinations of menu options will produce the
20685 log file for that query.</para>
20688 <screeninfo>A query for all logs related to the Circulation module
20689 produces a result like this</screeninfo>
20693 <imagedata fileref="images/tools/logs/logresults.png"/>
20698 <para>You will note that real names do not appear on the log, only
20699 identifying numbers. You need to use the identifying numbers when
20700 searching the logs as well.</para>
20703 <section id="newstool">
20704 <title>News</title>
20708 <para><emphasis>Get there:</emphasis> More > Tools >
20709 Additional Tools > News</para>
20713 <para>Koha's news module allows librarians to post news to the OPAC,
20714 staff interface and circulation receipts.</para>
20717 <screeninfo>Koha News Module</screeninfo>
20721 <imagedata fileref="images/tools/news/news.png"/>
20726 <para>To add news to either the OPAC, the Staff Client or a
20727 Circulation receipt:</para>
20731 <para>Click 'New Entry'</para>
20734 <screeninfo>Add Koha News Form</screeninfo>
20738 <imagedata fileref="images/tools/news/addnews.png"/>
20745 <para>Under 'Display Location' choose whether to put the news
20746 on the OPAC, Slip (circulation receipt) or the Librarian
20747 (Staff) Interface.</para>
20751 <para>Choose a title for your entry</para>
20755 <para>Using the publication and expiration date fields you can
20756 control how long your item appears</para>
20760 <para>'Appear in position' lets you decide what order your
20761 news items appear in</para>
20765 <para>The 'News' box allows for the use of HTML for formatting
20766 of your news item</para>
20772 <para>After filling in all of the fields, click 'Submit'</para>
20776 <para>News in the OPAC will appear above the <link
20777 linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
20780 <screeninfo>News in the OPAC</screeninfo>
20784 <imagedata fileref="images/tools/news/opacnews.png"/>
20791 <para>News in the Staff Client will appear on the far left of the
20795 <screeninfo>News in the Staff Client</screeninfo>
20799 <imagedata fileref="images/tools/news/librariannews.png"/>
20806 <para>News on the circulation receipts will appear below the items
20807 that are checked out</para>
20810 <screeninfo>News at the bottom of the circulation
20811 receipt</screeninfo>
20815 <imagedata fileref="images/tools/news/slipnews.png"/>
20823 <section id="taskscheduler">
20824 <title>Task Scheduler</title>
20828 <para><emphasis>Get there:</emphasis> More > Tools >
20829 Additional Tools > Task Scheduler</para>
20833 <para>The task scheduler is a way to schedule reports to run whenever
20836 <para>To schedule a task, visit the Task Scheduler and fill in the
20840 <screeninfo>Task Scheduler</screeninfo>
20844 <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
20851 <para>Current Server Time shows the time on your server (schedule
20852 all of your reports to run based on that time - not on your local
20857 <para>Time should be entered as hh:mm (2 digit hour, 2 digit
20862 <para>Date should be entered using the calendar pop up</para>
20866 <para>From Report choose the report you want to schedule</para>
20870 <para>Choose whether to receive the text of or a link to the
20875 <para>In the Email filed enter the email of the person you want to
20876 receive your report</para>
20880 <para>Below the task scheduler form, there is a list of scheduled
20884 <screeninfo>Scheduled Tasks</screeninfo>
20888 <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
20893 <para>You can also schedule reports directly from the list of saved
20894 reports by clicking the 'Schedule' link</para>
20897 <screeninfo>Saved Reports List</screeninfo>
20901 <imagedata fileref="images/tools/tasksched/savedreports.png"/>
20906 <section id="taskscedtroubleshoot">
20907 <title>Troubleshooting</title>
20909 <para>Task scheduler will not work if the user the web server runs
20910 as doesn't have the permission to use it. To find out if the right
20911 user has the permissions necessary, check /etc/at.allow to see what
20912 users are in it. If you don't have that file, check etc/at.deny. If
20913 at.deny exists but is blank, then every user can use it. Talk to
20914 your system admin about adding the user to the right place to make
20915 the task scheduler work.</para>
20919 <section id="QOTDEditor">
20920 <title>Quote of the Day (QOTD) Editor</title>
20923 <para><emphasis>Get there:</emphasis> More > Tools > Additional Tools > Edit
20924 quotes for QOTD feature</para>
20928 <para>This tool will allow you to add and edit quotes to show on the
20929 OPAC if you're using the Quote of the Day (QOTD) feature.</para>
20931 <para>To turn this feature on set the <link
20932 linkend="QuoteOfTheDay">QuoteOfTheDay</link> preference to 'Enable and
20933 add at least one quote via the Quote of the Day Editor. Once these
20934 steps are complete you will see your quotes above the <link
20935 linkend="OpacMainUserBlock">OpacMainUserBlock</link> in the
20939 <screeninfo>Quote in the OPAC</screeninfo>
20943 <imagedata fileref="images/tools/qotd/quoteinopac.png"/>
20948 <section id="addquote">
20949 <title>Add a Quote</title>
20951 <para>To add a quote:</para>
20955 <para>Click the 'Add quote' button in the toolbar and an empty
20956 quote entry will be added to the end of the current quote
20960 <screeninfo>Add quote button</screeninfo>
20964 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
20972 <para>Both the 'Source' and the 'Text' fields must be
20973 filled in in order to save the new quote.</para>
20976 <screeninfo>Add quote</screeninfo>
20980 <imagedata fileref="images/tools/qotd/addquote.png"/>
20990 <para>When finished filling in both fields, press the
20991 <Enter> key on your keyboard to save the new quote.</para>
20995 <para>The list will update and the new quote should now be
20996 visible in the list.</para>
21001 <para>You may cancel the addition of a new quote any time prior to
21002 saving it simply by pressing the <Esc> key on your
21007 <section id="editquote">
21008 <title>Edit/Delete a Quote</title>
21010 <para>Once the current quote pool has been loaded into the editing
21011 table, you may edit the quote source and text.</para>
21015 <para>Edit either the 'Source' or 'Text' fields by clicking on
21016 the desired field.</para>
21019 <screeninfo>Edit quote</screeninfo>
21023 <imagedata fileref="images/tools/qotd/editquote.png"/>
21030 <para>When you are finished editing a field, press the
21031 <Enter> key on your keyboard to save the changes.</para>
21035 <para>The list will be updated, the edits saved, and visible.</para>
21037 <para>If you'd like you can also delete quote(s).</para>
21041 <para>Select the quote(s) you desire to delete by clicking on
21042 the corresponding quote id.</para>
21046 <para>Once quote selection is finished, simply click the 'Delete
21047 quote(s)' button.</para>
21051 <para>You will be prompted to confirm the deletion.</para>
21055 <para>After confirming the deletion, the list will update and
21056 the quote(s) will no longer appear.</para>
21061 <section id="importquote">
21062 <title>Import Quotes</title>
21064 <para>If you'd like you can import a batch of quotes as a CSV file.
21065 Your file must contain two columns in the form: "source","text" with
21066 no header row.</para>
21069 <para>You will be prompted to confirm upload of files larger than
21075 <para>To start the import process click the 'Import quotes'
21076 button at the top of the screen</para>
21079 <screeninfo>Import quotes button</screeninfo>
21083 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
21090 <para>Once on the import quotes screen you can browse your
21091 computer for the file you would like to import</para>
21094 <screeninfo>Import quotes</screeninfo>
21098 <imagedata fileref="images/tools/qotd/importquotes.png"/>
21105 <para>After selecting the CSV file, click the 'Open' button and
21106 the file will be uploaded into a temporary editing table.</para>
21109 <screeninfo>Imported quotes</screeninfo>
21113 <imagedata fileref="images/tools/qotd/importedsummary.png"/>
21120 <para>From the listing you can edit either the 'Source' or
21121 'Text' fields by clicking on the desired field. When you are
21122 finished editing a field, press the <Enter> key on your
21123 keyboard to save the changes.</para>
21126 <screeninfo>Edit imported quote</screeninfo>
21130 <imagedata fileref="images/tools/qotd/editimported.png"/>
21137 <para>You can also delete quotes from this listing before
21138 completing the import.</para>
21142 <para>Select the quote(s) you desire to delete by clicking
21143 on the corresponding quote id.</para>
21146 <screeninfo>Selected for deletion</screeninfo>
21150 <imagedata fileref="images/tools/qotd/selectfordelete.png"/>
21157 <para>Once quote selection is finished, simply click the
21158 'Delete quote(s)' key.</para>
21161 <screeninfo>Delete quote(s)</screeninfo>
21165 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
21172 <para>You will be prompted to confirm the deletion.</para>
21175 <screeninfo>Confirm deletion</screeninfo>
21179 <imagedata fileref="images/tools/qotd/confirmdelete.png"/>
21186 <para>After confirming the deletion, the list will update
21187 and the quote(s) will no longer appear.</para>
21193 <para>Once you are satisfied with the quotes, click the 'Save
21194 quotes' button in the toolbar at the top and the quotes will be
21198 <screeninfo>Save quotes button</screeninfo>
21202 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
21213 <chapter id="patrons">
21214 <title>Patrons</title>
21216 <para>Before importing and/or adding patrons be sure to set up your <link
21217 linkend="patcats">patron categories</link>.</para>
21219 <section id="addnewpatron">
21220 <title>Add a new patron</title>
21222 <para>Patrons are added by going to the 'Patrons' module.<itemizedlist>
21224 <para><emphasis>Get there:</emphasis> Patrons</para>
21226 </itemizedlist></para>
21227 <para>Once there you can add a new patron.</para>
21231 <para>Click 'New patron'</para>
21234 <screeninfo>Choose patron type</screeninfo>
21238 <imagedata fileref="images/patrons/newpatron.png"/>
21245 <para>The fields that appear on the patron add form can be
21246 controlled by editing the <link
21247 linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
21252 <para>First enter the identifying information regarding your
21256 <screeninfo>Add Patron Form</screeninfo>
21260 <imagedata fileref="images/patrons/addpatronform.png"/>
21267 <para>Required fields are defined in the <link
21268 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
21269 system preference</para>
21273 <para>Salutation is populated by the <link
21274 linkend="BorrowersTitles">BorrowersTitles</link> system
21281 <para>Next enter the contact information</para>
21284 <screeninfo>Patron Contact Information</screeninfo>
21288 <imagedata fileref="images/patrons/addcontact.png"/>
21295 <para>For contact information, note that the primary phone and
21296 email addresses are the ones that appear on notices and slips
21297 printed during circulation (receipts, transfer slips and hold
21298 slips). The primary email is also the one that overdue notices
21299 and other messages go to.</para>
21305 <para>If this patron is a child, you will be asked to attach the
21306 child patron to an adult patron</para>
21309 <screeninfo>Guarantor Linking</screeninfo>
21313 <imagedata fileref="images/patrons/addGuarantor.png"/>
21320 <para>Click 'Set to Patron' to search your system for an
21321 existing patron</para>
21325 <para>If the Guarantor is not in the system, you can enter the
21326 first and last name in the fields available</para>
21330 <para>The relationships are set using the <link
21331 linkend="borrowerRelationship">borrowerRelationship</link>
21332 system preference</para>
21338 <para>If this patron is a professional, you will be asked to attach
21339 the patron to an organizational patron</para>
21342 <screeninfo>Organization Linking</screeninfo>
21346 <imagedata fileref="images/patrons/addOrg.png"/>
21353 <para>Click 'Set to Patron to search your system for an existing
21360 <para>Each patron can have an alternate contact</para>
21363 <screeninfo>Alternate Contact</screeninfo>
21367 <imagedata fileref="images/patrons/addaltcontact.png"/>
21374 <para>An alternate contact could be a parent or guardian. It can
21375 also be used in academic settings to store the patron's home
21382 <para>The library management section includes values that are used
21383 within the library</para>
21386 <screeninfo>Library Management</screeninfo>
21390 <imagedata fileref="images/patrons/addlibmanagement.png"/>
21397 <para>The card number field is automatically calculated if you
21398 have the <link linkend="autoMemberNum">autoMemberNum</link>
21399 system preference set that way</para>
21404 <para>For a newly installed system this preference will
21405 start at 1 and increment by 1 each time after. To have it
21406 start with the starting number of your barcodes, enter the
21407 first barcode by hand in the patron record and save the
21408 patron. After that the field will increment that number by
21416 <para>If you accidentally chose the wrong patron category at the
21417 beginning you can fix that here</para>
21421 <para>Sort 1 and 2 are used for statistical purposes within your
21428 <para>Next, the Library Setup section includes additional library
21432 <screeninfo>Library set-up options</screeninfo>
21436 <imagedata fileref="images/patrons/addlibsetup.png"/>
21443 <para>The registration date will automatically be filled in with
21444 today's date</para>
21448 <para>If your patron cards expire (based on your <link
21449 linkend="patcats">patron category settings</link>) the Expiry
21450 date will automatically be calculated</para>
21454 <para>The OPAC Note is a note for the patron - it will appear in
21455 the OPAC on the patron's record</para>
21459 <para>The Circulation Note is meant solely for your library
21460 staff and will appear when the circulation staff goes to check
21461 an item out to the patron</para>
21464 <screeninfo>Sample Circulation Note</screeninfo>
21468 <imagedata fileref="images/patrons/circnote.png"/>
21475 <para>The Staff/OPAC asks for the username and password to be
21476 used by the patron (and/or staff member) to log into their
21477 account in the OPAC and for staff to log in to the staff
21482 <para>Staff will only be able to use this log in info to log
21483 in to the staff client if they have the <link
21484 linkend="patronpermissions">necessary
21485 permissions</link>.</para>
21493 <para>If you have set <link
21494 linkend="patronattributetypes">additional patron attributes</link>
21495 up, these will appear next</para>
21498 <screeninfo>Additional Patron Attributes</screeninfo>
21502 <imagedata fileref="images/patrons/addattributes.png"/>
21509 <para id="setpatronmessaging">Finally, if you have <link
21510 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
21511 set to 'allow,' you can choose the messaging preferences for this
21515 <screeninfo>Patron Messaging Settings</screeninfo>
21519 <imagedata fileref="images/patrons/addpatronmsg.png"/>
21526 <para>These notices are:</para>
21529 <para>Advanced Notice : A notice in advance of the patron's items being due (The
21530 patron can choose the number of days in advance)</para>
21533 <para>Item Checkout : A notice that lists all the of the items the patron has just
21534 checked out and/or renewed, this is an electronic form of the checkout
21538 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
21542 <para>Item Due : A notice on the day and item is due back at the library</para>
21545 <para>Item Checkin : A notice that lists all the of the items the patron has just
21552 <para>These preferences will override any you set via the
21553 <link linkend="addingpatroncat">patron
21554 categories</link></para>
21560 <para>These preference can be altered by the patron via the
21568 <para>Once finished, click 'Save'</para>
21572 <para>If the system suspects this patron is a duplicate of another it
21573 will warn you.</para>
21576 <screeninfo>Patron Duplicate Suspected</screeninfo>
21580 <imagedata fileref="images/patrons/duplicatewarn.png"/>
21585 <para>If you have set a minimum or upper age limit on the patron
21586 category and are requiring that the birth date be filled in, Koha will
21587 warn you if the patron you're adding is too old or young for the patron
21588 category you have selected:</para>
21591 <screeninfo>Patron age warning</screeninfo>
21595 <imagedata fileref="images/patrons/patronagelimit.png"/>
21601 <section id="addstaffpatron">
21602 <title>Add a Staff Patron</title>
21604 <para>All staff members must be entered into Koha as patrons of the
21605 'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
21606 Patron</link> to add a staff member. To give the staff member
21607 permissions to access the staff client, follow the steps in <link
21608 linkend="patronpermissions">Patron Permissions</link></para>
21611 <para>Remember to assign your staff secure usernames and passwords
21612 since these will be used to log into the staff client.</para>
21616 <section id="addstatspatron">
21617 <title>Add a Statistical Patron</title>
21619 <para>One way to track use of in house items is to "check out" the
21620 materials to a statistical patron. The "check out" process doesn's check
21621 the book out, but instead tracks an in house use of the item. To use
21622 this method for tracking in house use you first will need a <link
21623 linkend="patcats">patron category</link> set up for your Statistical
21627 <screeninfo>In House Patron Category</screeninfo>
21631 <imagedata fileref="images/patrons/statspatcat.png"/>
21636 <para>Next, you will need to create a new patron of the statistical
21640 <screeninfo>New In House Patron</screeninfo>
21644 <imagedata fileref="images/patrons/newinhouse.png"/>
21649 <para>Next, follow the steps put forth in the '<link
21650 linkend="addnewpatron">Add a new Patron</link>' section of this manual.
21651 Since this patron is not a real person, simply fill in the required
21652 fields, the correct library and nothing else.</para>
21654 <para>To learn about other methods of tracking in house use visit the
21655 <link linkend="trackinhouse">Tracking inhouse use</link> section of this
21659 <section id="duplicatepatron">
21660 <title>Duplicate a Patron</title>
21662 <para>Sometimes when you're adding a new family to your system you don't
21663 want to type the contact information over and over. Koha allows for you
21664 to duplicate a patron and change only the parts you want to (or need to)
21669 <para>Open the patron you want to use as your base (the patron you
21670 want to duplicate information from)</para>
21674 <para>Click the 'Duplicate' button at the top of their record</para>
21677 <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
21681 <imagedata fileref="images/patrons/duplicatepatron.png"/>
21688 <para>All of the fields with the exception of first name, card
21689 number, username and password have been duplicated. Fill in the
21690 missing pieces and click 'Save'</para>
21693 <screeninfo>Duplicating Patron Form</screeninfo>
21697 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
21705 <para>Clicking in a field that is already populated with data
21706 will clear that field of all information (making it easier for
21707 you to type in something different)</para>
21714 <para>You will be brought to your new patron</para>
21717 <screeninfo>Newly created patron</screeninfo>
21721 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
21729 <section id="editpatrons">
21730 <title>Editing Patrons</title>
21732 <para>Patrons in Koha can be edited using one of many edit
21737 <para>To edit the entire patron record simply click the 'Edit'
21738 button at the top of the patron record.</para>
21741 <screeninfo>Main Patron Edit Menu</screeninfo>
21745 <imagedata fileref="images/patrons/patronedit.png"/>
21752 <para>Patron passwords are not recoverable. The stars show on the
21753 patron detail next to the Password label are always there even if a
21754 password isn't set. If a patron forgets their password the only
21755 option is to reset their password. To change the patron's password,
21756 click the 'Change Password' button</para>
21759 <screeninfo>Patron Password Change Form</screeninfo>
21763 <imagedata fileref="images/patrons/patronpassword.png"/>
21770 <para>Koha cannot display existing passwords. Leave the field
21771 blank to leave password unchanged.</para>
21775 <para>This form can automatically generate a random password if
21776 you click the link labeled "Click to fill with a randomly
21777 generated suggestion. Passwords will be displayed as
21784 <para>To edit a specific section of the patron record (for example
21785 the Library Use section) click the 'Edit' link below the
21789 <screeninfo>Library Use Section of Patron Record</screeninfo>
21793 <imagedata fileref="images/patrons/patroneditsection.png"/>
21800 <para>A patron image can be added by browsing for the image on your
21801 machine from the 'Manage Patron Image' section</para>
21804 <screeninfo>Manage Patron Image Form</screeninfo>
21808 <imagedata fileref="images/patrons/patronaddimage.png"/>
21815 <para>This form will not appear if you have the <link
21816 linkend="patronimages">patronimages</link> system preference to
21817 not allow patron images</para>
21821 <para>To add patron images in bulk, use the <link
21822 linkend="uploadpatronimages">Upload Patron Images</link>
21829 <para id="patronflags">Patrons can also be blocked from checking
21830 items out by setting Patron Flags</para>
21833 <screeninfo>Patron Warning Flags</screeninfo>
21837 <imagedata fileref="images/patrons/patronflags.png"/>
21844 <para>If you would like your circulation staff to confirm a
21845 patron's address before checking items out to the patron, you
21846 can see the 'Gone no Address' flag</para>
21849 <screeninfo>Patron's address in doubt</screeninfo>
21853 <imagedata fileref="images/patrons/patronaddress.png"/>
21860 <para>If you would like to bar a patron from the library you can
21861 set the 'Restricted' flag</para>
21865 <para>This flag can automatically be set with the <link
21866 linkend="noticetriggers">Overdue/Notice Status
21867 Triggers</link></para>
21870 <screeninfo>Patron restricted</screeninfo>
21874 <imagedata fileref="images/patrons/patronrestricted.png"/>
21883 <para>If you enter in a date and/or note related to the
21884 restriction you will see that in the restricted message as
21888 <screeninfo>Restricted until message</screeninfo>
21892 <imagedata fileref="images/patrons/restricteduntil.png"/>
21899 <para>If the patron reports that they have lost their card you
21900 can set the 'Lost Card' flag to prevent someone else from using
21901 that card to check items out</para>
21904 <screeninfo>Patron lost card</screeninfo>
21908 <imagedata fileref="images/patrons/patroncardlost.png"/>
21917 <para>Children patrons do not become adults automatically in Koha.
21918 To upgrade a child patron to and adult patron category click on the
21919 'More' menu and choose 'Update Child to Adult Patron'</para>
21922 <screeninfo>Update Child to Adult Patron</screeninfo>
21926 <imagedata fileref="images/patrons/updatetoadult.png"/>
21933 <para>You will then be presented with a pop up window asking
21934 which one of your adult patron categories this Child should be
21938 <screeninfo>Choose Adult Category to Update To</screeninfo>
21942 <imagedata fileref="images/patrons/choosadulttype.png"/>
21952 <section id="patronpermissions">
21953 <title>Patron Permissions</title>
21955 <para>Patron Permissions are used to allow staff members access to the
21956 staff client.</para>
21959 <para>In order for a staff member to log into the staff interface they
21960 must have (at the very least) 'catalogue' permissions which allow them
21961 to view the staff interface.</para>
21964 <section id="setpatronperms">
21965 <title>Setting Patron Permissions</title>
21967 <para>To set patron permissions, you must first <link
21968 linkend="addstaffpatron">have a patron of the 'Staff' type</link>
21973 <para>On the patron record click More and choose Set Permissions
21974 to alter patron permissions</para>
21977 <screeninfo>Set Patron Permissions</screeninfo>
21981 <imagedata fileref="images/patrons/editpatronpermissions.png"/>
21988 <para>You will be presented with a list of preferences, some of
21989 which can be expanded by clicking the plus sign to the left of the
21990 section title.</para>
21993 <screeninfo>Patron Permissions</screeninfo>
21997 <imagedata fileref="images/patrons/GranularPermissions.png"/>
22005 <section id="patronpermsdefined">
22006 <title>Patron Permissions Defined</title>
22012 <para>superlibrarian</para>
22016 <para>Access to all librarian functions</para>
22021 <para>With this selected there is no need to choose any
22022 other permissions</para>
22031 <para>circulate</para>
22035 <para>Check out and check in items</para>
22039 <para>This section can be expanded (<link
22040 linkend="circpermissions">Learn more</link>)</para>
22046 <para>catalogue</para>
22050 <para><emphasis role="bold">Required for staff login.</emphasis> Staff access,
22051 allows viewing the catalogue in staff client<itemizedlist>
22054 <para>Must be given to all staff members to allow them to login to the staff
22058 </itemizedlist></para>
22064 <para>parameters</para>
22068 <para>Manage Koha system systems (Administration panel)</para>
22072 <para>This secton can be expanded (<link
22073 linkend="parameterpermissions">Learn more</link>)</para>
22079 <para>borrowers</para>
22083 <para>Add or modify patrons</para>
22089 <para>permissions</para>
22093 <para>Set user permissions</para>
22099 <para>reserveforothers</para>
22103 <para>Place and modify holds for patrons</para>
22107 <para>This section can be expanded (<link
22108 linkend="reservepermissions">Learn more</link>)</para>
22114 <para>borrow</para>
22118 <para>Borrow books</para>
22124 <para>editcatalogue</para>
22128 <para>Edit Catalog (Modify bibliographic/hodings data)</para>
22132 <para>This section can be expanded (<link
22133 linkend="catpermissions">Learn more</link>)</para>
22139 <para>updatecharges</para>
22143 <para>Manage patrons fines and fees</para>
22149 <para>acquisition</para>
22153 <para>Acquisition and/or suggestion management</para>
22157 <para>This section can be expanded (<link
22158 linkend="acqpermissions">Learn more</link>)</para>
22164 <para>management</para>
22168 <para>Set library management paraments (deprecated)<itemizedlist>
22171 <para>This permission level no longer controls anything.</para>
22174 </itemizedlist></para>
22184 <para>Use all tools</para>
22188 <para>This section can be expanded (<link
22189 linkend="toolspermissions">Learn more</link>)</para>
22195 <para>editauthorities</para>
22199 <para>Edit Authorities</para>
22205 <para>serials</para>
22209 <para>Manage serial subscriptions</para>
22213 <para>This section can be expanded (<link
22214 linkend="serpermissions">Learn more</link>)</para>
22220 <para>reports</para>
22224 <para>Allow access to the reports module</para>
22228 <para>Reports found on the Circulation page are not controlled
22229 by this permission</para>
22233 <para>This section can be expanded (<link
22234 linkend="reportpermissions">Learn more</link>)</para>
22240 <para>staffaccess</para>
22244 <para>Allow staff members to modify permissions for other staff members</para>
22249 <para>Requires the borrowers permission above</para>
22256 <section id="circpermissions">
22257 <title>Granular Circulate Permissions</title>
22259 <para>If the staff member has 'circulate' permissions they have the
22260 ability to perform all of these actions. If you would like to
22261 control circulation permissions on a more granular level choose from
22262 these options:</para>
22266 <para>circulate_remaining_permissions</para>
22270 <para>Remaining circulation permissions</para>
22273 <para>All circulation rights except the ability to override renewals</para>
22279 <para>override_renewals</para>
22283 <para>Override blocked renewals</para>
22287 <para>Requires that the staff member also has
22288 circulate_remaining_permissions</para>
22295 <section id="parameterpermissions">
22296 <title>Granular Parameters Permissions</title>
22298 <para>If the staff member has 'parameters' permissions they have the
22299 ability to perform all of these actions. If you would like to
22300 control parameter permissions on a more granular level choose from
22301 these options:</para>
22305 <para>manage_circ_rules</para>
22309 <para>Manage circulation rules</para>
22312 <para>The ability to access the <link linkend="circfinerules">Circulation and
22313 fines rules</link> in the administration area</para>
22319 <para>parameters_remaining_permissions</para>
22323 <para>Remaining system parameters permissions</para>
22326 <para>The ability to access all areas in Administration (other than the
22327 Circulation and fine rules)</para>
22334 <section id="reservepermissions">
22335 <title>Granular Holds Permissions</title>
22337 <para>If the staff member has 'reserveforothers' permissions they
22338 have the ability to perform all of these actions. If you would like
22339 to control holds permissions on a more granular level choose from
22340 these options:</para>
22344 <para>modify_holds_priority</para>
22348 <para>Modify holds priority</para>
22351 <para>Allow staff members to alter the holds priority (moving patrons up and down
22358 <para>place_holds</para>
22362 <para>Place holds for patrons</para>
22369 <section id="catpermissions">
22370 <title>Granular Cataloging Permissions</title>
22372 <para>If the staff member has 'editcatalogue' permissions they have
22373 the ability to perform all of these actions. If you would like to
22374 control cataloging permissions on a more granular level choose from
22375 these options:</para>
22379 <para>edit_catalogue</para>
22383 <para>Edit catalog (Modify bibliographic/holdings data)</para>
22386 <para>Ability to access all cataloging functions via the <link
22387 linkend="cataloging">Cataloging</link> page</para>
22393 <para>edit_items</para>
22397 <para>Edit items</para>
22400 <para>Ability to make <link linkend="editingitems">edits to item/holdings
22401 records</link>, but not bibliographic records</para>
22407 <para id="fastaddpermissions">fast_cataloging</para>
22411 <para>Fast cataloging</para>
22414 <para>The ability to catalog using only the <link linkend="fastaddcat">Fast Add
22415 Framework</link> found on the <link linkend="circulation">Circulation</link>
22423 <section id="acqpermissions">
22424 <title>Granular Acquisitions Permissions</title>
22426 <para>If the staff member has 'acquisition' permissions they have
22427 the ability to perform all of these actions. If you would like to
22428 control acquisitions permissions on a more granular level choose
22429 from these options:</para>
22433 <para>budget_add_del</para>
22437 <para>Add and delete budgets (but can't modify them)</para>
22443 <para>budget_manage</para>
22446 <para>Manage budgets</para>
22452 <para>budget_manage_all <itemizedlist>
22454 <para>Manage all budgets</para>
22456 </itemizedlist></para>
22457 <para>budget_modify</para>
22460 <para>Modify budget (can't create lines, but can modify existing ones)</para>
22466 <para>contracts_manage</para>
22470 <para>Manage contracts</para>
22476 <para>group_manage</para>
22480 <para>Manage orders and basket groups</para>
22486 <para>order_manage</para>
22490 <para>Manage orders and baskets</para>
22496 <para>order_receive</para>
22500 <para>Manage orders and baskets</para>
22506 <para>period_manage</para>
22510 <para>Manage periods</para>
22516 <para>planning_manage</para>
22520 <para>Manage budget planning</para>
22526 <para>vendors_manage</para>
22530 <para>Manage vendors</para>
22537 <section id="serpermissions">
22538 <title>Granular Serials Permissions</title>
22540 <para>If the staff member has 'serials' permissions they have the
22541 ability to perform all of these actions. If you would like to
22542 control serials permissions on a more granular level choose from
22543 these options:</para>
22547 <para>check_expiration</para>
22551 <para>Check the <link linkend="serialexpiration">expiration of a
22552 serial</link></para>
22558 <para>claim_serials</para>
22562 <para>Claim missing serials via the <link linkend="serialclaims">Claims
22563 section</link></para>
22569 <para>create_subscription</para>
22573 <para>Create <link linkend="newsubscription">a new subscription</link></para>
22579 <para>delete_subscription</para>
22583 <para>Delete an existing subscription</para>
22589 <para>edit_subscription</para>
22593 <para>Edit an existing subscription</para>
22596 <para>This permission does not include the ability to delete or create a
22597 subscription</para>
22603 <para>receive_serials</para>
22607 <para>Serials receiving</para>
22610 <para>Receive serials on existing subscriptions</para>
22616 <para>renew_subscription</para>
22620 <para>Renew a subscription</para>
22626 <para>routing</para>
22630 <para>Routing</para>
22633 <para>Manage <link linkend="routinglist">routing lists</link></para>
22640 <section id="toolspermissions">
22641 <title>Granular Tools Permissions</title>
22643 <para>If the staff member has 'tools' permissions they have the
22644 ability to access and use all items under the Tools menu. If you
22645 would like to control which tools staff members have access to on a
22646 more granular level choose from these options:</para>
22650 <para>batch_upload_patron_images</para>
22654 <para>Upload patron images in batch or one at a time </para>
22657 <para>Access to the <link linkend="uploadpatronimages">Image Upload
22664 <para>delete_anonymize_patrons</para>
22668 <para>Delete old borrowers and anonymize circulation/reading history (deletes
22669 borrower reading history)</para>
22672 <para>Access to the <link linkend="anonpatrons">Anonymize Patron
22679 <para>edit_calendar</para>
22683 <para>Define days when the library is closed </para>
22686 <para>Access to the <link linkend="calholidays">Calendar/Holidays
22693 <para>edit_news</para>
22697 <para>Write news for the OPAC and staff interfaces </para>
22700 <para>Access to the <link linkend="newstool">News Tool</link></para>
22706 <para>edit_notice_status_triggers</para>
22710 <para>Set notice/status triggers for overdue items </para>
22713 <para>Access to the <link linkend="noticetriggers">Overdue Notice Status/Triggers
22720 <para>edit_notices</para>
22724 <para>Define notices </para>
22727 <para>Access to the <link linkend="notices">Notices Tool</link></para>
22733 <para>export_catalog</para>
22737 <para>Export bibliographic, authorities and holdings data </para>
22740 <para>Access to the <link linkend="exportbibs">Export Data Tool</link></para>
22746 <para>import_patrons</para>
22750 <para>Import patron data </para>
22753 <para>Access to the <link linkend="patronimport">Import Patrons Tool</link></para>
22759 <para>inventory</para>
22763 <para>Perform inventory (stocktaking) of your catalog </para>
22766 <para>Access to the <link linkend="inventory">Inventory Tool</link></para>
22772 <para>items_batchdel</para>
22776 <para>Perform batch deletion of items </para>
22779 <para>Access to the <link linkend="batchdeleteitems">Batch Item Deletion
22786 <para>items_batchmod</para>
22790 <para>Perform batch modification of items </para>
22793 <para>Access to the <link linkend="batchmodifyitems">Batch Item Modification
22800 <para>label_creator</para>
22804 <para>Create printable labels and barcodes from catalog and patron data </para>
22807 <para>Access to the <link linkend="labelcreator">Label Creator</link> and <link
22808 linkend="quicklabelcreator">Quick Label Creator</link> Tools</para>
22814 <para>manage_csv_profiles</para>
22818 <para>Manage CSV export profiles</para>
22821 <para>Access to the <link linkend="csvprofiles">CSV Profiles Tool</link></para>
22827 <para>manage_staged_marc</para>
22831 <para>Managed staged MARC records, including completing and reversing imports
22835 <para>Access to the <link linkend="managestaged">Manage Staged MARC Records
22842 <para>moderate_comments</para>
22846 <para>Moderate patron comments </para>
22849 <para>Access to the <link linkend="comments">Comments Tool</link>
22856 <para>moderate_tags<itemizedlist>
22858 <para>Moderate patron tags</para>
22861 <para>Access to the <link linkend="tagsmoderation">Tags Tool</link></para>
22863 </itemizedlist></para>
22866 <para>schedule_tasks</para>
22869 <para>Schedule tasks to run </para>
22872 <para>Access to the <link linkend="taskscheduler">Task Scheduler
22879 <para>stage_marc_import</para>
22883 <para>Stage MARC records into the reservoir </para>
22886 <para>Access to the <link linkend="stagemarc">Stage MARC Records
22893 <para>upload_local_cover_images</para>
22897 <para>Upload local cover images </para>
22900 <para>Access to the <link linkend="uploadlocalimages">Upload Local Cover Image
22907 <para>view_system_logs</para>
22911 <para>Browse the system logs </para>
22914 <para>Access to the <link linkend="logviewer">Log Viewer Tool</link></para>
22921 <section id="reportpermissions">
22922 <title>Granular Reports Permissions</title>
22924 <para>If the staff member has 'reports' permissions they have the
22925 ability to perform all of these actions. If you would like to
22926 control reports permissions on a more granular level choose from
22927 these options:</para>
22931 <para>create_reports</para>
22935 <para>Create SQL Reports</para>
22938 <para>The ability to create and edit but not run SQL reports</para>
22944 <para>execute_reports</para>
22948 <para>Execure SQL Reports</para>
22951 <para>The ability to run but not create or edit SQL reports <itemizedlist>
22955 <para>This include Circulation reports such as Overdues</para>
22959 </itemizedlist></para>
22968 <section id="patroninformation">
22969 <title>Patron Information</title>
22971 <para>When viewing a patron record you have the option to view information from one of many
22972 tabs found on the left hand side of the record.<itemizedlist>
22974 <para><emphasis role="italic">Get there:</emphasis> Patrons > Browse or search for
22975 patron > Click patron name</para>
22977 </itemizedlist></para>
22979 <section id="patcheckout">
22980 <title>Check Out</title>
22982 <para>For instruction on checking items out, view the <link
22983 linkend="checkingout">Checking Out</link> section of this
22987 <section id="patrondetails">
22988 <title>Details</title>
22990 <para>All patron information will appear on the Details tab. This
22991 includes all the contact information, notes, custom patron attributes,
22992 messaging preferences, etc entered when adding the patron.</para>
22994 <para>In the case of patrons who are marked as 'Child' or
22995 'Professional' and their Guarantors additional information will appear
22996 on their record.</para>
23000 <para>A child patron will list their Guarantor</para>
23003 <screeninfo>Guarantor listed and linked from the child
23004 record</screeninfo>
23008 <imagedata fileref="images/patrons/child.png"/>
23015 <para>On the Guarantor's record, all children and/or professionals
23016 will be listed</para>
23019 <screeninfo>Guarantees listed on the Guarantor's
23020 profile</screeninfo>
23024 <imagedata fileref="images/patrons/parent.png"/>
23031 <section id="patcircsummary">
23032 <title>Circulation Summary</title>
23034 <para>Below the patron's information on the details screen is a
23035 tabbed display of the items they have checked out, overdue, and on
23039 <screeninfo>Checkout summary</screeninfo>
23043 <imagedata fileref="images/patrons/checkoutsummary.png"/>
23048 <para>If they have family at the library staff can see what the
23049 other family members have checked out.</para>
23052 <screeninfo>Relative checkouts</screeninfo>
23056 <imagedata fileref="images/patrons/relativecheckouts.png"/>
23063 <section id="patronfines">
23064 <title>Fines</title>
23066 <para>The patron's complete accounting history will appear on the
23067 Fines tab. Contrary to its name, the Fines tab does not just show fine
23068 data, it also shows membership fees, rental fees, reserve fees and any
23069 other charge you may have for patrons.</para>
23072 <screeninfo>Patron Accounting Summary</screeninfo>
23076 <imagedata fileref="images/patrons/patronaccount.png"/>
23081 <para>The table will show you the following columns:</para>
23085 <para>Date: the date the charge/payment was posted</para>
23089 <para>In the case of fines this will be the last day that the
23090 fine was accrued</para>
23096 <para>Description: a description of the charges including the due
23097 date for overdue items and a link to the item record where one is
23102 <para>Note: any notes about this charge/payment</para>
23106 <para>Amount: the total amount of the payment or charge</para>
23110 <para>Outstanding: the amount still due on charge</para>
23114 <section id="chargefines">
23115 <title>Charging Fines/Fees</title>
23117 <para>Most fees and fines will be charged automatically if the <link
23118 linkend="finescronjob">fines cron job</link> is running:</para>
23122 <para>Fines will be charged based on your <link
23123 linkend="circfinerules">Circulation & Fines
23124 Rules</link></para>
23128 <para>Hold fees will be charged based on the rules you set in
23129 the <link linkend="patcats">Patron Types & Categories</link>
23130 administration area</para>
23134 <para>Rental fees will be charged based on the settings in your
23135 <link linkend="itemtypeadmin">Item Types</link> administration
23140 <para>Marking an item 'Lost' via the cataloging module will
23141 automatically charge the patron the replacement cost for that
23147 <section id="payfines">
23148 <title>Pay/Reverse Fines</title>
23150 <para>Each line item can be paid in full (or written off) using the
23151 'Pay Fines' tab.</para>
23154 <screeninfo>Paying Fines</screeninfo>
23158 <imagedata fileref="images/patrons/makepayment.png"/>
23165 <para>Each line item can be paid in full, partially paid, or
23166 written off.</para>
23170 <para>Pay a fine in full</para>
23174 <para>Click "Pay" next to the fine you want to pay in
23179 <para>The full amount of the fine will be populated for you
23180 in the "Collect From Patron" box</para>
23183 <screeninfo>Pay fine</screeninfo>
23187 <imagedata fileref="images/patrons/payfine.png"/>
23194 <para>Click "Confirm"</para>
23198 <para>The fine will be removed from outstanding fines, and
23199 displayed as fully paid.</para>
23205 <para>Pay a partial fine</para>
23209 <para>Click "Pay" next to the fine you want to partially
23214 <para>Enter the amount you are collecting from the patron in
23215 the "Collect From Patron" box</para>
23218 <screeninfo>Pay partial fine</screeninfo>
23222 <imagedata fileref="images/patrons/paypartial.png"/>
23229 <para>Click "Confirm"</para>
23233 <para>The fine will be updated to show the original Amount,
23234 and the current Amount Outstanding</para>
23240 <para>Pay an amount towards all fines</para>
23244 <para>Click the "Pay Amount" button</para>
23248 <para>Enter the amount you are collecting from the patron in
23249 "Collect from Patron." The sum of all fines is shown in
23250 "Total Amount Outstanding"</para>
23253 <screeninfo>Pay Amount</screeninfo>
23257 <imagedata fileref="images/patrons/payamount.png"/>
23264 <para>Click "Confirm"</para>
23268 <para>The fine totals will be updated with the payment
23269 applied to oldest fines first.</para>
23275 <para>Pay Selected fines</para>
23279 <para>Check the selection boxes next to the fines you wish
23280 to pay, click "Pay Selected"</para>
23283 <screeninfo>Select lines to pay</screeninfo>
23287 <imagedata fileref="images/patrons/payselected-select.png"/>
23294 <para>Enter an amount to pay towards the fines.</para>
23297 <screeninfo>Pay Selected</screeninfo>
23301 <imagedata fileref="images/patrons/payselected.png"/>
23308 <para>Click "Confirm"</para>
23312 <para>The fine totals will be updated with the payment
23313 applied to the oldest selected fines first.</para>
23319 <para>Writeoff a single fine</para>
23323 <para>Click "Writeoff" next to the fine you wish to
23328 <para>The fine will be removed from outstanding fines, and
23329 displayed as written off.</para>
23335 <para>Writeoff All fines</para>
23339 <para>Click the "Writeoff All" button</para>
23343 <para>All fines will be removed from outstanding fines, and
23344 displayed as written off.</para>
23350 <para>If you accidentally mark and item as paid, you can reverse
23351 that line item by clicking 'Reverse' to the right of the
23355 <screeninfo>Reverse Link</screeninfo>
23359 <imagedata fileref="images/patrons/reverselink.png"/>
23366 <para>Once clicked a new line item will be added to the
23367 account, showing the payment as reversed</para>
23370 <screeninfo>Reversed Payment</screeninfo>
23374 <imagedata fileref="images/patrons/reversed.png"/>
23384 <section id="manualinvoice">
23385 <title>Creating Manual Invoices</title>
23387 <para>For fees that are not automatically charged, librarians can
23388 create a manual invoice</para>
23391 <screeninfo>Create Manual Invoice</screeninfo>
23395 <imagedata fileref="images/patrons/manualinvoice.png"/>
23402 <para>First choose the type of invoice you would like to
23407 <para>To add additional values to the manual invoice type pull down menu, add them
23408 to the <link linkend="manualinvvals">MANUAL_INV</link> Authorized Value</para>
23413 <para>The value set as the Authorized Value for the MANUAL_INV authorized
23414 value category will appear as the Description and the Authorized Value
23415 Description will be used as the amount.</para>
23423 <para>If the fee is associated with an item you can enter its
23424 barcode so that the line item shows a link to that item</para>
23428 <para>The description field is where you will enter the
23429 description of the charge</para>
23433 <para>In the amount field, do not enter currency symbols, only
23434 numbers and decimals</para>
23439 <section id="manualcredit">
23440 <title>Creating Manual Credits</title>
23442 <para>Manual credits can be used to pay off parts of fines, or to
23443 forgive a fine amount.</para>
23446 <screeninfo>Create Manual Credit</screeninfo>
23450 <imagedata fileref="images/patrons/manualcredit.png"/>
23457 <para>First choose the type of credit you'd like to apply</para>
23461 <para>If this credit is associated with an item you can enter
23462 that item's barcode so that the line item links to the right
23467 <para>The description field is where you will enter the
23468 description of the credit</para>
23472 <para>In the amount field, do not enter currency symbols, only
23473 numbers and decimals</para>
23478 <section id="printinglineitems">
23479 <title>Printing Invoices</title>
23481 <para>To the right of each account line there is a print link.
23482 Clicking that link will print an invoice for the line item that
23483 includes the date and description of the line item along with the
23484 total outstanding on the account.</para>
23487 <screeninfo>Sample Invoice</screeninfo>
23491 <imagedata fileref="images/patrons/patroninvoice.png"/>
23498 <section id="patronroutingtab">
23499 <title>Routing Lists</title>
23501 <para>A list of all of the serial routing lists the patron belongs to
23502 will be accessible via the 'Routing Lists' tab on the patron
23506 <screeninfo>Routing Lists</screeninfo>
23510 <imagedata fileref="images/patrons/routinglisttab.png"/>
23515 <para>On this tab you will be able to see and edit all of the routing
23516 lists that this patron is on.</para>
23519 <screeninfo>Patron's routing lists</screeninfo>
23523 <imagedata fileref="images/patrons/patronroutinglists.png"/>
23529 <section id="circhistory">
23530 <title>Circulation History</title>
23532 <para>The circulation history tab will appear if you have set the
23533 <link linkend="intranetreadinghistory">intranetreadinghistory</link>
23534 preference to allow it to appear. If you have the <link
23535 linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
23536 'Allow' and the patron has decided that the library cannot keep this
23537 information this tab will only show currently checked out
23541 <screeninfo>Patron Circulation History</screeninfo>
23545 <imagedata fileref="images/patrons/readinghistory.png"/>
23550 <para>If you would like to export a list of barcodes for the items
23551 checked in today you can find that option under the More menu on the
23552 top right of the page.</para>
23555 <screeninfo>Export today's checkins</screeninfo>
23559 <imagedata fileref="images/patrons/readinghistory-export.png"/>
23564 <para>This will generate a text file with one barcode per line.</para>
23567 <section id="patmodlog">
23568 <title>Modification Log</title>
23570 <para>If you have set your <link
23571 linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
23572 records, then this tab will appear. The Modification Log will show
23573 when changes were made to the patron record. If you also have turned
23574 on the <link linkend="IssueLog">IssueLog</link> and <link
23575 linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
23576 this screen as well.</para>
23579 <screeninfo>Changes to Patron</screeninfo>
23583 <imagedata fileref="images/patrons/borrowerlog.png"/>
23590 <para>The Librarian field shows the patron number for the
23591 librarian who made the changes</para>
23595 <para>The module lists 'MEMBERS' for the patron module</para>
23599 <para>The action will tell you what action was being logged</para>
23603 <para>The Object field lists the borrowernumber that is being
23604 modified (in the example above, it was my changing my own
23610 <section id="patnotices">
23611 <title>Notices</title>
23613 <para>The <link linkend="setpatronmessaging">patron's messaging
23614 preferences</link> are set when <link
23615 linkend="addnewpatron">adding</link> or <link
23616 linkend="editpatrons">editing</link> the patron. This tab will show
23617 the messages that have been sent and those that are queued to be
23621 <screeninfo>Patron Notices Tab</screeninfo>
23625 <imagedata fileref="images/patrons/patnoticestab.png"/>
23630 <para>Clicking on the message title will expand the view to show you
23631 the full text of the message that was sent.</para>
23634 <screeninfo>Full message text</screeninfo>
23638 <imagedata fileref="images/patrons/patnoticestab-full.png"/>
23644 <section id="patronstatstab">
23645 <title>Statistics</title>
23647 <para>Depending on what you set for the values of your <link
23648 linkend="StatisticsFields">StatisticsFields</link> system preference,
23649 you can see statistics for one patron's circulation actions.</para>
23652 <screeninfo>Patron's Statistics</screeninfo>
23656 <imagedata fileref="images/patrons/patronstats.png"/>
23662 <section id="patronfiles">
23663 <title>Files</title>
23665 <para>If you set the <link
23666 linkend="EnableBorrowerFiles">EnableBorrowerFiles</link> preference to
23667 'Do' the Files tab will be visible on the patron information
23671 <screeninfo>Patron Files Tab</screeninfo>
23675 <imagedata fileref="images/patrons/patronfilestab.png"/>
23680 <para>From here you can upload files to attach to the patron
23684 <screeninfo>Upload patron files</screeninfo>
23688 <imagedata fileref="images/patrons/nopatronfiles.png"/>
23693 <para>All files that are uploaded will appear above a form where
23694 additional files can be uploaded from.</para>
23697 <screeninfo>List of files on the patron record</screeninfo>
23701 <imagedata fileref="images/patrons/patronfileslist.png"/>
23708 <section id="patronsearch">
23709 <title>Patron Search</title>
23711 <para>Clicking on the link to the Patron module will bring you to a search/browse screen for
23712 patrons. From here you can search for a patron by any part of their name or their card
23716 <screeninfo>Patron Search</screeninfo>
23720 <imagedata fileref="images/patrons/patronsearch.png"/>
23724 <para>If you want to filter your results to a specific branch or category, you can click the
23725 plus sign [+] to the right of the search box.</para>
23727 <screeninfo>Advanced Patron Search</screeninfo>
23730 <imagedata fileref="images/patrons/patronfilter.png"/>
23735 <para>Depending on what you have chosen for the 'Search fields' you can
23736 search for patrons in various different ways.</para>
23739 <screeninfo>Patron Search Fields</screeninfo>
23743 <imagedata fileref="images/patrons/patronfieldsearch.png"/>
23750 <para>Standard:</para>
23754 <para>Enter any part of their name, username, email address or
23761 <para>Email:</para>
23765 <para>Enter any part of their email address using % as a
23772 <para>Borrower number:</para>
23776 <para>Enter the Koha borrower number</para>
23782 <para>Phone number:</para>
23786 <para>Enter the phone number exactly as it is in the system or
23787 by using spaces between each batch of numbers.</para>
23791 <para>Example: To find (212) 555-1212 you can search for it
23792 exactly as it was entered or by searching for 212 555
23799 <para>Street address:</para>
23803 <para>Enter any part of the patron's address (includes all
23804 address fields) using % as a wildcard</para>
23808 <para>Example: To find Portland, ME you can search for %Port%
23809 and it will find the string "Port" anywhere in the address
23816 <para>You can also choose how your results will be sorted by using the
23817 'Order by' pull down menu at the end of the form.</para>
23820 <screeninfo>Patron search sort</screeninfo>
23824 <imagedata fileref="images/patrons/patronsearchsort.png"/>
23829 <para>You can also browse through the patron records by clicking on the
23830 linked letters across the top.</para>
23833 <screeninfo>Patron Browse</screeninfo>
23837 <imagedata fileref="images/patrons/patronbrowse.png"/>
23844 <chapter id="circulation">
23845 <title>Circulation</title>
23847 <para>Circulation functions can be accessed in several different ways. On
23848 the main page of the staff client there are some quick links in the center
23849 of the page to check items out, in or transfer them. For a complete
23850 listing of Circulation functions you can visit the Circulation page which
23851 is linked from the top left of every page or from the center of the main
23854 <para>Before circulating your collection you will want to set your <link
23855 linkend="globalsysprefs">Global System Preferences</link>, <link
23856 linkend="basicparams">Basic Parameters</link> and <link
23857 linkend="patscirc">Patrons & Circulation Rules</link>.</para>
23859 <para>While in Circulation you can jump between the tabs on the quick
23860 search box at the top of the screen by using the following hot
23865 <para>jump to the catalog search with Alt+Q</para>
23869 <para>jump to the checkout with Alt+U</para>
23873 <para>this will not work for Mac users</para>
23879 <para>jump to the checkin with Alt+R</para>
23884 <para>Mac users use the OPTION button in place of ALT</para>
23887 <section id="checkingout">
23888 <title>Check Out (Issuing)</title>
23890 <para>To begin the checkout process you must enter the patron barcode or
23891 part of their name. The checkout option appears in three main
23896 <para>Check out option on the top of the main staff client</para>
23899 <screeninfo>Check out box on main Koha Staff Client
23904 <imagedata fileref="images/circ/checkoutmain.png"/>
23911 <para>Check out option on the patron record</para>
23914 <screeninfo>Check out tab on a patron record</screeninfo>
23918 <imagedata fileref="images/circ/checkoutpatron.png"/>
23925 <para>Check out option on the quick search bar on the circulation
23929 <screeninfo>Check out tab on quick search bar</screeninfo>
23933 <imagedata fileref="images/circ/circquickbox.png"/>
23940 <section id="checkitemout">
23941 <title>Checking Items Out</title>
23943 <para>To check an item out to a patron, first search for that patron
23944 using one of the many options listed above.</para>
23947 <screeninfo>Check Out Screen</screeninfo>
23951 <imagedata fileref="images/circ/checkingout.png"/>
23956 <para>At the top of the Check Out screen is a box for you to type or
23957 scan the item's barcode into.</para>
23962 <para>Many modern barcode scanners will send a 'return' to the
23963 browser, making it so that the 'Check Out' button is
23964 automatically clicked</para>
23969 <para>If the barcode is not found you will be prompted to use fast
23970 cataloging to add the item. Learn more about <link
23971 linkend="fastaddcat">fast cataloging</link> later in this
23976 <para>Below the box for the barcode there may be options for you to
23977 override the default due date for the item.</para>
23981 <para>This option will only appear if you have set the <link
23982 linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
23983 to allow staff to override the due date</para>
23987 <para>At the bottom of the page there is a summary of the patron's
23988 current checked out items along with the due date (and time if the
23989 item is an hourly loan), items checked out today will appear at the
23993 <para>If the checked out time is listed as 00:00 then the item is a
23994 daily loan item. The due time for daily checkouts will show 23:59
23995 which is the last minute of the day.</para>
23999 <screeninfo>Patron's checkout summary</screeninfo>
24003 <imagedata fileref="images/circ/checkoutsummary.png"/>
24007 <para>If you have set your <link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link>
24008 preference, you will also see the option to export the patron's current checkout
24009 information using a CSV Profile or ISO2709 (MARC21) format.</para>
24011 <screeninfo>Export patron's checkout information</screeninfo>
24014 <imagedata fileref="images/circ/exportcheckouts.png"/>
24019 <para>Also at the bottom of the page is the list of items the patron
24023 <screeninfo>Holds summary on check out screen</screeninfo>
24027 <imagedata fileref="images/circ/holdssummary.png"/>
24032 <para>From the holds list you can suspend or resume patrons holds
24033 using the options at the bottom of the list if you have the <link
24034 linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
24035 set to 'allow.'</para>
24038 <para>If you have your <link
24039 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
24040 preference set to "Don't allow" then you will not have the option to
24041 put an end date on the hold suspension</para>
24044 <para>If there are notes on the patron record these will appear to the
24045 right of the checkout box</para>
24048 <screeninfo>Patron notes on check out screen</screeninfo>
24052 <imagedata fileref="images/circ/patronnotes.png"/>
24057 <para>If the patron has a hold waiting at the library that too will
24058 appear to the right of the check out box making it easy for the
24059 circulation librarian to see that there is another item to give the
24063 <screeninfo>Hold waiting message on check out screen</screeninfo>
24067 <imagedata fileref="images/circ/holdwaiting.png"/>
24072 <section id="printcircreceipt">
24073 <title>Printing Receipts</title>
24075 <para>Once you have checked out all of the items for the patron you
24076 can print them a receipt by choosing one of two methods.</para>
24078 <para>If you have the <link
24079 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
24080 preference set to 'open a print quick slip window' you can simply
24081 hit enter on your keyboard or scan a blank piece of paper with your
24082 barcode scanner. The idea being that you're "checking out" a blank
24083 barcode which triggers Koha to print the 'Quick slip.'</para>
24085 <para>You can also click the Print button at the top of the screen
24086 and choose 'Print slip' or 'Print quick slip'.</para>
24089 <screeninfo>Print receipt to slip printer</screeninfo>
24093 <imagedata fileref="images/circ/printslip.png"/>
24098 <para>If you choose 'Print slip' it will print all of the items the
24099 patron has checked out, including those they checked out at an
24100 earlier date. Choosing 'Print quick slip' will print only the items
24101 that were checked out today.</para>
24103 <para>What prints on the slips can be customized by altering the
24104 slip templates under the <link linkend="notices">Notices &
24105 Slips</link> tool.</para>
24108 <section id="clearpatroninfo">
24109 <title>Clear Patron Information</title>
24111 <para>When you're done checking an item out if you have the <link
24112 linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
24113 preference set to 'Show' you can clear the current patron by
24114 clicking the X in the top right of the patron's info to remove the
24115 current patron from the screen and start over.</para>
24118 <screeninfo>Clear Screen Button</screeninfo>
24122 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
24127 <para>If you have the <link
24128 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
24129 preference set to 'clear the screen' then you simply need to hit
24130 enter or scan a blank barcode and the screen will be cleared of the
24131 current patron.</para>
24135 <section id="checkoutmsg">
24136 <title>Check Out Messages</title>
24138 <para>If you check out an item that has multiple pieces and you have
24139 cataloged that information in subfield 3 of the item record (in
24140 MARC21) a message will pop up when you check out that item telling you
24141 how many pieces should be there.</para>
24144 <screeninfo>Materials in the checked out item</screeninfo>
24148 <imagedata fileref="images/circ/materialspecified.png"/>
24153 <para>There are times when Koha will prevent the librarian from being
24154 able to check out items to a patron. When this happens a warning will
24155 appear notifying the librarian of why the patron cannot check items
24160 <para>Patron owes too much in fines</para>
24163 <screeninfo>Patron owes too much in fines</screeninfo>
24167 <imagedata fileref="images/circ/fineswarning.png"/>
24174 <para>You can set the amount at which patron checkouts are
24175 blocked with the <link
24176 linkend="noissuescharge">noissuescharge</link> system
24183 <para>Patron has been barred from the library</para>
24186 <screeninfo>Patron account barred</screeninfo>
24190 <imagedata fileref="images/circ/debarwarning.png"/>
24197 <para>This can be set by the librarian editing a patron record
24198 and adding a <link linkend="patronflags">flag</link> or by the
24199 <link linkend="noticetriggers">Overdue/Notice Status
24200 Triggers</link></para>
24206 <para>Patron needs to confirm their address</para>
24209 <screeninfo>Patron's address warning</screeninfo>
24213 <imagedata fileref="images/circ/addresswarning.png"/>
24220 <para>This can be set by the librarian editing a patron record
24221 and adding a <link linkend="patronflags">flag</link></para>
24227 <para>Patrons has lost their library card</para>
24230 <screeninfo>Lost patron card warning</screeninfo>
24234 <imagedata fileref="images/circ/lostcardwarning.png"/>
24241 <para>This can be set by the librarian editing a patron record
24242 and adding a <link linkend="patronflags">flag</link></para>
24249 <section id="checkoutwarn">
24250 <title>Check Out Warnings</title>
24252 <para>Sometimes checkouts will trigger warning messages that will
24253 appear in a yellow box above the check out field. These warnings need
24254 to be acknowledged before you will be able to continue checking items
24259 <para>Patron has outstanding fines</para>
24262 <screeninfo>Patron has a debt</screeninfo>
24266 <imagedata fileref="images/circ/warnings/patrondebt.png"/>
24273 <para>Item on hold for someone else</para>
24276 <screeninfo>Item is on hold for someone else</screeninfo>
24280 <imagedata fileref="images/circ/warnings/onhold.png"/>
24287 <para>Item should be on the hold shelf waiting for someone
24291 <screeninfo>Item is on hold shelf waiting for someone
24296 <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
24303 <para>Item already checked out to this patron</para>
24306 <screeninfo>Item is currently checked out to this
24307 patron</screeninfo>
24311 <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
24318 <para>Item checked out to another patron</para>
24321 <screeninfo>Item checked out to another patron</screeninfo>
24325 <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
24332 <para>Item not for loan</para>
24335 <screeninfo>Item is not normally for loan</screeninfo>
24339 <imagedata fileref="images/circ/warnings/notforloan.png"/>
24346 <para>Patron has too many things checked out</para>
24349 <screeninfo>Too many checkouts</screeninfo>
24353 <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
24360 <para>Item cannot be renewed</para>
24363 <screeninfo>No more renewals</screeninfo>
24367 <imagedata fileref="images/circ/warnings/norenewals.png"/>
24374 <para>This can be overridden with the <link
24375 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
24376 system preference</para>
24382 <para>Barcode not found</para>
24385 <screeninfo>Barcode not found</screeninfo>
24389 <imagedata fileref="images/circ/barcodefastadd.png"/>
24396 <para>Learn more about <link linkend="fastaddcat">fast
24397 cataloging</link> later in this manual.</para>
24403 <para>Item being checked out is marked as 'lost'</para>
24407 <para>Depending on the value in your <link
24408 linkend="IssueLostItem">IssueLostItem</link> preference, you
24409 may just see a warning</para>
24412 <screeninfo>Warning that item is lost</screeninfo>
24416 <imagedata fileref="images/circ/lostitemmsg.png"/>
24421 <para>or a confirmation box</para>
24424 <screeninfo>Confirm checkout of lost item</screeninfo>
24428 <imagedata fileref="images/circ/lostitemconfirm.png"/>
24437 <para>Item being checked out is not recommended for a patron of
24441 <screeninfo>Age warning</screeninfo>
24445 <imagedata fileref="images/circ/warnings/agewarning.png"/>
24451 <para>Item being checked out meets the <link linkend="decreaseLoanHighHolds"
24452 >decreaseLoanHighHolds</link> system preference criteria</para>
24454 <screeninfo>Too many holds</screeninfo>
24457 <imagedata fileref="images/circ/warnings/decreaseLoanHighHoldsDuration.png"/>
24466 <section id="circrenew">
24467 <title>Renewing</title>
24469 <para>Checked out items can be renewed (checked out for another period
24470 of time) based on your <link linkend="circfinerules">circulation
24471 rules</link> and <link linkend="RenewalPeriodBase">renewal
24472 preferences</link>. If you allow it, patrons can renew their own items
24473 via the OPAC, but sometimes you'll need to help them by renewing their
24474 items via the staff client. To renew items checked out to a patron,
24475 visit their details page or checkout page and review their checkout
24476 summary at the bottom.</para>
24479 <screeninfo>Circulation Summary</screeninfo>
24483 <imagedata fileref="images/circ/circsummary.png"/>
24488 <para>In the Renew column you will see how many times each item has been
24489 renewed and a checkbox to renew the item for the patron. Check the boxed
24490 of the items you would like to renew and click the 'Renew or Return
24491 checked items' button, or to renew all items checked out to the patron
24492 simply click the 'Renew all' button.</para>
24495 <screeninfo>Renew buttons</screeninfo>
24499 <imagedata fileref="images/circ/renewbutton.png"/>
24504 <para>Sometimes renewals will be blocked based on your circulation
24505 rules, to override this block you must have your <link
24506 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
24507 preference set to 'Allow'. If you allow renewal limit overrides, you
24508 will see a checkbox at the bottom left of the circulation summary. Check
24509 that box and then choose the items you would like to renew.</para>
24512 <screeninfo>Override renewal limit</screeninfo>
24516 <imagedata fileref="images/circ/overriderenew.png"/>
24521 <para>Checking that box will add checkboxes in the renew column above
24522 where before the item was not renewable.</para>
24525 <section id="checkingin">
24526 <title>Check In (Returning)</title>
24528 <para>Checking in items can be performed from various different
24533 <para>The check in box on the top of the main staff client</para>
24536 <screeninfo>Check out box on main Koha Staff Client
24541 <imagedata fileref="images/circ/checkinmain.png"/>
24548 <para>The check in option on the quick search bar on the Circulation
24550 <screeninfo>Check in tab on quick search bar</screeninfo>
24554 <imagedata fileref="images/circ/checkinquickbox.png"/>
24557 </screenshot></para>
24561 <para>The check in link on the patron's checkout summary (and on the
24562 checkout summary page)</para>
24565 <screeninfo>Patron checkout summary includes 'Check In'
24570 <imagedata fileref="images/circ/checkinlink.png"/>
24577 <para>The Check in page under the Circulation menu</para>
24580 <screeninfo>Check in link on Circulation Module</screeninfo>
24584 <imagedata fileref="images/circ/checkincirc.png"/>
24591 <section id="checkitemin">
24592 <title>Checking Items In</title>
24594 <para>To check an item in scan the barcode for the item into the box
24595 provided. A summary of all items checked in will appear below the
24599 <screeninfo>Check In Summary</screeninfo>
24603 <imagedata fileref="images/circ/checkin.png"/>
24608 <para>If you are checking items in that were put in the dropbox while
24609 the library was closed you can check the 'Dropbox mode' box before
24610 scanning items. This will effectively roll back the returned date to
24611 the last date the library was open.</para>
24615 <para>This requires that you have your closings added to the <link
24616 linkend="calholidays">Holidays & Calendar Tool </link></para>
24620 <para>You can also choose to forgive all overdue charges for items you
24621 are checking in by checking the 'Forgive overdue charges' box before
24622 scanning items.</para>
24625 <section id="checkinmsg">
24626 <title>Check In Messages</title>
24628 <para>There are several messages that can appear when checking items
24633 <para>If you are checking an item in at a library other than the
24634 home branch, a message will appear asking you to transfer the book
24635 to the home library</para>
24638 <screeninfo>Check in Transfer Message</screeninfo>
24642 <imagedata fileref="images/circ/checkintransfer.png"/>
24649 <para>After this item is checked in the status of the item
24650 will be changed in the catalog to 'in transit'</para>
24653 <screeninfo>In Transit Status</screeninfo>
24657 <imagedata fileref="images/circ/transferstatus.png"/>
24664 <para>To mark an item as back at the home branch, check the
24665 item in at the home branch</para>
24668 <screeninfo>Check In Transferred Item</screeninfo>
24672 <imagedata fileref="images/circ/transfercheckin.png"/>
24679 <para>A message will appear tell you that the item is not
24680 checked out, but the status will now say available in the
24681 catalog. This step is necessary to mark items as received
24682 by the home branch.</para>
24690 <para>If you are checking in an item that should have multiple
24691 parts or pieces a message will appear warning you about the number
24692 of pieces you should have in your hand</para>
24695 <screeninfo>Materials Specified</screeninfo>
24699 <imagedata fileref="images/circ/materialspecified.png"/>
24706 <para>If you're checking an item in that has a hold on it, you
24707 will be prompted to confirm the hold</para>
24710 <screeninfo>Hold Found Check In Message</screeninfo>
24714 <imagedata fileref="images/circ/holdfound.png"/>
24721 <para>Clicking the Confirm hold button will mark the item as
24722 waiting for pickup from the library</para>
24725 <screeninfo>Hold waiting at the library</screeninfo>
24729 <imagedata fileref="images/circ/waitingstatus.png"/>
24736 <para>Clicking the Print Slip and Confirm button will mark the
24737 item as waiting for pickup at the library and present the
24738 library with a receipt to print and place on the book with the
24739 patron's information</para>
24743 <para>Ignoring the hold will leave the item on hold, but leave
24744 its status as Available (it will not cancel the hold)</para>
24750 <para>If you're checking in an item that has a hold on it at
24751 another branch you will be prompted to confirm and transfer the
24755 <screeninfo>Hold found for another branch</screeninfo>
24759 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
24766 <para>Clicking the Confirm hold and Transfer button will mark
24767 the item as in transit to the library where the hold was
24771 <screeninfo>In transit hold status</screeninfo>
24775 <imagedata fileref="images/circ/intransithold.png"/>
24782 <para>Clicking the Print Slip, Transfer and Confirm button
24783 will mark the item as in transit to the library where the hold
24784 was placed and present the library with a receipt to print and
24785 place on the book with the patron's information</para>
24789 <para>Ignoring the hold will leave the item on hold, but leave
24790 its status as Available (it will not cancel the hold)</para>
24796 <para>If you have the system showing you fines at the time of
24798 linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
24799 see a message telling you about the fine and providing you a link
24800 to the payment page for that patron</para>
24803 <screeninfo>FineNotifyAtCheckin</screeninfo>
24807 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
24816 <section id="circmessages">
24817 <title>Circulation Messages</title>
24819 <para>Circulation messages are short messages that librarians can leave
24820 for their patrons or their colleagues that will appear at the time of
24821 circulation.</para>
24823 <section id="setcircmsg">
24824 <title>Setting up Messages</title>
24826 <para>Circulation messages are set up as <link
24827 linkend="authorizedvalues">Authorized Values</link>. To add or edit
24828 Circulation Messages you want to work with the <link
24829 linkend="bornotes">BOR_NOTES</link> value.</para>
24832 <screeninfo>BOR_NOTES Authorized Values</screeninfo>
24836 <imagedata fileref="images/circ/bor_notes.png"/>
24841 <para>The 'Description' field can hold a canned message that you would
24842 like to appear on the patron's record. <important>
24843 <para>The 'Description' field is limited to 80 characters, but the
24844 patron message field can hold more than that. Enter 80 characters
24845 in the 'Description' field and then type the rest on the patron
24847 </important></para>
24850 <section id="addcircmsg">
24851 <title>Adding a Message</title>
24853 <para>When on the patron's check out tab you will see a link to 'Add a
24854 new message' to the right of the check out box.</para>
24857 <screeninfo>Circulation Message in Staff Client</screeninfo>
24861 <imagedata fileref="images/circ/staffmessages.png"/>
24866 <para>When you click 'Add a new message' you will be asked to choose
24867 if the message is for the librarians or the patron and the message you
24868 would like to leave.</para>
24871 <screeninfo>Leave a Circulation Message</screeninfo>
24875 <imagedata fileref="images/circ/leavecircmsg.png"/>
24881 <para>A message for the patron will also show to the library
24886 <section id="viewcircmsg">
24887 <title>Viewing Messages</title>
24889 <para>Circulation messages meant for the staff and/or the patron will
24890 appear on the patron's checkout screen to the right of the checkout
24891 box. Messages in bold and red are meant for the library staff only,
24892 whereas messages in regular italics font are meant for the patron and
24893 the librarian.</para>
24896 <screeninfo>Circulation Message in Staff Client</screeninfo>
24900 <imagedata fileref="images/circ/staffmessages.png"/>
24905 <para>Circulation messages meant for the patron will also appear when
24906 they log into the OPAC.</para>
24909 <screeninfo>Circulation Message in OPAC</screeninfo>
24913 <imagedata fileref="images/circ/opacmsg.png"/>
24920 <section id="holds">
24921 <title>Holds</title>
24923 <para>Koha allows patrons to put things on hold. A 'Hold' is a way to reserve an item.
24924 Depending on your <link linkend="circfinerules">circulation and fine rules</link> and <link
24925 linkend="circholdspolicy">hold preference</link> settings patrons will be able to place
24926 items on hold for pickup at the library at a later date/time.</para>
24928 <section id="holdsinstaff">
24929 <title>Placing Holds in Staff Client</title>
24931 <para>There are several ways to place holds from the staff client. The
24932 most obvious is using the 'Place Hold' button at the top of any
24933 bibliographic record.</para>
24936 <screeninfo>Place Hold Button on Bib Record</screeninfo>
24940 <imagedata fileref="images/circ/placeholdbib.png"/>
24945 <para>You can also click the smaller 'Place Hold' link found at the
24946 top of your catalog search results, or the 'Holds' link found below
24947 each result.</para>
24950 <screeninfo>Hold options on search results</screeninfo>
24954 <imagedata fileref="images/circ/placeholdsearch.png"/>
24959 <para>You will be asked to search for a patron by barcode or any part
24960 of their name to start the hold process.</para>
24963 <screeninfo>Find Patron For Hold</screeninfo>
24967 <imagedata fileref="images/circ/placeholdfindpatron.png"/>
24972 <para>If you'd like to search for the patron first and then the bib
24973 record for the hold, you can open the patron record and click on the
24974 'Search to Hold' button at the top of the patron record.</para>
24977 <screeninfo>Search to Hold on Patron Record</screeninfo>
24981 <imagedata fileref="images/circ/searchtohold.png"/>
24986 <para>After clicking the button you will be brought to the catalog
24987 search page where you can find the book(s) you want to place a hold
24988 on. Under each title on the results you'll see an option to 'Hold for
24989 Patron Name.'</para>
24992 <screeninfo>Hold for Patron links on Search Results</screeninfo>
24996 <imagedata fileref="images/circ/holdresults.png"/>
25001 <para>If you want to place a hold on multiple items, simply check the
25002 boxes to the left of them and click the arrow to the right of the
25003 'Place Hold' button.</para>
25006 <screeninfo>Hold Multiple Items for Patron</screeninfo>
25010 <imagedata fileref="images/circ/holdmultiresults.png"/>
25015 <para>Depending on how many items you choose to place a hold on at
25016 once you will see a different place hold form. If you are placing a
25017 hold on one bibliographic record you will see a list of all of the
25018 items you can place a hold on.</para>
25021 <screeninfo>Place Hold Form</screeninfo>
25025 <imagedata fileref="images/circ/placeholdsingle.png"/>
25032 <para>Enter any notes that might apply to this hold</para>
25036 <para>Choose the library where the patron will pick up the
25041 <para>If the patron wants the hold to start on a date other than
25042 today, enter that in the 'Hold starts on date' field</para>
25046 <para>This option will only appear if the <link
25047 linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
25048 system preference is set to 'Allow'</para>
25054 <para>If the patron has specified that they don't want the item
25055 after a certain date, or if you have limits on hold lengths, you
25056 can enter an expiration date for the hold in the 'Hold expires on
25061 <para>To have expired holds canceled automatically you will
25062 need to have the <link linkend="expiredholdscron">Expired
25063 Holds</link> cron job set to run on a regular basis.</para>
25069 <para>Next choose if you want to place a hold on the next
25070 available item or a specific item by clicking the radio button
25071 next to an individual item.</para>
25075 <para>If you're placing a hold on multiple items you will be presented
25076 with the next available option for all titles. If no items are
25077 available for hold it will say so on the confirmation screen.</para>
25080 <screeninfo>Place multiple items on hold</screeninfo>
25084 <imagedata fileref="images/circ/placeholdmultiple.png"/>
25089 <para>Once your hold is placed, if you'd like to have Koha forget that
25090 you used the 'Search to Hold' function, you can choose to have Koha
25091 'forget' the patron's name by clicking the arrow to the right of the
25092 'Place Hold' button on the search results and choosing the 'Forget'
25096 <screeninfo>Forget Search to Hold Option</screeninfo>
25100 <imagedata fileref="images/circ/forgethold.png"/>
25106 <section id="manageholds">
25107 <title>Managing Holds</title>
25109 <para>Holds can be altered and canceled from the Holds tab found on
25110 the left of the bibliographic record.</para>
25113 <screeninfo>Bibliographic Record Tabs</screeninfo>
25117 <imagedata fileref="images/circ/holdtab.png"/>
25122 <para>From the list of holds you can change the order of the holds,
25123 the pickup location, suspend and/or cancel the hold.</para>
25126 <screeninfo>Lists of Holds</screeninfo>
25130 <imagedata fileref="images/circ/holdslist.png"/>
25136 <para>If you have your <link
25137 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
25138 preference set to "Don't allow" then you will not have the option to
25139 put an end date on the hold suspension</para>
25143 <para>Depending on how you have your <link
25144 linkend="HidePatronName">HidePatronName</link> system preference set
25145 the list may show card numbers instead of names in the Patron column
25146 like in the image above.</para>
25149 <para>To rearrange or delete holds, simply make a selection from the
25150 'Priority' pull down or click the arrows to the right of the priority
25154 <screeninfo>Hold Priority Menu</screeninfo>
25158 <imagedata fileref="images/circ/holdpriority.png"/>
25163 <para>If you use the priority pull down to rearrange or delete holds
25164 you will need to click the 'Update hold(s)' button to save your
25167 <para>Clicking the down arrow to the right of the hold will stick the
25168 hold at the bottom of the list even if more requests are made.</para>
25170 <para>For example, your library has home-bound patrons that are
25171 allowed to keep books out for months at a time. It would not be fair
25172 to other patrons if a home-bound patron were able to check out a brand
25173 new book and keep it for months. For this reason, the home-bound
25174 patron's hold request would stay at the bottom of the queue until
25175 everyone else who wanted to read that book has already done so.</para>
25178 <screeninfo>Lowest Priority & Delete Options for
25183 <imagedata fileref="images/circ/lowestpriority.png"/>
25188 <para>If a patron asks to have their hold suspended and you have the
25189 <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
25190 system preference set to 'allow' you can do so by clicking the Suspend
25191 button to far right. If the patron gives you a date for the items to
25192 become unsuspended you can enter that in the date box and click the
25193 'Update hold(s)' button to save your changes.</para>
25196 <screeninfo>Hold suspension column</screeninfo>
25200 <imagedata fileref="images/circ/suspendholds.png"/>
25205 <para>To delete or cancel a hold click the red 'X' to the right of the
25206 hold line. To delete/cancel a bunch of holds you can choose 'del' from
25207 pull down to the left of each line and then click 'Update hold(s)' at
25208 the bottom of the list.</para>
25211 <screeninfo>Cancel Holds</screeninfo>
25215 <imagedata fileref="images/circ/cancelholds.png"/>
25221 <section id="receiveholds">
25222 <title>Receiving Holds</title>
25224 <para>When items that are on hold are <link linkend="checkingin">checked in</link> or <link
25225 linkend="checkingout">out</link> the system will remind the circulation librarian that
25226 the item is on hold and offer them options for managing the hold.</para>
25228 <para>When you check in an item that has a hold on it the system will
25229 ask you to either confirm and transfer the item</para>
25232 <screeninfo>Confirm Hold & Transfer</screeninfo>
25236 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
25241 <para>or just confirm the hold</para>
25244 <screeninfo>Confirm Hold</screeninfo>
25248 <imagedata fileref="images/circ/holdconfirm.png"/>
25253 <para>Clicking the Confirm button will mark the item as on hold for
25254 the patron. If the item needs to be transferred the item will also be
25255 marked as in transit to the proper branch. Clicking 'Ignore' will
25256 retain the hold, but allow you to check the item out to another
25257 patron. Choosing to confirm and print will present you with a
25258 printable page that you can slip inside the book with the necessary
25259 hold and/or transfer information.</para>
25261 <para>Once confirmed the hold will show on the patron record and on
25262 the checkout screen under the 'Hold' tab.</para>
25265 <screeninfo>Hold on Patron Record</screeninfo>
25269 <imagedata fileref="images/circ/holdpatronrec.png"/>
25274 <para>The item record will also show that the item is on hold.</para>
25277 <screeninfo>Hold on Item Record</screeninfo>
25281 <imagedata fileref="images/circ/holditem.png"/>
25286 <para>In some cases a patron may come in to pick up a hold for their
25287 partner (or someone else in their household). In this case you want to
25288 make sure that the hold is cancelled when you check the item out to
25289 someone else. When trying to check out an item that is already waiting
25290 for someone else you will be presented with a warning message.</para>
25293 <screeninfo>Hold waiting for someone else</screeninfo>
25297 <imagedata fileref="images/circ/holdwaitingwarn.png"/>
25302 <para>From here you can check the item out to the patron at the desk
25303 and cancel the hold for the patron.</para>
25307 <section id="transfers">
25308 <title>Transfers</title>
25310 <para>If you work in a multi-branch system you can transfer items from one library to another
25311 by using the Transfer tool.<itemizedlist>
25313 <para><emphasis role="italic">Get there</emphasis>: Circulation > Transfer</para>
25315 </itemizedlist></para>
25316 <para>To transfer an item</para>
25320 <para>Click 'Transfer' on the Circulation page</para>
25323 <screeninfo>Transfer Tool</screeninfo>
25327 <imagedata fileref="images/circ/transfer.png"/>
25334 <para>Enter the library you would like to transfer the item
25339 <para>Scan or type the barcode on the item you would like to
25346 <para>Click 'Submit'</para>
25349 <screeninfo>Transfer Summary</screeninfo>
25353 <imagedata fileref="images/circ/itemtransferred.png"/>
25360 <para>The item will now say that it is in transit</para>
25363 <screeninfo>Item in Transit</screeninfo>
25367 <imagedata fileref="images/circ/itemintransit.png"/>
25374 <para>When the item arrives at the other branch the librarian must
25375 check the item in to acknowledge that it is no longer in
25380 <para>The item will not be permanently moved to the new
25384 <screeninfo>Item record</screeninfo>
25388 <imagedata fileref="images/circ/itemlocations.png"/>
25395 <para>The item shows the same 'Home Library' but has updated the
25396 'Current Location' to note where it resides at this time</para>
25403 <section id="setlibrary">
25404 <title>Set Library</title>
25406 <para>By default you will enter the staff client as if you are at your
25407 home library. This library will appear in the top right of the Staff
25411 <screeninfo>My Library</screeninfo>
25415 <imagedata fileref="images/circ/mylibrary.png"/>
25420 <para>This is the library that all circulation transactions will take
25421 place at. If you are at another library (or on a bookmobile) you will
25422 want to set your library before you start circulating items. To do this
25423 you can click 'Set' at the top right or on the Circulation page.</para>
25426 <screeninfo>Set Library Form</screeninfo>
25430 <imagedata fileref="images/circ/setlibrary.png"/>
25435 <para>Once you have saved your changes you new library will appear in
25436 the top right.</para>
25439 <section id="fastaddcat">
25440 <title>Fast Add Cataloging</title>
25442 <para>Sometimes circulation librarians need to quickly add a record to
25443 the system for an item they are about to check out. This is called 'Fast
25444 Add.' To allow circulation librarians access to the Fast Add Cataloging
25445 tool, simply make sure they have the <link
25446 linkend="fastaddpermissions">fast_cataloging</link> permissions. There
25447 are two ways to add titles via fast add. If you know that you're about
25448 to check out an item that isn't in you catalog you can go to the
25449 Circulation module and click 'Fast cataloging.'</para>
25452 <screeninfo>Circulation Menu</screeninfo>
25456 <imagedata fileref="images/circ/circmenu.png"/>
25461 <para>The cataloging interface will open up with the short cataloging
25465 <screeninfo>Fast Add Framework</screeninfo>
25469 <imagedata fileref="images/circ/fastadd.png"/>
25474 <para>After adding your cataloging data you will be asked to enter item
25475 data. Enter the items barcode, collection code, etc and save the item
25476 before checking it out.</para>
25478 <para>The other way to fast catalog is from the checkout screen. When
25479 you enter a barcode at checkout that Koha can't find, it will prompt you
25480 to use fast cataloging to add the item to Koha and check it out.</para>
25483 <screeninfo>Barcode not found</screeninfo>
25487 <imagedata fileref="images/circ/barcodefastadd.png"/>
25492 <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
25493 form where you can enter the title information</para>
25496 <screeninfo>Fast cataloging</screeninfo>
25500 <imagedata fileref="images/circ/fastaddbarcode.png"/>
25505 <para>After clicking 'Save' you will be brought to the item record where
25506 the barcode will already be filled in with the barcode you're trying to
25510 <screeninfo>Fast cataloging item record</screeninfo>
25514 <imagedata fileref="images/circ/fastadditem.png"/>
25519 <para>After clicking the 'Add item' button the item will automatically
25520 be checked out the patron you were trying to check the book out to
25524 <screeninfo>Checked out item</screeninfo>
25528 <imagedata fileref="images/circ/fastaddcheckedout.png"/>
25534 <section id="circreports">
25535 <title>Circulation Reports</title>
25537 <para>Most reports can be found vai the Reports module, but some of the more common
25538 circulation reports are available right from the Circulation module.<itemizedlist>
25540 <para><emphasis role="italic">Get there</emphasis>: Circulation > Circulation
25543 </itemizedlist></para>
25545 <section id="holdsqueue">
25546 <title>Holds Queue</title>
25548 <para>This report will show you all of the holds at your
25552 <screeninfo>Sample Holds Queue</screeninfo>
25556 <imagedata fileref="images/circ/holdsqueue.png"/>
25561 <para>To generate this report, you must have the <link
25562 linkend="buildholdscron">Build Holds Queue cron job</link> running.
25563 This cron job is a script that should be run periodically if your
25564 library system allows borrowers to place on-shelf holds. This script
25565 decides which library should be responsible for fulfilling a given
25566 hold request.</para>
25568 <para>It's behavior is controlled by the system preferences <link
25569 linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link
25570 linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
25572 <para>If you do not want all of your libraries to participate in the
25573 on-shelf holds fulfillment process, you should list the the libraries
25574 that *do* participate in the process here by inputting all the
25575 participating library's branchcodes, separated by commas ( e.g.
25576 "MPL,CPL,SPL,BML" etc. ).</para>
25578 <para>By default, the holds queue will be generated such that the
25579 system will first attempt to hold fulfillment using items already at
25580 the pickup library if possible. If there are no items available at the
25581 pickup library to fill a hold, build_holds_queue.pl will then use the
25582 list of libraries defined in StaticHoldsQueueWeight. If
25583 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
25584 script will assign fulfillment requests in the order the branches are
25585 placed in the StaticHoldsQueueWeight system preference.</para>
25587 <para>For example, if your system has three libraries, of varying
25588 sizes ( small, medium and large ) and you want the burden of holds
25589 fulfillment to be on larger libraries before smaller libraries, you
25590 would want StaticHoldsQueueWeight to look something like
25591 "LRG,MED,SML".</para>
25593 <para>If you want the burden of holds fulfillment to be spread out
25594 equally throughout your library system, simply enable
25595 RandomizeHoldsQueueWeight. When this system preference is enabled, the
25596 order in which libraries will be requested to fulfill an on-shelf hold
25597 will be randomized each time the list is regenerated.</para>
25599 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
25600 time. Doing so will cause the build_holds_queue script to ignore
25601 RandomizeHoldsQueueWeight, causing the script to request hold
25602 fulfillment not randomly, but by alphabetical order.</para>
25605 <section id="holdspull">
25606 <title>Holds to pull</title>
25608 <para>This report will show you all of the items that have holds on
25609 them that are available at the library for pulling. If the items are
25610 available at multiple branches then all branches with that item
25611 available will see the hold to pull until one library triggers the
25615 <screeninfo>Holds to Pull</screeninfo>
25619 <imagedata fileref="images/circ/holdstopull.png"/>
25624 <para>You can limit the results you see by using the Refine box on the
25625 left side of the page:</para>
25628 <screeninfo>Refine Holds to Pull Report</screeninfo>
25632 <imagedata fileref="images/circ/refineholdstopull.png"/>
25638 <section id="holdspickup">
25639 <title>Holds awaiting pickup</title>
25641 <para>This report will show all of the holds that are waiting for
25642 patrons to pick them up.</para>
25645 <screeninfo>Holds Awaiting Pickup</screeninfo>
25649 <imagedata fileref="images/circ/holdspickup.png"/>
25654 <para>Items that have been on the hold shelf longer than you normally
25655 allow (based on the <link
25656 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
25657 preference value) will appear on the 'Holds Over' tab, they will not
25658 automatically be cancelled unless you have set the <link
25659 linkend="expiredholdscron">cron job</link> to do that for you, but you
25660 can cancel all holds using the button at the top of the list.</para>
25663 <screeninfo>Items waiting on the hold shelf too long</screeninfo>
25667 <imagedata fileref="images/circ/holdspickupover.png"/>
25673 <section id="holdratios">
25674 <title>Hold ratios</title>
25676 <para>Hold ratios help with collection development. Using this report
25677 you will be able to see how many of your patrons have holds on items
25678 and whether you should buy more. By default it will be set to the
25679 library needing 3 items per hold that has been placed. The report will
25680 tell you how many additional items need to be purchased to meet this
25684 <screeninfo>Hold Ratios</screeninfo>
25688 <imagedata fileref="images/circ/holdratio.png"/>
25694 <section id="transferstoreceive">
25695 <title>Transfers to receive</title>
25697 <para>This report will list all of the items that Koha thinks are in
25698 transit to your library.</para>
25701 <screeninfo>Transfers to Receive</screeninfo>
25705 <imagedata fileref="images/circ/transitreceive.png"/>
25710 <para>If your transfers are late in arriving at your library you will
25711 see a message stating how late your items are.</para>
25714 <screeninfo>Late transfers include warning messages</screeninfo>
25718 <imagedata fileref="images/circ/transferlate.png"/>
25724 <para>An item is considered late based on the number of days you
25725 have entered in the <link
25726 linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
25727 system preference.</para>
25731 <section id="overduesreport">
25732 <title>Overdues</title>
25735 <para>For libraries with a large patron base, this report may take a
25736 significant amount of time to run.</para>
25740 <para>Large libraries can choose to filter the report before it runs
25741 by setting the <link
25742 linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
25743 system preference to 'Require'.</para>
25746 <para>This report will list all items that are overdue at your
25750 <screeninfo>Overdues List</screeninfo>
25754 <imagedata fileref="images/circ/overdues.png"/>
25759 <para>The report can be filtered using the menu options found on the left of the report.<tip>
25760 <para>The 'Show any items currently checked out' checkbox basically switches this from a
25761 report of overdues to a report of checkouts. It will show all titles checked out
25762 regardless of due date.</para>
25766 <section id="overduesfines">
25767 <title>Overdues with fines</title>
25769 <para>This report will show you any overdues at your library that have
25770 accrued fines on them.</para>
25773 <screeninfo>Overdues with fines</screeninfo>
25777 <imagedata fileref="images/circ/overduewfines.png"/>
25782 <para>If you would like to limit the report you can use the pull down
25783 menu at the top to limit to a specific shelving location at your
25784 branch. To see overdues with fines at other branches you will have to
25785 <link linkend="setlibrary">change your branch</link> or log in at that
25787 <para>If you do not charge fines and/or don't have the <link
25788 linkend="finescronjob">fines cron job</link> running you will see
25789 no data on this report.</para>
25790 </important></para>
25794 <section id="trackinhouse">
25795 <title>Tracking In house Use</title>
25797 <para>Many libraries track the use of items within the library. This can
25798 be done in Koha one of two ways. The first is to create one or more
25799 <link linkend="addstatspatron">Statistical Patrons</link>. When
25800 collecting items that have been used within the library, you will want
25801 to check them out to your statistical patron:</para>
25804 <screeninfo>Check Out Items to Stats Patron</screeninfo>
25808 <imagedata fileref="images/circ/checkoutinhouse.png"/>
25813 <para>Instead of marking the item as 'checked out' the system will
25814 record that the item was used in house:</para>
25817 <screeninfo>Local Use Recorded</screeninfo>
25821 <imagedata fileref="images/circ/localuserecorded.png"/>
25826 <para>Repeat these steps for all items that have been used within the
25827 library to keep accurate statistics for item use.</para>
25829 <para>The other way to record local use of items is to set your <link
25830 linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
25831 preference to 'Record.' Then whenever you check an item in that is not
25832 checked out and not on hold a local use will be recorded.</para>
25835 <screeninfo>Local Use Recorded</screeninfo>
25839 <imagedata fileref="images/circ/localusecheckin.png"/>
25845 <para>If you have <link
25846 linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
25847 'Record' you can still use your statistical patrons to record local
25848 use as well.</para>
25852 <section id="processinglocations">
25853 <title>In Processing / Book Cart Locations</title>
25855 <para>Koha allows for handling temporary locations like the processing
25856 center and/or book carts throughout the library. For this feature to
25857 work you must first make sure you have <link
25858 linkend="authorizedvalues">authorized values</link> set in the <link
25859 linkend="shelvelocvals">LOC</link> category for PROC (Processing Center)
25860 and CART (Book Cart).</para>
25863 <screeninfo>CART & PROC values in LOC</screeninfo>
25867 <imagedata fileref="images/circ/LOCvalues.png"/>
25872 <para>Next you need to set the <link
25873 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
25874 preference to PROC. This will set the new items to the Processing Center
25875 as their default location.</para>
25877 <para>Create items with their desired final shelving location.</para>
25881 <para>These newly cataloged items will be temporarily set to the
25882 PROC location and will display with whatever description PROC has.
25883 The original location code entered at item creation is stored in the
25884 new items column 'permanent_location', for future use. Items will
25885 stay in the PROC location until they are checked in. To have those
25886 items then move to the shelving cart:</para>
25890 <para>Turn on the <link
25891 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
25892 system preference</para>
25896 <para>Check in those newly-created items and they will be moved
25897 to the location code of CART and display with whatever
25898 description CART has.</para>
25902 <para>A <link linkend="proccartcron">cron job</link> runs at
25903 specified intervals to age items from CART to the permanent
25904 shelving location. (For example, an hourly cron entry of
25905 cart_to_shelf.pl --hours 3 where --hours is the amount of time
25906 an item should spend on the cart before aging to its permanent
25913 linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
25914 system preference is turned on, any newly checked-in item
25915 is also automatically put into the shelving cart, to be
25916 covered by the same script run.</para>
25922 <para>Checkins with confirmed holds will not go into the
25923 shelving cart. If items on the shelving cart are checked
25924 out, the cart location will be cleared.</para>
25934 <section id="selfcheckout">
25935 <title>Self Checkout</title>
25937 <para>Koha comes with a very basic self checkout module. To enable this
25938 module you need to set the <link
25939 linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
25940 'Enable.' To use this module you have to log in as a <link
25941 linkend="addstaffpatron">staff member</link> with <link
25942 linkend="patronpermissions">circulation permissions</link>.</para>
25945 <para>Create a <link linkend="addstaffpatron">staff patron</link>
25946 specifically for this action so that you don't leave a real staff
25947 client logged into a computer all day</para>
25950 <para>There is no link to the Self Checkout module, but a simple
25951 addition to the <link linkend="intranetuserjs">intranetuserjs</link>
25952 system preference can add one.</para>
25954 <programlisting>$(document).ready(function(){ $("#login
25955 #submit").parent().after("<p><a
25956 href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
25957 target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
25960 <para>The code above has line breaks added to make it more readable,
25961 please be sure to enter the above as one line in when putting it in
25962 the system preference.</para>
25965 <para>The link will then appear at the bottom of the log in page:</para>
25968 <screeninfo>Self Checkout Link on Staff Login</screeninfo>
25972 <imagedata fileref="images/circ/selfcheckoutlink.png"/>
25977 <para>You can also access this module by going to :
25978 http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
25980 <para>When on the self checkout page depending on your value in the
25981 <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
25982 preference you will be asked to enter you cardnumber</para>
25985 <screeninfo>Self Checkout Patron Card Number</screeninfo>
25989 <imagedata fileref="images/circ/selfcheckout.png"/>
25994 <para>or your username and password:</para>
25997 <screeninfo>Shelf checkout by login</screeninfo>
26001 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
26006 <para>Once you're logged in to the self check module you will be asked
26007 to scan the items you are checking out</para>
26010 <screeninfo>Self Checkout</screeninfo>
26014 <imagedata fileref="images/circ/selfcheckoutuser.png"/>
26019 <para>As you scan items they will appear below the barcode box</para>
26022 <screeninfo>Self Checkout Summary</screeninfo>
26026 <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
26031 <para>When you are finished scanning items it is important to click the
26032 'Click here if done' button to log the patron out and prepare for the
26033 next patron.</para>
26035 <para>When attempting to check items out there are some instances where
26036 error messages will appear and the patron will be directed to the
26037 librarian. This will happen even if you are allowing overrides on
26038 circulation functions. Only a librarian can override a circulation block
26039 and so patrons must go to the librarian for help in these
26043 <screeninfo>Self Checkout Error Message</screeninfo>
26047 <imagedata fileref="images/circ/selfcheckoutfines.png"/>
26053 <section id="offlinecirc">
26054 <title>Offline Circulation Utility</title>
26056 <section id="firefoxofflinecirc">
26059 <firstname>Franois</firstname>
26061 <surname>Charbonnier</surname>
26065 <orgname>BibLibre</orgname>
26068 <othercredit role="copyeditor">
26069 <firstname>Nicole C.</firstname>
26071 <surname>Engard</surname>
26073 <contrib>Changed content where necessary.</contrib>
26076 <pubdate>2012</pubdate>
26079 <title>Firefox Plugin</title>
26081 <para>There is an offline circulation tool that you can add to your
26082 Firefox browser as a plugin/addon. To do so, just go to <ulink
26083 url="https://addons.mozilla.org/en/firefox/addon/koct/">https://addons.mozilla.org/en/firefox/addon/koct/</ulink>
26084 page and click on the "install now" button. You may have to confirm
26085 the installation, just click on "install now" and then restart Firefox
26086 to complete the installation.</para>
26088 <para>Once you have installed the plugin and restarted Firefox, you
26089 will see the Koha logo in the add-on bar at the bottom right of
26093 <screeninfo>Koha Icon on Add-on Bar</screeninfo>
26097 <imagedata fileref="images/circ/koctstatusbar.png"/>
26102 <para>A click on the logo will open the tool in its own window.</para>
26105 <screeninfo>Koha Offline Circ Tool</screeninfo>
26109 <imagedata fileref="images/circ/koct.png"/>
26114 <para>The plugin consists of four tabs:</para>
26118 <para>The Check Out tab is where you check out items</para>
26122 <para>The Check In tab is where you check in items</para>
26126 <para>The Log tab keeps track of every transaction done while in
26127 offline mode</para>
26131 <para>The log will keep information until you empty it. Each
26132 time you open the plugin and it contains data in the log it
26133 will warn you</para>
26136 <screeninfo>Koha Offline Circ Warning</screeninfo>
26140 <imagedata fileref="images/circ/koctwarn.png"/>
26145 <para>If you'd like to clear the log, check the 'I want to
26146 delete rows' box before hitting the 'OK' button. Otherwise
26147 clicking 'OK' will keep the items in the log and let you
26148 continue working with the tool.</para>
26154 <para>The Param tab is to set up the plugin</para>
26158 <para>The first thing you want to do then is to set up the plugin. Go
26159 to the Param tab to set up the plugin</para>
26162 <screeninfo>Koha Offline CIrc Params</screeninfo>
26166 <imagedata fileref="images/circ/koctparam.png"/>
26171 <para>Answer the 4 questions presented:</para>
26175 <para>Server = the URL of the librarian interface</para>
26179 <para>Branch Code = the code for the branch where you are
26184 <para>Username = your staff account login</para>
26188 <para>Password = your staff account password</para>
26193 <para>To save the settings, you will have to close the plugin
26194 window and re-open it by clicking again on the Koha logo in the
26197 <para>You can create a staff account dedicated to the offline
26198 circulation. So that, no matter who is at the circulation desk,
26199 they can all use the same login. Along those lines, you can use a
26200 group login that you already have in place for circulation as
26202 </tip>Once you have everything set up you can start checking items
26205 <para>Checking out:</para>
26208 <screeninfo>Koha Offline Circulation Check Out</screeninfo>
26212 <imagedata fileref="images/circ/koct.png"/>
26219 <para>Go to the Check Out tab</para>
26223 <para>Scan the patron barcode</para>
26227 <para>Scan the item barcode</para>
26231 <para>Click 'Save'</para>
26235 <para>Checking in:</para>
26238 <screeninfo>Koha Offline Circulation Check In</screeninfo>
26242 <imagedata fileref="images/circ/koctcheckin.png"/>
26249 <para>Go to the Check In tab</para>
26253 <para>Scan the item barcode</para>
26257 <para>Click Save</para>
26261 <para>Each time, you check out or check in an item, a new transaction
26262 is recorded in the local plugin database and you will see, at the
26263 bottom of the plugin how many transactions has been made during the
26264 offline circulation. For example, "10 Row(s) Added" means you did 10
26265 transactions.</para>
26268 <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
26272 <imagedata fileref="images/circ/koctcount.png"/>
26277 <para>Then, if you want an overview of every transaction, go to the
26278 Log tab. This tab will show you the transactions in the plugin
26282 <screeninfo>Koha Offline Circulation Log</screeninfo>
26286 <imagedata fileref="images/circ/koctlog.png"/>
26292 <para>The status will be "Local." as long as you are offline and
26293 don't process the transactions into Koha.</para>
26294 </tip>When your Internet connection comes back up you will want to
26295 get these transactions in to Koha. Before processing these
26296 transactions you should be aware of a few issues.</para>
26298 <para>Because you are not connected to your Koha database when using
26299 this plugin holds will need additional processing. If an item you
26300 check in while offline has a hold, the hold is kept on the item.
26301 Since, you can't confirm holds found during the processing of every
26302 check in, the holds stay on the item and will need to be managed
26303 later. If you only checked in a few items you can just keep a record
26304 of them all. If you checked in a lot of items you can use the Holds
26305 Queue once it rebuilds to see what holds made it to the shelf
26306 erroneously.</para>
26308 <para>Similarly, if an patron card was expired, the offline
26309 circulation tool won't know about it, so the checkout will be recorded
26310 regardless of the patron's account being blocked normally.</para>
26312 <para>You have two options for adding this data to Koha</para>
26316 <para>Commit to Koha</para>
26320 <para>If you checked in/out on more than one computer at the
26321 same time, what you want is to process every transaction
26322 consistently. Let's say for instance that one patron checked a
26323 book out on one computer and then checked the same book in on
26324 another computer. To be consistent, you need to record the
26325 check out first and then the check in. Not the opposite! To do
26326 so, you need to group every transaction in one place, sort
26327 them all and then, process everything. So, you need to use the
26328 "Commit to Koha" option from every plugin/computer you worked
26329 with. This way, the log will go to Koha and be accessible from
26330 the Offline Circulation page.</para>
26333 <screeninfo>Circulation Menu</screeninfo>
26337 <imagedata fileref="images/circ/offlinecirclink.png"/>
26344 <para><emphasis>Get there:</emphasis> Circulation > Offline
26345 Circulation (Firefox add-on)</para>
26348 <screeninfo>Offline Circulation</screeninfo>
26352 <imagedata fileref="images/circ/offlinecirclog.png"/>
26359 <para>Once all of the logs from all of the circulation
26360 computers are loaded you will be able to check them all or
26361 select just those you want to process into Koha.</para>
26365 <para>Click on the Process button and Koha will record every stored transaction one
26366 by one. For each transaction, the status will change to:</para>
26370 <para>"Success." if the transaction was processed
26375 <para>"Borrower not found." if the borrower card number is
26380 <para>"Item not found." if the item barcode is
26385 <para>"Item not issued." if you checked in an available
26392 <para>Once finished you will have a summary of all of your
26393 transactions</para>
26396 <screeninfo>Offline Circulation Summary</screeninfo>
26400 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
26409 <para>Apply directly</para>
26413 <para>If you performed all of the circulation actions on one
26414 computer then everything is sorted already so you can choose
26415 to "Apply directly"</para>
26419 <para>The status column will be updated to let you know if the
26420 transactions were applied</para>
26424 <para>"Success." if the transaction was processed
26429 <para>"Borrower not found." if the borrower card number is
26434 <para>"Item not found." if the item barcode is
26439 <para>"Item not issued." if you checked in an available
26446 <para>Once you're finished you can review all of the items
26447 right in the Log tab</para>
26450 <screeninfo>Koha Offline Circulation Apply
26451 Directly</screeninfo>
26455 <imagedata fileref="images/circ/koctdirectly.png"/>
26464 <para>Once you are done you can clear the log by clicking Clear. If
26465 you don't you will be warned the next time you open the Offline
26466 Circulation tool.</para>
26469 <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
26473 <imagedata fileref="images/circ/koctwarn.png"/>
26479 <section id="windowsofflinecirc">
26480 <title>Offline Circ Tool for Windows</title>
26482 <para>The Offline Circulation Utility can be downloaded at: <ulink url="http://kylehall.info/index.php/projects/koha/koha-offline-circulation/">http://kylehall.info/index.php/projects/koha/koha-offline-circulation/</ulink></para>
26483 <para>To generate a borrowers.db file for loading in to the Windows tool you will need to
26484 run the <link linkend="offlinecirccron">file generator via a cron job</link>.</para>
26488 <section id="uploadofflinecirc">
26489 <title>Upload Offline Circ File</title>
26491 <para>The <link linkend="windowsofflinecirc">offline circulation tool
26492 for Windows</link> will generate a KOC file that you can upload into
26493 Koha once your system comes back up.</para>
26495 <para>On the Circulation menu click 'Offline Circulation File (.koc)
26499 <screeninfo>Circulation menu</screeninfo>
26503 <imagedata fileref="images/circ/offlinecirclink.png"/>
26508 <para>Browse your computer for the *.koc file</para>
26511 <screeninfo>Upload KOC File</screeninfo>
26515 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
26520 <para>Once the file is uploaded, click the process the file</para>
26523 <screeninfo>Process offline circulation file</screeninfo>
26527 <imagedata fileref="images/circ/processoffline.png"/>
26532 <para>When this is complete you'll see the summary of actions from
26533 when you were offline (including any errors).</para>
26536 <screeninfo>Summary of offline actions</screeninfo>
26540 <imagedata fileref="images/circ/offlinesummary.png"/>
26548 <chapter id="cataloging">
26549 <title>Cataloging</title>
26551 <para>Before you start cataloging in Koha you're going to want to do some
26552 basic setup. Refer to the <link linkend="implementation">Implementation
26553 Checklist</link> for a full list of these things. Most importantly you're
26554 going to want to make sure that your <link
26555 linkend="marcbibframeworks">Frameworks</link> are all defined the way you
26556 want. Once in the cataloging module you will not be able to add or remove
26557 fields and subfields so your frameworks must be ready before you start
26559 <para>You can also use OCLC Connexion to send records directly in to Koha. For more information
26560 on that please review the <link linkend="oclcappendix">OCLC Connexion Setup
26561 appendix</link>.</para>
26565 <para><emphasis>Get there:</emphasis> More > Cataloging</para>
26569 <section id="catbibs">
26570 <title>Bibliographic Records</title>
26572 <para>In Koha the bibliographic record contains the main information
26573 related to the material. This includes things like the title, author,
26574 ISBN, etc. This information is stored in Koha in Marc (different flavors
26575 of Marc are supported in Koha). Once this information is saved, <link
26576 linkend="catitems">items or holdings</link> can be attached.</para>
26578 <section id="addbibrec">
26579 <title>Adding Records</title>
26581 <para>Records can be added to Koha via original or copy cataloging. If
26582 you would like to catalog a record using a blank template</para>
26586 <para>Click 'New Record'</para>
26589 <screeninfo>New Record Menu</screeninfo>
26593 <imagedata fileref="images/cataloging/newfromframework.png"/>
26600 <para>Choose the framework you would like to base your record
26607 <para>If you want to catalog a record based on an existing record at
26608 another library</para>
26612 <para>Click 'Z39.50 Search'</para>
26615 <screeninfo>Z39.50 Search</screeninfo>
26619 <imagedata fileref="images/cataloging/zsearch.png"/>
26626 <para>Search for the item you would like to catalog</para>
26631 <para>If no results are found, try searching for fewer
26632 fields, not all Z39.50 targets can search all of the
26633 fields above.</para>
26640 <para>Search targets can be altered by using the <link
26641 linkend="z3950admin">Z39.50 Admin</link> area.</para>
26645 <para>From the results you can view the MARC or Card view for
26646 the records or choose to Import them into Koha</para>
26649 <screeninfo>Z39.50 Search Results</screeninfo>
26653 <imagedata fileref="images/cataloging/zsearchresults.png"/>
26660 <para>In addition to the Import link to the right of each
26661 title, you can click on the title you're interested in and
26662 a menu will pop up with links to preview the record and
26666 <screeninfo>Import Link Popup on Z39.50 Search
26667 Results</screeninfo>
26671 <imagedata fileref="images/cataloging/importz39.png"/>
26678 <para>If you don't find the title you need in your Z39.50
26679 search results you can click the 'Try Another Search'
26680 button at the bottom left of your results</para>
26683 <screeninfo>Try another search</screeninfo>
26687 <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
26698 <para>Once you've opened a blank framework or imported a record via
26699 Z39.50 you will be presented with the form to continue
26703 <screeninfo>Add MARC Record</screeninfo>
26707 <imagedata fileref="images/cataloging/addmarc.png"/>
26714 <para>To expand a collapsed tag click on the tag
26719 <para>To get help from the Library of Congress on a Marc tag click
26720 the question mark (?) to the right of each field number</para>
26724 <para>If you feel that this clutters the screen you can hide
26725 the question marks by unchecking the box next to the 'Show
26726 MARC tag documentation links' note at the top right of the
26730 <screeninfo>Show MARC tag documentation links
26731 checkbox</screeninfo>
26735 <imagedata fileref="images/cataloging/marcdoclinks.png"/>
26744 <para>Sometimes fields may not be editable due to the value in
26746 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
26747 system preference. If you have this preference set to not allow
26748 catalogers to type in fields controlled by authorities you may see
26749 a lock symbol to the left of the field.</para>
26752 <screeninfo>Authority fields locked against editing</screeninfo>
26756 <imagedata fileref="images/cataloging/lockedauthority.png"/>
26763 <para>If this icon appears you must click the icon to the
26764 right of the field to search for an existing authority.</para>
26767 <screeninfo>Search for authority</screeninfo>
26771 <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
26778 <para>From the results list click 'Choose authority' to bring
26779 that into your catalog record</para>
26782 <screeninfo>Authority search results</screeninfo>
26786 <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
26795 <para>To duplicate a field click on the 'repeat this tag' icon to
26796 the right of the tag</para>
26799 <screeninfo>Duplicate a Field</screeninfo>
26803 <imagedata fileref="images/cataloging/dupfield.png"/>
26810 <para>To move subfields in to the right order, click the up
26811 arrow to the left of the field</para>
26815 <para>To duplicate a subfield click on the clone icon (to
26816 remove a copied field, click the delete clone icon) to the
26817 right of the field</para>
26820 <screeninfo>Clone Subfield</screeninfo>
26824 <imagedata fileref="images/cataloging/clonesubfield.png"/>
26831 <para>To remove a subfield (if there is more than one of the
26832 same type), click the - (minus sign) to the right of the
26839 <para>To use a plugin click on the icon to the right of the
26843 <screeninfo>Leader Builder Plugin</screeninfo>
26847 <imagedata fileref="images/cataloging/leaderbuilder.png"/>
26854 <para>Some fixed fields have editors that will change based on
26855 the material type you're cataloging (for example the 006 and
26856 the 008 fields)</para>
26859 <screeninfo>008 Plugin</screeninfo>
26863 <imagedata fileref="images/cataloging/008plugin.png"/>
26872 <para>Once you've finished, click the 'Save' button at the top and
26873 choose whether you want to save and view the bib record you have
26874 created or continue on to add/edit items attached to the
26878 <screeninfo>Record save options</screeninfo>
26882 <imagedata fileref="images/cataloging/savecataloging.png"/>
26889 <para>If you are about to add a duplicate record to the system
26890 you will be warned before saving</para>
26893 <screeninfo>Duplicate Record Warning</screeninfo>
26897 <imagedata fileref="images/cataloging/duprecordwarn.png"/>
26906 <section id="cataloganalytics">
26907 <title>Adding Analytic Records</title>
26908 <para>Libraries sometimes make journal articles and articles within monographs and serials
26909 accessible to library patrons through analytics cataloging. Analytics cataloging creates
26910 separate bibliographic records for these articles, chapters, sections, etc. found within a
26911 larger resource such as a book, an article within a journal, newspaper or serial. In
26912 analytics cataloging, although a separate bib record is created for the title, it is not
26913 physically separated from the host item. Learn more about Analytics in Chapter 13 of
26915 <para>If you would like to catalog analytic records there are two options. One is to use the
26916 <link linkend="catalogeasyanalytics">Easy Analytics</link> funtion; the other is the
26917 <link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow</link>.</para>
26918 <section id="catalogeasyanalytics">
26919 <title>Easy Analytics</title>
26920 <para>The Easy Analytics feature makes linking analytic records together easier. The first
26921 thing you need to do is set the <link linkend="EasyAnalyticalRecords"
26922 >EasyAnalyticalRecords</link> preference to 'Display' and the <link
26923 linkend="UseControlNumber">UseControlNumber</link> preference to 'Don't use.' </para>
26924 <para>After cataloging your analytic record (see <link linkend="addbibrec">Adding
26925 Records</link> for more on creating records) click 'Edit' from the normal view and
26926 choose to 'Link to Host Item'</para>
26928 <screeninfo>Link to Host Item</screeninfo>
26931 <imagedata fileref="images/cataloging/analyticslink.png"/>
26935 <para>This will prompt you to enter the barcode for the item this record should be linked
26938 <screeninfo>Barcode for Analytic Linking</screeninfo>
26941 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
26945 <para>After entering the item's barcode and clicking 'Select' you will receive a
26946 confirmation message.</para>
26948 <screeninfo>Analytic Link Success</screeninfo>
26951 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
26955 <para>The record will now have the 773 field filled in properly to complete the
26958 <screeninfo>773</screeninfo>
26961 <imagedata fileref="images/cataloging/analytics773.png"/>
26965 <para>To view all of the items tied to the host record, do a search for the record, click
26966 the Analytics tab on the left and the analytics tied to each barcode will be shown under
26967 the "Used in" column.</para>
26969 <screeninfo>Analytics Tab</screeninfo>
26972 <imagedata fileref="images/cataloging/analyticstab.png"/>
26977 <para>It is also possible to create analytic records from this screen by clicking on
26978 "Create Analytics"</para>
26980 <para>You can also see the analytics attached to this record by clicking the 'Show
26981 Analytic' link towards the top of the record in the normal view.</para>
26983 <screeninfo>Show Analytics on Bib Record</screeninfo>
26986 <imagedata fileref="images/cataloging/anayticbib.png"/>
26990 <para>When looking at the anaytic record you will also see a link to the host item under
26991 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.<screenshot>
26992 <screeninfo>Host Record</screeninfo>
26995 <imagedata fileref="images/cataloging/hostrecords.png"/>
26998 </screenshot></para>
27000 <section id="catalogenhanceanalytics">
27001 <title>Analytics Enhanced Workflow </title>
27002 <para>To use the Enhanced Workflow method of adding analytics, the first thing you need to
27003 do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
27004 preference to 'Don't display' and the <link linkend="UseControlNumber"
27005 >UseControlNumber</link> preference to 'Use.' </para>
27006 <para>After cataloging your original record (see <link linkend="addbibrec">Adding
27007 Records</link> for more on creating records) click 'New' from the normal view and
27008 choose to 'New child record.'<screenshot>
27009 <screeninfo>New child record</screeninfo>
27012 <imagedata fileref="images/cataloging/analyticschildlink.png"/>
27015 </screenshot></para>
27016 <para>This will open a new blank record for cataloging. The blank record will only have
27017 the 773 field filled in properly to complete the link once the record is saved.</para>
27019 <screeninfo>773</screeninfo>
27022 <imagedata fileref="images/cataloging/analytics773child.png"/>
27026 <para>To view all of the items tied to the host record, do a search for the record, click
27027 the Analytics tab on the left and the analytics tied to each barcode will be shown under
27028 the "Used in" column.</para>
27030 <screeninfo>Analytics Tab</screeninfo>
27033 <imagedata fileref="images/cataloging/analyticstab.png"/>
27037 <para>You can also see the analytics attached to this record by clicking the 'Show
27038 Analytic' link towards the top of the record in the normal view.</para>
27040 <screeninfo>Show Analytics on Bib Record</screeninfo>
27043 <imagedata fileref="images/cataloging/anayticbib.png"/>
27047 <para>When looking at the anaytic record you will also see a link to the host item under
27048 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.<screenshot>
27049 <screeninfo>Host Record</screeninfo>
27052 <imagedata fileref="images/cataloging/hostrecords.png"/>
27055 </screenshot></para>
27057 <section id="analyticediting">
27058 <title>Editing Analytics</title>
27059 <para>If you have linked an analytic record incorrectly you can remove that link by
27060 editing the item on the analytic record (not the host record). To do this, go to the
27061 analytic record and click the 'Edit' button and choose to 'Edit items'. To the left of
27062 each item you will see two options.</para>
27064 <screeninfo>Edit Analytic Item Record</screeninfo>
27067 <imagedata fileref="images/cataloging/analyticdelink.png"/>
27073 <para>Clicking 'Edit in Host' will allow you to edit the item on the host
27077 <para>Clicking 'Delink' will remove the 773 field and the link between the analytic
27078 and the host.</para>
27084 <section id="editbibrec">
27085 <title>Editing Records</title>
27087 <para>To edit a record you can click 'Edit Biblio' from the search
27088 results on the cataloging page</para>
27091 <screeninfo>Edit Biblio Option on Search Results</screeninfo>
27095 <imagedata fileref="images/cataloging/catalogsearch.png"/>
27100 <para>or by clicking the Edit button on the Bibliographic Record and
27101 choosing 'Edit Record'</para>
27104 <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
27108 <imagedata fileref="images/cataloging/editrecord.png"/>
27113 <para>The record will open in the MARC editor</para>
27116 <screeninfo>Editing MARC Record</screeninfo>
27120 <imagedata fileref="images/cataloging/editingrecord.png"/>
27125 <para>The alternative is to search via Z39.50 to overlay your record
27126 with a fuller record found at another library. You can do this by
27127 choosing 'Replace Record via Z39.50' from the Edit menu.</para>
27130 <screeninfo>Replace via Z39.50</screeninfo>
27134 <imagedata fileref="images/cataloging/replaceviaz39.png"/>
27139 <para>Once you choose that you will be brought to a Z39.50 search
27140 window to search other libraries for the record in question.</para>
27142 <para>Once you have made your edits (via either method) you can click
27143 'Save' at the top left of the editor.</para>
27145 <para>You can also use the edit menu to add your own custom cover
27146 image if you have either <link
27147 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
27148 <link linkend="LocalCoverImages">LocalCoverImages</link> set to
27149 'Display' by choosing 'Upload Image' from the menu.</para>
27152 <screeninfo>Upload Image</screeninfo>
27156 <imagedata fileref="images/cataloging/uploadimage.png"/>
27161 <para>Choosing to 'Upload Image' will take you to the <link
27162 linkend="uploadlocalimages">Upload Local Cover Image
27163 Tool</link>.</para>
27166 <section id="dupbibrec">
27167 <title>Duplicating Records</title>
27169 <para>Sometimes a copy of the record you need to catalog can't be
27170 found via Z39.50. In these cases you can create a duplicate of similar
27171 record and edit the necessary pieces to create a new record. To
27172 duplicate an existing record click 'Edit as New (Duplicate)' from the
27173 Edit menu on the Bibliographic Record</para>
27176 <screeninfo>Edit as New (Duplicate) Bibliographic
27177 Record</screeninfo>
27181 <imagedata fileref="images/cataloging/createduplicate.png"/>
27186 <para>This will open a new MARC record with the fields filled in with
27187 the values from the original Bibliographic Record.</para>
27190 <screeninfo>New Duplicate Record</screeninfo>
27194 <imagedata fileref="images/cataloging/newduprecord.png"/>
27200 <section id="mergebibs">
27201 <title>Merging Records</title>
27203 <para>If you would like to merge together multiple records you can do
27204 that via the <link linkend="lists">Lists</link> tool. <link
27205 linkend="mergebibrecs">Learn more here</link>.</para>
27207 <section id="deleterecord">
27208 <title>Deleting Records</title>
27209 <para>To delete a bibliographic record simply choose the 'Edit' button and select 'Delete record'<screenshot>
27210 <screeninfo>Delete record</screeninfo>
27213 <imagedata fileref="images/cataloging/deleterecord.png"/>
27216 </screenshot></para>
27217 <para>Bibliographic records can only be deleted one all items have been deleted. If you try
27218 to delete a bibliographic record with items still attached you will see that the delete
27219 option is grayed out.<screenshot>
27220 <screeninfo>Record with items still attached</screeninfo>
27223 <imagedata fileref="images/cataloging/nodeleterecord.png"/>
27226 </screenshot></para>
27230 <section id="catitems">
27231 <title>Item Records</title>
27233 <para>In Koha each bibliographic record can have one or more items
27234 attached. These items are sometimes referred to as holdings. Each item
27235 includes information to the physical copy the library has.</para>
27237 <section id="addingitems">
27238 <title>Adding Items</title>
27240 <para>After saving a new bibliographic record, you will be redirected
27241 to a blank item record so that you can attach an item to the
27242 bibliographic record. You can also click 'Add/Edit Items' from the
27243 cataloging search results</para>
27246 <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
27250 <imagedata fileref="images/cataloging/catalogsearch.png"/>
27255 <para>or you can add new item at any time by clicking 'New' on the
27256 bibliographic record and choosing 'New Item'</para>
27259 <screeninfo>New Item Button</screeninfo>
27263 <imagedata fileref="images/cataloging/newitem.png"/>
27268 <para>The item edit form will appear:</para>
27271 <screeninfo>Add item form</screeninfo>
27275 <imagedata fileref="images/cataloging/additem.png"/>
27280 <para>At the very least, if you plan on circulating the item, the
27281 following fields should be entered for new items:</para>
27285 <para>2 - Source of classification</para>
27289 <para>a - Permanent location</para>
27293 <para>b - Current location</para>
27297 <para>o - Full call number</para>
27301 <para>p - Barcode</para>
27305 <para>v - Cost, replacement price</para>
27309 <para>This value will be charged to patrons when you mark an
27310 item they have checked out as 'Lost'</para>
27316 <para>y - Koha item type</para>
27320 <para>To make sure that these values are filled in you can mark them
27321 as mandatory in the <link linkend="marcbibframeworks">framework</link>
27322 you're using and then they will appear in red with a 'required' label.
27323 The item will not save until the required fields are filled in.</para>
27326 <screeninfo>Required Item Subfield</screeninfo>
27330 <imagedata fileref="images/cataloging/requireditemfields.png"/>
27338 <para>To make item subfields required in a framework you'll want
27339 to edit the 952 field in the <link
27340 linkend="marcbibframeworks">framework editor</link>.</para>
27345 <para>Below the add form there are 3 buttons for adding the
27349 <screeninfo>Add Item Buttons</screeninfo>
27353 <imagedata fileref="images/cataloging/additembuttons.png"/>
27360 <para>Add Item will add just the one item</para>
27364 <para>Add & Duplicate will add the item and fill in a new form
27365 with the same values for your to alter</para>
27369 <para>Add Multiple Copies will ask how many copies and will then
27370 add that number of copies adding +1 to the barcode so each barcode
27375 <para>Your added items will appear above the add form once
27379 <screeninfo>Items</screeninfo>
27383 <imagedata fileref="images/cataloging/items.png"/>
27388 <para>Your items will also appear below the bibliographic details on
27389 the bib record display.</para>
27392 <screeninfo>List of Items on the Bib Record</screeninfo>
27396 <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
27401 <para>If you have <link
27402 linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
27403 set to 'Display' then there will also be a link to print a quick spine
27404 label next to each item.</para>
27407 <screeninfo>List of Items on the Bib Record with a Print Label
27412 <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
27418 <section id="editingitems">
27419 <title>Editing Items</title>
27421 <para>Items can be edited in several ways.</para>
27425 <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
27429 <screeninfo>Edit Items Menu Option</screeninfo>
27433 <imagedata fileref="images/cataloging/edititem.png"/>
27438 <para>Which will open up a list of items where you can click
27439 'Edit' to the left of the specific item you would like to
27443 <screeninfo>Edit individual items</screeninfo>
27447 <imagedata fileref="images/cataloging/edititemlink.png"/>
27454 <para>Clicking 'Edit Items' beside the item on the 'Items'
27458 <screeninfo>Items Tab</screeninfo>
27462 <imagedata fileref="images/cataloging/itemstab.png"/>
27467 <para>Which will open up a list of items where you can click
27468 'Edit' to the left of the specific item you would like to
27472 <screeninfo>Edit individual items</screeninfo>
27476 <imagedata fileref="images/cataloging/edititemlink.png"/>
27483 <para>Clicking 'Edit' and then 'Edit items in batch'</para>
27486 <screeninfo>Edit items in a batch</screeninfo>
27490 <imagedata fileref="images/cataloging/editinbatch.png"/>
27495 <para>This will open up the <link linkend="batchmodifyitems">batch
27496 item modification tool</link> where you can edit all of the items
27497 on this record as a batch.</para>
27501 <section id="itemquickedit">
27502 <title>Quick Item Status Updates</title>
27504 <para>Often circulation staff need to change the status of an item
27505 to Lost or Damaged. This doesn't require you to edit the entire item
27506 record. Instead clicking on the item barcode on the checkout summary
27507 or checkin history will bring you to an item summary. You can also
27508 get to the item summary by clicking on the Items tab to the left of
27509 the bib detail page.</para>
27512 <screeninfo>Item Edit</screeninfo>
27516 <imagedata fileref="images/cataloging/quickitemedit.png"/>
27521 <para>From this view you can mark an item lost by choosing a lost
27522 status from the pull down and clicking the 'Set Status'
27526 <screeninfo>Edit Lost Status</screeninfo>
27530 <imagedata fileref="images/cataloging/editloststatus.png"/>
27535 <para>You can also mark an item as damaged by choosing a damaged
27536 status from the pull down and clicking the 'Set Status'
27540 <screeninfo>Edit Damaged Status</screeninfo>
27544 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
27551 <section id="iteminfo">
27552 <title>Item Information</title>
27554 <para>To the left of every bibliographic record there is a tab to view
27558 <screeninfo>Items Tab</screeninfo>
27562 <imagedata fileref="images/cataloging/quickitemedit.png"/>
27567 <para>Clicking that tab will give you basic information about the
27568 items. If you ordered the item via the acquisitions module then the
27569 History section will include information about the order.</para>
27572 <screeninfo>History with order info</screeninfo>
27576 <imagedata fileref="images/cataloging/itemorderinfo.png"/>
27581 <para>If the Order or Accession date is linked, clicking it will bring
27582 you to the acquisitions information for that item.</para>
27585 <section id="moveitemrec">
27586 <title>Moving Items</title>
27588 <para>Items can be moved from one bibliographic record to another
27589 using the Attach Item option</para>
27592 <screeninfo>Attach Item Option</screeninfo>
27596 <imagedata fileref="images/cataloging/attachitem.png"/>
27601 <para>Visit the bibliographic record you want to attach the item to
27602 and choose 'Attach Item' from the 'Edit' menu.</para>
27605 <screeninfo>Attach Item Form</screeninfo>
27609 <imagedata fileref="images/cataloging/attachitemform.png"/>
27614 <para>Simply enter the barcode for the item you want to move and click
27617 <para>If you want to move all items to a new record creating only one
27618 bibliographic record you can use the <link
27619 linkend="mergebibrecs">Merge Records tool</link> instead.</para>
27622 <section id="deleteitems">
27623 <title>Deleting Items</title>
27625 <para>There are many ways to delete item records. If you only need to
27626 delete one item you can do this by opening up the detail page for the
27627 bib record and clicking the 'Edit' button at the top. From there you
27628 can choose to 'Edit items'.</para>
27631 <screeninfo>'Edit Items' menu option</screeninfo>
27635 <imagedata fileref="images/cataloging/edititemstodelete.png"/>
27640 <para>You will be presented with a list of items and next to each one
27641 will be a link labeled 'Delete'. Click that link and if the item is
27642 not checked out it will delete that item.</para>
27645 <screeninfo>Delete link on the left</screeninfo>
27649 <imagedata fileref="images/cataloging/deleteitemlink.png"/>
27654 <para>If you know that all of the items attached to your record are
27655 not currently checked out you can use the 'Delete all items' option
27656 under the 'Edit menu' and it will remove all items from the
27659 <para>Finally you can use the <link linkend="batchdeleteitems">batch
27660 delete tool</link> to delete a batch of items.</para>
27663 <section id="itemcirchistory">
27664 <title>Item Specific Circulation History</title>
27666 <para>Each bibliographic record keeps a circulation history (with or
27667 without the patron information depending on your settings), but each
27668 item also has its own circulation history page. To see this, click on
27669 the 'Items' tab to the left of the record you are viewing.</para>
27672 <screeninfo>Items tab</screeninfo>
27676 <imagedata fileref="images/cataloging/itemstab-long.png"/>
27681 <para>Below the 'History' heading is a link to 'View item's checkout
27682 history,' clicking that will open up the item's history which will
27683 look slightly different from the bibliographic record's history
27687 <screeninfo>Item Specific Circulation History</screeninfo>
27691 <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
27698 <section id="catauthorities">
27699 <title>Authorities</title>
27701 <para>Authority records are a way of controlling fields in your MARC
27702 records. Using authority records will provide you with control over
27703 subject headings, personal names and places.</para>
27705 <section id="addauthorities">
27706 <title>Adding Authorities</title>
27708 <para>To add a new authority record, choose the authority type from
27709 the 'New Authority' button.</para>
27712 <screeninfo>New Authority Record Options</screeninfo>
27716 <imagedata fileref="images/cataloging/newauthtypes.png"/>
27721 <para>The form that appears will allow you to enter all of the
27722 necessary details regarding your authority record.</para>
27725 <screeninfo>New Authority Record</screeninfo>
27729 <imagedata fileref="images/cataloging/newauthrec.png"/>
27734 <para>To expand collapsed values simply click on the title and the
27735 subfields will appear. To duplicate a field or subfield just click the
27736 plus sign (+) to the right of the label. To use field helper plugins
27737 simply click the ellipsis (...) to the right of the field.</para>
27739 <para>When linking authorities to other headings, you can use the
27740 authority finder plugin by clicking the ellipsis (...) to the right of
27744 <screeninfo>Authority search plugin</screeninfo>
27748 <imagedata fileref="images/cataloging/creatnewauthfromlink.png"/>
27753 <para>From there you can search your authority file for the authority
27754 to link. If you can't find the authority to link, you can click the
27755 'Create new' button and add the necessary authority for the link. This
27756 plugin also allows for you to choose the link relationship between the
27757 authorities.</para>
27760 <screeninfo>Authority relationships</screeninfo>
27764 <imagedata fileref="images/cataloging/authrelationships.png"/>
27770 <section id="searchauthorities">
27771 <title>Searching Authorities</title>
27773 <para>From the authorities page you can search for existing terms and
27774 the bibliographic records they are attached to.</para>
27777 <screeninfo>Authority Search</screeninfo>
27781 <imagedata fileref="images/cataloging/authoritysearch.png"/>
27786 <para>From the results you will see the authority record, how many
27787 bibliographic records it is attached to, and a delete link (if there
27788 are no bibliographic records attached).</para>
27791 <screeninfo>Authority Search Results</screeninfo>
27795 <imagedata fileref="images/cataloging/authorityresults.png"/>
27800 <para>Clicking on the Details link to the right of the authority
27801 record summary will open the full record and the option to edit the
27805 <screeninfo>Authority Record</screeninfo>
27809 <imagedata fileref="images/cataloging/authrecord.png"/>
27814 <para>If the authority has See Alsos in it you will see those broken
27815 out on the search results, clicking the linked headings will run a
27816 search for that heading instead.</para>
27819 <screeninfo>See Also in Authorities</screeninfo>
27823 <imagedata fileref="images/cataloging/authoritiesseealso.png"/>
27829 <section id="editauthorities">
27830 <title>Editing Authorities</title>
27832 <para>Authorities can be edited by clicking on the authority summary
27833 from the search results and then clicking the 'Edit' button above the
27837 <screeninfo>Edit Authority Record</screeninfo>
27841 <imagedata fileref="images/cataloging/editauthority.png"/>
27846 <para>Once you've made the necessary edits, simply click 'Save' and if
27847 you have the <link linkend="dontmerge">dontmerge</link> system
27848 preference set to 'Do' the next time the <link
27849 linkend="mergeauthcron">merge_authorities.pl cronjob</link> runs it
27850 will update all of the bib records that use that authority.</para>
27852 <para>To delete an authority record you first must make sure it's not
27853 linked to any bibliographic records. If it is not used by any
27854 bibliographic records a 'Delete' link will appear to the right of the
27855 record on the search results and as a button that appears after
27856 clicking on the summary of the authority record.</para>
27860 <section id="catguides">
27861 <title>Cataloging Guides</title>
27865 <section id="bibcatcheatsheet">
27868 <firstname>Jared</firstname>
27870 <surname>Camins-Esakov</surname>
27874 <orgname>American Numismatic Society</orgname>
27877 <othercredit role="copyeditor">
27878 <firstname>Nicole C.</firstname>
27880 <surname>Engard</surname>
27882 <contrib>Changed content where necessary.</contrib>
27885 <pubdate>2010</pubdate>
27888 <title>Bibliographic Record Cataloging Cheat Sheet</title>
27890 <table cellpadding="4" cellspacing="4" frame="all">
27891 <title>Cataloging Guide</title>
27893 <tgroup align="left" cols="4" colsep="1" rowsep="1">
27896 <entry><para>Tag</para></entry>
27898 <entry><para>Label</para></entry>
27900 <entry><para>Description</para></entry>
27902 <entry><para>Instructions</para></entry>
27908 <entry><para>000</para></entry>
27910 <entry><para>LEADER</para></entry>
27912 <entry><para>Describes the record(i.e. surrogate) -- is it a
27913 record for a monograph? A serial?</para></entry>
27915 <entry><para>Click in this field to fill it in. Then set
27916 "Bibliographic level" to 'a' for articles or 's' for serials.
27917 Otherwise, leave everything as is.</para></entry>
27921 <entry><para>001</para></entry>
27923 <entry><para>CONTROL NUMBER</para></entry>
27925 <entry><para>Accession number.</para></entry>
27927 <entry><para>Enter the accession number written inside the
27928 item here. For articles and items which do not have accession
27929 numbers, leave blank.</para></entry>
27933 <entry><para>003</para></entry>
27935 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
27937 <entry><para>Your MARC Organizational Code</para></entry>
27939 <entry><para>Click in this field to fill it in (will auto fill
27940 if you have your <link
27941 linkend="MARCOrgCode">MARCOrgCode</link> preference
27942 set).</para></entry>
27946 <entry><para>005</para></entry>
27948 <entry><para>D & T LATEST TRANSACTION</para></entry>
27950 <entry><para>Current date and time.</para></entry>
27952 <entry><para>Click in this field to fill it in.</para></entry>
27956 <entry><para>008</para></entry>
27958 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
27960 <entry><para>Field containing computer-readable
27961 representations of a number of things.</para></entry>
27963 <entry><para>Generally you will only use 's' (single) or 'm'
27964 (multiple) options for position 06- use the former when the
27965 item was published in a single year, the latter when it was
27966 published over the course of several. If there is a single
27967 date, only enter a date in the first date field (positions
27968 07-10). Enter the three-digit country code in positions 15-17,
27969 being sure to add spaces if the country code is fewer than
27970 three characters long. If there is an index, note that fact in
27971 position 31. Enter the three-letter language code in positions
27972 35-37.</para></entry>
27976 <entry><para>010</para></entry>
27978 <entry><para>LCCN</para></entry>
27980 <entry><para>A number assigned by the Library of Congress to
27981 uniquely identify the work.</para></entry>
27983 <entry><para>Check on the copyright page of the book (if it
27984 was published in the US) or the LC catalog for this number. If
27985 you can't find it, don't worry about it.</para></entry>
27989 <entry><para>020</para></entry>
27991 <entry><para>ISBN</para></entry>
27993 <entry><para>Unique number used by publishers to identify
27994 books.</para></entry>
27996 <entry><para>If this number isn't listed on the book, there
27997 probably isn't one.</para></entry>
28001 <entry><para>022</para></entry>
28003 <entry><para>ISSN</para></entry>
28005 <entry><para>Unique number used by publishers to identify
28006 serials.</para></entry>
28008 <entry><para>If this number isn't listed on the book, there
28009 probably isn't one.</para></entry>
28013 <entry><para>033</para></entry>
28015 <entry><para>DATE/TIME OF EVENT</para></entry>
28017 <entry><para>Used for auction dates. Required for auction
28018 catalogs.</para></entry>
28020 <entry><para>For auctions that took place on only one day,
28021 enter the date of the auction in the format YYYYMMDD in the
28022 subfield 'a' and a '0' in the first indicator. For auctions
28023 that took place over two consecutive days or any number of
28024 non-consecutive days, create a subfield 'a' for each day with
28025 the date in the format YYYYMMDD, and put a '1' in the first
28026 indicator. For auctions that took place over more than two
28027 consecutive days, create a subfield 'a' (in format YYYYMMDD)
28028 for the first day and a subfield 'a' (also in format YYYYMMDD)
28029 for the last day, and put a '2' in the first
28030 indicator.</para></entry>
28034 <entry><para>040</para></entry>
28036 <entry><para>CATALOGING SOURCE</para></entry>
28038 <entry><para>Identifies which libraries created and modified
28039 the record.</para></entry>
28041 <entry><para>For imported records, add a subfield 'd' with
28042 your OCLC code as the value. For new records, make sure that
28043 the subfield 'c' with your OCLC code as the
28044 value.</para></entry>
28048 <entry><para>041</para></entry>
28050 <entry><para>LANGUAGE CODE</para></entry>
28052 <entry><para>Identifies all the languages used in an item,
28053 when two or more languages are present.</para></entry>
28055 <entry><para>For significant portions of a text in a given
28056 language, there should be a subfield 'a' with that language
28057 code. If there are only summaries or abstracts in a specific
28058 language, create a subfield 'b' with that language
28059 code.</para></entry>
28063 <entry><para>100</para></entry>
28065 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
28067 <entry><para>Authorized form of the main author's
28068 name</para></entry>
28070 <entry><para>See Authorized headings sheet and AACR2. The
28071 first indicator should generally be a '1', to indicate that
28072 the entry is surname first. If the name consists only of a
28073 forename, however, the first indicator should be
28074 '0'.</para></entry>
28078 <entry><para>110</para></entry>
28080 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
28082 <entry><para>Authorized form of the name of the main corporate
28083 author. Required for auction catalogs.</para></entry>
28085 <entry><para>Auction catalogs should use a 110 field rather
28086 than a 100 field. See Authorized headings sheet and AACR2. Set
28087 the first indicator to '2'.</para></entry>
28091 <entry><para>111</para></entry>
28093 <entry><para>MAIN ENTRY--MEETING</para></entry>
28095 <entry><para>Authorized form of the name of a meeting which
28096 acted as a main offer (e.g. conference
28097 proceedings)</para></entry>
28099 <entry><para>See Authorized headings sheet and AACR2. Set the
28100 first indicator to '2'.</para></entry>
28104 <entry><para>245</para></entry>
28106 <entry><para>TITLE STATEMENT</para></entry>
28108 <entry><para>Transcription of the title statement from the
28109 title page (or chief source of information)</para></entry>
28111 <entry><para>Enter the title in subfield 'a', the subtitle in
28112 subfield 'b', and the statement of responsibility in subfield
28113 'c'. If you are creating a record for a single volume or part
28114 of a multi-part item, you should put the part number in
28115 subfield 'n' and the part title in subfield 'p.' For auction
28116 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
28117 in square brackets in subfield 'f'. See ISBD punctuation
28118 sheet. Set the first indicator to '0' if there is no author,
28119 otherwise set it to '1'. Set the second indicator to the
28120 number of non-filing characters (i.e. characters in an initial
28121 articles plus the space... for "The " set the second indicator
28122 to '4').</para></entry>
28126 <entry><para>246</para></entry>
28128 <entry><para>VARYING FORM OF TITLE</para></entry>
28130 <entry><para>Alternate form of title for searching and filing
28131 purposes</para></entry>
28133 <entry><para>If the patron might look for the work under a
28134 different title, enter it here. Do not include initial
28135 articles. The first indicator should be '3', unless the title
28136 is merely a variant spelling, in which case the first
28137 indicator should be '1'.</para></entry>
28141 <entry><para>250</para></entry>
28143 <entry><para>EDITION STATEMENT</para></entry>
28145 <entry><para>Transcription of the edition statement from the
28146 title page (or chief source of information)</para></entry>
28148 <entry><para>Transcribe the edition statement exactly as it
28149 appears on the title-page. You may abbreviate if the edition
28150 statement is very long.</para></entry>
28154 <entry><para>260</para></entry>
28156 <entry><para>PUBLICATION (IMPRINT)</para></entry>
28158 <entry><para>Publication information.</para></entry>
28160 <entry><para>Put the location of publication in subfield 'a',
28161 the publisher in subfield 'b', and the year (or probable year)
28162 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
28166 <entry><para>300</para></entry>
28168 <entry><para>PHYSICAL DESCRIPTION</para></entry>
28170 <entry><para>Physical description</para></entry>
28172 <entry><para>Enter the pagination statement in subfield 'a', a
28173 brief description of "special" contents such as illustrations
28174 or maps in subfield 'b' (see AACR2), and the size of the item
28175 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
28179 <entry><para>490</para></entry>
28181 <entry><para>SERIES STATEMENT</para></entry>
28183 <entry><para>Shows the series statement exactly as it appears
28184 on the item.</para></entry>
28186 <entry><para>Transcribe the series statement into subfield 'a'
28187 with the volume number in subfield 'v'. See ISBD punctuation
28188 sheet. Set the first indicator to '1' if you are using an 830.
28189 As a general rule, you should do so.</para></entry>
28193 <entry><para>500</para></entry>
28195 <entry><para>GENERAL NOTE</para></entry>
28197 <entry><para>Notes that don't fit anywhere
28198 else.</para></entry>
28200 <entry><para>Enter notes as full sentences, with a separate
28201 500 field for each distinct topic.</para></entry>
28205 <entry><para>501</para></entry>
28207 <entry><para>WITH NOTE</para></entry>
28209 <entry><para>Notes whether the work is bound with the works
28210 described by other records.</para></entry>
28212 <entry><para>Put description of relationship in subfield
28213 'a'.</para></entry>
28217 <entry><para>504</para></entry>
28219 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
28221 <entry><para>Indicates whether the work includes a
28222 bibliography.</para></entry>
28224 <entry><para>If the work includes a bibliography and index,
28225 put the text "Includes bibliographical references (p. XXX-XXX)
28226 and index." in subfield 'a'. If the work does not include an
28227 index, remove that part of the sentence. If the references are
28228 scattered throughout the work and not gathered into a distinct
28229 sentence, remove the parenthetical statement.</para></entry>
28233 <entry><para>505</para></entry>
28235 <entry><para>FORMATTED CONTENTS</para></entry>
28237 <entry><para>List of contents in a standard format.
28238 Unformatted contents can be listed in a 500 (General Note)
28239 field.</para></entry>
28241 <entry><para>See ISBD punctuation sheet. Set the first
28242 indicator to '0'. If you are separately coding authors and
28243 titles, set the second indicator to '0'. Otherwise, leave the
28244 second indicator blank.</para></entry>
28248 <entry><para>518</para></entry>
28250 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
28252 <entry><para>Used for auction dates.</para></entry>
28254 <entry><para>For auction catalogs, enter the date of the
28255 auction in the format 'January 2, 1984' in the subfield
28260 <entry><para>520</para></entry>
28262 <entry><para>SUMMARY, ETC.</para></entry>
28264 <entry><para>A brief summary or abstract of the book or
28265 article.</para></entry>
28267 <entry><para>In general you do not need to write a summary. A
28268 summary might be called for, however, with items that cannot
28269 be easily reviewed by a patron, such as books with highly
28270 acidic paper or CD-ROMs.</para></entry>
28274 <entry><para>546</para></entry>
28276 <entry><para>LANGUAGE NOTE</para></entry>
28278 <entry><para>Note describing the languages used in the
28279 work</para></entry>
28281 <entry><para>Only needed for works in multiple languages. See
28282 ISBD punctuation sheet.</para></entry>
28286 <entry><para>561</para></entry>
28288 <entry><para>PROVENANCE INFORMATION</para></entry>
28290 <entry><para>Describes the previous ownership of the
28291 item.</para></entry>
28293 <entry><para>Used only for rare books.</para></entry>
28297 <entry><para>563</para></entry>
28299 <entry><para>BINDING INFORMATION</para></entry>
28301 <entry><para>Describes the binding of the item.</para></entry>
28303 <entry><para>Used only for rare books.</para></entry>
28307 <entry><para>590</para></entry>
28309 <entry><para>LOCAL NOTE</para></entry>
28311 <entry><para>Local notes. Required for auction
28312 catalogs.</para></entry>
28314 <entry><para>Used for auction catalogs to indicate what types
28315 of coins are sold in the auction- Roman, Greek,
28316 etc.</para></entry>
28320 <entry><para>600</para></entry>
28322 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
28324 <entry><para>Authorized form of personal names for people
28325 discussed in the work</para></entry>
28327 <entry><para>See Authorized headings sheet and AACR2. The
28328 first indicator should generally be a '1', to indicate that
28329 the entry is surname first. If the name consists only of a
28330 forename, however, the first indicator should be '0'. If you
28331 found the name in the LC authority file, set the second
28332 indicator to '0'. Otherwise set the second indicator to
28333 '4'.</para></entry>
28337 <entry><para>610</para></entry>
28339 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
28341 <entry><para>Authorized form of corporate names for
28342 organizations discussed in the work</para></entry>
28344 <entry><para>See Authorized headings sheet and AACR2. Set the
28345 first indicator to '2'. If you found the name in the LC
28346 authority file, set the second indicator to '0'. Otherwise set
28347 the second indicator to '4'.</para></entry>
28351 <entry><para>611</para></entry>
28353 <entry><para>SUBJECT ADDED--MEETING</para></entry>
28355 <entry><para>Authorized form of meeting names for meetings
28356 discussed in the work</para></entry>
28358 <entry><para>See Authorized headings sheet and AACR2. Set the
28359 first indicator to '2'. If you found the name in the LC
28360 authority file, set the second indicator to '0'. Otherwise set
28361 the second indicator to '4'.</para></entry>
28365 <entry><para>630</para></entry>
28367 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
28369 <entry><para>Authorized form of titles for other works
28370 discussed in the work</para></entry>
28372 <entry><para>See Authorized headings sheet and AACR2. Set the
28373 first indicator to the number of non-filing characters (i.e.
28374 characters in an initial articles plus the space... for "The "
28375 set the first indicator to '4'). If you found the name in the
28376 LC authority file, set the second indicator to '0'. Otherwise
28377 set the second indicator to '4'.</para></entry>
28381 <entry><para>650</para></entry>
28383 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
28385 <entry><para>Library of Congress Subject Heading terms
28386 describing the subject of the work</para></entry>
28388 <entry><para>See Authorized headings sheet and AACR2. If you
28389 found the name in the LC authority file, set the second
28390 indicator to '0'. Otherwise set the second indicator to
28391 '4'.</para></entry>
28395 <entry><para>651</para></entry>
28397 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
28399 <entry><para>Library of Congress Subject Heading geographical
28400 terms describing the subject of the work</para></entry>
28402 <entry><para>See Authorized headings sheet and AACR2. If you
28403 found the name in the LC authority file, set the second
28404 indicator to '0'. Otherwise set the second indicator to
28405 '4'.</para></entry>
28409 <entry><para>655</para></entry>
28411 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
28413 <entry><para>Describes what an item is as opposed to what the
28414 item is about.</para></entry>
28416 <entry><para>Generally used only for auction catalogs, which
28417 should have the genre heading "Auction catalogs." (make sure
28418 to find the authorized heading!) If you found the name in the
28419 LC authority file, set the second indicator to '0'. If you are
28420 using a term from a specific thesaurus, set the second
28421 indicator to '7' and put the code for the thesaurus in
28422 subfield '2'. Otherwise set the second indicator to
28423 '4'.</para></entry>
28427 <entry><para>690</para></entry>
28429 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
28431 <entry><para>Used for headings from any custom subject
28432 authority file.</para></entry>
28434 <entry><para>If there is no appropriate LCSH term, you can use
28435 a 690 with subject headings you find on other items in the
28436 catalog.</para></entry>
28440 <entry><para>691</para></entry>
28442 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
28444 <entry><para>Used for headings from any custom subject
28445 authority file.</para></entry>
28447 <entry><para>If there is no appropriate LCSH term, you can use
28448 a 691 with subject headings you find on other items in the
28449 catalog.</para></entry>
28453 <entry><para>700</para></entry>
28455 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
28457 <entry><para>Used for second authors and other persons related
28458 to the production of the work.</para></entry>
28460 <entry><para>See Authorized headings sheet and AACR2. The
28461 first indicator should generally be a '1', to indicate that
28462 the entry is surname first. If the name consists only of a
28463 forename, however, the first indicator should be
28464 '0'.</para></entry>
28468 <entry><para>710</para></entry>
28470 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
28472 <entry><para>Used for corporate bodies related to the
28473 production of the work (e.g. publishers).</para></entry>
28475 <entry><para>See Authorized headings sheet and AACR2. Set the
28476 first indicator to '2'.</para></entry>
28480 <entry><para>711</para></entry>
28482 <entry><para>ADDED ENTRY--MEETING</para></entry>
28484 <entry><para>Used for meetings related to the production of
28485 the work (e.g. symposia that contributed to the
28486 work).</para></entry>
28488 <entry><para>See Authorized headings sheet and AACR2. Set the
28489 first indicator to '2'.</para></entry>
28493 <entry><para>730</para></entry>
28495 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
28497 <entry><para>Used for uniform titles related to the production
28498 of the work (e.g. a work that inspired the present
28499 work)</para></entry>
28501 <entry><para>See Authorized headings sheet and AACR2. Set the
28502 first indicator to the number of non-filing characters (i.e.
28503 characters in an initial articles plus the space... for "The "
28504 set the first indicator to '4').</para></entry>
28508 <entry><para>773</para></entry>
28510 <entry><para>HOST ITEM ENTRY</para></entry>
28512 <entry><para>Describes the larger bibliographic unit that
28513 contains the work (e.g. book or journal containing the article
28514 being described in the current record)</para></entry>
28516 <entry><para>If the host publication is author main entry,
28517 enter the authorized form of the author's name in subfield
28518 'a'. Put the title in subfield 't'. If the host publication is
28519 an independent work, put publication information in subfield
28520 'd'. When available, ISSN and ISBN should always be used in,
28521 in subfields 'x' and 'z' respectively. Relationship
28522 information (e.g. volume number, page number, etc.) goes in
28523 subfield 'g'. Subfield 'q' contains an encoded representation
28524 of the location of the item: volume, issue, and section
28525 numbers are separated by colons, and the first page is entered
28526 following a '<' at the end of the subfield. See ISBD
28527 punctuation sheet. Set the first indicator to '0'. If you want
28528 the label "In:" to be generated, leave the second indicator
28529 blank. If you want something else displayed before the 773
28530 text, set the second indicator to '8' and add a subfield 'i'
28531 with the label you want at the beginning of the field (e.g.
28532 "$iOffprint from:").</para></entry>
28536 <entry><para>830</para></entry>
28538 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
28540 <entry><para>Authorized form of the series name transcribed in
28541 the 490 field. Often this will just be the same as the
28542 490.</para></entry>
28544 <entry><para>See Authorized headings sheet and AACR2. Set the
28545 second indicator to the number of non-filing characters (i.e.
28546 characters in an initial articles plus the space... for "The "
28547 set the second indicator to '4').</para></entry>
28551 <entry><para>852</para></entry>
28553 <entry><para>LOCATION/CALL NUMBER</para></entry>
28555 <entry><para>Provides the section name for pre-barcode books,
28556 pamphlets, and some articles and serials.</para></entry>
28558 <entry><para>Do not put anything in this field if you are
28559 cataloging a volume which gets only one record and a barcode.
28560 If the item does not get a barcode, or you are currently
28561 creating a record for an article in a volume, put the section
28562 in subfield 'a' (see ANS cataloging documentation), and the
28563 call number in subfield 'i'. Set the first indicator to
28564 '8'.</para></entry>
28568 <entry><para>856</para></entry>
28570 <entry><para>ELECTRONIC ACCESS</para></entry>
28572 <entry><para>Links to material available
28573 online.</para></entry>
28575 <entry><para>Put the URL of any electronic copies or
28576 summaries, etc. in subfield 'u' and a link title in subfield
28577 'y'. Set the first indicator to '4'.</para></entry>
28581 <entry><para>942</para></entry>
28583 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
28585 <entry><para>Used for Koha-specific data.</para></entry>
28587 <entry><para>Set the subfield 'c' to the appropriate item
28588 type.</para></entry>
28595 <section id="itemcatguide">
28596 <title>Item/Holdings Record Cataloging Guide</title>
28598 <para>This table represents the default embedded holdings data in Koha. This information can
28599 be used for migration or importing data purposes</para>
28601 <table cellpadding="4" cellspacing="4" frame="all">
28602 <title>Koha Embedded Holdings Data</title>
28604 <tgroup align="left" cols="4" colsep="1" rowsep="1">
28605 <colspec colname="tag" colnum="1"/>
28607 <colspec colname="data" colnum="2"/>
28609 <colspec colname="desc" colnum="3"/>
28611 <colspec colname="note" colnum="4"/>
28615 <entry><para>MARC21 Tag/subfield</para></entry>
28617 <entry><para>Data Element</para></entry>
28619 <entry><para>Description</para></entry>
28621 <entry><para>Notes</para></entry>
28627 <entry><para>952$0</para></entry>
28629 <entry><para>Withdrawn status</para></entry>
28631 <entry><para>Default values: </para> <itemizedlist>
28633 <para>0 = Not withdrawn</para>
28637 <para>1 = Withdrawn</para>
28639 </itemizedlist></entry>
28641 <entry><para>Coded value, matching <link
28642 linkend="authorizedvalues">Authorized Value</link> category
28643 ('WITHDRAWN' in default installation)</para></entry>
28647 <entry><para>952$1</para></entry>
28649 <entry><para>Lost status</para></entry>
28651 <entry><para>Default values:</para> <itemizedlist>
28653 <para>0 = Available</para>
28657 <para>1 = Lost</para>
28661 <para>2 = Long Overdue (Lost)</para>
28665 <para>3 = Lost and Paid For</para>
28669 <para>4 = Missing in Inventory</para>
28673 <para>5 = Missing in Hold Queue</para>
28675 </itemizedlist></entry>
28677 <entry><para>It's possible to configure OPAC so that lost
28678 items don't display with the <link
28679 linkend="hidelostitems">hidelostitems</link> system
28680 preference. </para> <para>Coded value, matching <link
28681 linkend="authorizedvalues">Authorized Value</link> category
28682 ('LOST' in default installation)</para></entry>
28686 <entry><para>952$2</para></entry>
28688 <entry><para>Classification</para></entry>
28690 <entry><para>Classification scheme that defines filing rules
28691 used for sorting call numbers.</para></entry>
28693 <entry><para>A choice of <link
28694 linkend="classificationsources">classification sources</link>
28695 as they are defined in administration. If no classification
28696 scheme is entered, the system will use the value entered in
28698 linkend="DefaultClassificationSource">DefaultClassificationSource</link>
28699 preference.</para></entry>
28703 <entry><para>952$3</para></entry>
28705 <entry><para>Materials specified</para></entry>
28707 <entry><para>Specific issues of serials or multi-part
28708 items.</para></entry>
28710 <entry><para>Displayed when items are checked out and in to
28711 tell the staff how many pieces the item has. Copy/volume data
28712 is stored in 952$h and $t for display in Normal
28713 views.</para></entry>
28717 <entry><para>952$4</para></entry>
28719 <entry><para>Damaged status</para></entry>
28721 <entry><para>Default values: </para> <itemizedlist>
28723 <para>0 = Not damaged</para>
28727 <para>1 = Damaged</para>
28729 </itemizedlist></entry>
28731 <entry><para>Coded value, matching <link
28732 linkend="authorizedvalues">Authorized Value</link> category
28733 ('DAMAGE' in default installation)</para></entry>
28737 <entry><para>952$5</para></entry>
28739 <entry><para>Use restrictions</para></entry>
28741 <entry><para>Default values:</para> <itemizedlist>
28743 <para>0 = No use restrictions</para>
28747 <para>1 = Restricted Access</para>
28749 </itemizedlist></entry>
28751 <entry><para>Coded value, matching <link
28752 linkend="authorizedvalues">Authorized Value</link> category
28753 ('RESTRICT' in default installation). This value has no effect
28754 on circulation.</para></entry>
28758 <entry><para>952$7</para></entry>
28760 <entry><para>Not for loan</para></entry>
28762 <entry><para>Default values:</para> <itemizedlist>
28764 <para>-1 = Ordered</para>
28768 <para>0 = Available for loans</para>
28772 <para>1 = Not for Loan</para>
28776 <para>2 = Staff Collection</para>
28778 </itemizedlist></entry>
28780 <entry><para>Coded value, matching <link
28781 linkend="authorizedvalues">Authorized Value</link> category
28782 ('NOT_LOAN' in default installation). Negative number values
28783 can still be placed on hold.</para></entry>
28787 <entry><para>952$8</para></entry>
28789 <entry><para>Collection code</para></entry>
28791 <entry><para>Coded value</para></entry>
28793 <entry><para>Coded value, matching <link
28794 linkend="authorizedvalues">Authorized Value</link> category
28795 ('CCODE' in default installation)</para></entry>
28799 <entry><para>952$9</para></entry>
28801 <entry><para>Item number</para></entry>
28803 <entry><para>System-generated item number.</para></entry>
28805 <entry><para>Does not display in the item
28806 record.</para></entry>
28810 <entry><para>952$a</para></entry>
28812 <entry><para>Owning Library **</para></entry>
28814 <entry><para>Branch code</para></entry>
28816 <entry><para><emphasis role="bold">Required</emphasis>. Code
28817 must be defined in <link linkend="libsgroups">Libraries,
28818 Branches and Groups</link></para></entry>
28822 <entry><para>952$b</para></entry>
28824 <entry><para>Holding library ** (usually the same as 952$a
28827 <entry><para>Branch code</para></entry>
28829 <entry><para><emphasis role="bold">Required</emphasis>. Code
28830 must be defined in <link linkend="libsgroups">Libraries,
28831 Branches and Groups</link></para></entry>
28835 <entry><para>952$c</para></entry>
28837 <entry><para>Shelving location code</para></entry>
28839 <entry><para/></entry>
28841 <entry><para>Coded value, matching <link
28842 linkend="authorizedvalues">Authorized Value</link> category
28843 ('LOC' in default installation)</para></entry>
28847 <entry><para>952$d</para></entry>
28849 <entry><para>Date acquired</para></entry>
28851 <entry><para>YYYY-MM-DD</para></entry>
28853 <entry><para>Date formats in the 952 subfields are required to
28854 be in the system internal format for data loading and
28855 subsequent item editing: YYYY-MM-DD</para></entry>
28859 <entry><para>952$e</para></entry>
28861 <entry><para>Source of acquisition</para></entry>
28863 <entry><para>Coded value or vendor string</para></entry>
28865 <entry><para>Filled in automatically with the Koha assigned
28866 vendor id by Acquisitions when an item is
28867 received.</para></entry>
28871 <entry><para>952$g</para></entry>
28873 <entry><para>Purchase price</para></entry>
28875 <entry><para>Decimal number, no currency symbol (ex.
28876 10.00)</para></entry>
28878 <entry><para>Filled in automatically by Acquisitions when an
28879 item is received.</para></entry>
28883 <entry><para>952$h</para></entry>
28885 <entry><para>Serial enumeration</para></entry>
28887 <entry><para/></entry>
28889 <entry><para>Filled in automatically by Serials if the issue
28890 is received there.</para></entry>
28894 <entry><para>952$o</para></entry>
28896 <entry><para>Koha full call number</para></entry>
28898 <entry><para/></entry>
28900 <entry><para>Can be filled in automatically based on the <link
28901 linkend="itemcallnumber">itemcallnumber</link> system
28902 preference.</para></entry>
28906 <entry><para>952$p</para></entry>
28908 <entry><para>Barcode *</para></entry>
28910 <entry><para>Max 20 characters</para></entry>
28912 <entry><para/></entry>
28916 <entry><para>952$t</para></entry>
28918 <entry><para>Copy number</para></entry>
28920 <entry><para>Max 32 characters</para></entry>
28922 <entry><para/></entry>
28929 <para>Uniform Resource Identifier </para>
28932 <para>Item specific URL</para>
28935 <para>Full URL starting with http:// Only needed if your item has its own URL, not
28936 necessary if the bib record has a 856$u that applies to all items on the record.
28945 <para>Replacement price</para>
28948 <para>Decimal number, no currency symbol (ex. 10.00)</para>
28951 <para>Filled in automatically by Acquisitions when an item is received.</para>
28956 <entry><para>952$w</para></entry>
28958 <entry><para>Price effective from</para></entry>
28960 <entry><para>YYYY-MM-DD</para></entry>
28962 <entry>Date formats in the 952 subfields are required to be in
28963 the system internal format for data loading and subsequent
28964 item editing: YYYY-MM-DD. Filled in automatically by
28965 Acquisitions when an item is received.</entry>
28972 <para>Nonpublic note</para>
28977 <entry>This is a note field for notes that will not appear in the OPAC. Right now
28978 this note does not appear anywhere but in the item edit screen in the staff
28983 <entry><para>952$y</para></entry>
28985 <entry><para>Koha item type **</para></entry>
28987 <entry><para>Coded value, required field for
28988 circulation</para></entry>
28990 <entry><para><emphasis role="bold">Required</emphasis>. Coded
28991 value, must be defined in <link linkend="itemtypeadmin">Item
28992 types</link></para></entry>
28996 <entry><para>952$z</para></entry>
28998 <entry><para>Public note</para></entry>
29000 <entry><para/></entry>
29002 <entry><para/></entry>
29008 <para>* - required for circulation</para>
29010 <para>** - required by Koha</para>
29013 <section id="onorderitemholds">
29015 <corpauthor>VOKAL</corpauthor>
29018 <firstname>Nicole C.</firstname>
29020 <surname>Engard</surname>
29023 <pubdate>2010</pubdate>
29025 <bibliosource><ulink
29026 url="http://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Handling_On_Order_items_and_ho">http://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Handling_On_Order_items_and_ho</ulink></bibliosource>
29029 <title>Handling On Order Items and Holds</title>
29031 <para>If you tend to import your MARC records when you have ordered
29032 the book (as opposed to when you receive the books), and allow patrons
29033 to place holds on those books, you may need to add item records to the
29034 *.mrc file before importing.</para>
29036 <para>The easiest way to import your latest order is to first run your records through
29037 <ulink url="http://marcedit.reeset.net/">MARCEdit</ulink>. Download your MARC records,
29038 saving them to your desktop or some other location you use/will remember. If you have
29039 MARCEdit already installed you should simply have to double click on your MARC records,
29040 and they will automatically open in MARCEdit.<important>
29041 <para>This tutorial was written with MARCEdit version 5.2.3769.41641 on Windows XP,
29042 instructions may be different if your version or operating system is different.</para>
29043 </important></para>
29047 <para>Your original file will automatically be in the input;
29048 ensure MarcBreaker is chosen, and then click "Execute"</para>
29051 <screeninfo>MarcBreaker</screeninfo>
29055 <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
29062 <para>You will be presented with a summary of the records
29063 processed at the bottom of the screen</para>
29066 <screeninfo>MarcBreaker Summary</screeninfo>
29070 <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
29077 <para>Click 'Edit Records' to continue on to adding item
29082 <para>Your screen will be replaced with a larger screen containing
29083 the MARC records</para>
29086 <screeninfo>MARC file for editing</screeninfo>
29090 <imagedata fileref="images/appendix-onorder/editrecords.png"/>
29097 <para>Click on Tools > Add/Edit Field</para>
29100 <screeninfo>Add/Delete Field</screeninfo>
29104 <imagedata fileref="images/appendix-onorder/addfield.png"/>
29111 <para>Enter in the Koha specific item info</para>
29114 <screeninfo>Add 942 Field</screeninfo>
29118 <imagedata fileref="images/appendix-onorder/add942.png"/>
29125 <para>In the Field box, type 942</para>
29129 <para>In the Field Data box, type \\$c and the item type code
29130 (\\$cBOOK in this example)</para>
29134 <para>Check the 'Insert last' option</para>
29138 <para>Click 'Add Field'</para>
29144 <para>Enter in the item record data</para>
29147 <screeninfo>Add 952 Field</screeninfo>
29151 <imagedata fileref="images/appendix-onorder/add952.png"/>
29158 <para>In the Field box, type 952</para>
29162 <para>In the Field Data box, type
29163 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
29167 <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
29171 <para>In a default install of Koha -1 is the value for
29172 the Ordered status</para>
29178 <para>You may want to look at other subfields you would
29179 like data in -- for example, changing the collection code
29180 to put all the items in the same collection (8),
29181 automatically fill in the acquisition date (d), or put in
29182 a public note (z).</para>
29186 <para>Be sure you use the $ to separate subfields; adding
29187 each subfield on a separate line will cause that many
29188 items to be imported with your MARC record (in the example
29189 above, four items, each with one of those subfields
29194 <para>Make sure you look at the Administration >
29195 Authorized Values in Koha to put the correct code into the
29202 <para>Check the 'Insert last' option</para>
29206 <para>Click 'Add Field'</para>
29212 <para>Close the field editor window</para>
29216 <para>Click on File > Compile into MARC</para>
29219 <screeninfo>Compile into MARC</screeninfo>
29223 <imagedata fileref="images/appendix-onorder/compile.png"/>
29230 <para>Choose where to save your file</para>
29234 <para>Now you want to go into your Koha system and follow the
29235 instructions for <link linkend="stagemarc">importing MARC
29236 records</link>.</para>
29238 <para>Once the item has come in, you will need to go to the item
29239 record and individually change the item to have the correct barcode,
29240 and manually change the status from Ordered to the blank line in the
29241 Not for Loan field.</para>
29244 <para>If you purchase your cataloged item records, you may want to
29245 request your vendor put in the information you need into the MARC
29246 records for you; that way, you could import the edited-by-the-vendor
29247 file, overwriting the current record, automatically replacing the
29248 data with what you need.</para>
29254 <chapter id="serials">
29255 <title>Serials</title>
29257 <para>Serials actions can be accessed by going to the More menu at the top
29258 of your screen and choosing Serials or by clicking Serials on the main
29259 Koha staff client page. The Serials module in Koha is used for keeping
29260 track of journals, newspapers and other items that come on a regular
29261 schedule. As with all modules, make sure you go through the related <link
29262 linkend="impserials">Implementation Checklist</link> before using the
29263 Serials module.</para>
29267 <para><emphasis>Get there:</emphasis> More > Serials</para>
29271 <section id="newsubscription">
29272 <title>Add a subscription</title>
29274 <para>Subscriptions can be added by clicking the 'New' button on any
29275 bibliographic record</para>
29278 <screeninfo>New Subscription Button</screeninfo>
29282 <imagedata fileref="images/serials/newsubfrombib.png"/>
29287 <para>Or by visiting the Serials module and clicking 'New
29288 Subscription'</para>
29291 <screeninfo>New Subscription Button</screeninfo>
29295 <imagedata fileref="images/serials/newsubbutton.png"/>
29300 <para>If you are entering a new subscription from the Serials module you
29301 will be presented with a blank form (if creating new from a
29302 bibliographic record the form will include the bib info).</para>
29305 <screeninfo>Add a new Subscription Form</screeninfo>
29309 <imagedata fileref="images/serials/addsub.png"/>
29316 <para>'Librarian' field will show the logged in librarian's
29321 <para>'Vendor' can be found by either searching vendors entered via
29322 the <link linkend="acqmodule">Acquisitions module</link> or entering
29323 the vendor ID number</para>
29327 <para>Vendor information is not required</para>
29331 <para>In order to claim missing and late issues you need to
29332 enter vendor information</para>
29335 <screeninfo>Vendor Missing Warning</screeninfo>
29339 <imagedata fileref="images/serials/vendorwarning.png"/>
29348 <para>'Biblio' is the MARC record you'd like to link this
29349 subscription to</para>
29353 <para>This can be done by searching for an existing record by
29354 clicking on the 'Search for Biblio' link below the boxes or by
29355 entering the bib number for a record in the first box. Only if
29356 you search with the field between the parenthesis.</para>
29362 <para>Next you can choose whether a new item is created when
29363 receiving an issue</para>
29367 <para>'Location' is for the shelving location</para>
29371 <para>'Call Number' is for your item's call number prefix</para>
29375 <para>'Library' is the branch that owns this subscription.</para>
29379 <para>If more than one library subscribes to this serial you
29380 will need to create a subscription for each library</para>
29384 <para>This can be done easily by using the 'Edit as New
29385 (Duplicate)' option found on the subscription information page
29386 and changing only the 'Library' field</para>
29389 <screeninfo>New Duplicate Subscription</screeninfo>
29393 <imagedata fileref="images/serials/newasdup.png"/>
29402 <para>The 'Grace Period' is the number of days before an issue is
29403 automatically moved from 'expected' status to 'waiting' and how many
29404 days before an issue is automatically moved from 'waiting' status to
29409 <para>Use the 'Public Note' for any notes you would like to appear
29410 in the OPAC for the patrons</para>
29414 <para>'Nonpublic Note' should be used for notes that are only
29415 visible to the librarians via the staff client</para>
29419 <para>To set up a routing list for serials, choose 'Routing List'
29420 from the 'Patron notification' field.</para>
29424 <para>For this option to appear you need to make sure that you
29425 have a Routing List notice set up in the <link
29426 linkend="notices">Notices Tool</link></para>
29430 <para>Learn more about <link linkend="routinglist">Routing
29431 Lists</link> later in this manual</para>
29437 <para>The Staff and OPAC Display options allow you to control how
29438 many issues appear by default on bibliographic records in the Staff
29439 Client and the OPAC</para>
29443 <para>If no values are entered in these fields, they will use
29445 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
29447 linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
29448 system preference values</para>
29454 <para>In 'First issue publication date' you want to enter the date
29455 of the issue you have in your hand, the date from which the
29456 prediction pattern will start</para>
29460 <para>There are several pre-defined options for the 'Frequency' of
29465 <para>Without periodicy: some very specific (usually high level
29466 science journals) don't have a true periodicity. When you
29467 subscribe to the title, you subscribe for 6 issues, which can
29468 arrive in 1 year... or 2... There is no regularity or known
29473 <para>Unknown select this if none of the other choices are
29478 <para>Irregular: The journal is not "regular" but has a
29479 periodicity. You know that it comes out on January, then in
29480 October and December, it is irregular, but you know when it's
29481 going to arrive.</para>
29485 <para>2/day: Twice daily</para>
29489 <para>1/day: Daily</para>
29493 <para>3/week: Three times a week</para>
29497 <para>1/week: Weekly</para>
29501 <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
29505 <para>1/ 3 weeks: Tri-weekly</para>
29509 <para>1/month: Monthly</para>
29513 <para>1/ 2 months (6/year): Bi-monthly</para>
29517 <para>1/ 3 months (1/quarter): Quarterly</para>
29521 <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
29522 Summer, Autumn, Winter, Spring)</para>
29526 <para>2/year: Half yearly</para>
29530 <para>1/year: Annual</para>
29534 <para>1/ 2 years: Bi-annual</para>
29540 <para>Checking the 'Manual history' box will allow you to enter
29541 serials outside the prediction pattern.</para>
29545 <para>'Numbering pattern' will help you determine how the numbers
29546 are printed for each issue</para>
29550 <para>Start with the numbering on the issue you have in hand,
29551 the numbering that matches the date you entered in the 'First
29552 issue publication' field</para>
29556 <para>If you have chosen any 'Numbering Format' other than
29557 'Number' in the 'Rollover at' field, enter the last issue number
29558 before the volume number changes</para>
29562 <para>If you chose the 'Number' Numbering Format you will
29563 see 'issues expected' in which you will enter the total
29564 number of issues you expect to receive.</para>
29567 <screeninfo>Number as Numbering Pattern</screeninfo>
29571 <imagedata fileref="images/serials/numberonly.png"/>
29580 <para>You can choose to create your own numbering pattern by
29581 choosing 'None of the above' and clicking the 'Show/Hide
29582 Advanced Pattern' button at the bottom of the form</para>
29588 <para>'Subscription start date' is the date at which the
29589 subscription begins. This is used for setting up renewal
29594 <para>'Subscription length' is the number of issues or months in the
29595 subscription. This is also used for setting up renewal alerts</para>
29599 <para>'Subscription end date' should only be entered for
29600 subscriptions that have ended (if you're entering in a backlog of
29605 <para>The 'Numbering formula' is editable to match the way you'd
29606 like your numbering to print on the item record and subscription
29607 information pages</para>
29611 <para>Click 'Save Subscription' to save the information you have
29612 entered. <link linkend="sampleserialsapp">Find sample serial examples in
29613 the appendix</link>.</para>
29616 <section id="receiveissues">
29617 <title>Receive Issues</title>
29619 <para>Issues can be marked as received from several locations. To find a
29620 subscription, use the search box at the top of the Serials page to
29621 search for the serial you'd like to receive issues for:</para>
29624 <screeninfo>Subscription Search</screeninfo>
29628 <imagedata fileref="images/serials/subsearch.png"/>
29633 <para>From the search results you can click the 'Serial Receive' link or
29634 you can click on the subscription title and then click the 'Receive'
29638 <screeninfo>Subscription Buttons</screeninfo>
29642 <imagedata fileref="images/serials/subbuttons.png"/>
29647 <para>The final way to receive serials is from the 'Serial Collection'
29648 page. To the left of the Subscription summary page there is a menu with
29649 a link to 'Serial Collection'</para>
29652 <screeninfo>Serial Subscription Menu</screeninfo>
29656 <imagedata fileref="images/serials/serialcolllink.png"/>
29661 <para>From the page that opens up you can click 'Edit Serial' with the
29662 issue you want to receive checked.</para>
29665 <screeninfo>Edit Issues</screeninfo>
29669 <imagedata fileref="images/serials/editissue.png"/>
29674 <para>All three of these options will open up the issue receive
29678 <screeninfo>Receive Serials</screeninfo>
29682 <imagedata fileref="images/serials/receiveissue.png"/>
29689 <para>Choose 'Arrived' from the status pull down to mark a serial as
29694 <para>If you have decided to have an item record created for each issue an <link
29695 linkend="addingitems">item add form</link> will appear after choosing 'Arrived'<screenshot>
29696 <screeninfo>Serial item record</screeninfo>
29699 <imagedata fileref="images/serials/serialitem.png"/>
29702 </screenshot></para>
29706 <para>If your issue has a supplemental issue with it, fill in the
29707 Supplemental Issue information.</para>
29711 <para>If you have decided to have an item record created for each
29712 issue an <link linkend="addingitems">item add form</link> will
29713 appear for your supplement and for the issue itself</para>
29717 <para>Once you have entered your info you can click 'Save'</para>
29721 <para>If you are receiving multiple issues at once, or have marked an
29722 issue as 'Late' or 'Missing' there you can click the 'Generate Next'
29723 button below the list of issues.</para>
29726 <screeninfo>Generate Next Button</screeninfo>
29730 <imagedata fileref="images/serials/editissue.png"/>
29735 <para>Clicking this button will generate the next issue for you and mark
29736 the previously expected issue as 'Late' automatically. You can then
29737 check the 'Edit' box to the right of each issue and edit the status on
29738 multiple issues at once.</para>
29741 <section id="routinglist">
29742 <title>Create a Routing List</title>
29744 <para>A routing list is a list of people who receive the serial before
29745 it goes to the shelf. When setting up your serial subscription you want
29746 to be sure to pick 'Routing List' from the 'Patron Notification' pull
29750 <screeninfo>Patron Notification Option</screeninfo>
29754 <imagedata fileref="images/serials/serialnotification.png"/>
29759 <para>When on the subscription page you will see a link to the left that
29760 reads 'Create Routing List' or 'Edit Routing List'</para>
29763 <screeninfo>Subscription Routing List Link</screeninfo>
29767 <imagedata fileref="images/serials/createroutinglink.png"/>
29772 <para>Clicking that link will bring you to the menu to add a new routing
29776 <screeninfo>Routing List Creation</screeninfo>
29780 <imagedata fileref="images/serials/createroutinglist.png"/>
29785 <para>From here you want to click 'Add recipients' in order to add
29786 people to the routing list. In the menu that appears you can filter
29787 patrons by part of their name, their library and/or patron
29791 <screeninfo>Add Members to Routing List</screeninfo>
29795 <imagedata fileref="images/serials/addtorouting.png"/>
29800 <para>Clicking 'Add' to the right of each name will add them to the
29801 routing list. When you have chosen all of the people for the list, click
29802 the 'Close' link to be redirected to the routing list.</para>
29805 <screeninfo>Routing List</screeninfo>
29809 <imagedata fileref="images/serials/editroutinglist.png"/>
29814 <para>If the list looks the way you expect it to, then click 'Save'.
29815 Next you will be brought to a preview of the routing list. To print the
29816 list click 'Save and preview routing slip.' This will open a printable
29817 version of the list.</para>
29820 <screeninfo>Preview Routing List</screeninfo>
29824 <imagedata fileref="images/serials/previewroutinglist.png"/>
29830 linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
29831 on then patrons listed in the routing list will automatically be added
29832 to the holds list for the issue.</para>
29834 <para>To see a list of all of the routing lists a specific patron is on
29835 visit the <link linkend="patronroutingtab">Routing Lists tab</link> on
29836 their patron record.</para>
29839 <section id="serialsubinstaff">
29840 <title>Subscriptions in Staff Client</title>
29842 <para>Subscription information will appear on bibliographic records
29843 under the 'Subscriptions' tab</para>
29846 <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
29850 <imagedata fileref="images/serials/subinfoonbib.png"/>
29855 <para>Clicking the 'Subscription Details' link will take you to the
29856 Subscription summary page in the staff client.</para>
29859 <screeninfo>Subscription Detail</screeninfo>
29863 <imagedata fileref="images/serials/subscriptiondetail.png"/>
29869 <section id="serialsubinopac">
29870 <title>Subscriptions in OPAC</title>
29872 <para>When viewing the subscription in the OPAC there will be several
29875 <para>Like in the staff client, there will be a Subscriptions tab on the
29876 bibliographic record.</para>
29879 <screeninfo>Subscriptions Tab in OPAC</screeninfo>
29883 <imagedata fileref="images/serials/subopac.png"/>
29888 <para>Under this tab will appear the number of issues you chose when
29889 setting up the subscription or in your <link
29890 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
29891 system preference. Clicking the 'More details' link will provide you
29892 with additional information about the serial history. You can set the
29893 default view of a serial in the OPAC with the <link
29894 linkend="SubscriptionHistory">SubscriptionHistory</link> system
29897 <para>There are two views, compact and full. The compact serial
29898 subscription will show basic information regarding the
29899 subscription</para>
29902 <screeninfo>Compact Serial View</screeninfo>
29906 <imagedata fileref="images/serials/compactopac.png"/>
29911 <para>From this compact display patrons can subscribe to routing lists
29912 by clicking the subscribe link that appears below subscriptions that
29913 offer a routing list.</para>
29916 <screeninfo>Subscribe link in the OPAC</screeninfo>
29920 <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
29925 <para>Whereas the full view shows extensive details, broken out by year,
29926 regarding the subscription</para>
29929 <screeninfo>Full Serial View</screeninfo>
29933 <imagedata fileref="images/serials/fullopac.png"/>
29939 <section id="serialclaims">
29940 <title>Claim Late Serials</title>
29942 <para>Koha can send email messages to your serial vendors if you have
29943 late issues. To the left of the main serials page there is a link to
29947 <screeninfo>Link to Claims on Serials Menu</screeninfo>
29951 <imagedata fileref="images/serials/serialclaimmenu.png"/>
29956 <para>The links to claims also appears to the left of the subscription
29960 <screeninfo>Link to Claims on the Serials Menu</screeninfo>
29964 <imagedata fileref="images/serials/serialclaimmenu1.png"/>
29969 <para>If you don't have a claim notice defined yet you will see a
29970 warning message that you need to first define a notice.</para>
29973 <screeninfo>Missing Claims Notice Warning</screeninfo>
29977 <imagedata fileref="images/serials/noserialclaim.png"/>
29982 <para>Clicking 'Claims' will open a report that will ask you to choose
29983 from your various serial vendors to generate claims for late
29987 <screeninfo>Serial Claims</screeninfo>
29991 <imagedata fileref="images/serials/serialclaims.png"/>
29996 <para>From the list of late issues you can choose which ones you want to
29997 send a claim email to by clicking the checkbox to the left of late
29998 issue, choosing the notice template to use and clicking the 'Send
29999 notification' button.</para>
30002 <section id="serialexpiration">
30003 <title>Check Serial Expiration</title>
30005 <para>When adding serials you enter a subscription length, using the
30006 check expiration tool you can see when your subscriptions are about to
30007 expire. To use the tool click the link to 'Check expiration' on the
30008 serials menu.</para>
30011 <screeninfo>Check Serial Expiration</screeninfo>
30015 <imagedata fileref="images/serials/serialexpiresearch.png"/>
30020 <para>In the form that appears you need to enter at least a date to
30023 <para>In your results you will see all subscriptions that will expire
30024 before the date you entered. From there you can choose to view the
30025 subscription further or renew it in one click.</para>
30028 <screeninfo>Serial Expiration Search Results</screeninfo>
30032 <imagedata fileref="images/serials/serialexpire.png"/>
30038 <section id="serialrenew">
30039 <title>Renewing Serials</title>
30041 <para>If your serial subscription has expired you won't be able to
30042 receive issues. To renew your subscription you can click the 'Renew'
30043 button at the top of your subscription detail page.</para>
30046 <screeninfo>Renew option on subscription detail</screeninfo>
30050 <imagedata fileref="images/serials/renewsubscription.png"/>
30055 <para>Another option is to click the 'Renew' link to the right of the
30056 subscription on the Serial Collection page.</para>
30059 <screeninfo>Renew option on serial collection</screeninfo>
30063 <imagedata fileref="images/serials/collectionrenew.png"/>
30068 <para>Once you click the 'Renew' link or button you will be presenting
30069 with renewal options.</para>
30072 <screeninfo>Subscription renewal form</screeninfo>
30076 <imagedata fileref="images/serials/serialrenew.png"/>
30083 <para>The start date should be the date your subscription period
30088 <para>For the subscription length you'll want to fill in one of the
30089 three fields presented: Number of num (issues), Number of months or
30090 Number of weeks.</para>
30094 <para>Finally enter any notes you might have about this
30100 <section id="serialsearch">
30101 <title>Searching Serials</title>
30103 <para>Once in the Serials module there is basic search box at the top
30104 that you can use to find subscriptions using any part of the ISSN and/or
30108 <screeninfo>Basic Serials Search</screeninfo>
30112 <imagedata fileref="images/serials/serialsearch.png"/>
30117 <para>You can also click the 'Advanced Search' link to the right of the
30118 'Submit' button to do a more thorough search of your serials.</para>
30121 <screeninfo>Advanced Serials Search</screeninfo>
30125 <imagedata fileref="images/serials/advanceserialsearch.png"/>
30130 <para>From your results you can filter by using the search boxes at the
30131 bottom of each column and adjust the number of resutls using the toolbar
30132 at the top of the results set.</para>
30135 <screeninfo>Serial Search Results</screeninfo>
30139 <imagedata fileref="images/serials/serialsearchresults.png"/>
30146 <chapter id="acqmodule">
30147 <title>Acquisitions</title>
30149 <para>The Koha Acquisitions module provides a way for the library to
30150 record orders placed with vendors and manage purchase budgets.</para>
30154 <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
30158 <section id="acqsetup">
30159 <title>Setup</title>
30161 <para>Before using the Acquisitions Module you will want to make sure
30162 that you have completed all of the set up.</para>
30164 <para>First, set your <link linkend="acqprefs">Acquisitions System
30165 Preferences</link> and <link linkend="acqadmin">Acquisitions
30166 Administration</link> to match your library's workflow.</para>
30168 <para>On the main acquisitions page you will see your library's funds
30172 <screeninfo>Acquisitions Funds Summary</screeninfo>
30176 <imagedata fileref="images/acquisitions/acqfunds.png"/>
30182 <para>If the total line is confusing for the funds you have set up
30183 you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
30185 <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
30189 <para>To see all active funds you can click the checkbox next to 'Show
30190 all' below the funds table.</para>
30192 <para>To see a history of all orders in a fund you can click on the
30193 linked amount and it will run a search for you.</para>
30196 <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
30200 <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
30205 <para>Learn more in the <link linkend="fundtracking">Budget/Fund
30206 Tracking</link> section of this manual.</para>
30209 <section id="acqvendors">
30210 <title>Vendors</title>
30212 <para>Before any orders can be places you must first enter at least one
30215 <section id="addacqvendor">
30216 <title>Add a Vendor</title>
30218 <para>To add a vendor click the 'New Vendor' button on the
30219 Acquisitions page</para>
30222 <screeninfo>New Vendor Button on Acquisitions</screeninfo>
30226 <imagedata fileref="images/acquisitions/newvendbutton.png"/>
30231 <para>The vendor add form is broken into three pieces</para>
30235 <para>The first section is for basic information about the
30239 <screeninfo>Basic Vendor Information</screeninfo>
30243 <imagedata fileref="images/acquisitions/newvendor1.png"/>
30250 <para>Of these fields, only the Vendor name is required, the
30251 rest of the information should be added to help with
30252 generating claim letters and invoices</para>
30258 <para>The second section is for information regarding your contact
30259 at the Vendor's office</para>
30262 <screeninfo>Vendor Contact Details</screeninfo>
30266 <imagedata fileref="images/acquisitions/newvendor2.png"/>
30273 <para>None of these fields are required, they should only be
30274 entered if you want to keep track of your contact's
30275 information within Koha</para>
30281 <para>The final section is for billing information</para>
30284 <screeninfo>Vendor Ordering/Billing Information</screeninfo>
30288 <imagedata fileref="images/acquisitions/newvendor3.png"/>
30295 <para>To be able to order from a vendor you must make them
30300 <para>For List Prices and Invoice Prices choose the
30305 <para>Currencies are assigned in the <link
30306 linkend="currexchangeadmin">Currencies & Exchange
30307 Rates</link> admin area</para>
30313 <para>If your library is charged tax mark your Tax Number as
30318 <para>Note if you list prices and/or invoice prices include
30323 <para>If the vendor offers a consistent blank discount, enter
30324 that in the 'Discount' field</para>
30328 <para>You can enter item specific discounts when placing
30335 <para>Enter your tax rate if your library is charged taxes on
30340 <para>If you know about how long it usually takes orders to
30341 arrive from this vendor you can enter a delivery time. This
30342 will allow Koha to estimate when orders will arrive at your
30343 library on the late orders report.</para>
30347 <para>Notes are for internal use</para>
30354 <section id="editacqvendor">
30355 <title>View/Edit a Vendor</title>
30357 <para>To view a vendor's information page you must search for the
30358 vendor from the Acquisitions home page. Your search can be for any
30359 part of the Vendor's name:</para>
30362 <screeninfo>Vendor Search Results</screeninfo>
30366 <imagedata fileref="images/acquisitions/vendorsearch.png"/>
30371 <para>From the results, click on the name of the vendor you want to
30372 view or edit</para>
30375 <screeninfo>Vendor Information Page</screeninfo>
30379 <imagedata fileref="images/acquisitions/vendorpage.png"/>
30384 <para>To make changes to the vendor, simply click the 'Edit'
30387 <para>If the vendor has no baskets attached to it then a 'Delete'
30388 button will also be visible and the vendor can be deleted.</para>
30391 <screeninfo>Delete Vendor Button</screeninfo>
30395 <imagedata fileref="images/acquisitions/deletevendor.png"/>
30401 <section id="vendorcontracts">
30402 <title>Vendor Contracts</title>
30404 <para>You can define contracts (with a start and end date) and attach
30405 them to a vendor. This is used so that at the end of the year you can
30406 see how much you spent on a specific contract with a vendor. In some
30407 places, contracts are set up with a minimum and maximum yearly
30410 <section id="addvendorcontract">
30411 <title>Add a Contract</title>
30413 <para>At the top of a Vendor Information Page, you will see a 'New
30414 Contract' button.</para>
30417 <screeninfo>New Contract Button</screeninfo>
30421 <imagedata fileref="images/acquisitions/newcontract.png"/>
30426 <para>The contract form will ask for some very basic information
30427 about the contract</para>
30430 <screeninfo>New Contract Form</screeninfo>
30434 <imagedata fileref="images/acquisitions/newcontractform.png"/>
30440 <para>You cannot enter a contract retrospectively. The end date
30441 must not be before today's date.</para>
30444 <para>Once the contract is saved it will appear below the vendor
30445 information.</para>
30448 <screeninfo>Vendor with contracts</screeninfo>
30452 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
30457 <para>It will also be an option when creating a basket</para>
30460 <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
30464 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
30472 <section id="managesuggest">
30473 <title>Managing Suggestions</title>
30475 <para>Depending on your settings in the <link
30476 linkend="suggestionspref">suggestion</link> system preference, patrons
30477 may be able to make purchase suggestions via the OPAC. When a suggestion
30478 is waiting for library review, it will appear on the Acquisitions home
30479 page under the vendor search.</para>
30482 <screeninfo>Pending suggestions on Acquisitions</screeninfo>
30486 <imagedata fileref="images/acquisitions/suggestonacq.png"/>
30491 <para>It will also appear on the main staff dashboard under the module
30495 <screeninfo>Pending suggestions on main page</screeninfo>
30499 <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
30504 <para>Clicking 'Manage suggestions' will take you to the suggestion
30505 management tool. If there are no pending suggestions you can access the
30506 suggestion management tool by clicking the 'Manage suggestions' link on
30507 the menu on the left of the Acquisitions page.</para>
30510 <screeninfo>Suggestion Management</screeninfo>
30514 <imagedata fileref="images/acquisitions/suggestmanage.png"/>
30519 <para>Your suggestions will be sorted into several tabs: Accepted,
30520 Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
30521 suggestion will show the name of the librarian who managed the
30522 suggestion and the reason they gave for accepting or rejecting it (found
30523 under 'Status').</para>
30524 <para>An 'Accepted' suggestion is one that you have marked as 'Accepted' using the form below
30525 the suggestions. A 'Pending' suggestion is one that is awaiting action from the library. A
30526 'Checked' suggestion is one that has been marked as 'Checked' using the form before the
30527 suggestions. An 'Ordered' suggestion is on that has been ordered using the '<link
30528 linkend="orderfromsuggestion">From a purchase suggestion</link>' link in your basket. A
30529 'Rejected' suggestion is one that you have marked at 'Rejected' using the form below the
30530 list of suggestions.</para>
30532 <para>For libraries with lots of suggestions, there are filters on the
30533 left hand side of the Manage Suggestions page to assist in limiting the
30534 number of titles displayed on the screen.</para>
30537 <screeninfo>Suggestion Filtering</screeninfo>
30541 <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
30546 <para>Clicking on the blue headings will expand the filtering options
30547 and clicking '[clear]' will clear all filters and show all
30549 <para>The suggestions page will automatically be limited to
30550 suggestions for your library. To see information for all (or any
30551 other) libraries click on the 'Acquisition information' filter and
30552 change the library.</para>
30555 <screeninfo>Branch filter</screeninfo>
30559 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
30565 <para>When reviewing 'Pending' suggestions you can choose to check the
30566 box next to the item(s) you want to approve/reject and then choose the
30567 status and reason for your selection. You can also choose to completely
30568 delete the suggestion by checking the 'Delete selected' box.</para>
30571 <screeninfo>Pending Suggestions</screeninfo>
30575 <imagedata fileref="images/acquisitions/suggestpending.png"/>
30580 <para>Another option for libraries with long lists of suggestions is to
30581 approve or reject suggestions one by one by clicking on the title of the
30582 suggestion to open a summary of the suggestion, including information if
30583 the item was purchased.</para>
30586 <screeninfo>Suggestion Information</screeninfo>
30590 <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
30595 <para>Clicking 'edit' to the right of the suggested title will open a
30596 suggestion editing page.</para>
30599 <screeninfo>Edit Purchase Suggestion</screeninfo>
30603 <imagedata fileref="images/acquisitions/editsuggestion.png"/>
30608 <para>From this form you can make edits to the suggestion (adding more
30609 details or updating incorrect information provided by the patron). You
30610 can also choose to accept or reject the suggestion on an individual
30615 <para>Choosing to mark a request as 'Pending' will move the request
30616 back to the 'Pending' tab.</para>
30620 <para>Reasons for accepting and rejecting suggestions are defined by the
30621 <link linkend="suggestauthorized">SUGGEST</link> authorized
30625 <screeninfo>Reasons for approving or rejecting
30626 suggestions</screeninfo>
30630 <imagedata fileref="images/acquisitions/suggestreasons.png"/>
30635 <para>If you choose 'Others...' as your reason you will be prompted to
30636 enter your reason in a text box. Clicking 'Cancel' to the right of the
30637 box will bring back the pull down menu with authorized reasons.</para>
30640 <screeninfo>Enter reason for 'Others...'</screeninfo>
30644 <imagedata fileref="images/acquisitions/suggestothers.png"/>
30649 <para>Once you have clicked 'Submit' the suggestion will be moved to the
30650 matching tab. The status will also be updated on the patron's account in
30651 the OPAC and an <link linkend="notices">email notice</link> will be sent
30652 to the patron using the template that matches the status you have
30656 <screeninfo>Purchase suggestions in the OPAC</screeninfo>
30660 <imagedata fileref="images/acquisitions/mysuggestions.png"/>
30666 <section id="placingacqorder">
30667 <title>Placing Orders</title>
30669 <para>To place an order you must first search for the vendor or
30670 bookseller you want to send the order to.</para>
30672 <section id="createacqbasket">
30673 <title>Create a basket</title>
30675 <para>To create a basket you must first search for the vendor you're
30676 ordering from:</para>
30679 <screeninfo>New Basket / Add Basket Options</screeninfo>
30683 <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
30688 <para>Next to the vendor name you will see a 'New Basket'
30692 <screeninfo>Add Basket Form</screeninfo>
30696 <imagedata fileref="images/acquisitions/addbasket.png"/>
30703 <para>When adding a basket you want to give it a name that will
30704 help you identify it later</para>
30708 <para>Enter in the Billing Place and Delivery Place (this will
30709 default the library you're logged in at)</para>
30713 <para>If you would like to change the vendor you're ordering from
30714 you can use the Vendor pull down menu</para>
30718 <para>The notes fields are optional and can contain any type of
30723 <para>If you have <link linkend="addvendorcontract">added
30724 contracts</link> to the vendor you're ordering from, you will also
30725 have an option to choose which contract you're ordering these items
30729 <screeninfo>Basket with contract options</screeninfo>
30733 <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
30738 <para>When finished, click 'Save'</para>
30741 <screeninfo>New Empty Basket</screeninfo>
30745 <imagedata fileref="images/acquisitions/basket.png"/>
30750 <para>Once your basket is created you are presented with several
30751 options for adding items to the order.</para>
30755 <para>If you are ordering another copy of an existing item, you
30756 can simply search for the record in your system.</para>
30759 <screeninfo>Search for existing records</screeninfo>
30763 <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
30770 <para>From the results, simply click 'Order' to be brought to
30771 the order form.</para>
30774 <screeninfo>Order form</screeninfo>
30778 <imagedata fileref="images/acquisitions/existingitemorder.png"/>
30785 <para>All of the details associated with the item will
30786 already be listed under 'Catalog details.'</para>
30793 <listitem id="orderfromsuggestion">
30794 <para>If you allow patrons to make purchase suggestions (learn more in the <link
30795 linkend="managesuggest">Managing Suggestions</link> section of this manual), then
30796 you can place orders from those suggestions. In order to keep track of suggestions
30797 that have been ordered and received you must place the order using this link. </para>
30799 <screeninfo>Approved Suggestions to Order From</screeninfo>
30802 <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
30808 <para>From the results, click 'Order' next to the item you want to order and you
30809 will be presented with the order form including a link to the suggestion</para>
30811 <screeninfo>Order from a Suggestion</screeninfo>
30814 <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
30820 <para>From this form you can make changes to the Catalog Details if
30824 <para>When the item appears in your basket it will include a link to the
30827 <screeninfo>Suggestion Link in basket</screeninfo>
30830 <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
30838 <para>Orders added to the basket in this way will notify the patron via email that
30839 their suggestion has been ordered and will update the patron's '<link
30840 linkend="opacmysuggestions">My purchase suggestions</link>' page in the
30847 <para>To order from a record that can't be found anywhere else,
30848 choose the 'From a new (empty) record.'</para>
30851 <screeninfo>Order a new record</screeninfo>
30855 <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
30862 <para>You will be presented with an empty form to fill in all
30863 of the necessary details about the item you are
30870 <para>If you want to search other libraries for an item to
30871 purchase, you can use the 'From an external source' option that
30872 will allow you to order from a MARC record found via a Z39.50
30876 <screeninfo>Search for record to add</screeninfo>
30880 <imagedata fileref="images/acquisitions/orderz39.png"/>
30887 <para>From the results, click the Order link next to the item
30888 you want to purchase.</para>
30891 <screeninfo>Search Results to Order From</screeninfo>
30895 <imagedata fileref="images/acquisitions/orderz39results.png"/>
30902 <para>If the item you're ordering from an external source
30903 looks like it might be a duplicate, Koha will warn you and
30904 give you options on how to proceed.</para>
30907 <screeninfo>Duplicate order warning</screeninfo>
30911 <imagedata fileref="images/acquisitions/dupwarning.png"/>
30918 <para>From the warning, you can choose to order another
30919 copy on the existing bib record, create a new bib record,
30920 or cancel your order of this item.</para>
30926 <para>In the order form that pops up, you will not be able to
30927 edit the catalog details.</para>
30930 <screeninfo>New order from Z39.50 Search</screeninfo>
30934 <imagedata fileref="images/acquisitions/orderz39form.png"/>
30943 <para>The final option for ordering is to order from a staged
30944 record (<link linkend="stagemarc">learn more about staging
30945 records</link>).</para>
30948 <screeninfo>Staged Files to Order From</screeninfo>
30952 <imagedata fileref="images/acquisitions/stagedfiles.png"/>
30959 <para>From the list of files you are presented with, choose
30960 the 'Add orders' link.</para>
30963 <screeninfo>Records in the staged file</screeninfo>
30967 <imagedata fileref="images/acquisitions/stagedrecords.png"/>
30974 <para>From the list of records, click 'Add order' next to
30975 the item that you want to add to your order.</para>
30978 <screeninfo>New order from Staged Record</screeninfo>
30982 <imagedata fileref="images/acquisitions/stagedorder.png"/>
30989 <para>From the order form, you will not be able to
30990 edit the catalog details.</para>
30996 <para>The other option is to import all records from the
30997 staged file by scrolling below the list of records in the
30998 staged file and filling in the item information.</para>
31001 <screeninfo>Import All</screeninfo>
31005 <imagedata fileref="images/acquisitions/importallstaged.png"/>
31012 <para>If you choose this option the Koha will look in
31013 the 020$c and grab the pricing information from that
31014 field and put that on each order line.</para>
31024 <para>After bringing in the bib information, if your <link
31025 linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
31026 to add an item when ordering you will enter the item info next. You
31027 need to fill out at least one item record and then click the 'Add'
31028 button at the bottom left of the item form.</para>
31031 <screeninfo>Item order</screeninfo>
31035 <imagedata fileref="images/acquisitions/itemonorder.png"/>
31040 <para>After clicking the 'Add item' button below the item record the item will appear above
31041 the form and then you can enter your next item the same way (if ordering more than one
31045 <screeninfo>Item ordered</screeninfo>
31049 <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
31054 <para>Once you have entered the info about the item, you need to enter
31055 the Accounting information.</para>
31058 <screeninfo>Accounting Details</screeninfo>
31062 <imagedata fileref="images/acquisitions/accounting.png"/>
31069 <para>Quantity is populated by the number of items you've added to the order above.<itemizedlist>
31072 <para>You cannot edit the quantity manually, you must click 'Add' below the item
31073 form to add as many items as you're ordering.</para>
31076 </itemizedlist></para>
31080 <para>The list of funds is populated by the <link
31081 linkend="funds">funds</link> you have assigned in the Acquisitions
31082 Administration area.</para>
31086 <para>The currency pull down will have the <link
31087 linkend="currexchangeadmin">currencies</link> you set up in the
31088 <link linkend="acqadmin">Acquisitions Administration</link>
31093 <para>The vendor price is the price before any taxes or discounts
31094 are applied.</para>
31098 <para>If the price is uncertain, check the uncertain price
31103 <para>A basket with at least one uncertain price can't be
31110 <para>If you are charged sales tax, choose that from the gstrate
31115 <para>Enter the percentage discount you're receiving on this
31116 order, once you enter this, hit tab and Koha will populate the
31117 rest of the cost fields below.</para>
31121 <para>If you added Planning Values when <link
31122 linkend="addbudgetfund">creating the Fund</link>, those values
31123 will appear in the two Planning Value fields.</para>
31127 <para>Once an item is added to the basket you will be presented with a
31128 basket summary.</para>
31131 <screeninfo>Basket with item info</screeninfo>
31135 <imagedata fileref="images/acquisitions/finalbasket.png"/>
31140 <para>If you would like to see more details you can check the 'Show
31141 all details' checkbox</para>
31144 <screeninfo>Show all details</screeninfo>
31148 <imagedata fileref="images/acquisitions/showalldetails.png"/>
31153 <para>From here, you can edit or remove the items that you have
31158 <para>Choosing to 'Delete the order' will delete the order line
31159 but leave the record in the catalog.</para>
31163 <para>Choosing to 'Delete order and catalog record' removes both
31164 the order line and the record in the catalog.</para>
31168 <para>The catalog record cannot always be deleted. You might
31169 see notes explaining why.</para>
31172 <screeninfo>Can't delete order line</screeninfo>
31176 <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
31185 <para>On the summary page, you also have the option to edit the
31186 information that you entered about the basket by clicking the 'Edit
31187 basket header information' button, to delete the basket altogether by
31188 clicking the 'Delete this basket' button, or to export your basket as
31189 a CSV file by clicking the 'Export this basket as CSV' button.</para>
31192 <screeninfo>Basket Buttons</screeninfo>
31196 <imagedata fileref="images/acquisitions/basketbuttons.png"/>
31201 <para>Once you're sure your basket is complete, you can click 'Close
31202 this basket' button to indicate that this basket is complete and has
31203 been sent to the vendor. If you have your <link
31204 linkend="BasketConfirmations">BasketConfirmations</link> preference
31205 set to show a confirmation, you will be asked if you are sure about
31206 closing the basket.</para>
31209 <screeninfo>Basket Closure Confirmation</screeninfo>
31213 <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
31218 <para>When closing the basket you can choose to add the basket to a
31219 group for easy printing and retrieval. If you check the box to 'Attach
31220 this basket to a new basket group' you will be brought to the group
31221 list where you can print a PDF of the order.</para>
31224 <screeninfo>Closed Baskets</screeninfo>
31228 <imagedata fileref="images/acquisitions/basketgroup.png"/>
31234 <para>A basket with at least one item marked as 'uncertain price'
31235 will not be able to be closed.</para>
31238 <screeninfo>A basket with items where the price is
31239 uncertain</screeninfo>
31243 <imagedata fileref="images/acquisitions/basketuncertain.png"/>
31247 </important></para>
31249 <para>Clicking the 'Uncertain Prices' button will call up a list of
31250 items with uncertain prices to quick editing. From that list, you can
31251 quickly edit the items by entering new prices and quantities.</para>
31254 <screeninfo>Uncertain Prices</screeninfo>
31258 <imagedata fileref="images/acquisitions/uncertainprices.png"/>
31264 <para>The Uncertain Prices page is independent of the basket. It is
31265 linked to the vendor so you will see all items on order with
31266 uncertain prices for that vendor.</para>
31270 <section id="acqbasketgroup">
31271 <title>Create a basket group</title>
31273 <para>A basket group is simply a group of baskets. In some libraries,
31274 you have several staff members that create baskets, and, at the end of
31275 a period of time, someone then groups them together to send to the
31276 vendor in bulk. That said, it is possible to have one basket in a
31277 basket group if that's the workflow used in your library.</para>
31280 <section id="printacqbasket">
31281 <title>Printing baskets</title>
31283 <para>When you are finished adding items to your basket, click 'Close
31284 this Basket.'</para>
31287 <screeninfo>Close Basket</screeninfo>
31291 <imagedata fileref="images/acquisitions/closebasket.png"/>
31296 <para>You will be asked if you want to create a purchase order at this
31300 <screeninfo>Create Purchase Order</screeninfo>
31304 <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
31309 <para>Your completed order will be listed on the Basket Grouping page
31310 for printing or further modification.</para>
31313 <screeninfo>Basket Grouping</screeninfo>
31317 <imagedata fileref="images/acquisitions/grouping.png"/>
31322 <para>Clicking 'Print' below your order will generate a PDF for
31323 printing, which will have all of your library information followed by
31324 the items in your order.</para>
31327 <screeninfo>Order found on PDF</screeninfo>
31331 <imagedata fileref="images/acquisitions/pdforder.png"/>
31338 <section id="receiveacqorder">
31339 <title>Receiving Orders</title>
31341 <para>Orders can be received from the vendor information page</para>
31344 <screeninfo>Receive from Vendor Information</screeninfo>
31348 <imagedata fileref="images/acquisitions/receivefromvendor.png"/>
31353 <para>or the vendor search results page</para>
31356 <screeninfo>Vendor Search Results</screeninfo>
31360 <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
31365 <para>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a
31366 shipment received date, a shipping cost and a budget to subtract that shipping amount
31370 <screeninfo>Receive Shipment</screeninfo>
31374 <imagedata fileref="images/acquisitions/receive.png"/>
31379 <para>The receive page will list all items still on order with the
31380 vendor regardless of the basket the item is from.</para>
31383 <screeninfo>Receipt Summary</screeninfo>
31387 <imagedata fileref="images/acquisitions/receiptsummary.png"/>
31392 <para>To receive a specific item, click the 'Receive' link to the right
31393 of the item.</para>
31396 <screeninfo>Receive Item Form</screeninfo>
31400 <imagedata fileref="images/acquisitions/receiveitem.png"/>
31405 <para>From this form you can alter the cost information. You can also
31406 choose to mark only part of the order as received if the vendor didn't
31407 send your entire order by checking only the boxes next to the items on
31408 the left that you want to receive. The values you enter in the
31409 'Replacement cost' and 'Actual cost' will automatically populate the
31410 item record by filling in subfield v (Cost, replacement price) and
31411 subfield g (Cost, normal purchase price) on the item record after
31415 <screeninfo>Item record after receipt</screeninfo>
31419 <imagedata fileref="images/acquisitions/receiveditem.png"/>
31424 <para>You can also make edits to the item record from this form by
31425 clicking the 'Edit' link next to each item. This will allow you to enter
31426 in accurate call numbers and barcodes if you'd like to do that at the
31427 point of receipt. Once you have made any changes necessary (to the order
31428 and/or items, click 'Save' to mark the item(s) as received.</para>
31431 <screeninfo>Already Received Items</screeninfo>
31435 <imagedata fileref="images/acquisitions/received.png"/>
31440 <para>When you're finished receiving items you can navigate away from
31441 this page or click the 'Finish receiving' button at the bottom of the
31444 <para>You will also see that the item is received and/or cancelled if
31445 you view the basket.</para>
31448 <screeninfo>One item marked (rcvd) in basket</screeninfo>
31452 <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
31457 <section id="acqinvoices">
31458 <title>Invoices</title>
31459 <para>When orders are received invoices are generated. Invoices can be searched by clicking
31460 on 'Invoices' in the left of the Acquisitions page.<screenshot>
31461 <screeninfo>Invoices page</screeninfo>
31464 <imagedata fileref="images/acquisitions/invoicesearch.png"/>
31467 </screenshot></para>
31468 <para>After searching, your results will appear to the right of the search options.</para>
31470 <screeninfo>Invoice search results</screeninfo>
31473 <imagedata fileref="images/acquisitions/invoices.png"/>
31477 <para>From the results you can click the 'Details' link to see the full invoice or 'Close' to
31478 note that the invoice is closed/paid for.</para>
31480 <screeninfo>Invoice details</screeninfo>
31483 <imagedata fileref="images/acquisitions/invoice.png"/>
31489 <section id="acqclaims">
31490 <title>Claims & Late Orders</title>
31492 <para>If you have entered in an email address for the vendors in your
31493 system you can send them claim emails when an order is late. Before you
31494 can send claims you will need to set up an <link
31495 linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
31497 <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
31498 page you will be presented with a series of filter options on the left
31499 hand side. These filters will be applied only closed baskets.</para>
31502 <screeninfo>Acquisitions Late Order Filters</screeninfo>
31506 <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
31512 <para>The vendor pull down only shows vendors with closed baskets that
31516 <para>Once you filter your orders to show you the things you consider to
31517 be late you will be presented with a list of these items.</para>
31520 <screeninfo>Late Orders</screeninfo>
31524 <imagedata fileref="images/acquisitions/lateorders.png"/>
31529 <para>To the right of each late title you will be see a checkbox. Check
31530 off the ones you want a claim letter sent to and click 'Claim Order' at
31531 the bottom right of the list. This will automatically send an email to
31532 the vendor at the email address you have on file.<note>
31533 <para>The Estimated Delivery Date is based on the Delivery time
31534 value entered on the vendor record.</para>
31537 <para>If you would rather use a different acquisition claim letter
31538 (other than the default) you can <link linkend="addnotices">create that
31539 in the notices module</link> and choose it from the menu above the list
31540 of late items.</para>
31543 <screeninfo>Choose a Claim Letter</screeninfo>
31547 <imagedata fileref="images/acquisitions/claimletter.png"/>
31553 <section id="acqsearch">
31554 <title>Acquisition Searches</title>
31556 <para>At the top of the various Acquisition pages there is a quick
31557 search box where you can perform either a Vendor Search or an Order
31561 <screeninfo>Acquisition Searches</screeninfo>
31565 <imagedata fileref="images/acquisitions/acqsearches.png"/>
31570 <para>In the Vendor Search you can enter any part of the vendor name to
31571 get results.</para>
31574 <screeninfo>Vendor Search Results</screeninfo>
31578 <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
31583 <para>Using the Orders Search you can search for items that have been
31584 ordered with or without the vendor.</para>
31587 <screeninfo>Order Search Box</screeninfo>
31591 <imagedata fileref="images/acquisitions/ordersearch.png"/>
31596 <para>You can enter info in one or both fields and you can enter any
31597 part of the title and/or vendor name.</para>
31600 <screeninfo>Order Search Results</screeninfo>
31604 <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
31609 <para>Clicking the plus sign to the right of the Vendor search box will
31610 expand the search and allow you to search for additional fields.</para>
31613 <screeninfo>Expanded Orders Search</screeninfo>
31617 <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
31622 <para>Clicking Advanced Search to the right of the search button will
31623 give you all of the order search options available.</para>
31626 <screeninfo>Full Order Search</screeninfo>
31630 <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
31636 <section id="fundtracking">
31637 <title>Budget/Fund Tracking</title>
31639 <para>On the main acquisitions page there will be a table on the right
31640 showing you all of your active funds and a breakdown of what has been
31641 ordered or spent against them.</para>
31644 <screeninfo>Fund Table</screeninfo>
31648 <imagedata fileref="images/acquisitions/budgettable.png"/>
31653 <para>Clicking on the linked amounts under spent or ordered will show
31654 you a summary of the titles ordered on that budget.</para>
31657 <screeninfo>Titles Spent</screeninfo>
31661 <imagedata fileref="images/acquisitions/spent.png"/>
31668 <chapter id="stafflists">
31669 <title>Lists & Cart</title>
31671 <para>Lists are a way to save a collection of content on a specific topic
31672 or for a specific purpose. The Cart is a session specific storage
31677 <para><emphasis>Get there:</emphasis> More > Lists</para>
31681 <section id="lists">
31682 <title>Lists</title>
31686 <section id="createlist">
31687 <title>Create a List</title>
31689 <para>A list can be created by visiting the Lists page and clicking
31693 <screeninfo>New List Button</screeninfo>
31697 <imagedata fileref="images/lists/newlistbutton.png"/>
31702 <para>The new list form offers several options for creating your
31706 <screeninfo>New List Form</screeninfo>
31710 <imagedata fileref="images/lists/newlistform.png"/>
31717 <para>The name is what will appear on the list of Lists</para>
31721 <para>You can also choose how to sort the list</para>
31724 <para>Next decide if your list is going to be private or public</para>
31727 <para>A Private List is managed by you and can be seen only by you (depending on
31728 your permissions settings below)</para>
31731 <para>A Public List can be seen by everybody, but managed only by you (depending on
31732 your permissions settings below)</para>
31737 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
31739 <para>anyone else to add entries</para>
31742 <para>anyone to remove his own contributed entries<itemizedlist>
31745 <para>The owner of a list is always allowed to add entries, but needs
31746 permission to remove.</para>
31749 </itemizedlist></para>
31752 <para>anyone to remove other contributed entries </para>
31754 </itemizedlist></para>
31758 <para>A list can also be created from the catalog search
31762 <screeninfo>New list from catalog search</screeninfo>
31766 <imagedata fileref="images/lists/newlistsearch.png"/>
31773 <para>Check the box to the left of the titles you want to add to
31774 the new list</para>
31778 <para>Choose [New List] from the 'Add to:' pull down menu</para>
31781 <screeninfo>New List from Search Results</screeninfo>
31785 <imagedata fileref="images/lists/newlistfromsearch.png"/>
31792 <para>Name the list and choose what type of list this
31797 <para>A Private List is managed by you and can be seen
31802 <para>A Public List can be seen by everybody, but managed
31811 <para>Once the list is saved it will accessible from the Lists page
31812 and from the 'Add to' menu at the top of the search results.</para>
31815 <section id="addtolist">
31816 <title>Add to a List</title>
31818 <para>To add titles to an existing list click on the list name from
31819 the page of lists</para>
31822 <screeninfo>List of Lists</screeninfo>
31826 <imagedata fileref="images/lists/listslist.png"/>
31831 <para>From the List page you can add titles by scanning barcodes into
31832 the box at the bottom of the page</para>
31835 <screeninfo>Content of a List</screeninfo>
31839 <imagedata fileref="images/lists/listcontents.png"/>
31844 <para>A title can also be added to a list by selecting titles on the
31845 search results page and choosing the list from the 'Add to'
31849 <screeninfo>Add to List</screeninfo>
31853 <imagedata fileref="images/lists/addtolist.png"/>
31859 <section id="viewlist">
31860 <title>Viewing Lists</title>
31862 <para>To see the contents of a list, visit the Lists page on the staff
31866 <screeninfo>List of Lists</screeninfo>
31870 <imagedata fileref="images/lists/listslist.png"/>
31875 <para>Clicking on the 'List Name' will show the contents of the
31879 <screeninfo>Content of a List</screeninfo>
31883 <imagedata fileref="images/lists/listcontents.png"/>
31889 <section id="mergebibrecs">
31890 <title>Merging Bibliographic Records Via Lists</title>
31892 <para>The easiest way to merge together duplicate bibliographic
31893 records is to add them to a list and use the Merge Tool from
31897 <screeninfo>List of Duplicate Records</screeninfo>
31901 <imagedata fileref="images/lists/listofdups.png"/>
31906 <para>From the list, check the two items you want to merge. If you
31907 choose more than or fewer than 2, you will be presented with an
31911 <screeninfo>Merge Items Error</screeninfo>
31915 <imagedata fileref="images/lists/merge2rec.png"/>
31920 <para>Once you have selected the records you want to merge, click the
31921 'Merge selected items' button. You will be asked which of the two
31922 records you would like to keep as your primary record and which will
31923 be deleted after the merge. If the records were created using
31924 different frameworks, Koha will also ask you what Framework you would
31925 like the newly merged record to use.</para>
31928 <screeninfo>Choose Primary Record for Merge</screeninfo>
31932 <imagedata fileref="images/lists/mergeprimary.png"/>
31937 <para>You will be presented with the MARC for both of the records
31938 (each accessible by tabs labeled with the bib numbers for those
31939 records). By default the entire first record will be selected, uncheck
31940 the fields you don't want in the final (destination) record and then
31941 move on to the second tab to choose which fields should be in the
31942 final (destination) record.</para>
31945 <screeninfo>Merging Records</screeninfo>
31949 <imagedata fileref="images/lists/mergerecs.png"/>
31954 <para>Should you try to add a field that is not repeatable two times
31955 (like choosing the 245 field from both record #1 and #2) you will be
31956 presented with an error</para>
31959 <screeninfo>Non-repeatable Error</screeninfo>
31963 <imagedata fileref="images/lists/nondupfield.png"/>
31968 <para>Once you have completed your selections click the 'merge'
31969 button. The primary record will now CONTAIN the data you chose for it
31970 as well as all of the items/holdings from both bib records, and the
31971 second record will be deleted.<important>
31972 <para>It is important to rebuild your zebra index immediately
31973 after merging records. If a search is performed for a record which
31974 has been deleted Koha will present the patrons with an error in
31976 </important></para>
31980 <section id="cart">
31981 <title>Cart</title>
31983 <para>The cart is a temporary holding place for items in the OPAC and/or
31984 staff client. The cart will be emptied once the session is ended (by
31985 closing the browser or logging out). The cart is best used for
31986 performing batch operations (holds, printing, emailing) or for getting a
31987 list of items to be printed or emailed to yourself or a patron.</para>
31989 <para>If you would like to enable the cart in the staff client, you need
31990 to set the <link linkend="intranetbookbag">intranetbookbag</link> system
31991 preference to 'Show.' To add things to the cart, search the catalog and
31992 select the items you would like added to your cart and choose 'Cart'
31993 from the 'Add to' menu</para>
31996 <screeninfo>Add to Cart</screeninfo>
32000 <imagedata fileref="images/lists/addtocart.png"/>
32005 <para>A confirmation will appear below the cart button at the top of the
32006 staff client</para>
32009 <screeninfo>Items added to Cart</screeninfo>
32013 <imagedata fileref="images/lists/itemsaddedcart.png"/>
32018 <para>Clicking on the Cart icon will provide you with the contents of
32022 <screeninfo>Cart Contents</screeninfo>
32026 <imagedata fileref="images/lists/cart.png"/>
32033 <para>From this list of items you can perform several actions</para>
32037 <para>'Send' will send the list to the email address you
32042 <para>'Download' will allow you to download the cart using one of 3
32043 default formats or your <link linkend="csvprofiles">CSV
32044 Profiles</link></para>
32048 <para>'Print' will present you with a printable version of the
32053 <para>'Empty and Close' will empty the list and close the
32058 <para>'Hide Window' will close the window</para>
32064 <chapter id="reports">
32065 <title>Reports</title>
32067 <para>Reports in Koha are a way to gather data. Reports are used to
32068 generate statistics, member lists, shelving lists, or any list of data in
32069 your database.</para>
32073 <para><emphasis>Get there:</emphasis> More > Reports</para>
32077 <section id="customreports">
32078 <title>Custom Reports</title>
32080 <para>Koha's data is stored in a MySQL database which means that
32081 librarians can generate nearly any report they would like by either
32082 using the <link linkend="quidedreportwizard">Guided Reports
32083 Wizard</link> or writing their own <link linkend="reportfromsql">SQL
32084 query</link>.</para>
32086 <section id="customreport">
32087 <title>Add Custom Report</title>
32091 <section id="quidedreportwizard">
32092 <title>Guided Report Wizard</title>
32094 <para>The guided report wizard will walk you through a six step
32095 process to generate a report.</para>
32097 <para>Step 1: Choose the module you want to report on. This will
32098 determine what tables and fields are available for you to
32101 <para>'Report is public' should be left to the default of 'No' in
32102 most cases. A report can be made public if you intend to allow
32103 access to it through the JSON webservice interface. This is a system
32104 that can be used by developers to make custom presentations of the
32105 data from the report, for example displaying it using a graphing
32106 API. To learn more speak to your local developer.</para>
32110 <para>A public report is accessible via a URL that looks like
32111 this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
32116 <screeninfo>Chose Module for Report</screeninfo>
32120 <imagedata fileref="images/reports/report1.png"/>
32125 <para>Step 2: Choose a report type. For now, Tabular is the only
32126 option available.</para>
32129 <screeninfo>Report Type</screeninfo>
32133 <imagedata fileref="images/reports/report2.png"/>
32138 <para>Step 3: Choose the fields you want in your report. You can
32139 select multiple fields and add them all at once by using CTRL+Click
32140 on each item you want to add before clicking the Add button.</para>
32143 <screeninfo>Select database fields to query</screeninfo>
32147 <imagedata fileref="images/reports/report3.png"/>
32152 <para>Step 4: Choose any limits you might want to apply to your
32153 report (such as item types or branches). If you don't want to apply
32154 any limits, simply click Next instead of making an option.</para>
32157 <screeninfo>Choose limits</screeninfo>
32161 <imagedata fileref="images/reports/report4.png"/>
32166 <para>Step 5: Perform math functions. If you don't want to do any
32167 calculations, simply click Next instead of making an option.</para>
32170 <screeninfo>Choose math functions</screeninfo>
32174 <imagedata fileref="images/reports/report5.png"/>
32179 <para>Step 6: Choose data order. If you want the data to print out
32180 in the order it's found in the database, simply click Finish.</para>
32183 <screeninfo>Choose ordering</screeninfo>
32187 <imagedata fileref="images/reports/report6.png"/>
32192 <para>When you are finished you will be presented with the SQL
32193 generated by the report wizard. From here you can choose to save the
32194 report by clicking 'Save' or copy the SQL and make edits to it by
32198 <screeninfo>Custom Report Confirmation</screeninfo>
32202 <imagedata fileref="images/reports/reportconfirm.png"/>
32207 <para>If you choose to save the report you will be asked to name
32208 your report and enter any notes regarding it.</para>
32211 <screeninfo>Save custom report</screeninfo>
32215 <imagedata fileref="images/reports/reportsave.png"/>
32220 <para>Once your report is saved it will appear on the 'Use Saved'
32221 page with all other saved reports.</para>
32224 <screeninfo>Saved Reports list</screeninfo>
32228 <imagedata fileref="images/reports/savedreports.png"/>
32233 <para>From here you can make edits, run the report, or schedule a
32234 time to have the report run. To find the report you created you can
32235 sort by any of the columns by clicking the on the column header
32236 (creation date is the best bet for finding the report you just
32237 added). You can also filter your results using the filter menu on
32241 <section id="reportfromsql">
32242 <title>Report from SQL</title>
32244 <para>In addition to the report wizard, you have the option to write
32245 your own queries using SQL. To find reports written by other Koha
32246 users, visit the Koha Wiki: <ulink
32247 url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink>.
32248 You can also find your database structure in
32249 /installer/data/mysql/kohastructure.sql or online at: <ulink
32250 url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
32252 <para>To add your query, click the link to 'Create from SQL' on the
32253 main reports module or the New button at the top of the Saved
32254 Reports page.</para>
32257 <screeninfo>New SQL Report</screeninfo>
32261 <imagedata fileref="images/reports/newsql.png"/>
32266 <para>Fill in the form presented</para>
32269 <screeninfo>Create Report from SQL</screeninfo>
32273 <imagedata fileref="images/reports/reportfromsql.png"/>
32280 <para>The 'Name' is what will appear on the Saved Reports page
32281 to help you identify the report later. It will also be
32282 searchable using the filters found the left of the Saved Reports
32287 <para>You can use the 'Report group' to organize your reports so
32288 that you can easily filter reports by groups. Report groups are
32289 set in the <link linkend="reportgroup">REPORT_GROUP</link>
32290 authorized value category.</para>
32293 <screeninfo>Report group</screeninfo>
32297 <imagedata fileref="images/reports/reportgroup.png"/>
32304 <para>You can use 'Report subgroup' to further organize your
32305 reports so that you can easily filter reports by groups and
32306 subgroups. Report subgroups are set in the <link
32307 linkend="reportsubgroup">REPORT_SUBGROUP</link> authorized value
32311 <screeninfo>Report subgroup</screeninfo>
32315 <imagedata fileref="images/reports/reportsubgroup.png"/>
32321 <listitem id="publicreport">
32322 <para>'Report is public' should be left to the default of 'No' in most cases. A report
32323 can be made public if you intend to allow access to it through the JSON webservice
32324 interface. This is a system that can be used by developers to make custom
32325 presentations of the data from the report, for example displaying it using a
32326 graphing API. To learn more speak to your local developer.</para>
32329 <para>A public report is accessible via a URL that looks like this:
32330 http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
32336 <para>'Notes' will also appear on the Saved Reports page, this
32337 can be used to provide more details about the report or tips on
32338 how to enter values when it runs</para>
32342 <para>The type should always be 'Tabular' at this time since the
32343 other formats have not been implemented</para>
32347 <para>In the 'SQL' box you will type or paste the SQL for the
32352 <para>If you feel that your report might be too resource
32353 intensive you might want to consider using runtime parameters to
32354 your query. Runtime parameters basically make a filter appear
32355 before the report is run to save your system resources.</para>
32357 <para>There is a specific syntax that Koha will understand as
32358 'ask for values when running the report'. The syntax is
32359 <<Question to ask|authorized_value>>.</para>
32363 <para>The << and >> are just delimiters. You
32364 must put << at the beginning and >> at the end
32365 of your parameter</para>
32369 <para>The 'Question to ask' will be displayed on the left of
32370 the string to enter.</para>
32374 <para>The authorized_value can be omitted if not applicable.
32375 If it contains an authorized value category, or branches or
32376 itemtype or categorycode, a list with the Koha authorized
32377 values will be displayed instead of a free field Note that
32378 you can have more than one parameter in a given SQL Note
32379 that entering nothing at run time won't probably work as you
32380 expect. It will be considered as "value empty" not as
32381 "ignore this parameter". For example entering nothing for :
32382 "title=<<Enter title>>" will display results
32383 with title='' (no title). If you want to have to have
32384 something not mandatory, use "title like <<Enter
32385 title>>" and enter a % at run time instead of
32390 <para>Examples:</para>
32394 <para>SELECT surname,firstname FROM borrowers WHERE
32395 branchcode=<<Enter patrons library|branches>>
32396 AND surname like <<Enter filter for patron surname (%
32397 if none)>></para>
32401 <para>SELECT * FROM items WHERE homebranch = <<Pick
32402 your branch|branches>> and barcode like
32403 <<Partial barcode value here>></para>
32408 <para>To generate a date picker calendar to the right of the
32409 field when running a report you can use the 'date' keyword
32410 like this: <<Enter Date|date>></para>
32413 <screeninfo>Date Picker</screeninfo>
32417 <imagedata fileref="images/reports/datepicker.png"/>
32424 <para>You have to put "%" in a text box to 'leave it blank'.
32425 Otherwise, it literally looks for "" (empty string) as the
32426 value for the field.</para>
32430 <para>In addition to using any authorized value code to
32431 generate a dropdown, you can use the following values as
32432 well: Branches (branches), Item Types (itemtypes) and Patron
32433 Categories (categorycode). For example a branch pull down
32434 would be generated like this
32435 <<Branch|branches>></para>
32438 <screeninfo>Branch pull down</screeninfo>
32442 <imagedata fileref="images/reports/branchpulldown.png"/>
32446 </important></para>
32451 <para>There is a limit of 10,000 records put on SQL statements
32452 entered in Koha. To get around this you want to add 'LIMIT 100000'
32453 to the end of your SQL statement (or any other number above
32457 <para>Once everything is entered click the 'Save Report' button and
32458 you'll be presented with options to run it. Once a report is saved
32459 you do not have to recreate it you can simply find it on the Saved
32460 Reports page and <link linkend="runcustomreport">run</link> or <link
32461 linkend="editcustomreports">edit</link> it.</para>
32465 <section id="editcustomreports">
32466 <title>Edit Custom Reports</title>
32468 <para>Every report can be edited from the reports lists. To see the
32469 list of reports already stored in Koha, click 'Use Saved.'</para>
32472 <screeninfo>Saved Reports</screeninfo>
32476 <imagedata fileref="images/reports/savedreports.png"/>
32481 <para>To find the report you'd like to edit you can sort by any of the
32482 columns by clicking the on the column header. You can also filter your
32483 results using the filter menu on the left.</para>
32485 <para>From this list you can edit any custom report by clicking 'Edit
32489 <screeninfo>Edit SQL Form</screeninfo>
32493 <imagedata fileref="images/reports/editreport.png"/>
32499 <section id="runcustomreport">
32500 <title>Running Custom Reports</title>
32502 <para>Once custom reports are saved to Koha, you can run them by going
32503 to the Saved Reports page and clicking the Run link to the right of
32507 <screeninfo>Run Report</screeninfo>
32511 <imagedata fileref="images/reports/runreport.png"/>
32516 <para>When you report runs you will either be asked for some
32520 <screeninfo>Enter report parameters</screeninfo>
32524 <imagedata fileref="images/reports/reportparameters.png"/>
32529 <para>or you will see the results right away</para>
32532 <screeninfo>Report results</screeninfo>
32536 <imagedata fileref="images/reports/reportresults.png"/>
32541 <para>From the results you can choose to rerun the report by clicking
32542 'Run report' at the top, edit the report by clicking the 'Edit' button
32543 or starting over and creating a new report by using the 'New' button.
32544 You can also download your results by choosing a file type at the
32545 bottom of the results next to the 'Download the report' label and
32546 clicking 'Download.'<tip>
32547 <para>A Comma Separated Text file is a CSV file and it can be
32548 opened by any spreadsheet application.</para>
32553 <section id="statsreports">
32554 <title>Statistics Reports</title>
32556 <para>Statistic reports will show you counts and sums. These reports are
32557 all about numbers and statistics, for reports that return more detailed
32558 data, use the <link linkend="quidedreportwizard">Guided Report
32559 Wizard</link>. These reports are limited in what data they can look at,
32560 so it's often recommended to use <link linkend="customreports">custom
32561 reports</link> for official end of the year statistics.</para>
32563 <section id="acqstats">
32564 <title>Acquisitions Statistics</title>
32567 <para>These reports are limited in what data they can look at, so
32568 it's often recommended to use <link linkend="customreports">custom
32569 reports</link> for official end of the year statistics.</para>
32572 <para>Using the form provided, choose which value you would like to
32573 appear in the Column and which will appear in the Row.</para>
32576 <screeninfo>Acquisitions Statistics</screeninfo>
32580 <imagedata fileref="images/reports/acqform.png"/>
32585 <para>If you choose to output to the browser your results will print
32586 to the screen.</para>
32589 <screeninfo>Acquisitions Statistics Results</screeninfo>
32593 <imagedata fileref="images/reports/acqnumbers.png"/>
32598 <para>You can also choose to export to a file that you can manipulate
32599 to your needs.</para>
32601 <para>When generating your report, note that you get to choose between
32602 counting or summing the values.</para>
32605 <screeninfo>Acquisitions Stats Options</screeninfo>
32609 <imagedata fileref="images/reports/acqtotal.png"/>
32614 <para>Choosing amount will change your results to appear as the sum of
32615 the amounts spent.</para>
32618 <screeninfo>Acquisitions statistics with totals</screeninfo>
32622 <imagedata fileref="images/reports/acqamounts.png"/>
32628 <section id="patstats">
32629 <title>Patron Statistics</title>
32632 <para>These reports are limited in what data they can look at, so
32633 it's often recommended to use <link linkend="customreports">custom
32634 reports</link> for official end of the year statistics.</para>
32637 <para>Using the form provided, choose which value you would like to
32638 appear in the Column and which will appear in the Row.</para>
32641 <screeninfo>Patron Statistics Options</screeninfo>
32645 <imagedata fileref="images/reports/patronform.png"/>
32650 <para>If you choose to output to the browser your results will print
32651 to the screen.</para>
32654 <screeninfo>Patron Statistics Results</screeninfo>
32658 <imagedata fileref="images/reports/patronresults.png"/>
32663 <para>Based on your selections, you may see some query information
32664 above your results table. You can also choose to export to a file that
32665 you can manipulate to your needs.</para>
32668 <section id="catstats">
32669 <title>Catalog Statistics</title>
32672 <para>These reports are limited in what data they can look at, so
32673 it's often recommended to use <link linkend="customreports">custom
32674 reports</link> for official end of the year statistics.</para>
32677 <para>Using the form provided, choose which value you would like to
32678 appear in the Column and which will appear in the Row.</para>
32681 <screeninfo>Catalog Statistics Form</screeninfo>
32685 <imagedata fileref="images/reports/catalogform.png"/>
32690 <para>If you choose to output to the browser your results will print
32691 to the screen.</para>
32694 <screeninfo>Catalog Statistic Results</screeninfo>
32698 <imagedata fileref="images/reports/catalogresults.png"/>
32703 <para>You can also choose to export to a file that you can manipulate
32704 to your needs.</para>
32707 <section id="circstats">
32708 <title>Circulation Statistics</title>
32711 <para>These reports are limited in what data they can look at, so
32712 it's often recommended to use <link linkend="customreports">custom
32713 reports</link> for official end of the year statistics.</para>
32716 <para>Using the form provided, choose which value you would like to
32717 appear in the Column and which will appear in the Row.</para>
32720 <screeninfo>Circulation Statistics</screeninfo>
32724 <imagedata fileref="images/reports/circform.png"/>
32729 <para>If you choose to output to the browser your results will print
32730 to the screen.</para>
32733 <screeninfo>Circulation Statistic Results</screeninfo>
32737 <imagedata fileref="images/reports/circresults.png"/>
32742 <para>You can also choose to export to a file that you can manipulate
32743 to your needs.<tip>
32744 <para>To get a complete picture of your monthly or daily
32745 circulation, you can run the report twice, once for 'Type' of
32746 'Checkout' and again for 'Renewal.'</para>
32748 <para>This report uses 'Period,' or date, filtering that allows
32749 you to limit to a month by simply selecting the first day of the
32750 first month through the first day of the next month. For example,
32751 10/1 to 11/1 to find statistics for the month of October.</para>
32755 <para>To find daily statistics, set your date
32756 range.</br> Example: "I want circulation data starting
32757 with date XXX up to, but not including, date XXX."</para>
32761 <para>For a whole month, an example range would be: 11/01/2009
32762 to 12/01/2009</para>
32766 <para>For a whole year, an example range would be: 01/01/2009
32767 to 01/01/2010</para>
32771 <para>For a single day, an example would be: 11/15/2009 to
32772 11/16/2009 to find what circulated on the 15th</para>
32777 <section id="inhouseuse">
32778 <title>Tracking in house use</title>
32780 <para>Using the Circulation statistics reporting wizard you can run
32781 reports on in house usage of items simply by choosing 'Local Use'
32782 from the 'Type' pull down:</para>
32785 <screeninfo>In House Use Stats</screeninfo>
32789 <imagedata fileref="images/reports/inhouse.png"/>
32796 <section id="serialstats">
32797 <title>Serials Statistics</title>
32800 <para>These reports are limited in what data they can look at, so
32801 it's often recommended to use <link linkend="customreports">custom
32802 reports</link> for official end of the year statistics.</para>
32805 <para>Using the form provided, choose how you would like to list the
32806 serials in your system.</para>
32809 <screeninfo>Serials Statistics</screeninfo>
32813 <imagedata fileref="images/reports/serialsform.png"/>
32818 <para>If you choose to output to the browser your results will print
32819 to the screen.</para>
32822 <screeninfo>Serials Results</screeninfo>
32826 <imagedata fileref="images/reports/serialsresults.png"/>
32831 <para>You can also choose to export to a file that you can manipulate
32832 to your needs.</para>
32835 <section id="holdstats">
32836 <title>Holds Statistics</title>
32839 <para>These reports are limited in what data they can look at, so
32840 it's often recommended to use <link linkend="customreports">custom
32841 reports</link> for official end of the year statistics.</para>
32844 <para>Using the form provided you can see statistics for holds placed,
32845 filled, cancelled and more at your library. From the form choose what
32846 value you want to display in the column and what value to show in the
32847 row. You can also choose from the filters on the far right of the
32851 <screeninfo>Hold Statistics Form</screeninfo>
32855 <imagedata fileref="images/reports/holdstatsform.png"/>
32860 <para>If you choose to output to the browser your results will print
32861 to the screen.</para>
32864 <screeninfo>Hold Stats Results</screeninfo>
32868 <imagedata fileref="images/reports/holdstatsresults.png"/>
32873 <para>You can also choose to export to a file that you can manipulate
32874 to your needs.</para>
32877 <section id="mostcheckouts">
32878 <title>Patrons with the most checkouts</title>
32880 <para>This report will simply list the patrons who have the most
32884 <screeninfo>Patrons with the most checkouts form</screeninfo>
32888 <imagedata fileref="images/reports/topcheckoutsform.png"/>
32893 <para>If you choose to output to the browser your results will print
32894 to the screen.</para>
32897 <screeninfo>Top checkouts results</screeninfo>
32901 <imagedata fileref="images/reports/topcheckoutsresult.png"/>
32906 <para>You can also choose to export to a file that you can manipulate
32907 to your needs.</para>
32910 <section id="mostcirculated">
32911 <title>Most Circulated Items</title>
32913 <para>This report will simply list the items that have the been
32914 checked out the most.</para>
32917 <screeninfo>Most Circulation Items Form</screeninfo>
32921 <imagedata fileref="images/reports/topcircform.png"/>
32926 <para>If you choose to output to the browser your results will print
32927 to the screen.</para>
32930 <screeninfo>Top Circulation Items Results</screeninfo>
32934 <imagedata fileref="images/reports/topcircresults.png"/>
32939 <para>You can also choose to export to a file that you can manipulate
32940 to your needs.</para>
32943 <section id="patnocheckouts">
32944 <title>Patrons with no checkouts</title>
32946 <para>This report will list for you the patrons in your system who
32947 haven't checked any items out.</para>
32950 <screeninfo>Patrons with no Checkouts</screeninfo>
32954 <imagedata fileref="images/reports/patnocheckout.png"/>
32959 <para>If you choose to output to the browser your results will print
32960 to the screen.</para>
32963 <screeninfo>Results for Patrons with no Checkouts</screeninfo>
32967 <imagedata fileref="images/reports/patnocheckout-results.png"/>
32972 <para>You can also choose to export to a file that you can manipulate
32973 to your needs.</para>
32976 <section id="itemnocheckouts">
32977 <title>Items with no checkouts</title>
32979 <para>This report will list items in your collection that have never
32980 been checked out.</para>
32983 <screeninfo>Items with No Checkouts</screeninfo>
32987 <imagedata fileref="images/reports/nocheckoutsform.png"/>
32992 <para>If you choose to output to the browser your results will print
32993 to the screen.</para>
32996 <screeninfo>Items with no checkouts results</screeninfo>
33000 <imagedata fileref="images/reports/nocheckoutsresults.png"/>
33005 <para>You can also choose to export to a file that you can manipulate
33006 to your needs.</para>
33009 <section id="catbyitem">
33010 <title>Catalog by Item Type</title>
33012 <para>This report will list the total number of items of each item
33013 type per branch.</para>
33016 <screeninfo>Catalog by Item Type</screeninfo>
33020 <imagedata fileref="images/reports/itemtotals.png"/>
33025 <para>If you choose to output to the browser your results will print
33026 to the screen.</para>
33029 <screeninfo>Total of Items by Type and Branch</screeninfo>
33033 <imagedata fileref="images/reports/itemtotalsresults.png"/>
33038 <para>You can also choose to export to a file that you can manipulate
33039 to your needs.</para>
33042 <section id="lostreport">
33043 <title>Lost Items</title>
33045 <para>This report will allow you to generate a list of items that have
33046 been marked as Lost within the system</para>
33049 <screeninfo>Lost Items Report</screeninfo>
33053 <imagedata fileref="images/reports/lostitems.png"/>
33059 <section id="avloantime">
33060 <title>Average Loan Time</title>
33062 <para>This report will list the average time items are out on loan
33063 based on the criteria you enter:</para>
33066 <screeninfo>Average Checkout Period Form</screeninfo>
33070 <imagedata fileref="images/reports/averloanform.png"/>
33075 <para>If you choose to output to the browser your results will print
33076 to the screen.</para>
33079 <screeninfo>Average Checkout Period Results</screeninfo>
33083 <imagedata fileref="images/reports/avercheckout.png"/>
33088 <para>You can also choose to export to a file that you can manipulate
33089 to your needs.</para>
33093 <section id="reportdic">
33094 <title>Report Dictionary</title>
33096 <para>The report dictionary is a way to pre-define common filters you'd
33097 like to apply to your reports. This is a good way to add in filters that
33098 the report wizard doesn't include by default. To add a new definition,
33099 or filter, click 'New Definition' on the Reports Dictionary page and
33100 follow the 4 step process.</para>
33102 <para>Step 1: Name the definition and provide a description if
33106 <screeninfo>Create a Definition</screeninfo>
33110 <imagedata fileref="images/reports/dict1.png"/>
33115 <para>Step 2: Choose the module that the will be queried.</para>
33118 <screeninfo>Select Koha Module</screeninfo>
33122 <imagedata fileref="images/reports/dict2.png"/>
33127 <para>Step 3: Choose columns to query from the tables presented.</para>
33130 <screeninfo>Choose columns</screeninfo>
33134 <imagedata fileref="images/reports/dict3.png"/>
33139 <para>Step 4: Choose the value(s) from the field(s). These will be
33140 automatically populated with options available in your database.</para>
33143 <screeninfo>Choose fields and values</screeninfo>
33147 <imagedata fileref="images/reports/dict4.png"/>
33152 <para>Confirm your selections to save the definition.</para>
33155 <screeninfo>Confirm Definition</screeninfo>
33159 <imagedata fileref="images/reports/dictconfirm.png"/>
33164 <para>Your definitions will all appear on the Reports Dictionary
33168 <screeninfo>Reports Dictionary Listing</screeninfo>
33172 <imagedata fileref="images/reports/dictlist.png"/>
33177 <para>Then when generating reports on the module you created the value
33178 for you will see an option to limit by the definition at the bottom of
33179 the usual filters.</para>
33182 <screeninfo>Dictionary Limit Option</screeninfo>
33186 <imagedata fileref="images/reports/dictionarylimit.png"/>
33193 <chapter id="opac">
33194 <title>OPAC</title>
33196 <para>This chapter assumes that you have the following preferences set as
33201 <para><link linkend="opacthemes">opacthemes</link> = prog</para>
33204 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> = default</para>
33209 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
33214 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
33219 <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
33223 <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
33228 <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
33233 <para><link linkend="reviewson">reviewson</link> = Allow</para>
33237 <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
33241 <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
33246 <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
33252 linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
33257 <para><link linkend="XISBN">XISBN</link> = Use</para>
33261 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
33262 = Default set of links</para>
33266 <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
33267 = Don't show</para>
33271 <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
33277 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
33282 <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
33287 <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
33292 <para><link linkend="OPACShowBarcode">OPACShowBarcode</link> = Don't
33297 <para>If your system preferences are set differently your displays may
33300 <section id="opacsearchresults">
33301 <title>Search Results</title>
33303 <para>To search the OPAC you can either choose to enter your search
33304 words in the box at the top of the OPAC or click on the 'Advanced
33305 Search' link to perform a more detailed search.</para>
33308 <screeninfo>OPAC Search Box</screeninfo>
33312 <imagedata fileref="images/opac/searchbox.png"/>
33317 <para>For more on searching check the '<link
33318 linkend="searching">Searching</link>' chapter in this manual.</para>
33320 <section id="opacresultsoverview">
33321 <title>Results Overview</title>
33323 <para>After performing a search the number of results found for your
33324 search will appear above the results</para>
33327 <screeninfo>Total Results</screeninfo>
33331 <imagedata fileref="images/opac/totalresults-rss.png"/>
33336 <para>By default your search results will be sorted based on your
33337 <link linkend="opacdefaultsort">OPACdefaultSortField and
33338 OPACdefaultSortOrder</link> system preference values. To change this
33339 you can choose another sorting method from the pull down on the
33343 <screeninfo>Results Sorting Options</screeninfo>
33347 <imagedata fileref="images/opac/sortingresults.png"/>
33352 <para>Under each title on your results list a series of values from
33353 your leader will appear. It is important to note that this has nothing
33354 to do with the item types or collection codes you have applied to your
33355 records, this data is all pulled from your leader.</para>
33358 <screeninfo>Leader Visualization</screeninfo>
33362 <imagedata fileref="images/opac/leader.png"/>
33367 <para>Below each title you will see the availability for the items
33368 attached to the record. Note that even if you filtered on one library
33369 location all locations that hold the item will appear on the search
33373 <screeninfo>Holdings Information</screeninfo>
33377 <imagedata fileref="images/opac/holdings-results.png"/>
33382 <para>If you have turned on <link linkend="enhancedcontent">Enhanced
33383 Content</link> preferences you may have book jackets on your search
33387 <screeninfo>Book Jacket on Results</screeninfo>
33391 <imagedata fileref="images/opac/coverresults.png"/>
33395 <para>If you have set your <link linkend="didyoumean">Did you mean?</link> options you will
33396 see a yellow bar across the top of your results will other related searches.<screenshot>
33397 <screeninfo>Did you mean?</screeninfo>
33400 <imagedata fileref="images/opac/didyoumeanopac.png"/>
33403 </screenshot></para>
33406 <section id="opacfilter">
33407 <title>Filters</title>
33409 <para>To filter your results click on the links below the 'Refine Your
33410 Search' menu on the left of your screen</para>
33413 <screeninfo>Refine Your Results</screeninfo>
33417 <imagedata fileref="images/opac/refineresults.png"/>
33422 <para>If you only have one library/branch in Koha you will not see the
33423 'Libraries' filter, instead you will see a filter on Shelving
33424 Location. The same will happen if you have <link
33425 linkend="singleBranchMode">singleBranchMode</link> set to "Don't
33429 <screeninfo>Location facet</screeninfo>
33433 <imagedata fileref="images/opac/locationfacet.png"/>
33439 <section id="searchrss">
33440 <title>Search RSS Feeds</title>
33442 <para>You will be able to subscribe to your search results as an RSS
33443 feed by clicking the RSS icon in your address bar or next to the
33444 number of results. To learn more about what RSS feeds are check out
33445 <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
33446 video</ulink>.</para>
33449 <screeninfo>RSS Feed Icon</screeninfo>
33453 <imagedata fileref="images/opac/totalresults-rss.png"/>
33458 <para>Subscribing to search results as RSS feeds will allow you to see
33459 when a new item is added to the catalog in your area of
33464 <section id="opacbibrec">
33465 <title>Bibliographic Record</title>
33467 <para>When you click on a title from the search results, you're brought
33468 to the bibliographic detail of the record. This page is broken down in
33469 several different areas.</para>
33471 <para>At the top of your screen will be the title and the GMD:</para>
33474 <screeninfo>Title</screeninfo>
33478 <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
33483 <para>Below the title the authors will be listed. These come from your
33484 1xx and 7xx fields. Clicking the author will run a search for other
33485 titles with that author.</para>
33488 <screeninfo>Author Display</screeninfo>
33492 <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
33497 <para>If you have an authority file you will see a magnifying glass to
33498 the right of author (and other) authorities. Clicking that magnifying
33499 glass will take you directly to the authority record.</para>
33502 <screeninfo>Authority link</screeninfo>
33506 <imagedata fileref="images/opac/bibdetail/authoritylink.png"/>
33511 <para>If you have your <link
33512 linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
33513 set to 'show' you will see a material type that is determined by values
33514 in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
33515 Item Types</link> Appendix).</para>
33518 <screeninfo>XSLT Item Type</screeninfo>
33522 <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
33527 <para>Next you'll see the description of the record you're
33531 <screeninfo>Basic Details</screeninfo>
33535 <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
33540 <para>Following that information you'll find the subject headings which
33541 can be clicked to search for other titles on similar topics</para>
33544 <screeninfo>Bibliographic Subjects</screeninfo>
33548 <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
33553 <para>If your record has a table of contents or summary it will appear
33554 next to the 'Summary' or 'Table of Contents' label</para>
33557 <screeninfo>Summary</screeninfo>
33561 <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
33566 <para>If your record has data in the 856 fields you'll see the links to
33567 the right of the 'Online Resources' label</para>
33570 <screeninfo>Online Resources</screeninfo>
33574 <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
33579 <para>If the title you're viewing is in a public list then you'll see a
33580 list of those to the right of the 'List(s) this item appears in' label
33581 and if it has tags they will appear below the 'Tags from this library'
33585 <screeninfo>Tags</screeninfo>
33589 <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
33594 <para>In the tabs below the details you will find your holdings
33602 <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
33607 <para>Any notes (5xx fields) that have been cataloged will appear under
33608 'Title Notes'</para>
33611 <screeninfo>Title notes</screeninfo>
33615 <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
33620 <para>If you're allowing comments they will appear in the next
33624 <screeninfo>Comments</screeninfo>
33628 <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
33633 <para>And finally if you have enabled FRBR and you have other editions
33634 of the title in your collection you will see the 'Editions' tab.</para>
33637 <screeninfo>Editions</screeninfo>
33641 <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
33646 <para>To the right of the details you'll find a series of boxes. The
33647 first box is a list of buttons to help navigate the search results. From
33648 there you can see the next or previous result from your search or return
33649 to the results.</para>
33652 <screeninfo>Search Options</screeninfo>
33656 <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
33661 <para>Clicking Browse Results at the top of the right column will open
33662 up your search results on the detail page</para>
33665 <screeninfo>Search Results</screeninfo>
33669 <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
33674 <para>Below the search buttons you'll find the links to place a hold,
33675 print the record, save the record to your lists, or add it to your
33679 <screeninfo>More options</screeninfo>
33683 <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
33688 <para>Clicking 'More Searches' will show the list of libraries you
33689 entered in your <link
33690 linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
33694 <screeninfo>More Searches</screeninfo>
33698 <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
33703 <para>Under the 'Save Record' label you will find a series of file
33704 formats you can save the record as. This list can be customized by
33705 altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
33706 system preference.</para>
33709 <screeninfo>Save Record</screeninfo>
33713 <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
33718 <para>If at any time you want to change the view from the 'Normal' view
33719 to see the Marc or the ISBD you can click the tabs across the top of the
33723 <screeninfo>Record Views</screeninfo>
33727 <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
33733 <section id="opaclistscart">
33734 <title>Lists & Cart</title>
33736 <para>A cart is a temporary holding place for records you're interested
33737 in finding during this session. That means that once you log out of the
33738 OPAC or close the browser you lose the items in your cart. A list is a
33739 more permanent location for saving items. To learn more about lists,
33740 check the <link linkend="stafflists">Lists in the Staff Client</link>
33741 chapter of this manual.</para>
33743 <section id="opaclists">
33744 <title>Lists</title>
33746 <para>Patrons can manage their own private lists by visiting the 'my
33747 lists' section of their account.</para>
33750 <screeninfo>Lists Management</screeninfo>
33754 <imagedata fileref="images/opac/nolists.png"/>
33759 <section id="opacaddlists">
33760 <title>Creating Lists</title>
33762 <para>Lists can also be created by choosing the 'New List' option in
33763 the 'Add to' menu on the search results</para>
33766 <screeninfo>Add to New List</screeninfo>
33770 <imagedata fileref="images/opac/addtonewlist.png"/>
33775 <para>To create a list the patron simply needs to click the 'New
33776 List' link and populate the form that appears</para>
33779 <screeninfo>Create a new list</screeninfo>
33783 <imagedata fileref="images/opac/newlist.png"/>
33788 <para>The only field required is the 'List Name,' but the patron can also choose how they
33789 want the list sorted and if the list is public or private.<itemizedlist>
33791 <para>A Private List is managed by you and can be seen only by you (depending on
33792 your permissions settings below)</para>
33795 <para>A Public List can be seen by everybody, but managed only by you (depending on
33796 your permissions settings below)</para>
33798 </itemizedlist><important>
33799 <para>If you aren't allowing patrons to create public lists with the <link
33800 linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
33801 preference then patrons will only be able to create private lists.</para>
33802 </important></para>
33805 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
33807 <para>anyone else to add entries</para>
33810 <para>anyone to remove his own contributed entries<itemizedlist>
33813 <para>The owner of a list is always allowed to add entries, but needs
33814 permission to remove.</para>
33817 </itemizedlist></para>
33820 <para>anyone to remove other contributed entries </para>
33822 </itemizedlist></para>
33827 <section id="opacaddtolists">
33828 <title>Adding titles to Lists</title>
33830 <para>Titles can be added to lists from the search results and/or
33831 from the bibliographic record. On the search results options to add
33832 items to the list appear below each result and across the top of the
33833 results page</para>
33836 <screeninfo>Add to Lists from Results</screeninfo>
33840 <imagedata fileref="images/opac/addtolistcart.png"/>
33845 <para>To add a single title to a list, click the 'Save to Lists'
33846 option and then choose the list you'd like to add the title to. To
33847 add multiple titles to a list check the boxes on the left of the
33848 titles you want to add and then choose the list you want to add the
33849 titles to from the 'Add too' pull down at the top of the
33853 <section id="listscontent">
33854 <title>Viewing Lists Contents</title>
33856 <para>To view the contents of a list, click on the list name under
33857 the Lists button.</para>
33860 <screeninfo>Lists</screeninfo>
33864 <imagedata fileref="images/opac/chooselist.png"/>
33869 <para>The contents of the list will look similar to your search
33870 results pages except that there will be different menu options
33871 across the top of the list.</para>
33874 <screeninfo>List View</screeninfo>
33878 <imagedata fileref="images/opac/listview.png"/>
33883 <para>Using the menu options above the list you can place multiple
33884 items on hold, download the list contents, email the list or print
33885 the list out.</para>
33889 <para>To place a hold on one or more list items check the box to
33890 the left of the item and click the 'Place Hold' link at the
33895 <para>To download the list contents click the 'Download List'
33896 link and choose the format you'd like to download the list
33902 <para>iso2079 is MARC format</para>
33909 <para>To email the list contents to someone, click the 'Send
33910 List' link and enter in your email details in the form that pops
33914 <screeninfo>Email List Contents</screeninfo>
33918 <imagedata fileref="images/opac/emailist.png"/>
33925 <para>To print the contents of your list out click the 'Print
33931 <section id="opacmanagelists">
33932 <title>Managing Lists</title>
33934 <para>Once the list is saved patrons can begin adding items to it.
33935 From the 'my lists' tab on the patron record the patron can edit and
33936 delete the lists they have created by clicking the appropriate link
33937 to the right of the list name.</para>
33940 <screeninfo>My Lists</screeninfo>
33944 <imagedata fileref="images/opac/mylists.png"/>
33949 <para>To edit the list's title or sorting patrons click the 'Edit'
33950 link to the right of the list description.</para>
33953 <screeninfo>Editing List</screeninfo>
33957 <imagedata fileref="images/opac/editlist.png"/>
33962 <para>When clicking 'Delete' next to a list you will be asked to
33963 confirm that you want to delete the list.</para>
33966 <screeninfo>Delete list confirmation</screeninfo>
33970 <imagedata fileref="images/opac/deletelist.png"/>
33975 <para>The list will not be deleted until the 'Confirm' button is
33976 clicked to the right of the list you'd like to delete.</para>
33982 <section id="opaccart">
33983 <title>Cart</title>
33987 <section id="opacaddtocart">
33988 <title>Adding titles to the Cart</title>
33990 <para>Titles can be added to the cart from the search results and/or
33991 from the bibliographic record. On the search results options to add
33992 items to the cart appear below each result and across the top of the
33993 results page</para>
33996 <screeninfo>Add to Cart on Search Results</screeninfo>
34000 <imagedata fileref="images/opac/addtolistcart.png"/>
34005 <para>Clicking the 'Add to Cart' button will add the one title to
34006 your cart. To add multiple titles at once, check the box to the left
34007 of each result and then choose 'Cart' from the 'Add to' pull down at
34008 the top of the screen. Once titles are added to the cart you will be
34009 presented with a confirmation</para>
34012 <screeninfo>Items added to Cart</screeninfo>
34016 <imagedata fileref="images/opac/addedtocart.png"/>
34022 <section id="manageopaccart">
34023 <title>Managing the Cart</title>
34025 <para>Once you have titles in your cart you can manage the contents
34026 by clicking on the 'Cart' button usually found at the top of the
34027 screen to the right of the search box. Your cart will open in a new
34031 <screeninfo>Contents of your cart</screeninfo>
34035 <imagedata fileref="images/opac/cartcontents.png"/>
34040 <para>From this window you are presented with several options.
34041 Across the top of the cart are several buttons.</para>
34043 <para>First is the 'More details' button. Clicking this will show
34044 you additional information about the titles in your cart (ISBNs,
34045 Subjects, Publisher Info, Notes and more).</para>
34047 <para>Next is the option to send the contents of your cart to an
34048 email address. This is handy if you want to send the resources you
34049 found at the library to your home email account to refer to later or
34050 to send to a patron researching a specific topic. Clicking this link
34051 will open up a new window that asks for the email address and
34052 message to send.</para>
34055 <screeninfo>Email Cart</screeninfo>
34059 <imagedata fileref="images/opac/emailcart.png"/>
34064 <para>In addition to sending your cart you can download the contents
34065 of your cart in several pre-defined formats or using a <link
34066 linkend="csvprofiles">CSV Profile</link> that you defined in the
34067 Tools module.</para>
34070 <screeninfo>Download Cart</screeninfo>
34074 <imagedata fileref="images/opac/downloadcart.png"/>
34079 <para>Finally you can print out the contents of your cart by
34080 choosing the 'Print' link.</para>
34082 <para>In addition to the various different ways to save the contents
34083 of your cart, there are ways to add value to the data in your cart.
34084 By selecting one or more titles from the cart you can add them to a
34085 list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
34086 tag them (click 'Tag'). All of these operations follow the same
34087 procedure as they do when performing them in the OPAC.</para>
34092 <section id="opacplacehold">
34093 <title>Placing Holds</title>
34095 <para>Patrons can place holds on items via the OPAC if they're logged in
34096 and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
34097 preference set to 'Allow'. If the item can be placed on hold the option
34098 to place it on hold will appear in several different places.</para>
34102 <para>When viewing a list or search results page you'll see the
34103 option to place hold on multiple items by checking the boxes to the
34104 left of the results and clicking 'Place Hold' at the top</para>
34107 <screeninfo>Place Hold from Results</screeninfo>
34111 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
34118 <para>When viewing a list or search results page you'll see the
34119 option to place the item on hold below the basic information about
34123 <screeninfo>Place Hold</screeninfo>
34127 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
34134 <para>When viewing an individual title you'll see the option to
34135 place a hold in the box on the right side of the screen</para>
34138 <screeninfo>Place Hold</screeninfo>
34142 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
34149 <para>No matter which of the above links you click to place your hold
34150 you'll be brought to the same hold screen.</para>
34153 <screeninfo>Place Hold Form</screeninfo>
34157 <imagedata fileref="images/opac/opacplacehold.png"/>
34164 <para>Check the box to the left of the items you'd like to place on
34169 <para>The title includes a link back to the detail page for the
34174 <para>The priority shows where in the holds queue this hold will
34179 <para>If allowed by your <link
34180 linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link>
34181 preference, the 'Hold Starts on Date' column will show. This field
34182 allows the patron to have their hold start on a future date.</para>
34186 <para>By default holds placed in the system remain until canceled,
34187 but if the patron fills in a 'Hold Not Needed After' date then the
34188 hold has an expiration date.</para>
34193 <para>Expired holds are removed by the <link
34194 linkend="expiredholdscron">Expired Holds Cron Job</link>, this
34195 is not an automatic process and must be set up by your system
34196 administrator</para>
34203 <para>If allowed by your <link
34204 linkend="OPACItemHolds">OPACItemHolds</link> preference the patron
34205 will be allowed to choose whether to place the hold on the next
34206 available copy or a specific copy</para>
34209 <screeninfo>Specific Copy Hold</screeninfo>
34213 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
34220 <para>If allowed by your <link
34221 linkend="OPACAllowUserToChooseBranch">OPACAllowUserToChooseBranch</link>
34222 preference the patron can choose where they'd like to pick up their
34227 <para>After clicking the Place Hold button the patron will be brought to
34228 their account page where they'll see all of the items they have on
34232 <section id="opacenhancedcontent">
34233 <title>Enhanced Content</title>
34237 <section id="opactagging">
34238 <title>Tagging</title>
34240 <para>Depending on your settings for the <link
34241 linkend="TagsEnabled">TagsEnabled</link>, <link
34242 linkend="TagsInputOnList">TagsInputOnList</link> and <link
34243 linkend="TagsInputOnDetail">TagsInputOnDetail</link> preferences you
34244 may be able to add tags to bibliographic records from the search
34245 results and/or bibliographic records. If you are allowing patrons to
34246 add tags from the search results screen you will see an input box
34247 below each result and a 'Tag' option at the top of the screen.</para>
34250 <screeninfo>Tagging Options on Results</screeninfo>
34254 <imagedata fileref="images/opac/tags-results.png"/>
34259 <para>To add a tag to one item, type the tabs (separated by commas) in
34260 the 'New tag' box and click 'Add'. You will be presented with a
34261 confirmation of your tags being added.</para>
34264 <screeninfo>Tags Added on Results</screeninfo>
34268 <imagedata fileref="images/opac/tagsadded-results.png"/>
34273 <para>From the results you can also tag items in bulk by clicking the
34274 checkboxes on the left and then clicking the 'Tag' button at the top.
34275 After clicking the button it will change into an input box for you to
34276 add tags to all of the items you have selected.</para>
34279 <screeninfo>Add Tags to Multiple Items</screeninfo>
34283 <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
34289 <section id="opaccomments">
34290 <title>Comments</title>
34292 <para>Patrons can leave comments in the OPAC if you have the <link
34293 linkend="reviewson">reviewson</link> preference set to allow this.
34294 Each bibliographic record has a comments tab below the bibliographic
34295 information.</para>
34298 <screeninfo>Comments Tab</screeninfo>
34302 <imagedata fileref="images/opac/commentstab.png"/>
34307 <para>If the patron is logged in they will see a link to add a comment
34308 to the item. Clicking this link will open a pop up window with a box
34309 for their comments.</para>
34312 <screeninfo>Add a Comment</screeninfo>
34316 <imagedata fileref="images/opac/addcomment.png"/>
34321 <para>Once the comment has been typed and the 'Submit' button clicked,
34322 the patron will see their comment as pending and other patrons will
34323 simply see that there are no comments on the item.</para>
34326 <screeninfo>Pending Comment</screeninfo>
34330 <imagedata fileref="images/opac/commentpending.png"/>
34335 <para>Once the comment is approved the patron will see the number of
34336 comments on the 'Comments' tab and the comment highlighted in yellow
34337 as their comment.</para>
34340 <screeninfo>Your Comments</screeninfo>
34344 <imagedata fileref="images/opac/yourcomment.png"/>
34349 <para>Other patrons will see the comment with the name of the patron
34350 who left the comment (unless you have set the <link
34351 linkend="ShowReviewer">ShowReviewer</link> preference to not show
34352 patron names).</para>
34355 <screeninfo>Comment by other patron</screeninfo>
34359 <imagedata fileref="images/opac/commentby.png"/>
34364 <para>If you'd like to link to a page of recent comments added to your
34365 catalog you simply need to add a link to
34366 http://YOURCATALOG/cgi-bin/koha/opac-showreviews.pl to anywhere on
34370 <screeninfo>Recent Comments List</screeninfo>
34374 <imagedata fileref="images/opac/recentcomments.png"/>
34380 <section id="zotero">
34381 <title>Zotero</title>
34383 <para>Zotero is a Firefox add on that allows for the saving and
34384 generating of a bibliography. Learn more about and download Zotero at
34385 <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
34387 <para>When on the search results in the Koha OPAC, if you have Zotero
34388 installed, you will see a folder icon in the address bar to the right
34389 of the URL. Clicking that folder will open up a list of titles on the
34390 page for you to pick from to add to Zotero.</para>
34393 <screeninfo>Zotero pop up</screeninfo>
34397 <imagedata fileref="images/opac/zoteroaddressbar.png"/>
34402 <para>Select the titles you want to add to Zotero and then click the
34403 'OK' button. This will add the title to Zotero. You can see the title
34404 by opening your Zotero library.</para>
34407 <screeninfo>Title in the Zotero Library</screeninfo>
34411 <imagedata fileref="images/opac/zoterotitle.png"/>
34417 <section id="customrss">
34418 <title>Custom RSS Feeds</title>
34420 <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
34421 any SQL query (for example a new acquisitions RSS feed). rss.pl is run
34422 on the command line to produce an RSS XML document.</para>
34424 <para>The output should be placed in a directory accessible to the
34425 OPAC (or staff) web interface so that users can download the RSS
34428 <para>An example of usage can be found at: misc/cronjobs/rss.pl
34429 lastAcquired.conf</para>
34431 <para>Normally rss.pl should be run periodically (e.g., daily) to keep
34432 the feed up-to-date.</para>
34434 <para>The configuration file (e.g., lastAcquired.conf) lists</para>
34438 <para>name of the template file to use</para>
34442 <para>path of output file</para>
34446 <para>SQL query</para>
34450 <para>rss.pl runs the SQL query, then feeds the output of the query
34451 through the template to produce the output file.</para>
34454 <para>To use custom RSS feeds you need to turn on the cron
34456 </important></para>
34460 <section id="opacmyaccount">
34461 <title>My Account</title>
34463 <para>From the OPAC patrons can log in and access their account if you
34464 have set the <link linkend="opacuserlogin">opacuserlogin</link>
34465 preference to 'Allow'. Once logged in patrons are brought to their
34466 account summary. If you would like to get to your account in the OPAC,
34467 you can click on your name in the top right of any page in the
34470 <section id="opacmysummary">
34471 <title>My Summary</title>
34474 <screeninfo>My Summary</screeninfo>
34478 <imagedata fileref="images/opac/myaccount.png"/>
34483 <para>From the 'my summary' tab, patrons will see all of the items
34484 they have checked out with the overdue items highlighted in red. If
34485 you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
34486 set to 'Allow' then your patrons will be able to renew their books
34487 right from the OPAC. If you have HTML entered in the <link
34488 linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
34489 you will see that to the right of the 'Fines' column.</para>
34492 <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
34496 <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
34501 <para>If your patrons would like to see the items barcodes on their
34502 list of checked out items you can set up a <link
34503 linkend="patronattributetypes">patron attribute</link> with the value
34504 of SHOW_BCODE and <link linkend="authorizedvalues">authorized
34505 value</link> of YES_NO.</para>
34508 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
34512 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
34517 <para>Then on the <link linkend="editpatrons">patron's record set the
34518 value</link> for SHOW_BCODE to yes.</para>
34521 <screeninfo>Setting value for SHOW_BCODE on patron
34522 record</screeninfo>
34526 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
34531 <para>This will add a column to the check out summary in the OPAC that
34532 shows the patrons the barcodes of the items they have checked
34536 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
34540 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
34545 <para>Clicking on the 'Overdue' tab will show only the items that are
34549 <screeninfo>Overdue Items</screeninfo>
34553 <imagedata fileref="images/opac/myoverdues.png"/>
34558 <para>The 'Fines' tab will show just a total of what the patron owes.
34559 Clicking on the total will take them to the 'my fines' tab where they
34560 will see a complete breakdown of their fines and bills. If you don't
34561 charge fines at your library you can turn the display of these tabs
34562 off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
34563 preference to 'Don't Allow.'</para>
34566 <screeninfo>Patron Fines</screeninfo>
34570 <imagedata fileref="images/opac/myfines.png"/>
34575 <para>Finally, clicking on the 'Holds' tab will show the patron the
34576 status of all of the items they have on hold. Items that are ready for
34577 pickup will be highlighted in yellow.</para>
34580 <screeninfo>Patron holds status</screeninfo>
34584 <imagedata fileref="images/opac/myholds.png"/>
34589 <para>Patrons can cancel their own holds if they are not in transit or
34590 already waiting for them. They can also suspend all of their holds
34591 (depending on the value of your <link
34592 linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference)
34593 indefinitely or until a specific date if they choose by filling in the
34594 suspend options at the bottom of the page.</para>
34597 <para>If you have your <link
34598 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
34599 preference set to "Don't allow" then you will not have the option to
34600 put an end date on the hold suspension</para>
34604 <section id="opacmyaccount-flags">
34605 <title>Patron Flags</title>
34607 <para>If you have <link linkend="patronflags">flagged your patron's
34608 account</link> they may see one of the following error messages at the
34609 top of their account.</para>
34613 <para>Card marked as lost</para>
34616 <screeninfo>Library card lost</screeninfo>
34620 <imagedata fileref="images/opac/nocard.png"/>
34627 <para>Patron address in question</para>
34630 <screeninfo>Patron address in question</screeninfo>
34634 <imagedata fileref="images/opac/noaddress.png"/>
34642 <para>this error message will not include a link to the
34643 update form if you have <link
34644 linkend="OPACPatronDetails">OPACPatronDetails</link> set to
34645 'Don't allow'</para>
34652 <para>Patron marked restricted</para>
34655 <screeninfo>Patron restricted</screeninfo>
34659 <imagedata fileref="images/opac/debarred.png"/>
34667 <section id="opacmyfines">
34668 <title>My Fines</title>
34670 <para>If your library charges fines the next tab on the left is 'my
34671 fines.' Opening this tab will show the patron an entire history of
34672 their accounting at the library.</para>
34675 <screeninfo>Library Fines & Charges</screeninfo>
34679 <imagedata fileref="images/opac/mybilling.png"/>
34685 <section id="opacmydetails">
34686 <title>My Details</title>
34688 <para>If you have your <link
34689 linkend="OPACPatronDetails">OPACPatronDetails</link> preference set to
34690 'Allow', your patrons will see a form filled in with their contacting
34691 information by clicking on the 'my personal details' tab.</para>
34694 <screeninfo>Patron's personal details</screeninfo>
34698 <imagedata fileref="images/opac/myprofile.png"/>
34703 <para>Patrons can edit their details in this form and click 'Submit
34704 Changes' to have their edits sent to the library for review before
34705 their record is updated. The email with the changes is sent to the
34706 library administration email address and lines that the patron changed
34707 will start with the field name in all caps.</para>
34710 linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set
34711 to 'Don't allow' then patrons will simply see their details in plain
34715 <screeninfo>Patron's personal details with no edits</screeninfo>
34719 <imagedata fileref="images/opac/myprofile-noedit.png"/>
34725 <section id="opacmytags">
34726 <title>My Tags</title>
34728 <para>If your library has <link
34729 linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
34730 next tab on the left will be 'my tags.' This tab will show patrons all
34731 of the tags in the system as a cloud and then all of the tags they
34732 have applied in a list format. From here patrons have the ability to
34733 remove tags that they have added if they want.</para>
34736 <screeninfo>Patron's tags</screeninfo>
34740 <imagedata fileref="images/opac/mytags.png"/>
34746 <section id="opacmypassword">
34747 <title>Change My Password</title>
34749 <para>Next, if you have <link
34750 linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
34751 the next tab will be 'change my password,' where patrons can change
34752 their password for logging into the OPAC. Patrons will be presented
34753 with a standard form asking them to enter their old password and then
34754 their new password twice.</para>
34757 <screeninfo>Change my password</screeninfo>
34761 <imagedata fileref="images/opac/mypassword.png"/>
34767 <section id="opacmysearchistory">
34768 <title>My Search History</title>
34770 <para>If you have your <link
34771 linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
34772 preference set to 'Allow' then your patrons can access their search
34773 history via the 'my search history' tab.</para>
34776 <screeninfo>my search history tab</screeninfo>
34780 <imagedata fileref="images/opac/mysearchhistory.png"/>
34785 <para>The search history is a record of all searches run by the
34786 patron. Clicking on any of the search phrases will re-run the search
34787 for the patron. The search history can be deleted by the patron at any
34788 time by clicking the 'Delete your search history' link found at the
34789 top of this tab or by clicking the little red 'x' next to the 'Search
34790 history' link at the top right of the OPAC.</para>
34793 <screeninfo>Search history link at the top right of the
34798 <imagedata fileref="images/opac/searchistory.png"/>
34804 <section id="opacmyhistory">
34805 <title>My Reading History</title>
34807 <para>Depending on your library's setting for <link
34808 linkend="opacreadinghistory">opacreadinghistory</link> your patrons
34809 may see the 'my reading history' tab next. This will show the patron
34810 their entire reading history unless they have asked the library to not
34811 keep that information via the 'my privacy' tab which will appear if
34812 you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
34813 set to 'Allow.'</para>
34816 <screeninfo>Patron reading history</screeninfo>
34820 <imagedata fileref="images/opac/myhistory.png"/>
34826 <section id="opacmyprivacy">
34827 <title>My Privacy</title>
34829 <para>The 'my privacy' tab will appear if you have both the <link
34830 linkend="opacreadinghistory">opacreadinghistory</link> and the <link
34831 linkend="OPACPrivacy">OPACPrivacy</link> preferences set to 'Allow.'
34832 This tab will allow the patrons to decide how the library keeps their
34833 circulation history data.</para>
34836 <screeninfo>my privacy tab</screeninfo>
34840 <imagedata fileref="images/opac/myprivacy.png"/>
34845 <para>The patron can choose from three options:</para>
34849 <para>Forever: keep my reading history without limit. This is the
34850 option for users who want to keep track of what they are
34855 <para>Default: keep my reading history according to local laws.
34856 This is the default option : the library will keep your reading
34857 history for the duration permitted by local laws.</para>
34861 <para>Never: Delete my reading history immediately. This will
34862 delete all record of the item that was checked-out upon
34867 <para>Depending on the patron's suggestions the contents of the '<link
34868 linkend="opacmyhistory">my reading history</link>' tab and the '<link
34869 linkend="circhistory">Circulation History</link>' tab in the staff
34870 client may change.</para>
34872 <para>Regardless of the patron's choice they can delete their reading
34873 history in bulk at any time by clicking the 'Immediate deletion'
34877 <screeninfo>Delete Circulation History</screeninfo>
34881 <imagedata fileref="images/opac/deletecirchistory.png"/>
34886 <para>Clicking this button will not delete items that are currently
34887 checked out, but will clear the patron's past reading history.</para>
34890 <section id="opacmysuggestions">
34891 <title>My Purchase Suggestions</title>
34893 <para>If your library allows patrons to make purchase suggestions the
34894 next tab will show all suggestions that the patron made to the library
34895 and their statuses. To disable this tab and the suggestion
34896 functionality set the <link
34897 linkend="suggestionspref">suggestion</link> preference to 'Don't
34901 <screeninfo>Patron purchase suggestions</screeninfo>
34905 <imagedata fileref="images/opac/mysuggestions.png"/>
34911 <section id="opacmymsgs">
34912 <title>My Messaging</title>
34914 <para>If your library has the <link
34915 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
34916 preference set to 'Allow' then your patrons will be able to choose
34917 which messages they receive from the library (with the exception of
34918 overdue notices which the library controls).</para>
34921 <screeninfo>Patron messaging preferences</screeninfo>
34925 <imagedata fileref="images/opac/mymessages.png"/>
34930 <para>If you also allow SMS messages with the <link
34931 linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
34932 an additional column to receive these messages as SMS (or text
34933 messages) and a field for a cell (or SMS) number.</para>
34936 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
34940 <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
34946 <para>These notices are:</para>
34949 <para>Advanced Notice : A notice in advance of the patron's items being due (The
34950 patron can choose the number of days in advance)</para>
34953 <para>Item Checkout : A notice that lists all the of the items the patron has just
34954 checked out and/or renewed, this is an electronic form of the checkout
34958 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
34962 <para>Item Due : A notice on the day and item is due back at the library</para>
34965 <para>Item Checkin : A notice that lists all the of the items the patron has just
34973 <section id="opacmylists">
34974 <title>My Lists</title>
34976 <para>Finally, if your library has the <link
34977 linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
34978 last tab will by 'my lists.' From here your patrons can review public
34979 lists and create or edit their own private lists.</para>
34982 <screeninfo>Patron lists</screeninfo>
34986 <imagedata fileref="images/opac/mylists.png"/>
34993 <section id="purchasesuggest">
34994 <title>Purchase Suggestions</title>
34996 <para>If your library has the <link
34997 linkend="suggestionspref">suggestion</link> preference set to 'Allow'
34998 then patrons will have the option to make purchase suggestions in
34999 several areas in the OPAC.</para>
35001 <para>There will be a link at the top of your OPAC under the search
35005 <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
35009 <imagedata fileref="images/opac/suggestfromsearch.png"/>
35014 <para>There will be a link when the patron finds nothing for their
35018 <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
35022 <imagedata fileref="images/opac/suggestfromnoresults.png"/>
35027 <para>And there will be a link on the patron's <link
35028 linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
35031 <screeninfo>Purchase Suggestion from My Purchase Suggestions
35036 <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
35041 <para>Clicking any one of these links will open the purchase suggestion
35045 <screeninfo>New Purchase Suggestion</screeninfo>
35049 <imagedata fileref="images/opac/newsuggestion.png"/>
35056 <para>From the form on the 'Title' is required by the
35061 <para>If you would like the 'Reason for suggestion' menu shown in
35062 the screenshot above to appear on your suggestions list you need to
35063 add an <link linkend="authorizedvalues">authorized value</link>
35064 category titled 'OPAC_SUG' and include reasons as values in that
35069 <para>If you would like the patron to be able to choose which branch
35070 they are making a suggestion for you need to set the <link
35071 linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
35072 preference to 'Allow'</para>
35076 <para>Once the form is submitted the data will be saved to the <link
35077 linkend="managesuggest">Acquisitions</link> module for the librarians to
35080 <section id="mobileopac">
35081 <title>Mobile OPAC</title>
35082 <para>If you have chosen to use the CCSR theme (set in the <link linkend="opacthemes"
35083 >opacthemes</link> preference) then you also have a mobile specific view for your OPAC. </para>
35084 <para>The main page of your OPAC will be customized per your <link linkend="opacprefs">OPAC
35085 system preferences</link> (always be sure to test in customizations on the desktop in
35086 multiple browsers and on as many mobile devices as possible. Your main page will look
35087 something like this:</para>
35090 <screeninfo>Mobile OPAC</screeninfo>
35093 <imagedata fileref="images/opac/mobile/mobileccsr.png"/>
35098 <para>Your search results will look something like this:</para>
35101 <screeninfo>Mobile search results</screeninfo>
35104 <imagedata fileref="images/opac/mobile/mobilesearchccsr.png"/>
35109 <para>A detail page will show more info along with the place hold link in the top right<screenshot>
35113 <imagedata fileref="images/opac/mobile/mobiledetail.png"/>
35116 </screenshot></para>
35117 <para>Clicking the place hold link on the search results or detail page will open up the holds
35118 screen for placing holds<screenshot>
35122 <imagedata fileref="images/opac/mobile/mobilehold.png"/>
35125 </screenshot></para>
35126 <para>Patrons will be able to log in to their account and see what they have checked out<screenshot>
35130 <imagedata fileref="images/opac/mobile/mobilemyaccount.png"/>
35133 </screenshot></para>
35134 <para>Once logged in they can click the menu button in the top left to see the usualy patron
35135 account menu<screenshot>
35139 <imagedata fileref="images/opac/mobile/mobilemenu.png"/>
35142 </screenshot></para>
35143 <para>They will be able to renew items (if you allow renewals via the OPAC)<screenshot>
35147 <imagedata fileref="images/opac/mobile/mobilerenew.png"/>
35150 </screenshot></para>
35154 <chapter id="searching">
35155 <title>Searching</title>
35159 <section id="searchprefixes">
35160 <title>Advanced Search Prefixes</title>
35162 <para>The following prefixes can be added to search terms in the keyword
35163 search box to limit items returned</para>
35167 <para>ti: title search</para>
35171 <para>ex. ti:hamlet</para>
35177 <para>su: subject search</para>
35181 <para>ex. su:cooking</para>
35187 <para>pb: publisher search</para>
35191 <para>ex. pb:penguin</para>
35197 <para>au: author search</para>
35201 <para>ex. au:rowling</para>
35207 <para>su-geo: geographic subjects</para>
35211 <para>ex. su-geo:wales and kw:description and kw:travel</para>
35217 <para>bc: barcode</para>
35221 <para>ex. bc:502326000912</para>
35227 <para>lex: lexile</para>
35231 <para>levels lex:510</para>
35240 <section id="searchguide">
35243 <firstname>Becky</firstname>
35245 <surname>Bell</surname>
35248 <orgname>WALDO</orgname>
35252 <pubdate>October 2008</pubdate>
35254 <othercredit role="copyeditor">
35255 <firstname>Nicole C.</firstname>
35257 <surname>Engard</surname>
35259 <contrib>Fixed typos, changed content where necessary and added new
35260 screenshots.</contrib>
35264 <title>Guide to Searching</title>
35266 <para>This brief guide will explain a chart that shows a sample of how a
35267 MARC21 database can be configured, as well as a brief introductory
35268 searching guide. The indexing fields described in this document relate
35269 to the bibliographic data and does not address authority database
35272 <section id="searchguide-indexing">
35273 <title>Indexing and Searching Description</title>
35275 <para>Koha's databases are indexed by the Zebra open-source software.
35276 The overview to the documentation describes Zebra as:</para>
35279 <para>"...Zebra is a high-performance, general-purpose structured
35280 text indexing and retrieval engine. It reads records in a variety of
35281 input formats (eg. email, XML, MARC) and provides access to them
35282 through a powerful combination of Boolean search expressions and
35283 relevance-ranked free-text queries.</para>
35285 <para>Zebra supports large databases (tens of millions of records,
35286 tens of gigabytes of data). It allows safe, incremental database
35287 updates on live systems. Because Zebra supports the
35288 industry-standard information retrieval protocol, Z39.50, you can
35289 search Zebra databases using an enormous variety of programs and
35290 toolkits, both commercial and free, which understands this
35291 protocol..." Zebra - User's Guide and Reference, p. 1, <ulink
35292 url="http://www.indexdata.dk/zebra/doc/zebra.pdf">http://www.indexdata.dk/zebra/doc/zebra.pdf</ulink></para>
35295 <para>This brief guide will explain a chart that shows a sample of how
35296 a MARC21 database can be configured, as well as a brief introductory
35297 searching guide. The indexing fields described in this document relate
35298 to the bibliographic data and does not address authority database
35302 <para>The indexing described in this document is the set used by
35303 SouthEastern University. Your local indexing may vary.</para>
35307 <section id="searchguide-indexconfig">
35308 <title>Indexing Configuration</title>
35310 <para>There are three configuration files that Koha uses while
35313 <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
35314 contains the Z39.50 bib-1 attribute list, plus the Koha local use
35315 attributes for Biblio Indexes, Items Index, and Fixed Fields and other
35316 special indexes. The Z39.50 Bib-1 profile is made up of several
35317 different types of attributes: Use, Relation, Position, Structure,
35318 Truncation, and Completeness. The bib-1 'Use' attribute is represented
35319 on the chart; the other attributes are used primarily when doing
35320 searches. While there are over 150+ use attributes that could be used
35321 to define your indexing set, it's unlikely that you will choose to use
35322 them all. The attributes you elect to use are those that become the
35323 indexing rules for your database. The other five attribute sets define
35324 the various ways that a search can be further defined, and will not
35325 specifically be addressed in this document. For a complete list of the
35326 standard Bib-1 attributes, go to <ulink
35327 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
35329 <para>The second file
35330 (etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs) contains
35331 the abstract syntax which maps the MARC21 tags to the set of Use
35332 Attributes you choose to use. The rules established in this file
35333 provides a passable Bath level 0 and 1 service, which includes author,
35334 title, subject, keyword and exact services such as standard
35335 identifiers (LCCN, ISBN, ISSN, etc.)</para>
35337 <para>The third file (etc/zebradb/ccl.properties) is the Common
35338 Command Language (CCL) field mappings. This file combines the bib-1
35339 attribute set file and the abstract file and adds the qualifiers,
35340 usually known as index names. The qualifiers, or indexes, for this
35341 database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
35342 su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
35343 mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
35345 <para>The <link linkend="kohasearchindexes">Koha Indexing Chart</link> summarizes the
35346 contents of all three of these files in a more readable format. The first two columns
35347 labeled Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes file. The
35348 third column labeled MARC tags indexed is where you find which MARC tags are mapped to an
35349 attribute. The fourth column labeled Qualifiers identifies the search abbreviations used
35350 in the internal CCL query. The following description provides a definition for the word
35351 'qualifiers'.</para>
35353 <para><emphasis>Qualifiers are used to direct the search to a
35354 particular searchable index, such as title (ti) and author indexes
35355 (au). The CCL standard itself doesn't specify a particular set of
35356 qualifiers, but it does suggest a few shorthand notations. You can
35357 customize the CCL parser to support a particular set of qualifiers to
35358 reflect the current target profile. Traditionally, a qualifier would
35359 map to a particular use-attribute within the BIB-1attribute set. It is
35360 also possible to set other attributes, such as the structure
35361 attribute.</emphasis></para>
35363 <para>In the MARC tags indexed column, there are some conventions used
35364 that have specific meanings. They are:</para>
35368 <para>A three digit tag (100) means that all subfields in the tag
35369 can be used in a search query. So, if you enter a search for
35370 'Jackson' as an author, you will retrieve records where Jackson
35371 could be the last name or the first name.</para>
35375 <para>A three digit tag that has a '$' followed by a letter
35376 (600$a) means that a search query will only search the 'a'
35381 <para>A three digit tag that is followed by a ':' and a letter
35382 (240:w) means that a search query can be further qualified. The
35383 letter following the ':' identifies how to conduct the search. The
35384 most common values you'll see are 'w' (word), 'p' (phrase), 's'
35385 (sort), and 'n' (numeric).</para>
35389 <para>The contents of the MARC tags, subfields, and/or fixed field
35390 elements that are listed in this chart are all indexed. You'll see
35391 that every attribute line is not mapped to a specific qualifier
35392 (index)-LC card number, line 9 is one example. However, every indexed
35393 word (a string of characters preceded and succeeded by a space) can be
35394 searched using a keyword (kw) search. So, although an LC card number
35395 specific index doesn't exist, you can still search by the LCCN since
35396 tag 010 is assigned to the LC-card-number attribute. To verify this,
35397 enter 72180055 in the persistent search box. You should retrieve The
35398 gods themselves, by Isaac Asimov.</para>
35400 <para>Examples of fixed field elements indexing can be seen on the
35401 chart between Attribute 8822 and Attribute 8703. These attributes are
35402 most commonly used for limiting. The fixed field attributes currently
35403 represent the BK codes. Other format codes, if needed, could be
35407 <section id="searchguide-basics">
35408 <title>Basic Searching</title>
35410 <para>The search box that library staff and library patrons will see
35411 most often is the persistent search box at the top of the page. Koha
35412 interprets the searches as keyword searches.</para>
35415 <screeninfo>Koha search box</screeninfo>
35419 <imagedata fileref="images/searching/searchbox.png"/>
35424 <para>To start a search, you enter a word or multiple words in the
35425 search box. When a single word is entered, a keyword search is
35426 performed. You can check this out by typing one word into the form and
35427 note the number of results located. Then, repeat the search with a
35428 minor change. In front of the search word, type 'kw=' followed by the
35429 same search term. The results will be identical.</para>
35431 <para>When you have more than one word in the search box, Koha will
35432 still do a keyword search, but a bit differently. Each word will be
35433 searched on its own, then the Boolean connector 'and' will narrow your
35434 search to those items with all words contained in matching
35437 <para>Suppose you want to find material about how libraries are using
35438 mashups. You'll select the major words and enter them into the
35439 persistent search box.</para>
35442 <screeninfo>Keyword Search</screeninfo>
35446 <imagedata fileref="images/searching/searchterms.png"/>
35451 <para>The response to this search is:</para>
35454 <screeninfo>Results</screeninfo>
35458 <imagedata fileref="images/searching/resultssummary.png"/>
35463 <para>The order of the words does not affect the retrieval results, so
35464 you could also enter the search as "mashups library". The response to
35465 this search is results</para>
35468 <screeninfo>Results</screeninfo>
35472 <imagedata fileref="images/searching/resultssummary2.png"/>
35477 <para>Too many words in the search box will find very few matches, as
35478 the following example illustrates:</para>
35481 <screeninfo>No results found</screeninfo>
35485 <imagedata fileref="images/searching/noresults.png"/>
35491 <section id="searchguide-advanced">
35492 <title>Advanced Searching</title>
35494 <para>When you can't find the most appropriate material with a general
35495 search, you can move to the Advanced Search page by clicking on the
35496 Search option on the persistent toolbar.</para>
35499 <screeninfo>Koha Menu</screeninfo>
35503 <imagedata fileref="images/searching/menubar.png"/>
35508 <para>The Advanced Search page offers many ways to limit the results
35509 of your search. You can search using the Boolean operators AND, OR,
35510 and NOT; limit by item type; limit by year and language; limit by
35511 subtypes audience, content, format, or additional content types; by
35512 location and by availability.</para>
35514 <para>The first limiting section on the Advanced Search page provides
35515 a quick and simple way to use the Boolean operators in your search.
35516 Note that this display depends on a system preference setting. This
35517 option can be found on the Administration > System Preferences >
35518 Searching page. The option called <link
35519 linkend="expandedSearchOption">expandedSearchOption</link> must be set
35520 to 'show' to see the following display.</para>
35523 <screeninfo>Advanced Search Options</screeninfo>
35527 <imagedata fileref="images/searching/searchoptions.png"/>
35532 <para>In this section you can choose among the many indexes by
35533 clicking on the arrow in the first box. The blank box that follows is
35534 where you enter your first search term or terms. On the second line,
35535 you can choose the Boolean operator you want to use in your search.
35536 The options are 'and', 'or', and 'not'. Then, you would again choose
35537 the index to search, followed by the second term or terms. If you have
35538 more concepts you want to include in your search, you can click the
35539 [+] to add another line for your search.</para>
35541 <para>A sample search is shown next, followed by its results:</para>
35544 <screeninfo>Advanced Search</screeninfo>
35548 <imagedata fileref="images/searching/advsearch.png"/>
35554 <screeninfo>Results from Advanced Search</screeninfo>
35558 <imagedata fileref="images/searching/numresults.png"/>
35563 <para>When you use the Boolean operators to broaden or narrow a
35564 search, remember the action of each operator. The 'and' operator
35565 narrows the results you'll retrieve because the search will retrieve
35566 the records that include all your search terms. The 'or' operator
35567 expands the results because the search will look for occurrences of
35568 all of your search terms. The 'not' operator excludes records with the
35569 term that follows the operator.</para>
35571 <para>Note: If you leave this <link
35572 linkend="expandedSearchOption">expandedSearchOption</link> set to
35573 'don't show', this is the display you will see:</para>
35576 <screeninfo>Fewer Search Options</screeninfo>
35580 <imagedata fileref="images/searching/feweropts.png"/>
35585 <para>The Advanced Search page then shows the multiple kinds of limits
35586 that can be applied to your search results. Either check a box or
35587 select from the drop down menus to narrow your search. You will type
35588 the year, year range, or a 'greater than (>)' or 'less than (<)'
35592 <screeninfo>Other Advanced Search Options</screeninfo>
35596 <imagedata fileref="images/searching/advoptions.png"/>
35601 <para>Finally, you can choose how the results will be sorted. The
35602 pre-defined sort options are in the final area of the Advanced Search
35606 <screeninfo>Sort Results By</screeninfo>
35610 <imagedata fileref="images/searching/advsortby.png"/>
35615 <para>The default sort is by relevance, although you can choose to
35616 sort by author, by title, by call number, by dates, or by popularity.
35617 If you would prefer a different default sort, you can set <link
35618 linkend="defaultSortField">defaultSortField</link> to one of the other
35619 choices in Administration > System Preferences >
35623 <section id="searchguide-ccl">
35624 <title>Common Command Language Searching</title>
35626 <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
35627 internal search protocol. Searches initiated in the graphical
35628 interface use this protocol as well, although the searcher doesn't
35629 know which indexes, operators and limiters are available and being
35630 used to conduct their search. The searcher can use the Advanced Search
35631 when more precise results set are desired and where the search indexes
35632 are somewhat known. However, some library users and many library staff
35633 prefer using a command based structure. This part of the document will
35634 present and explain the use of the Koha command based structure. The
35635 indexes, operators, and limiters used are identical to those used in
35636 the graphical interface.</para>
35638 <section id="searchguide-indexes">
35639 <title>Indexes</title>
35641 <para>The CCL standard itself doesn't specify a particular set of
35642 qualifiers (indexes), but it does suggest a few short-hand notations
35643 such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
35644 it's possible to customize that set by adding needed indexes based
35645 on local requirements. A qualifier (index) maps to a particular
35646 use-attribute within the Z39.50 BIB-1 attribute set. The complete
35647 Z39.50 Bib-1 Attribute can be viewed at <ulink
35648 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
35650 <para>The standard Koha set of indexes is a fairly common example of
35651 MARC21 indexing rules. The indexes that are defined in Koha are
35652 indexes typically used by other integrated library systems. The
35653 defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
35655 <table cellpadding="4" cellspacing="4" frame="all">
35656 <title>Attributes</title>
35658 <tgroup align="left" cols="2" colsep="1" rowsep="1">
35661 <entry>Bib-1 Attribute</entry>
35663 <entry>Qualifier (index)</entry>
35669 <entry>Personal-name</entry>
35675 <entry>Corporate-name</entry>
35681 <entry>Conference-name</entry>
35687 <entry>Title</entry>
35693 <entry>Title-series</entry>
35699 <entry>Title-uniform</entry>
35705 <entry>ISBN</entry>
35711 <entry>ISSN</entry>
35717 <entry>Local number</entry>
35723 <entry>Local-classification</entry>
35725 <entry>lcn and callnum</entry>
35729 <entry>Subject</entry>
35731 <entry>su, su-to, su-geo, su-ut</entry>
35735 <entry>Pubdate</entry>
35737 <entry>yr,pubdate</entry>
35741 <entry>Date-of-Acquisition</entry>
35743 <entry>acqdate</entry>
35747 <entry>Language</entry>
35753 <entry>Place-of-publication</entry>
35759 <entry>Abstract</entry>
35765 <entry>Notes</entry>
35771 <entry>Record-type</entry>
35773 <entry>rtype, mc-rtype, mus</entry>
35777 <entry>Author</entry>
35779 <entry>au, aut</entry>
35783 <entry>Subject-person-name</entry>
35785 <entry>su-na</entry>
35789 <entry>Any (keyword)</entry>
35795 <entry>Publisher</entry>
35801 <entry>Content-type</entry>
35803 <entry>ctype</entry>
35807 <entry>Koha-Auth-Number</entry>
35813 <entry>Author-personal-bibliography</entry>
35819 <entry>Author-in-order</entry>
35827 <para>Refer to the <link linkend="kohasearchindexes">Koha Indexing Chart</link> for the
35828 MARC21 tags mapped to each Bib-1 Attribute and index combination.</para>
35830 <section id="search-audexamp">
35831 <title>Audience Examples</title>
35835 <para>aud:a Preschool</para>
35838 <para>aud:b Primary</para>
35841 <para>aud:c Pre-Adolescent</para>
35844 <para>aud:d Adolescent</para>
35848 <para>aud:e Adult</para>
35851 <para>aud:f Specialized</para>
35854 <para>aud:g General</para>
35857 <para>aud:j Juvenile</para>
35862 <section id="search-contentsexamp">
35863 <title>Contents Examples</title>
35867 <para>fic:1 Fiction</para>
35871 <para>fic:0 Non Fiction</para>
35875 <para>bio:b Biography</para>
35879 <para>mus:j Musical recording</para>
35883 <para>mus:I Non musical record</para>
35889 <section id="searchguide-syntax">
35890 <title>Search Syntax</title>
35892 <para>In the persistent search box, single words generally retrieve
35893 large sets. To narrow a search, you can use multiple words. Koha
35894 automatically uses the 'and' Boolean operator to create a set of
35895 records matching your input. When you want to narrow the search to
35896 an author or a title or a subject or some other specific field or
35897 use a Boolean operator, there isn't an obvious way to accomplish
35898 that specificity. The library user can, of course, go to the
35899 Advanced Search page; however, if you know how to construct a CCL
35900 search, you can achieve more specificity while using the persistent
35901 search box on any page.</para>
35903 <para>There is a specific order to the CCL search syntax. Although
35904 it can be used for simple searches, it is an especially effective
35905 way to perform complex searches, as it affords you a great deal of
35906 control over your search results. To construct a CCL search, first
35907 enter a desired index code, then an equal sign, followed by your
35908 search word(s). Following are examples of simple CCL
35913 <para>ti=principles of accounting</para>
35917 <para>au=brown joseph</para>
35921 <para>su=poetry</para>
35925 <para>su-na=Shakespeare</para>
35929 <para>kw=marlin</para>
35933 <para>You can refine your search by combining search terms with
35934 Boolean operators 'and', 'or', or 'not'. Following are examples of
35935 searches using Boolean operators.</para>
35939 <para>ti=principles of accounting and au=brown joseph</para>
35943 <para>su=poetry not su-na=Shakespeare</para>
35947 <para>kw=communication and su=debate</para>
35951 <para>You can also choose to search for things that start with a
35952 character or series of characters</para>
35956 <para>ti,first-in-subfield=C (will show you all titles that
35957 start with the letter 'C')</para>
35961 <para>Other string location searches can be performed with the
35962 following keywords:</para>
35966 <para>rtrn : right truncation</para>
35970 <para>ltrn : left truncation</para>
35974 <para>lrtrn : left and right truncation</para>
35978 <para>st-date : type date</para>
35982 <para>st-numeric : type number (integer)</para>
35986 <para>ext : exact search on whole subfield (does not work with
35991 <para>phr : search on phrase anywhere in the subfield</para>
35995 <para>startswithnt : subfield starts with</para>
35999 <para>Using specific indexes and Boolean operators are not the only
36000 way a search can be refined. You can also refine your search as a
36001 phrase when looking for a title, author, or subject. The syntax for
36002 this search is <emphasis>index,phr=search words</emphasis>.</para>
36004 <para>To illustrate the results of various search types, a search
36005 was done for the words 'supreme court'. The results illustrate that
36006 the search index and the word order make a difference in search
36007 results. Only the results count and the search itself is in these
36008 examples. The search executed will always be between the single
36012 <screeninfo>Sample Search 1</screeninfo>
36016 <imagedata fileref="images/searching/ex1.png"/>
36022 <screeninfo>Sample Search 2</screeninfo>
36026 <imagedata fileref="images/searching/ex2.png"/>
36032 <screeninfo>Sample Search 3</screeninfo>
36036 <imagedata fileref="images/searching/ex3.png"/>
36042 <screeninfo>Sample Search 4</screeninfo>
36046 <imagedata fileref="images/searching/ex4.png"/>
36052 <screeninfo>Sample Search 5</screeninfo>
36056 <imagedata fileref="images/searching/ex5.png"/>
36062 <screeninfo>Sample Search 6</screeninfo>
36066 <imagedata fileref="images/searching/ex6.png"/>
36072 <screeninfo>Sample Search 7</screeninfo>
36076 <imagedata fileref="images/searching/ex7.png"/>
36082 <screeninfo>Sample Search 8</screeninfo>
36086 <imagedata fileref="images/searching/ex8.png"/>
36092 <screeninfo>Sample Search 9</screeninfo>
36096 <imagedata fileref="images/searching/ex9.png"/>
36101 <para>You can also choose to use limiters in your search query. Some
36102 common limiters include dates, languages, record types, and item
36103 types. In the Advance Search, you can either click a box or key in
36104 data to limit your search. You can also apply the same limits with
36105 CCL by using the syntax in the following examples. In all</para>
36107 <para><emphasis>By Date: su=supreme court and
36108 yr,st-numeric=>2000</emphasis></para>
36111 <screeninfo>Sample Search 10</screeninfo>
36115 <imagedata fileref="images/searching/ex10.png"/>
36120 <para>When you limit by date, you can use the '>' (greater than),
36121 '<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
36124 <para><emphasis>By Item Type: su=nursing and
36125 itype:BK</emphasis></para>
36128 <screeninfo>Sample Search 11</screeninfo>
36132 <imagedata fileref="images/searching/ex11.png"/>
36137 <para>Each library will have a different set of item types defined
36138 in their circulation configuration. When you set up item types, you
36139 define a code and a name for each one. The name will appear on the
36140 Advance Search page. The code you assigned is used as a CCL search
36141 limit, formatted as 'itype:x', where 'x' is the assigned code. The
36142 initial set of item types in Koha will usually be edited to reflect
36143 your collections, so your item type limiters may be different than
36144 the initial ones. The initial item type limiters follow.</para>
36148 <para>itype:BKS Books, Booklets, Workbooks</para>
36152 <para>itype:SR Audio Cassettes, CDs</para>
36156 <para>itype:IR Binders</para>
36160 <para>itype:CF CD-ROMs, DVD-ROMs, General Online
36165 <para>itype:VR DVDs, VHS</para>
36169 <para>itype:KT Kit</para>
36173 <para>itype:AR Models</para>
36177 <para>itype:SER Serials</para>
36181 <para><emphasis>By format: su=supreme court not
36182 l-format:sr</emphasis></para>
36185 <screeninfo>Sample Search 12</screeninfo>
36189 <imagedata fileref="images/searching/ex12.png"/>
36194 <para>The format limiters are derived from a combination of LDR, 006
36195 and 007 positions. The formats that are currently defined are the
36200 <para>l-format:ta Regular print</para>
36204 <para>l-format:tb Large print</para>
36208 <para>l-format:fk Braille</para>
36212 <para>l-format:sd CD audio</para>
36216 <para>l-format:ss Cassette recording</para>
36220 <para>l-format:vf VHS tape</para>
36224 <para>l-format:vd DVD video</para>
36228 <para>l-format:co CD software</para>
36232 <para>l-format:cr Website</para>
36236 <para><emphasis>By content type: su=supreme court not
36237 ctype:l</emphasis></para>
36240 <screeninfo>Sample Search 13</screeninfo>
36244 <imagedata fileref="images/searching/ex13.png"/>
36249 <para>The content types are taken from the 008 MARC tag, positions
36252 <para>There are two other limiter types that are not described in
36253 this document. They are: Audience and Content. The only difference
36254 in the syntax of the CCL is the actual limiter. They are reproduced
36255 here just in case you would like to use these limiters.</para>
36260 <section id="kohasearchindexes">
36261 <title>Koha Search Indexes</title>
36263 <para>By default, not all fields are indexed in the Zebra search engine,
36264 but many are. Below are the MARC21 fields that are indexed in
36267 <table cellpadding="4" cellspacing="4" frame="all">
36268 <title>Indexes</title>
36270 <tgroup align="left" cols="2" colsep="1" rowsep="1">
36273 <entry><para>Field</para></entry>
36275 <entry><para>Description</para></entry>
36281 <entry><para>001</para></entry>
36283 <entry><para>Control-number</para></entry>
36287 <entry><para>005</para></entry>
36289 <entry><para>Date/time-last-modified</para></entry>
36293 <entry><para>007</para></entry>
36295 <entry><para>Microform-generation:n:range(data,11,1),
36296 Material-type,ff7-00:w:range(data,0,1),
36297 ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
36298 ff7-01-02:w:range(data,0,2)</para></entry>
36302 <entry><para>008</para></entry>
36304 <entry><para>date-entered-on-file:n:range(data,0,5),
36305 date-entered-on-file:s:range(data,0,5),
36306 pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
36307 pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
36308 pl:w:range(data,15,3), ta:w:range(data,22,1),
36309 ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
36310 lf:w:range(data,33,1), bio:w:range(data,34,1),
36311 ln:n:range(data,35,3), ctype:w:range(data,24,4),
36312 Record-source:w:range(data,39,0)</para></entry>
36316 <entry><para>010</para></entry>
36318 <entry><para>LC-card-number, Identifier-standard</para></entry>
36322 <entry><para>011</para></entry>
36324 <entry><para>LC-card-number, Identifier-standard</para></entry>
36328 <entry><para>015</para></entry>
36330 <entry><para>BNB-card-number, BGF-number, Number-db,
36331 Number-natl-biblio, Identifier-standard</para></entry>
36335 <entry><para>017</para></entry>
36337 <entry><para>Number-legal-deposit,
36338 Identifier-standard</para></entry>
36342 <entry><para>018</para></entry>
36344 <entry><para>Identifier-standard</para></entry>
36348 <entry><para>020$a</para></entry>
36350 <entry><para>ISBN:w, Identifier-standard:w</para></entry>
36354 <entry><para>020</para></entry>
36356 <entry><para>Identifier-standard</para></entry>
36360 <entry><para>022$a</para></entry>
36362 <entry><para>ISSN:w, Identifier-standard:w</para></entry>
36366 <entry><para>022</para></entry>
36368 <entry><para>Identifier-standard</para></entry>
36372 <entry><para>023</para></entry>
36374 <entry><para>Identifier-standard</para></entry>
36378 <entry><para>024$a</para></entry>
36380 <entry><para>Identifier-other</para></entry>
36384 <entry><para>024</para></entry>
36386 <entry><para>Identifier-standard</para></entry>
36390 <entry><para>025</para></entry>
36392 <entry><para>Identifier-standard</para></entry>
36396 <entry><para>027</para></entry>
36398 <entry><para>Report-number, Identifier-standard</para></entry>
36402 <entry><para>028</para></entry>
36404 <entry><para>Number-music-publisher,
36405 Identifier-standard</para></entry>
36409 <entry><para>030</para></entry>
36411 <entry><para>CODEN, Identifier-standard</para></entry>
36415 <entry><para>034</para></entry>
36417 <entry><para>Map-scale</para></entry>
36421 <entry><para>037</para></entry>
36423 <entry><para>Identifier-standard, Stock-number</para></entry>
36427 <entry><para>040</para></entry>
36429 <entry><para>Code-institution, Record-source</para></entry>
36433 <entry><para>041</para></entry>
36435 <entry><para>ln</para></entry>
36439 <entry><para>043</para></entry>
36441 <entry><para>Code-geographic</para></entry>
36445 <entry><para>050$b</para></entry>
36447 <entry><para>LC-call-number:w, LC-call-number:p,
36448 LC-call-number:s</para></entry>
36452 <entry><para>050</para></entry>
36454 <entry><para>LC-call-number:w, LC-call-number:p,
36455 LC-call-number:s</para></entry>
36459 <entry><para>052</para></entry>
36461 <entry><para>Geographic-class</para></entry>
36465 <entry><para>060</para></entry>
36467 <entry><para>NLM-call-number</para></entry>
36471 <entry><para>070</para></entry>
36473 <entry><para>NAL-call-number</para></entry>
36477 <entry><para>080</para></entry>
36479 <entry><para>UDC-classification</para></entry>
36483 <entry><para>082</para></entry>
36485 <entry><para>Dewey-classification:w,
36486 Dewey-classification:s</para></entry>
36490 <entry><para>086</para></entry>
36492 <entry><para>Number-govt-pub</para></entry>
36496 <entry><para>100$9</para></entry>
36498 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
36502 <entry><para>100$a</para></entry>
36504 <entry><para>Author,Author:p, Author:s, Editor,
36505 Author-personal-bibliography, Author-personal-bibliography:p,
36506 Author-personal-bibliography:s</para></entry>
36510 <entry><para>100</para></entry>
36512 <entry><para>Author, Author-title, Author-name-personal, Name,
36513 Name-and-title, Personal-name</para></entry>
36517 <entry><para>110$9</para></entry>
36519 <entry><para>Koha-Auth-Number</para></entry>
36523 <entry><para>110</para></entry>
36525 <entry><para>Author, Author-title, Author-name-corporate, Name,
36526 Name-and-title, Corporate-name</para></entry>
36530 <entry><para>111$9</para></entry>
36532 <entry><para>Koha-Auth-Number</para></entry>
36536 <entry><para>111</para></entry>
36538 <entry><para>Author, Author-title, Author-name-corporate, Name,
36539 Name-and-title, Conference-name</para></entry>
36543 <entry><para>130$n</para></entry>
36545 <entry><para>Thematic-number</para></entry>
36549 <entry><para>130$r</para></entry>
36551 <entry><para>Music-key</para></entry>
36555 <entry><para>130$9</para></entry>
36557 <entry><para>Koha-Auth-Number</para></entry>
36561 <entry><para>130</para></entry>
36563 <entry><para>Title, Title-uniform</para></entry>
36567 <entry><para>210</para></entry>
36569 <entry><para>Title, Title-abbreviated</para></entry>
36573 <entry><para>211</para></entry>
36575 <entry><para>Title, Title-abbreviated</para></entry>
36579 <entry><para>212</para></entry>
36581 <entry><para>Title, Title-other-variant</para></entry>
36585 <entry><para>214</para></entry>
36587 <entry><para>Title, Title-expanded</para></entry>
36591 <entry><para>222</para></entry>
36593 <entry><para>Title, Title-key</para></entry>
36597 <entry><para>240$r</para></entry>
36599 <entry><para>Music-key</para></entry>
36603 <entry><para>240$n</para></entry>
36605 <entry><para>Thematic-number</para></entry>
36609 <entry><para>240</para></entry>
36611 <entry><para>Title:w, Title:p, Title-uniform</para></entry>
36615 <entry><para>243$n</para></entry>
36617 <entry><para>Thematic-number</para></entry>
36621 <entry><para>243$r</para></entry>
36623 <entry><para>Music-key</para></entry>
36627 <entry><para>243</para></entry>
36629 <entry><para>Title:w, Title:p, Title-collective</para></entry>
36633 <entry><para>245$a</para></entry>
36635 <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
36636 Title:w, Title:p, Title:s</para></entry>
36640 <entry><para>245$c</para></entry>
36642 <entry><para>Author, Author-in-order:w, Author-in-order:p,
36643 Author-in-order:s</para></entry>
36647 <entry><para>245$9</para></entry>
36649 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
36653 <entry><para>245</para></entry>
36655 <entry><para>Title:w, Title:p</para></entry>
36659 <entry><para>246</para></entry>
36661 <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
36662 Title-former</para></entry>
36666 <entry><para>247</para></entry>
36668 <entry><para>Title, Title:p, Title-former, Title-other-variant,
36669 Related-periodical</para></entry>
36673 <entry><para>260$a</para></entry>
36675 <entry><para>pl:w, pl:p</para></entry>
36679 <entry><para>260$b</para></entry>
36681 <entry><para>Publisher:w, Publisher:p</para></entry>
36685 <entry><para>260$c</para></entry>
36687 <entry><para>copydate, copydate:s</para></entry>
36691 <entry><para>260</para></entry>
36693 <entry><para>pl</para></entry>
36697 <entry><para>300</para></entry>
36699 <entry><para>Extent:w, Extent:p</para></entry>
36703 <entry><para>400$a</para></entry>
36705 <entry><para>Name-and-title</para></entry>
36709 <entry><para>400$t</para></entry>
36711 <entry><para>Author-title, Name-and-title, Title,
36712 Title-series</para></entry>
36716 <entry><para>400$9</para></entry>
36718 <entry><para>Koha-Auth-Number</para></entry>
36722 <entry><para>400</para></entry>
36724 <entry><para>Author, Author-name-personal, Name,
36725 Personal-name</para></entry>
36729 <entry><para>410</para></entry>
36731 <entry><para>Author, Corporate-name</para></entry>
36735 <entry><para>410$a</para></entry>
36737 <entry><para>Name-and-title</para></entry>
36741 <entry><para>410$t</para></entry>
36743 <entry><para>Author-title, Title, Title-series</para></entry>
36747 <entry><para>410$9</para></entry>
36749 <entry><para>Koha-Auth-Number</para></entry>
36753 <entry><para>410</para></entry>
36755 <entry><para>Author-name-corporate, Name</para></entry>
36759 <entry><para>411</para></entry>
36761 <entry><para>Author, Conference-name</para></entry>
36765 <entry><para>411$a</para></entry>
36767 <entry><para>Name-and-title</para></entry>
36771 <entry><para>411$t</para></entry>
36773 <entry><para>Author-title, Title-series</para></entry>
36777 <entry><para>411</para></entry>
36779 <entry><para>Author-name-corporate, Name</para></entry>
36783 <entry><para>440$a</para></entry>
36785 <entry><para>Title-series:w, Title-series:p</para></entry>
36789 <entry><para>440$9</para></entry>
36791 <entry><para>Koha-Auth-Number</para></entry>
36795 <entry><para>440</para></entry>
36797 <entry><para>Title-series:w, Title-series:p, Title,
36798 Title-series</para></entry>
36802 <entry><para>490$a</para></entry>
36804 <entry><para>Title-series:w, Title-series:p</para></entry>
36808 <entry><para>490</para></entry>
36810 <entry><para>Title, Title-series</para></entry>
36814 <entry><para>490$9</para></entry>
36816 <entry><para>Koha-Auth-Number</para></entry>
36820 <entry><para>500</para></entry>
36822 <entry><para>Note:w, Note:p</para></entry>
36826 <entry><para>502</para></entry>
36828 <entry><para>Material-type</para></entry>
36832 <entry><para>505$r</para></entry>
36834 <entry><para>Author</para></entry>
36838 <entry><para>505$t</para></entry>
36840 <entry><para>Title</para></entry>
36844 <entry><para>505</para></entry>
36846 <entry><para>Note:w, Note:p</para></entry>
36850 <entry><para>510</para></entry>
36852 <entry><para>Indexed-by</para></entry>
36856 <entry><para>520</para></entry>
36858 <entry><para>Abstract:w, Abstract:p</para></entry>
36862 <entry><para>521$a</para></entry>
36864 <entry><para>lex:n</para></entry>
36868 <entry><para>526$c</para></entry>
36870 <entry><para>arl, arl:n</para></entry>
36874 <entry><para>526$d</para></entry>
36876 <entry><para>arp, arp:n</para></entry>
36880 <entry><para>590</para></entry>
36882 <entry><para>Note:w, Note:p</para></entry>
36886 <entry><para>600$a</para></entry>
36888 <entry><para>Name-and-title, Name, Personal-name,
36889 Subject-name-personal, Subject</para></entry>
36893 <entry><para>600$t</para></entry>
36895 <entry><para>Name-and-title, Title, Subject</para></entry>
36899 <entry><para>600$9</para></entry>
36901 <entry><para>Koha-Auth-Number</para></entry>
36905 <entry><para>600</para></entry>
36907 <entry><para>Name, Personal-name, Subject-name-personal,
36908 Subject</para></entry>
36912 <entry><para>610$a</para></entry>
36914 <entry><para>Name-and-title</para></entry>
36918 <entry><para>610$t</para></entry>
36920 <entry><para>Name-and-title, Title</para></entry>
36924 <entry><para>610$9</para></entry>
36926 <entry><para>Koha-Auth-Number</para></entry>
36930 <entry><para>610</para></entry>
36932 <entry><para>Name, Subject, Corporate-name</para></entry>
36936 <entry><para>611</para></entry>
36938 <entry><para>Conference-name</para></entry>
36942 <entry><para>611$a</para></entry>
36944 <entry><para>Name-and-title</para></entry>
36948 <entry><para>611$t</para></entry>
36950 <entry><para>Name-and-title, Title</para></entry>
36954 <entry><para>611$9</para></entry>
36956 <entry><para>Koha-Auth-Number</para></entry>
36960 <entry><para>611</para></entry>
36962 <entry><para>Name, Subject</para></entry>
36966 <entry><para>630$n</para></entry>
36968 <entry><para>Thematic-number</para></entry>
36972 <entry><para>630$r</para></entry>
36974 <entry><para>Music-key</para></entry>
36978 <entry><para>630$9</para></entry>
36980 <entry><para>Koha-Auth-Number</para></entry>
36984 <entry><para>630</para></entry>
36986 <entry><para>Subject</para></entry>
36990 <entry><para>650$9</para></entry>
36992 <entry><para>Koha-Auth-Number</para></entry>
36996 <entry><para>650</para></entry>
36998 <entry><para>Subject, Subject:p</para></entry>
37002 <entry><para>651$9</para></entry>
37004 <entry><para>Koha-Auth-Number</para></entry>
37008 <entry><para>651</para></entry>
37010 <entry><para>Name-geographic, Subject,Subject:p</para></entry>
37014 <entry><para>652$9</para></entry>
37016 <entry><para>Koha-Auth-Number</para></entry>
37020 <entry><para>653$9</para></entry>
37022 <entry><para>Koha-Auth-Number</para></entry>
37026 <entry><para>653</para></entry>
37028 <entry><para>Subject, Subject:p</para></entry>
37032 <entry><para>654$9</para></entry>
37034 <entry><para>Koha-Auth-Number</para></entry>
37038 <entry><para>654</para></entry>
37040 <entry><para>Subject</para></entry>
37044 <entry><para>655$9</para></entry>
37046 <entry><para>Koha-Auth-Number</para></entry>
37050 <entry><para>655</para></entry>
37052 <entry><para>Subject</para></entry>
37056 <entry><para>656$9</para></entry>
37058 <entry><para>Koha-Auth-Number</para></entry>
37062 <entry><para>656</para></entry>
37064 <entry><para>Subject</para></entry>
37068 <entry><para>657$9</para></entry>
37070 <entry><para>Koha-Auth-Number</para></entry>
37074 <entry><para>657</para></entry>
37076 <entry><para>Subject</para></entry>
37080 <entry><para>690$9</para></entry>
37082 <entry><para>Koha-Auth-Number</para></entry>
37086 <entry><para>690</para></entry>
37088 <entry><para>Subject, Subject:p</para></entry>
37092 <entry><para>700$9</para></entry>
37094 <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
37098 <entry><para>700$a</para></entry>
37100 <entry><para>Author, Author:p</para></entry>
37104 <entry><para>700$n</para></entry>
37106 <entry><para>Thematic-number</para></entry>
37110 <entry><para>700$r</para></entry>
37112 <entry><para>Music-key</para></entry>
37116 <entry><para>700$t</para></entry>
37118 <entry><para>Author-title, Name-and-title, Title,
37119 Title-uniform</para></entry>
37123 <entry><para>700</para></entry>
37125 <entry><para>Author, Author-name-corporate,
37126 Author-name-personal, Name, Editor, Personal-name</para></entry>
37130 <entry><para>710</para></entry>
37132 <entry><para>Author, Corporate-name</para></entry>
37136 <entry><para>710$t</para></entry>
37138 <entry><para>Author-title, Name-and-title, Title,
37139 Title-uniform</para></entry>
37143 <entry><para>710$a</para></entry>
37145 <entry><para>Name-and-title</para></entry>
37149 <entry><para>710$9</para></entry>
37151 <entry><para>Koha-Auth-Number</para></entry>
37155 <entry><para>710</para></entry>
37157 <entry><para>Author, Name</para></entry>
37161 <entry><para>711$a</para></entry>
37163 <entry><para>Name-and-title</para></entry>
37167 <entry><para>711$t</para></entry>
37169 <entry><para>Author-title, Title, Title-uniform</para></entry>
37173 <entry><para>711$9</para></entry>
37175 <entry><para>Koha-Auth-Number</para></entry>
37179 <entry><para>711</para></entry>
37181 <entry><para>Author-name-corporate, Name,
37182 Conference-name</para></entry>
37186 <entry><para>730$n</para></entry>
37188 <entry><para>Thematic-number</para></entry>
37192 <entry><para>730$r</para></entry>
37194 <entry><para>Music-key</para></entry>
37198 <entry><para>730$9</para></entry>
37200 <entry><para>Koha-Auth-Number</para></entry>
37204 <entry><para>730</para></entry>
37206 <entry><para>Title, Title-uniform</para></entry>
37210 <entry><para>740</para></entry>
37212 <entry><para>Title, Title-other-variant</para></entry>
37216 <entry><para>773$t</para></entry>
37218 <entry><para>Host-item</para></entry>
37222 <entry><para>780$t</para></entry>
37224 <entry><para>Title</para></entry>
37228 <entry><para>780</para></entry>
37230 <entry><para>Title, Title-former,
37231 Related-periodical</para></entry>
37235 <entry><para>785</para></entry>
37237 <entry><para>Related-periodical</para></entry>
37241 <entry><para>800$a</para></entry>
37243 <entry><para>Name-and-title</para></entry>
37247 <entry><para>800$t</para></entry>
37249 <entry><para>Author-title, Name-and-title, Title,
37250 Title-series</para></entry>
37254 <entry><para>800$9</para></entry>
37256 <entry><para>Koha-Auth-Number</para></entry>
37260 <entry><para>800</para></entry>
37262 <entry><para>Author, Author-name-personal, Name,
37263 Personal-name</para></entry>
37267 <entry><para>810$a</para></entry>
37269 <entry><para>Name-and-title</para></entry>
37273 <entry><para>810$t</para></entry>
37275 <entry><para>Author-title, Name-and-title, Title,
37276 Title-series</para></entry>
37280 <entry><para>810$9</para></entry>
37282 <entry><para>Koha-Auth-Number</para></entry>
37286 <entry><para>810</para></entry>
37288 <entry><para>Author, Corporate-name, Author-name-corporate,
37289 Name</para></entry>
37293 <entry><para>811$a</para></entry>
37295 <entry><para>Name-and-title</para></entry>
37299 <entry><para>811$9</para></entry>
37301 <entry><para>Koha-Auth-Number</para></entry>
37305 <entry><para>811$t</para></entry>
37307 <entry><para>Author-title, Name-and-title, Title,
37308 Title-series</para></entry>
37312 <entry><para>811</para></entry>
37314 <entry><para>Author, Author-name-corporate, Name,
37315 Conference-name</para></entry>
37319 <entry><para>830$9</para></entry>
37321 <entry><para>Koha-Auth-Number</para></entry>
37325 <entry><para>830</para></entry>
37327 <entry><para>Title, Title-series</para></entry>
37331 <entry><para>840</para></entry>
37333 <entry><para>Title, Title-series</para></entry>
37337 <entry><para>999$c</para></entry>
37339 <entry><para>Local-Number:n, Local-Number:w,
37340 Local-Number:s</para></entry>
37344 <entry><para>999$d</para></entry>
37346 <entry><para>biblioitemnumber:n, biblioitemnumber:w,
37347 biblioitemnumber:s</para></entry>
37351 <entry><para>942$0</para></entry>
37353 <entry><para>totalissues:n, totalissues:s</para></entry>
37357 <entry><para>942$2</para></entry>
37359 <entry><para>cn-bib-source</para></entry>
37363 <entry><para>942$6</para></entry>
37365 <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
37369 <entry><para>942$c</para></entry>
37371 <entry><para>itemtype:w</para></entry>
37375 <entry><para>942$n</para></entry>
37377 <entry><para>Suppress:w, Suppress:n</para></entry>
37381 <entry><para>942$h</para></entry>
37383 <entry><para>cn-class</para></entry>
37387 <entry><para>942$i</para></entry>
37389 <entry><para>cn-item</para></entry>
37393 <entry><para>942$k</para></entry>
37395 <entry><para>cn-prefix</para></entry>
37399 <entry><para>942$m</para></entry>
37401 <entry><para>cn-suffix</para></entry>
37405 <entry><para>952$0</para></entry>
37407 <entry><para>withdrawn:n, withdrawn:w</para></entry>
37411 <entry><para>952$1</para></entry>
37413 <entry><para>lost, lost:n</para></entry>
37417 <entry><para>952$2</para></entry>
37419 <entry><para>classification-source</para></entry>
37423 <entry><para>952$3</para></entry>
37425 <entry><para>materials-specified</para></entry>
37429 <entry><para>952$4</para></entry>
37431 <entry><para>damaged:n, damaged:w</para></entry>
37435 <entry><para>952$5</para></entry>
37437 <entry><para>restricted:n, restricted:w</para></entry>
37441 <entry><para>952$6</para></entry>
37443 <entry><para>cn-sort:n, cn-sort:s</para></entry>
37447 <entry><para>952$7</para></entry>
37449 <entry><para>notforloan:n, notforloan:w</para></entry>
37453 <entry><para>952$8</para></entry>
37455 <entry><para>ccode</para></entry>
37459 <entry><para>952$9</para></entry>
37461 <entry><para>itemnumber:n, itemnumber:s</para></entry>
37465 <entry><para>952$a</para></entry>
37467 <entry><para>homebranch</para></entry>
37471 <entry><para>952$b</para></entry>
37473 <entry><para>holdingbranch</para></entry>
37477 <entry><para>952$c</para></entry>
37479 <entry><para>location</para></entry>
37483 <entry><para>952$d</para></entry>
37485 <entry><para>Date-of-acquisition, Date-of-acquisition:d,
37486 Date-of-acquisition:s</para></entry>
37490 <entry><para>952$e</para></entry>
37492 <entry><para>acqsource</para></entry>
37496 <entry><para>952$f</para></entry>
37498 <entry><para>coded-location-qualifier</para></entry>
37502 <entry><para>952$g</para></entry>
37504 <entry><para>price</para></entry>
37508 <entry><para>952$j</para></entry>
37510 <entry><para>stack:n, stack:w</para></entry>
37514 <entry><para>952$l</para></entry>
37516 <entry><para>issues:n, issues:w, issues:s</para></entry>
37520 <entry><para>952$m</para></entry>
37522 <entry><para>renewals:n, renewals:w</para></entry>
37526 <entry><para>952$n</para></entry>
37528 <entry><para>reserves:n, reserves:w</para></entry>
37532 <entry><para>952$o</para></entry>
37534 <entry><para>Local-classification:w, Local-classification:p,
37535 Local-classification:s</para></entry>
37539 <entry><para>952$p</para></entry>
37541 <entry><para>barcode, barcode:n</para></entry>
37545 <entry><para>952$q</para></entry>
37547 <entry><para>onloan:n, onloan:w</para></entry>
37551 <entry><para>952$r</para></entry>
37553 <entry><para>datelastseen</para></entry>
37557 <entry><para>952$s</para></entry>
37559 <entry><para>datelastborrowed</para></entry>
37563 <entry><para>952$t</para></entry>
37565 <entry><para>copynumber</para></entry>
37569 <entry><para>952$u</para></entry>
37571 <entry><para>uri:u</para></entry>
37575 <entry><para>952$v</para></entry>
37577 <entry><para>replacementprice</para></entry>
37581 <entry><para>952$w</para></entry>
37583 <entry><para>replacementpricedate</para></entry>
37587 <entry><para>952$y</para></entry>
37589 <entry><para>itype:w</para></entry>
37593 <entry><para>952$z</para></entry>
37595 <entry><para>Note:w, Note:p</para></entry>
37603 <chapter id="aboutkoha">
37604 <title>About Koha</title>
37606 <para>The 'About Koha' area will give you important server information as
37607 well as general information about Koha.</para>
37611 <para><emphasis>Get there:</emphasis> More > About Koha</para>
37615 <section id="aboutserver">
37616 <title>Server Information</title>
37618 <para>Under the 'Server Information' tab you will find information about
37619 the Koha version and the machine you have installed Koha on. This
37620 information is very important for debugging problems. When reporting
37621 issues to your support provider or to the various other support avenues
37622 (mailing lists, chat room, etc), it's always good to give the
37623 information from this screen.</para>
37626 <screeninfo>Server Information on Koha</screeninfo>
37630 <imagedata fileref="images/about/aboutserver.png"/>
37636 <section id="aboutserverperl">
37637 <title>Perl Modules</title>
37639 <para>In order to take advantage of all of the functionalities of Koha,
37640 you will need to keep your Perl modules up to date. The 'Perl Modules'
37641 tab will show you all of the modules required by Koha, the version you
37642 have installed and whether you need to upgrade certain modules.</para>
37645 <screeninfo>Perl Modules</screeninfo>
37649 <imagedata fileref="images/about/aboutperlmodules.png"/>
37654 <para>Items listed in bold are required by Koha, items highlighed in red
37655 are missing completely and items highlighted in yellow simply need to be
37659 <section id="aboutsystem">
37660 <title>System Information</title>
37662 <para>This tab will provide you with warnings if you are using system
37663 preferences that have since been deprecated or system preferences that
37664 you have set without other required preferences</para>
37667 <screeninfo>System Information</screeninfo>
37671 <imagedata fileref="images/about/systeminfo.jpg"/>
37678 <chapter id="implementation">
37679 <title>Implementation Checklist</title>
37681 <para>The following guide will walk you through the areas of Koha you need
37682 to look at in order to prepare to start using the system.</para>
37684 <section id="imp-migration">
37685 <title>Data Migration</title>
37687 <para>Before you can start using Koha you'll need to have some data.
37688 This can be done by entering it all by hand, but most people already
37689 have their data in electronic format of some sort and just need to
37690 reformat it a bit for importing into Koha.</para>
37694 <para>Create a list of libraries and enter their info and codes into
37695 <link linkend="libsgroups">Libraries & Groups</link></para>
37699 <para>Define your list of <link linkend="itemtypeadmin">Item
37700 Types</link></para>
37704 <para>Define you patron categories and enter the categories and
37705 their codes into <link linkend="patcats">Patron
37706 Categories</link></para>
37710 <para>Enter any additional patron information fields you use in your
37711 library in the <link linkend="patronattributetypes">Patron
37712 Attributes</link></para>
37716 <para>Requires that you first set the <link
37717 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
37718 system preference if you have custom fields</para>
37724 <para>Define all of your <link linkend="authorizedvalues">Authorized
37725 Values</link></para>
37729 <para><link linkend="ccode">Collection codes</link></para>
37733 <para><link linkend="shelvelocvals">Shelving
37734 locations</link></para>
37738 <para>Item statuses (<link linkend="lost">lost</link>, <link linkend="notforloan">not
37739 for loan</link>, <link linkend="damageauth">damaged</link>, <link
37740 linkend="withdrawnauth">withdrawn</link>)</para>
37744 <para>Plus any others that are needed in your library</para>
37750 <para>Optionally define <link linkend="citytowns">City/State/Postal Code</link> combos and
37751 <link linkend="roadtypes">Road Types</link> for patron entry</para>
37755 <para><link linkend="kohamarcmapping">Map your bibliographic
37756 data</link> from your legacy system to Koha fields and migrate
37757 (remembering to use the collection, shelving, item type and library
37758 codes you entered in the above setting areas)</para>
37762 <para><link linkend="patronimport">Map your patron data</link> from
37763 your legacy system to the Koha fields and migrate (remembering to
37764 use the patron and library codes you defined above)</para>
37768 <para>Test your migrated data to be sure that everything is as you
37769 expect it to be, some things to test include:</para>
37773 <para>Check some of your titles with diacritics and make sure
37774 that they migrated properly.</para>
37778 <para>Check titles in a series and make sure that series
37779 information migrated properly.</para>
37783 <para>Make sure that your patrons have their contact information
37784 in the right fields.</para>
37788 <para>If your serials data was migrated search for these records
37789 in the catalog and confirm that they look right.</para>
37793 <para>If your serials data was migrated search for these records
37794 in the serials module and confirm that they look right.</para>
37798 <para>Check marc records to verify a variety of items are
37799 cataloged correctly</para>
37803 <para>Check cataloging process to see if all necessary fields
37804 are available</para>
37808 <para>If fines are migrated, check to see that they are applied
37813 <para>If holds are migrated, check to see they are accurate in
37814 catalog and patron record</para>
37821 <section id="impadmin">
37822 <title>Admin Configuration</title>
37824 <para>Most of these preferences won't need to be changed to use your
37825 Koha system, but there are a few that you might want to
37830 <para>If your library uses CAS Authentication, you'll want to set
37831 the various <link linkend="casauthentication">CAS system
37832 preferences</link></para>
37836 <para>Administration System Preferences</para>
37841 linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
37842 This is the email address that will be used by the system in
37843 'from' lines and to send errors to if there is no email set for
37848 <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
37849 Decide if you want to show item type icons in the staff client
37854 <para><link linkend="delimiter">delimiter</link> : This value
37855 will be put in between fields when exporting data from
37860 <para><link linkend="virtualshelves">virtualshelves</link> :
37861 Decide if you want the staff and/or patrons to use lists in
37866 <para><link linkend="insecure">insecure</link> : If your system
37867 is behind a local firewall, you can set it to no require log in
37868 for the staff client</para>
37872 <para><link linkend="AutoLocation">AutoLocation</link> : Require
37873 staff to log in to the staff client from a specific IP
37879 linkend="IndependantBranches">IndependantBranches</link> :
37880 Prevent librarians from editing content that belongs to other
37887 <para>Go through the <link linkend="logs">Log System
37888 Preferences</link> and decide which actions you want to keep track
37889 of in the logs</para>
37894 <section id="implocal">
37895 <title>Localization Configuration</title>
37897 <para>Koha is used worldwide and so you need to make sure you set your
37898 localization preferences so that options throughout Koha appear properly
37899 for your location/language.</para>
37903 <para>Localization/Internationalization System Preferences</para>
37907 <para><link linkend="dateformat">dateformat</link> : Decide how
37908 dates are displayed throughout Koha</para>
37913 linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
37914 Decide if patrons can choose what language the OPAC appears
37919 <para><link linkend="opaclanguages">opaclanguages</link> :
37920 Decide which languages the patrons can choose from</para>
37926 <para><link linkend="languagepref">language</link> : Decide
37927 which languages appear in the staff client</para>
37932 linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
37933 Define your first day of the week</para>
37940 <section id="impcirc">
37941 <title>Circulation Configuration</title>
37943 <para>Before you start circulating your collection you'll need to set up
37944 your rules and preferences for circulation.</para>
37948 <para>Define you <link linkend="circfinerules">Circulation/Fine
37949 rules</link></para>
37953 <para>Enter the <link linkend="calholidays">days your library is
37954 closed</link> for fines and due date calculations</para>
37958 <para>Circulation System Preferences</para>
37962 <para><link linkend="CircControl">CircControl</link> : Define
37963 whether circ rules are based on item's location, patron's
37964 location or transaction location</para>
37968 <para><link linkend="useDaysMode">useDaysMode</link> : Define
37969 how due dates are calculated</para>
37973 <para><link linkend="finesCalendar">finesCalendar</link> :
37974 Define how fines are calculated (for every late date or only for
37975 days the library is open)</para>
37979 <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> :
37980 Decide if staff are allowed to override due dates on
37986 linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
37987 Decide if items are sent back to the owning branch when checked
37993 linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
37994 : Decide how items checked out today display on the patron
38000 linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
38001 : Decide how items checked out prior to today display on the
38002 patron record</para>
38006 <para><link linkend="noissuescharge">noissuescharge</link> :
38007 Define the maximum amount a patron can owe before checkouts are
38013 linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
38014 if patrons need to return items before their accounts
38019 <para><link linkend="AllowOnShelfHolds">AllowOnShelfHolds</link>
38020 : Decide if patrons can place holds on items that are marked as
38021 being available</para>
38026 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
38027 : Decide if you want the staff to be able to override the
38028 setting for the above at checkout</para>
38035 linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
38036 : Decide if patrons can place holds on items that are marked as
38042 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
38043 : Decide if you want the staff to be able to override the
38044 setting for the above at checkout</para>
38050 <para><link linkend="maxreserves">maxreserves</link> : Decide
38051 how many items a patron can have on hold at once</para>
38056 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
38057 : Decide if you want the staff to be able to override the
38058 setting for the above at checkout</para>
38064 <para><link linkend="maxoutstanding">maxoutstanding</link> :
38065 Define the maximum amount a patron can owe before holds are
38071 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
38072 : Decide if you want the staff to be able to override the
38073 setting for the above at checkout</para>
38080 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
38081 Define the number of days before a hold expires</para>
38085 <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
38086 : Decide if you want to use the built in web-based self-checkout
38092 linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
38093 Decide if the self-checkout system requires login</para>
38098 linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
38099 : Decide if you want patron images to show on the self
38100 checkout screen</para>
38107 linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
38108 : Decide if you want the staff to be able to checkout items
38109 marked as 'not for loan'</para>
38114 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
38115 : Decide if you want staff to override the limit put on
38120 <para><link linkend="AllowFineOverride">AllowFineOverride</link>
38121 : Decide if you want staff to be able to override fine
38126 <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
38127 : Decide what date renewals are based on</para>
38131 <para><link linkend="finesMode">finesMode</link> : Switch to
38132 'Calculate and Charge' before go live if you charge fines</para>
38136 <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
38137 If you want to receive a copy of every overdue notice sent out,
38138 enter your email address here</para>
38143 linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
38144 : Decide if you want an email every time a hold is placed</para>
38149 linkend="ReservesControlBranch">ReservesControlBranch</link> :
38150 Decide which branch's hold rules are considered first</para>
38154 <para><link linkend="soundon">soundon</link> : Decide if you
38155 want to have sounds on for circulation actions</para>
38160 linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
38161 : If you have a large amount of overdues, you might want to turn
38162 this preference on so as to allow you to filter before results
38168 linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
38169 : If you have a lot of staff members sharing one circ computer
38170 you might want to enable this so that staff can clear the screen
38171 in between checkouts to protect patron's privacy</para>
38176 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
38177 Decide how you want Koha to react if you scan in a blank barcode
38178 on the checkout screen</para>
38183 linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
38184 and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
38185 : Decide if you want patrons and/or staff to be able to suspend
38191 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
38192 : If you allow holds to be suspended decide if you want them
38193 to automatically resume on the date entered by the staff
38194 and/or patron</para>
38202 <para>Customize your <link linkend="notices">Notices &
38203 Slips</link></para>
38207 <para>Define your <link linkend="noticetriggers">Overdue Notice
38208 Triggers</link></para>
38212 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
38216 <para>Populate <link linkend="buildholdscron">your holds
38217 queue</link> (every 1-4 hours)</para>
38221 <para>Decide <link linkend="expiredholdscron">when holds
38222 expire</link> (daily)</para>
38226 <para><link linkend="finescronjob">Calculate fines due</link>
38231 <para>Fines on hourly loans will calculate when you check
38232 the items in</para>
38238 <para><link linkend="longoverduecron">Mark long overdue items as
38239 lost</link> (daily)</para>
38243 <para>Decide when the system <link linkend="msgqueuecron">sends
38244 out messages</link> (1-4 hours)</para>
38248 <para>Decide when the system <link
38249 linkend="overduenoticecron">queues overdue notices</link>
38254 <para>Set up <link linkend="printholdcron">hold notices that
38255 didn't send for printing</link> (daily after overdues and
38256 message queue)</para>
38260 <para>Decide when the system <link
38261 linkend="advnoticecron">queues the advanced notice of items
38262 due</link> (daily)</para>
38266 <para>Find holds that need to be <link
38267 linkend="unsuspendholdcron">resumed and remove suspension</link>
38275 <section id="imppratrons">
38276 <title>Patron Configuration</title>
38278 <para>You have already imported patron data from your old system, but
38279 there are plenty of options available to you regarding patrons and their
38284 <para>Enter your <link linkend="addstaffpatron">staff members as
38285 patrons</link></para>
38289 <para>Define <link linkend="patronpermissions">staff members
38290 access permissions</link></para>
38296 <para>Patron System Preferences</para>
38300 <para><link linkend="AddPatronLists">AddPatronLists</link> :
38301 Decide how patron categories appear when creating a new
38306 <para><link linkend="autoMemberNum">autoMemberNum</link> :
38307 Decide if the patrons barcodes are auto-generated or if you
38308 enter them yourself</para>
38312 <para><link linkend="MaxFine">MaxFine</link> : Determine the
38313 maximum amount that people can owe in fines</para>
38318 linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
38319 : Decide when to warn staff that the patron account is about to
38325 linkend="intranetreadinghistory">intranetreadinghistory</link> :
38326 Decide if the staff can see the patron's reading/checkout
38332 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
38333 List fields that you want to appear as mandatory on the patron
38334 add/edit form</para>
38338 <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
38339 Add or change the titles for your patrons</para>
38344 linkend="borrowerRelationship">borrowerRelationship</link> : Add
38345 or change borrower relationships (child to adult and
38346 professional to organization)</para>
38351 linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
38352 : Determine if the patrons get an email confirming the creation
38353 of their account</para>
38358 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
38359 : Decide if patrons can choose from a series of notices (other
38360 than overdues)</para>
38364 <para><link linkend="patronimages">patronimages</link> : Decide
38365 if you want to save patron images in your system</para>
38370 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
38371 : Decide if you want to enable custom patron fields</para>
38375 <para><link linkend="minPasswordLength">minPasswordLength</link>
38376 : Enter the minimum number of characters you want passwords to
38382 linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
38383 Decide what fields your library doesn't need to see on the
38384 patron entry form</para>
38391 <section id="impcatalog">
38392 <title>Cataloging Configuration</title>
38394 <para>Before you start cataloging in Koha you'll want to set up your
38395 preferences and other rules.</para>
38399 <para>Define your cataloging templates aka <link
38400 linkend="marcbibframeworks">MARC Bibliographic
38401 Frameworks</link></para>
38405 <para>Run the <link linkend="marcbibframeworkstest">MARC
38406 Bibliographic Framework Test</link> to be sure your changes are
38413 <para>Define any <link linkend="authorizedvalues">authorized
38414 values</link> you might want to use in cataloging</para>
38418 <para>Set up <link linkend="classificationsources">custom
38419 classification sources</link> (if you use something other than the
38424 <para>Set up <link linkend="recordmatchingrules">MARC matching rules</link> for importing
38425 records from mrc files or Z39.50</para>
38429 <para>Set up <link linkend="keywordmapping">Koha to Keyword
38430 mapping</link> for deciding how to display marc fields to the screen
38431 (still in beta - only one field)</para>
38435 <para>Set up the <link linkend="z3950admin">Z39.50 targets</link> you want to search for
38436 cataloging (and acquisitions)</para>
38440 <para>Cataloging System Preferences</para>
38444 <para><link linkend="URLLinkText">URLLinkText</link> : Enter
38445 text to display when 856 fields do not have pre-defined
38450 <para><link linkend="hide_marc">hide_marc</link> : If you are
38451 unfamiliar with MARC you can have the MARC fields number
38456 <para><link linkend="LabelMARCView">LabelMARCView</link> :
38457 Choose how you want duplicate fields to appear on the
38463 linkend="DefaultClassificationSource">DefaultClassificationSource</link>
38464 : Choose which classification source is the default in your
38470 linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
38471 if you need labels to appear on your MARC editor</para>
38475 <para><link linkend="marcflavour">marcflavour</link> : Choose
38476 your MARC format</para>
38480 <para><link linkend="itemcallnumber">itemcallnumber</link> :
38481 Enter which field and subfields to look into for the call
38486 <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
38487 your MARC Organizational Code (not the same as your OCLC
38492 <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
38493 Koha generates item barcodes for you</para>
38497 <para><link linkend="OpacSuppression">OpacSuppression</link> :
38498 Decide if you want to hide items marked as suppressed from the
38499 OPAC search results</para>
38505 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
38509 <para>Decide when the system <link linkend="checkurlcron">checks
38510 URLs in catalog records</link> to see if they are still
38518 <section id="impauthorities">
38519 <title>Authorities Configuration</title>
38521 <para>Koha has the ability to keep track of your authority records and
38522 how they're linked to your bibliographic records. Before using
38523 authorities you should configure several preferences.</para>
38527 <para>Set <link linkend="authoritiesadmin">Authority
38528 Frameworks</link> aka templates</para>
38532 <para>Authority System Preferences</para>
38537 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
38538 Decide if Koha creates authorities when cataloging</para>
38542 <para><link linkend="dontmerge">dontmerge</link> : Decide if
38543 updates to authorities trigger updates to the bibliographic
38544 records that link to them</para>
38549 linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
38550 Decide when authorities are created</para>
38554 <para><link linkend="LinkerModule">LinkerModule</link> : Decide
38555 which match the authority linker should use</para>
38559 <para><link linkend="LinkerOptions">LinkerOptions</link> :
38560 Decide if you want authority linking to be broader or more
38566 linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
38567 Decide if you want to enable authority linking while
38574 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
38578 <para>Choose when the system looks for authorities updates to
38579 <link linkend="mergeauthcron">merge changes into bibliographic
38580 records</link></para>
38587 <section id="impsearching">
38588 <title>Searching Configuration</title>
38590 <para>There are several system preferences related to searching, it is
38591 not always recommended to make too many changes to these preferences
38592 since they are set to get you the most relevant results. If you would
38593 like to change the default way that Koha handles searching, view the
38594 <link linkend="searchingprefs">Searching system preferences</link>
38599 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
38603 <para>Decide how often your <link
38604 linkend="rebuildsearchcron">system rebuilds the search
38605 index</link> (4-10 min)</para>
38611 <para>Searching System Preferences</para>
38616 linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> :
38617 Decide which authorized value fields you want patrons and staff
38618 to be able to limit their advanced searches by</para>
38623 linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
38624 : Decide how you want Koha to handle subject searches in the
38630 linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
38631 : Decide how you want Koha to handle subject searches in the
38637 linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
38638 : Decide how you want Koha to handle subject searches in the
38645 <para><link linkend="displayFacetCount">displayFacetCount</link>
38646 : Decide whether to show facet counts on search results</para>
38653 <section id="impopac">
38654 <title>OPAC Configuration</title>
38656 <para>There are a lot of ways you can customize your OPAC in
38661 <para>Decide how you want your OPAC to look & what content you
38662 want on the main page</para>
38666 <para>Create a library branded stylesheet using CSS</para>
38671 <para>Do not edit the default CSS files, instead create a new
38672 one, that way the system can always fall back on the original
38680 <para>Create a custom XSLT stylesheet to change the way search
38681 results and bib records appear in the OPAC</para>
38685 <para>OPAC System preferences</para>
38689 <para><link linkend="opacuserlogin">opacuserlogin</link> :
38690 Decide if you want to allow patrons to login to the OPAC to
38691 access customized functionality (searching will be allowed
38692 without logging in)</para>
38696 <para><link linkend="RequestOnOpac">RequestOnOpac</link> :
38697 Decide if patrons can place holds via the OPAC</para>
38701 <para><link linkend="OPACItemHolds">OPACItemHolds</link> :
38702 Decide if patrons can place holds on specific items (instead
38703 of just the next available item)</para>
38708 linkend="OpacPasswordChange">OpacPasswordChange</link> :
38709 Decide if patrons can change their password (don't allow
38710 this if you're using LDAP)</para>
38715 linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> :
38716 Decide if patrons can renew their checked out items via the
38722 linkend="opacreadinghistory">opacreadinghistory</link> :
38723 Decide if patrons can view their reading/checkout history
38724 via the OPAC</para>
38728 <para><link linkend="reviewson">reviewson</link> : Decide if
38729 you want to allow patrons to comment on bib records via the
38734 <para><link linkend="OpacStarRatings">OpacStarRatings</link>
38735 : Decide if patrons can leave star ratings</para>
38739 <para><link linkend="virtualshelves">virtualshelves</link> :
38740 Decide if you want patrons to be able to create Lists</para>
38745 linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
38746 : If patrons can create lists then decide if they are
38747 allowed to create public lists</para>
38751 <para><link linkend="suggestionspref">suggestion</link> :
38752 Decide if you want patrons to be able to submit purchase
38758 linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
38759 : Decide if you want patrons to be able to see purchase
38760 suggestions made by other patrons</para>
38766 <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
38767 patrons can save items into their cart</para>
38771 <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
38772 Decide if you want non logged in users to be able to make
38773 purchase suggestions</para>
38778 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> :
38779 Decide if you want to use the XSLT stylesheets on the OPAC
38780 search results</para>
38785 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> :
38786 Decide if you want to use the XSLT stylesheets on the bib
38787 records in the OPAC</para>
38791 <para><link linkend="LibraryName">LibraryName</link> : Enter
38792 your library name for display in the <title> tag and on
38793 the top of the OPAC</para>
38797 <para><link linkend="opacsmallimage">opacsmallimage</link> :
38798 Choose a logo to replace the Koha logo</para>
38802 <para><link linkend="opaccredits">opaccredits</link> : Enter
38803 HTML to appear at the bottom of every page in the OPAC</para>
38807 <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
38808 : Enter HTML that will appear in the center of the main OPAC
38813 <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
38814 will appear to the left on the main OPAC page</para>
38818 <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
38819 HTML that will appear below OpacNav</para>
38823 <para><link linkend="OpacNavRight">OpacNavRight</link> : Enter
38824 HTML that will appear below the login box on the right</para>
38828 <para><link linkend="opacheader">opacheader</link> : Enter the
38829 HTML that will appear above the search box on the OPAC</para>
38834 linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
38835 the HTML that will appear when no results are found</para>
38840 linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
38841 the HTML that will appear below the facets on your search
38846 <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
38847 : Enter the HTML that will appear in the far right of the
38848 circulation summary in the OPAC</para>
38852 <para>Customize your stylesheets:</para>
38856 <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
38857 any additional fields you want to define styles for</para>
38862 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
38863 Point to a CSS file on your Koha server</para>
38868 linkend="opaccolorstylesheet">opaccolorstylesheet</link> :
38869 Point to a CSS file on your Koha server</para>
38876 linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
38877 Decide if you want search terms to be highlighted on the search
38882 <para><link linkend="hidelostitems">hidelostitems</link> :
38883 Decide if you want to show patrons items you have marked as
38888 <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
38889 : Decide what view is the default for bib records on the
38894 <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> : Decide if you want to
38895 enable the shelf browse functionality</para>
38898 <para><link linkend="opacthemes">opacthemes</link> : Choose which theme you would like
38899 to use. If you would like a mobile interface you want to choose CCSR.</para>
38904 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
38905 Decide if URLs clicked in the OPAC are opened in a new
38911 linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
38912 you have a multi-branch system decide if you want patrons to
38913 search their library first</para>
38917 <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
38918 Decide if you want patrons to be able to search your authority
38923 <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if
38924 you want patrons to browse your authority file</para>
38929 linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
38930 Choose which libraries you want patrons to be able to re-run
38931 their search in</para>
38936 linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
38937 : If you're a multi-branch system you can add a pull down to the
38938 search bar for patrons to search which library to search</para>
38943 linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
38944 : Decide if you want the system to keep a search history</para>
38950 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
38954 <para>If you have the <link
38955 linkend="OpacBrowser">OpacBrowser</link> preference set decide
38956 <link linkend="authbrowsercron">when you want the contents to
38957 rebuild</link></para>
38961 <para>If you have <link linkend="customrss">custom RSS
38962 feeds</link>, decide when you want the <link
38963 linkend="customrssfeedcron">feed to be populated</link></para>
38969 <section id="editableopac">
38970 <title>Editable OPAC Regions</title>
38972 <para>Using the OPAC system preferences you can customize various regions, the following
38973 graphics will define what preferences update each regions in the PROG theme.</para>
38976 <screeninfo>OPAC Editable Regions</screeninfo>
38980 <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
38985 <para>An example of a way to customize the page is included as
38989 <screeninfo>Customized Koha OPAC</screeninfo>
38993 <imagedata fileref="images/appendix-opac/opaccustomregions-customized.jpg"/>
39000 <section id="impenhanced">
39001 <title>Enhanced Content Configuration</title>
39003 <para>Koha allows you to pull in content from outside sources to enhance
39004 your bib records. All of this content can be toggled on and off using
39005 the enhanced content system preferences.</para>
39009 <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
39013 <para>If you would like to have your OPAC and/or staff client
39014 show an 'Editions' tab on the bib record, you want to enable one
39015 or the other FRBR preferences and then either one or both of the
39016 ISBN services (XISBN and ThingISBN).</para>
39022 <para><link linkend="amazonprefs">Amazon</link> : This service is
39023 free and just requires that you visit <ulink
39024 url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
39029 <para>Using the Amazon preferences you can choose to show cover
39030 images from Amazon.</para>
39036 <para><link linkend="Babelthequeprefs">Babelthèque</link></para>
39040 <para>This is a pay service. Contact Babelthèque to learn how to
39041 enable this content in the OPAC.</para>
39047 <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
39051 <para>This is a pay service from Baker & Taylor. Contact
39052 Baker & Taylor for the information to enter into these
39053 preferences.</para>
39059 <para><link linkend="googleprefs">Google</link></para>
39063 <para>This service is free and does not require registration,
39064 simply enable GoogleJackets and you're set to go.</para>
39070 <para><link linkend="librarythingprefs">LibraryThing</link></para>
39074 <para>With the exception of ThingISBN, you will need to contact
39075 LibraryThing for the information to enter into these
39080 <para>Enabling ThingISBN will help to populate the editions tab
39081 on the bib record display if you have enabled FRBR.</para>
39087 <para><link linkend="novelistselect">Novelist</link></para>
39091 <para>This is a pay service from Ebsco. Contact Ebsco for the
39092 information to enter into these preferences</para>
39098 <para><link linkend="oclcprefs">OCLC</link></para>
39101 <para>XISBN is used to populate the editions tab on the bib record display if you have
39102 enabled FRBR. This service is free for up to 999 queries a day.</para>
39107 <para><link linkend="OpenLibraryPrefs">Open Library</link><itemizedlist>
39109 <para>Open Library project is an open system that you can pull cover images (and in
39110 the future additional content) from</para>
39112 </itemizedlist></para>
39116 <para><link linkend="Syndeticsprefs">Syndetics</link></para>
39120 <para>This is a pay service from Syndetics to add content for
39121 your bib records. Contact Syndetics for the information to enter
39122 into these preferences.</para>
39128 <para><link linkend="taggingprefs">Tagging</link></para>
39132 <para>Choose whether or not you want to allow patrons to add
39133 tags to records in Koha.</para>
39140 <section id="impacq">
39141 <title>Acquisitions Configuration</title>
39143 <para>When using acquisitions in Koha you first need to define some
39148 <para>Set up your <link linkend="budgetplanning">funds &
39149 budgets</link></para>
39153 <para>Choose your <link linkend="currexchangeadmin">default
39154 currency</link> and enter others if you order from multiple
39159 <para>Enter in your <link linkend="acqvendors">vendor
39160 information</link></para>
39164 <para>Create an <link linkend="marcbibframeworks">Framework with the
39165 code ACQ</link> (if you're going to enter item records at the time
39166 of ordering or receiving)</para>
39170 <para>Acquisitions System preferences</para>
39174 <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
39175 Decide if an item record is created during acquisition</para>
39179 <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
39180 Decide how you want monetary amounts to display</para>
39184 <para><link linkend="gist">gist</link> : Enter your sales tax
39185 (if you are billed for tax)</para>
39189 <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
39190 Decide what format you want your print orders to use</para>
39197 <section id="impserials">
39198 <title>Serials Configuration</title>
39200 <para>When you use serials there are a few options you can set before
39205 <para>Serials System Preferences</para>
39210 linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
39211 : Decide if you want renewing serials to add a suggestion for
39212 easy purchasing</para>
39216 <para><link linkend="RoutingSerials">RoutingSerials</link> :
39217 Decide if you want to route serials around your library</para>
39222 linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
39223 Decide if holds are placed on serials when there is a routing
39224 list in place</para>
39230 <para>Cataloging System Preferences</para>
39235 linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
39236 : Decide how many of the most recent issues to display in the
39237 staff client</para>
39242 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
39243 : Decide how many of the most recent issues to display in the
39249 linkend="SubscriptionHistory">SubscriptionHistory</link> :
39250 Decide how you want the subscription information to display in
39258 <section id="impgolive">
39259 <title>Planning for Go-Live</title>
39261 <para>Once you have all of your settings ready, you need to prepare for
39262 making your system live:</para>
39266 <para>Decide if you need training by an outside service or if your
39267 staff can do the training themselves.</para>
39271 <para>Make sure that there is time for your staff to play with your
39272 test system and get comfortable with it</para>
39276 <para>If this is a migration, work with your previous company to
39277 extract data right before you go live</para>
39281 <para>Come up with URLs for your new Koha OPAC & Staff
39286 <para>Make sure that if you're hosting your own system you have a
39293 <chapter id="sopac">
39294 <title>SOPAC2 Installation</title>
39296 <section id="sopacintro">
39299 <firstname>Jean-André</firstname>
39301 <surname>Santoni</surname>
39304 <orgname>BibLibre</orgname>
39308 <pubdate>August 2009</pubdate>
39310 <othercredit role="translator">
39311 <firstname>Nicole C.</firstname>
39313 <surname>Engard</surname>
39315 <contrib>Translation</contrib>
39319 <title>Introduction</title>
39321 <para>This is an installation guide for SOPAC2 and its Koha connector. It
39322 has been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
39323 3.0.x. It does not cover the installation of Koha and Drupal, only
39324 SOPAC, its dependencies and the connector.</para>
39327 <section id="sopacinstall">
39328 <title>Installation of Locum and Insurge</title>
39330 <para>Locum and Insurge are the two libraries used primarily by SOPAC.
39331 They serve as a layer of abstraction to the data. Insurge manages the
39332 social aspect (tags, reviews, ratings), while Locum manages the
39333 connection to the ILS via the connector. Both libraries use a different
39334 database from that of Drupal.</para>
39336 <section id="sopacdepend">
39337 <title>Dependencies</title>
39339 <para>There are no packages for Debian MDB2 yet, you can install it
39342 <programlisting># apt-get install php-pear
39343 # pear install MDB2
39344 # pear install MDB2#mysql</programlisting>
39347 <section id="sopacdownload">
39348 <title>Download</title>
39350 <para>Download the Locum and Insurge libraries from SVN:</para>
39352 <programlisting># cd /usr/local/lib
39353 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
39354 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
39357 <section id="sopaccreatedb">
39358 <title>Creation of the Database</title>
39360 <programlisting>$ mysql -u root
39361 mysql> create database scas;
39362 mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
39363 mysql> flush privileges;
39364 mysql> exit</programlisting>
39367 <section id="sopacdsn">
39368 <title>Sync DSN</title>
39370 <para>This file will provide the connection information to a DB
39373 <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
39375 <para>It should contain:</para>
39377 <programlisting><?php
39378 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
39381 <section id="sopacinstallinsurge">
39382 <title>Installation of Insurge</title>
39384 <para>If you customize the name of the database, remember to edit the
39387 <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
39389 <para>Import Insurge:</para>
39391 <programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
39393 <para>Configure Insurge:</para>
39395 <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
39397 <para>The variables in insurge.ini are empty. The default values are
39398 too long and cause MySQL errors.</para>
39400 <para>Here is a sample of insurge.ini</para>
39402 <programlisting>; This is the Locum configuration file
39403 ; General configuration options for your installation of Insurge.
39405 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
39406 ; This is where you configure your repository membership information.
39408 ; parent_server is the server name of the repository parent server you have been
39410 ; group_id = The group ID you have been given by your repository admin.
39411 ; These configuration points are OPTIONAL and are only necessary if you are
39412 ; participating in a repository relationship.
39416 group_key = ""</programlisting>
39419 <section id="sopacinstallocum">
39420 <title>Installation of Locum</title>
39422 <para>The same procedure applies to Locum</para>
39424 <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
39425 # mysql < /usr/local/lib/locum/sql/scas_locum.sql
39426 # nano /usr/local/lib/locum/sql/locum_init.sql
39427 # mysql < /usr/local/lib/locum/sql/locum_init.sql
39428 # nano /usr/local/lib/locum/config/locum.ini
39429 # mkdir /usr/local/var
39430 # mkdir /usr/local/var/log</programlisting>
39432 <para>Configure the DSN:</para>
39434 <programlisting>[locum_config]
39435 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
39437 <para>And the information for your Koha installation:</para>
39439 <programlisting>[ils_config]
39441 ils_version = "30x"
39442 ils_server = "localhost"
39443 ils_harvest_port = "80"</programlisting>
39445 <para>The rest depends on your Koha configuration.</para>
39449 <section id="sopackoha">
39450 <title>Installation of Koha Connector</title>
39452 <para>Download the Koha connector using SVN:</para>
39454 <programlisting># cd /usr/local/lib/locum/connectors/
39455 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
39458 <section id="sopacharvest">
39459 <title>Harvest Records</title>
39461 <para>Now that the connector is in place, we will be able to launch
39462 harvest.php, a tool that will reap Locum DB Koha and fill the
39465 <para>Start by configuring harvest.php:</para>
39467 <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
39469 <para>Here are the variables you must change:</para>
39471 <programlisting>$first_record = 1;
39472 $last_record = 30;</programlisting>
39474 <para>These are the minimum and maximum biblionumbers from your Koha
39477 <para>Then start the harvest:</para>
39479 <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
39480 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
39483 <section id="sopacphinx">
39484 <title>Installation of Sphinx</title>
39486 <para>Sphinx is the indexer for the database used by Locum and
39489 <section id="sphinxdepend">
39490 <title>Dependencies</title>
39492 <para>There is no Debian package for Sphinx so you'll have to compile
39493 the source directly:</para>
39495 <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
39498 <section id="sphinxdownload">
39499 <title>Download and Compile</title>
39501 <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
39502 $ tar zxvf sphinx-0.9.8.tar.gz
39504 $ ./configure --prefix=/usr/local/sphinx
39507 # mkdir /usr/local/sphinx
39508 # mkdir /usr/local/sphinx/lib
39509 # cp api/sphinxapi.php /usr/local/sphinx/lib/
39510 $ rm -R sphinx-0.9.8*</programlisting>
39513 <section id="sphinxuser">
39514 <title>Creation of User and Group</title>
39516 <para>Creating a Sphinx user and change the owner:</para>
39518 <programlisting># adduser sphinx
39520 # usermod -G sphinx sphinx
39521 # mkdir /usr/local/sphinx/var/run
39522 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
39525 <section id="demonsphinx">
39526 <title>The Sphinx daemon</title>
39528 <para>Download:</para>
39530 <programlisting># cd /etc/init.d
39531 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
39532 # chmod +x /etc/init.d/sphinx</programlisting>
39534 <para>Add Sphinx to the default boot services:</para>
39536 <programlisting># update-rc.d sphinx defaults</programlisting>
39539 <section id="sphinxconfig">
39540 <title>Configuration</title>
39542 <para>Copy the configuration file supplied with the source of Sphinx
39543 before the change:</para>
39545 <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
39546 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
39547 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
39548 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
39550 <para>And if you personalize the name of the database:</para>
39552 <programlisting># sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
39555 <section id="sphinxindexing">
39556 <title>Indexing documents</title>
39558 <para>Indexing is necessary if you want to use the search features of
39561 <para>You must first complete the Insurge table index</para>
39563 <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
39564 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
39566 <para>Then start indexing Sphinx</para>
39568 <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
39570 <para>Finally, we must start the daemon:</para>
39572 <programlisting># /etc/init.d/sphinx start</programlisting>
39574 <para>When the daemon is running, you can update the index with:</para>
39576 <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
39580 <section id="installsopac">
39581 <title>Installation of SOPAC2</title>
39583 <para>Now to the SOPAC software itself:</para>
39585 <section id="downloadsopac">
39586 <title>Download</title>
39588 <para>Download from SVN:</para>
39590 <programlisting>$ cd /chemin/vers/drupal/sites/all/
39593 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
39596 <section id="sopacinstallation">
39597 <title>Installation</title>
39599 <para>In Drupal's administration settings, activate the module.
39600 Also, enable the dependencies:</para>
39604 <para>Profile</para>
39608 <para>PHP Filter</para>
39616 <para>The Drupal menu should now list these entries.</para>
39619 <section id="configsopac">
39620 <title>Configuration</title>
39622 <para>Then go into the settings of SOPAC.</para>
39626 <para>Configure the paths to the Locum and Insurge
39631 <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
39632 with content like:</para>
39636 <programlisting><?php
39637 print sopac_search_form('both');
39638 print theme('pages_catalog');</programlisting>
39642 <para>Check the Input Format "PHP Code"</para>
39646 <para>Check Move to front page</para>
39650 <para>In URL path settings, set the SOPAC URL prefix you have
39655 <para>Go to the root of Drupal, a search form will appear.</para>
39657 <para>Remember to empty Drupal's cache when something does not
39660 <para>Drupal offers a few blocks, which are not configured by default.
39661 You must specify on which page they should appear.</para>
39666 <chapter id="cronjobsch">
39667 <title>Cron Jobs</title>
39671 <section id="cronjobs">
39672 <title>Cron Jobs</title>
39674 <para>The locations below assume a dev install which puts the crons in
39675 misc/, if you have a standard install you may want to look in bin/ for
39676 these files if you cannot find them in misc/</para>
39678 <section id="searchcron">
39679 <title>Search</title>
39683 <section id="rebuildsearchcron">
39684 <title>Rebuild Index</title>
39686 <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
39688 <para>Does: Updates Zebra indexes with recently changed data.</para>
39690 <para>Required by: Zebra</para>
39692 <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
39693 depending on performance needs</para>
39697 <section id="circcron">
39698 <title>Circulation</title>
39700 <section id="buildholdscron">
39701 <title>Holds Queue</title>
39703 <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
39705 <para>Does: Updates holds queue report</para>
39707 <para>Required by: <link linkend="holdsqueue">Holds Queue
39708 Report</link></para>
39710 <para>Frequency suggestion: every 1-4 hours</para>
39712 <para>Description:</para>
39716 <para>A script that should be run periodically if your library
39717 system allows borrowers to place on-shelf holds. This script
39718 decides which library should be responsible for fulfilling a
39719 given hold request.</para>
39721 <para>It's behavior is controlled by the system preferences
39722 <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
39724 linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
39726 <para>If you do not want all of your libraries to participate in
39727 the on-shelf holds fulfillment process, you should list the the
39728 libraries that *do* participate in the process here by inputting
39729 all the participating library's branchcodes, separated by commas
39730 ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
39732 <para>By default, the holds queue will be generated such that
39733 the system will first attempt to hold fulfillment using items
39734 already at the pickup library if possible. If there are no items
39735 available at the pickup library to fill a hold,
39736 build_holds_queue.pl will then use the list of libraries defined
39737 in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
39738 disabled ( which it is by default ), the script will assign
39739 fulfillment requests in the order the branches are placed in the
39740 StaticHoldsQueueWeight system preference.</para>
39742 <para>For example, if your system has three libraries, of
39743 varying sizes ( small, medium and large ) and you want the
39744 burden of holds fulfillment to be on larger libraries before
39745 smaller libraries, you would want StaticHoldsQueueWeight to look
39746 something like "LRG,MED,SML".</para>
39748 <para>If you want the burden of holds fulfillment to be spread
39749 out equally throughout your library system, simply enable
39750 RandomizeHoldsQueueWeight. When this system preference is
39751 enabled, the order in which libraries will be requested to
39752 fulfill an on-shelf hold will be randomized each time the list
39753 is regenerated.</para>
39755 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
39756 this time. Doing so will cause the build_holds_queue script to
39757 ignore RandomizeHoldsQueueWeight, causing the script to request
39758 hold fulfillment not randomly, but by alphabetical order.</para>
39762 <section id="buildholdscronperl">
39763 <title>Perl Documentation</title>
39766 role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
39768 <para>my $biblionumber_aref =
39769 GetBibsWithPendingHoldRequests();</para>
39771 <para>Return an arrayref of the biblionumbers of all bibs that
39772 have one or more unfilled hold requests.</para>
39775 role="bold">GetPendingHoldRequestsForBib</emphasis></para>
39777 <para>my $requests =
39778 GetPendingHoldRequestsForBib($biblionumber);</para>
39780 <para>Returns an arrayref of hashrefs to pending, unfilled hold
39783 <para>the bib identified by $biblionumber. The following keys are
39784 present in each hashref:</para>
39788 <para>biblionumber</para>
39792 <para>borrowernumber</para>
39796 <para>itemnumber</para>
39800 <para>priority</para>
39804 <para>branchcode</para>
39808 <para>reservedate</para>
39812 <para>reservenotes</para>
39816 <para>borrowerbranch</para>
39820 <para>The arrayref is sorted in order of increasing
39824 role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
39826 <para>my $available_items =</para>
39828 <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
39830 <para>Returns an arrayref of items available to fill hold requests
39831 for the bib identified by $biblionumber. An item is available to
39834 <para>request if and only if:</para>
39838 <para>it is not on loan</para>
39842 <para>it is not withdrawn</para>
39846 <para>it is not marked notforloan</para>
39850 <para>it is not currently in transit</para>
39854 <para>it is not lost</para>
39858 <para>it is not sitting on the hold shelf</para>
39863 role="bold">MapItemsToHoldRequests</emphasis></para>
39865 <para>MapItemsToHoldRequests($hold_requests,
39866 $available_items);</para>
39869 role="bold">CreatePickListFromItemMap</emphasis></para>
39871 <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
39874 role="bold">_get_branches_to_pull_from</emphasis></para>
39876 <para>Query system preferences to get ordered list of branches to
39877 use to fill hold requests.</para>
39881 <section id="expiredholdscron">
39882 <title>Expired Holds</title>
39885 misc/cronjobs/holds/cancel_expired_holds.pl</para>
39887 <para>Does: By default, this cron job will only automatically cancel
39888 holds where the user has set an expiration date. If the library is
39890 linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
39892 linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
39893 preferences then this script will also cancel holds that have been
39894 sitting on the hold shelf for too long and will (if the library
39895 does) charge the patron for not picking up the hold.</para>
39897 <para>Frequency suggestion: daily</para>
39900 <section id="unsuspendholdcron">
39901 <title>Unsuspend Holds</title>
39904 misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
39906 <para>Does: This script checks to find holds that should no longer
39907 be suspended and removes the suspension if the <link
39908 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
39909 preference is set to 'allow'. This puts the patron back in to the
39910 queue where they were when the hold was suspended.</para>
39912 <para>Frequency suggestion: daily</para>
39915 <section id="finescronjob">
39916 <title>Fines</title>
39918 <para>Script path: misc/cronjobs/fines.pl</para>
39919 <para>Does: Calculates and posts fines to patron accounts.</para>
39921 <para>Required by: <link linkend="finesMode">finesMode</link> system
39924 <para>Frequency suggestion: nightly</para>
39927 <section id="longoverduecron">
39928 <title>Long Overdues</title>
39930 <para>Script path: misc/cronjobs/longoverdue.pl</para>
39932 <para>Does: allows one to specify delays for changing items to
39933 different lost statuses, and optionally charge for them using the
39934 replacement price listed on the item record.</para>
39936 <para>Frequency suggestion: nightly</para>
39938 <section id="longoverduecronperl">
39939 <title>Perl Documentation</title>
39941 <para><emphasis role="bold">NAME</emphasis></para>
39943 <para>longoverdue.pl cron script to set lost statuses on overdue
39944 materials. Execute without options for help.</para>
39948 <section id="updateissuescron">
39949 <title>Track total checkouts</title>
39951 <para>Script path: misc/cronjobs/update_totalissues.pl</para>
39953 <para>Does: updates the biblioitems.totalissues field in the
39954 database with the latest tally of checkouts.</para>
39956 <para>Frequency suggestion: nightly</para>
39957 <section id="updateissuesperldoc">
39958 <title>Perl Documentation</title>
39959 <para><emphasis role="bold">NAME</emphasis>
39961 <para>update_totalissues.pl </para>
39962 <para><emphasis role="bold">SYNOPSIS</emphasis>
39964 <para>update_totalissues.pl --use-stats </para>
39965 <para>update_totalissues.pl --use-items </para>
39966 <para>update_totalissues.pl --commit=1000 </para>
39967 <para>update_totalissues.pl --since='2012-01-01' </para>
39968 <para>update_totalissues.pl --interval=30d </para>
39969 <para><emphasis role="bold">DESCRIPTION</emphasis>
39971 <para>This batch job populates bibliographic records' total issues count based on
39972 historical issue statistics. </para>
39973 <para>--help Prints this help </para>
39974 <para>-v|--verbose </para>
39975 <para>Provide verbose log information (list every bib modified). </para>
39976 <para>--use-stats </para>
39977 <para>Use the data in the statistics table for populating total issues. </para>
39978 <para>--use-items </para>
39979 <para>Use items.issues data for populating total issues. Note that issues data from the
39980 items table does not respect the --since or --interval options, by definition. Also
39981 note that if both --use-stats and --use-items are specified, the count of biblios
39982 processed will be misleading. </para>
39983 <para>-s|--since=DATE </para>
39984 <para>Only process issues recorded in the statistics table since DATE. </para>
39985 <para>-i|--interval=S </para>
39986 <para>Only process issues recorded in the statistics table in the last N units of time.
39987 The interval should consist of a number with a one- letter unit suffix. The valid
39988 suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
39989 unit is days. </para>
39990 <para>--incremental </para>
39991 <para>Add the number of issues found in the statistics table to the existing total
39992 issues count. Intended so that this script can be used as a cron job to update
39993 popularity information during low-usage periods. If neither --since or --interval are
39994 specified, incremental mode will default to processing the last twenty-four hours. </para>
39995 <para>--commit=N </para>
39996 <para>Commit the results to the database after every N records are processed. </para>
39997 <para>--test </para>
39998 <para>Only test the popularity population script. </para>
39999 <para><emphasis role="bold">WARNING</emphasis>
40001 <para>If the time on your database server does not match the time on your Koha server
40002 you will need to take that into account, and probably use the --since argument instead
40003 of the --interval argument for incremental updating. </para>
40004 <para><emphasis role="bold">CREDITS</emphasis>
40006 <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
40007 Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
40008 Arcadia Public Library. </para>
40009 <para><emphasis role="bold">AUTHOR</emphasis>
40011 <para>Jared Camins-Esakov <jcamins AT cpbibliography DOT com></para>
40014 <section id="offlinecirccron">
40015 <title>Generate Patron File for Offline Circulation</title>
40016 <para>Script path: misc/cronjobs/create_koc_db.pl</para>
40017 <para>Does: Generates the borrowers.db file for use with the <link
40018 linkend="windowsofflinecirc">Koha Offline Circulation</link> tool</para>
40019 <para>Frequency suggestion: weekly</para>
40023 <section id="patroncrons">
40024 <title>Patrons</title>
40026 <section id="anonymizecron">
40027 <title>Anonymize Patron Data</title>
40028 <para>Script path: misc/cronjobs/batch_anonymise.pl</para>
40029 <para>Does: Used to anonymize patron data. This will remove borrowernumbers from
40030 circulation history so that the stats are kept, but the patron information is removed
40031 for privacy reasons.</para>
40033 <section id="j2acron">
40034 <title>Update Child to Adult Patron Type</title>
40035 <para>Script path: misc/cronjobs/j2a.pl</para>
40036 <para>Does: Convert juvenile/child patrons from juvenile patron category and category code
40037 to corresponding adult patron category and category code when they reach the upper age
40038 limit defined in the Patron Categories. </para>
40039 <para>Frequency suggestion: nightly</para>
40040 <section id="j2aperldoc">
40041 <title>Perl Documentation</title>
40042 <para><emphasis role="bold">NAME</emphasis>
40044 <para>juv2adult.pl - convert juvenile/child patrons from juvenile patron category and
40045 category code to corresponding adult patron category and category code when they reach
40046 the upper age limit defined in the Patron Categories. </para>
40047 <para><emphasis role="bold">SYNOPSIS</emphasis>
40049 <para>juv2adult.pl [ -b=<branchcode> -f=<categorycode> -t=<categorycode> ] </para>
40050 <para>Options: </para>
40051 <para>--help brief help message </para>
40052 <para>--man full documentation </para>
40053 <para>-v verbose mode </para>
40054 <para>-n take no action, display only </para>
40055 <para>-b <branchname> only deal with patrons from this library/branch </para>
40056 <para>-f <categorycode> change patron category from this category </para>
40057 <para>-t <categorycode> change patron category to this category </para>
40058 <para>=head1 OPTIONS </para>
40059 <para>--help Print a brief help message and exits. </para>
40060 <para>--man Prints the manual page and exits. </para>
40061 <para>-v Verbose. Without this flag set, only fatal errors are reported. </para>
40062 <para>-n No Action. With this flag set, script will report changes but not actually
40063 execute them on the database. </para>
40064 <para>-b changes patrons for one specific branch. Use the value in the
40065 branches.branchcode table.</para>
40066 <para> -f *required* defines the juvenile category to update. Expects the code from
40067 categories.categorycode. </para>
40068 <para>-t *required* defines the category juvenile patrons will be converted to. Expects
40069 the code from categories.categorycode. </para>
40070 <para><emphasis role="bold">DESCRIPTION</emphasis>
40072 <para>This script is designed to update patrons from juvenile to adult patron types,
40073 remove the guarantor, and update their category codes appropriately when they reach
40074 the upper age limit defined in the Patron Categories. </para>
40075 <para><emphasis role="bold">USAGE EXAMPLES</emphasis>
40077 <para>"juv2adult.pl" - Suggests that you read this help. :) </para>
40078 <para>"juv2adult.pl" -b=<branchcode> -f=<categorycode> -t=<categorycode> -
40079 Processes a single branch, and updates the patron categories from fromcat to tocat. </para>
40080 <para>"juv2adult.pl" -f=<categorycode> -t=<categorycode> -v -n - Processes all
40081 branches, shows all messages, and reports the patrons who would be affected. Takes no
40082 action on the database.</para>
40087 <section id="noticescron">
40088 <title>Notices</title>
40092 <section id="msgqueuecron">
40093 <title>Message Queue</title>
40095 <para>Script path: misc/cronjobs/process_message_queue.pl</para>
40097 <para>Does: processes the message queue to send the check out, check in and hold filled
40098 emails and SMS message to users and sends outgoing emails to patrons. requires <link
40099 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> to be
40102 <para>Frequency suggestion: 1-4 hours<important>
40103 <para>Item due and Advanced due notices are controlled by the <link
40104 linkend="advnoticecron">advance_notices cron</link>.</para>
40105 </important></para>
40108 <section id="advnoticecron">
40109 <title>Advanced Notice</title>
40111 <para>Script path: misc/cronjobs/advance_notices.pl</para>
40113 <para>Does: prepares "pre-due" notices and "item due" notices for
40114 patrons who request them prepares notices for patrons for items just
40115 due or coming due soon. requires <link
40116 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
40119 <para>Frequency suggestion: nightly</para>
40122 <para>This script does not actually send the notices. It queues
40123 them in the <link linkend="msgqueuecron">message queue</link> for
40127 <section id="advnoticecronperl">
40128 <title>Perl Documentation</title>
40130 <para><emphasis role="bold">NAME</emphasis></para>
40132 <para>advance_notices.pl - cron script to put item due reminders
40133 into message queue</para>
40135 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
40137 <para>./advance_notices.pl -c</para>
40139 <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
40141 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
40143 <para>This script prepares pre-due and item due reminders to be
40144 sent to patrons. It queues them in the message queue, which is
40145 processed by the process_message_queue.pl cronjob. The type and
40146 timing of the messages can be configured by the patrons in their
40147 "My Alerts" tab in the OPAC.</para>
40149 <para><emphasis role="bold">METHODS</emphasis></para>
40151 <para>parse_letter</para>
40155 <section id="overduenoticecron">
40156 <title>Overdue Notice</title>
40158 <para>Script path: misc/cronjobs/overdue_notices.pl</para>
40160 <para>Does: prepares messages to alert patrons of overdue messages
40161 (both via email and print)</para>
40163 <para>Frequency suggestion: nightly</para>
40166 <para>This script does not actually send the notices. It queues
40167 them in the <link linkend="msgqueuecron">message queue</link> for
40168 later or generates the HTML for later printing</para>
40171 <section id="overduenoticecronperl">
40172 <title>Perl Documentation</title>
40174 <para><emphasis role="bold">NAME</emphasis></para>
40176 <para>overdue_notices.pl - prepare messages to be sent to patrons
40177 for overdue items</para>
40179 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
40181 <para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
40182 -library <branchcode>...] [ -max <number of days> ] [
40183 -csv [ <filename> ] ] [-itemscontent <field list>
40186 <para>Options:</para>
40188 <para>-help brief help message</para>
40190 <para>-man full documentation</para>
40192 <para>-n No email will be sent</para>
40194 <para>-max <days> maximum days overdue to deal with</para>
40196 <para>-library <branchname> only deal with overdues from
40197 this library (repeatable : several libraries can be given)</para>
40199 <para>-csv <filename> populate CSV file</para>
40201 <para>-html <filename> Output html to file</para>
40203 <para>-itemscontent <list of fields> item information in
40206 <para>-borcat <categorycode> category code that must be
40209 <para>-borcatout <categorycode> category code that must be
40212 <para><emphasis role="bold">OPTIONS</emphasis></para>
40214 <para>-help Print a brief help message and exits.</para>
40216 <para>-man Prints the manual page and exits.</para>
40218 <para>-v Verbose. Without this flag set, only fatal errors are
40221 <para>-n Do not send any email. Overdue notices that would have
40222 been sent to the patrons or to the admin are printed to standard
40223 out. CSV data (if the -csv flag is set) is written to standard out
40224 or to any csv filename given.</para>
40226 <para>-max Items older than max days are assumed to be handled
40227 somewhere else, probably the longoverdues.pl script. They are
40228 therefore ignored by this program. No notices are sent for them,
40229 and they are not added to any CSV files. Defaults to 90 to match
40230 longoverdues.pl.</para>
40232 <para>-library</para>
40234 <para>select overdues for one specific library. Use the value in
40235 the branches.branchcode table. This option can be repeated in
40236 order to select overdues for a group of libraries.</para>
40238 <para>-csv Produces CSV data. if -n (no mail) flag is set, then
40239 this CSV data is sent to standard out or to a filename if
40240 provided. Otherwise, only overdues that could not be emailed are
40241 sent in CSV format to the admin.</para>
40243 <para>-itemscontent</para>
40245 <para>comma separated list of fields that get substituted into
40246 templates in places of the <<items.content>>
40247 placeholder. This defaults to
40248 issuedate,title,barcode,author</para>
40250 <para>Other possible values come from fields in the biblios,
40251 items, and issues tables.</para>
40253 <para>-borcat Repetable field, that permit to select only few of
40254 patrons categories.</para>
40256 <para>-borcatout</para>
40258 <para>Repetable field, permis to exclude some patrons
40261 <para>-t | --triggered</para>
40263 <para>This option causes a notice to be generated if and only if
40264 an item is overdue by the number of days defined in a notice
40267 <para>By default, a notice is sent each time the script runs,
40268 which is suitable for less frequent run cron script, but requires
40269 syncing notice triggers with the cron schedule to ensure proper
40270 behavior. Add the --triggered option for daily cron, at the risk
40271 of no notice being generated if the cron fails to run on
40274 <para>-list-all</para>
40276 <para>Default items.content lists only those items that fall in
40277 the range of the currently processing notice. Choose list-all to
40278 include all overdue items in the list (limited by -max
40281 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
40283 <para>This script is designed to alert patrons and administrators
40284 of overdue items.</para>
40286 <para>Configuration</para>
40288 <para>This script pays attention to the overdue notice
40289 configuration performed in the "Overdue notice/status triggers"
40290 section of the "Tools" area of the staff interface to Koha. There,
40291 you can choose which letter templates are sent out after a
40292 configurable number of days to patrons of each library. More
40293 information about the use of this section of Koha is available in
40294 the Koha manual.</para>
40296 <para>The templates used to craft the emails are defined in the
40297 "Tools: Notices" section of the staff interface to Koha.</para>
40299 <para>Outgoing emails</para>
40301 <para>Typically, messages are prepared for each patron with
40302 overdue items. Messages for whom there is no email address on file
40303 are collected and sent as attachments in a single email to each
40304 library administrator, or if that is not set, then to the email
40305 address in the "KohaAdminEmailAddress" system preference.</para>
40307 <para>These emails are staged in the outgoing message queue, as
40308 are messages produced by other features of Koha. This message
40309 queue must be processed regularly by the
40310 misc/cronjobs/process_message_queue.pl program.</para>
40312 <para>In the event that the "-n" flag is passed to this program,
40313 no emails are sent. Instead, messages are sent on standard output
40314 from this program. They may be redirected to a file if
40317 <para>Templates</para>
40319 <para>Templates can contain variables enclosed in double angle
40320 brackets like <<this>>. Those variables will be
40321 replaced with values specific to the overdue items or relevant
40322 patron. Available variables are:</para>
40324 <para><<bib>></para>
40326 <para>the name of the library</para>
40328 <para><<items.content>></para>
40330 <para>one line for each item, each line containing a tab separated
40331 list of title, author, barcode, issuedate</para>
40333 <para><<borrowers.*>></para>
40335 <para>any field from the borrowers table</para>
40337 <para><<branches.*>></para>
40339 <para>any field from the branches table</para>
40341 <para>CSV output</para>
40343 <para>The "-csv" command line option lets you specify a file to
40344 which overdues data should be output in CSV format.</para>
40346 <para>With the "-n" flag set, data about all overdues is written
40347 to the file. Without that flag, only information about overdues
40348 that were unable to be sent directly to the patrons will be
40349 written. In other words, this CSV file replaces the data that is
40350 typically sent to the administrator email address.</para>
40352 <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
40354 <para>"overdue_notices.pl" - In this most basic usage, with no
40355 command line arguments, all libraries are processed individually,
40356 and notices are prepared for all patrons with overdue items for
40357 whom we have email addresses. Messages for those patrons for whom
40358 we have no email address are sent in a single attachment to the
40359 library administrator's email address, or to the address in the
40360 KohaAdminEmailAddress system preference.</para>
40362 <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
40363 email and populates /tmp/overdues.csv with information about all
40364 overdue items.</para>
40366 <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
40367 of overdues in the last 2 weeks for the MAIN library.</para>
40369 <para><emphasis role="bold">SEE ALSO</emphasis></para>
40371 <para>The misc/cronjobs/advance_notices.pl program allows you to
40372 send messages to patrons in advance of their items becoming due,
40373 or to alert them of items that have just become due.</para>
40375 <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
40377 <para>These methods are internal to the operation of
40378 overdue_notices.pl.</para>
40380 <para>parse_letter</para>
40382 <para>parses the letter template, replacing the placeholders with
40383 data specific to this patron, biblio, or item</para>
40385 <para>named parameters:</para>
40387 <para>letter - required hashref</para>
40389 <para>borrowernumber - required integer</para>
40391 <para>substitute - optional hashref of other key/value pairs that
40392 should be substituted in the letter content</para>
40394 <para>returns the "letter" hashref, with the content updated to
40395 reflect the substituted keys and values.</para>
40397 <para>prepare_letter_for_printing</para>
40399 <para>returns a string of text appropriate for printing in the
40400 event that an overdue notice will not be sent to the patron's
40401 email address. Depending on the desired output format, this may be
40402 a CSV string, or a human-readable representation of the
40405 <para>required parameters:</para>
40407 <para>letter</para>
40409 <para>borrowernumber</para>
40411 <para>optional parameters:</para>
40413 <para>outputformat</para>
40417 <section id="printholdcron">
40418 <title>Print Hold Notices</title>
40420 <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
40422 <para>Does: looks through the message queue for hold notices that
40423 didn't go through because the patron didn't have an email address
40424 and generates a print notice</para>
40426 <para>Frequency suggestion: nightly</para>
40429 <section id="talkingtechcrons">
40430 <title>Talking Tech</title>
40432 <para>To learn more about setting up this third party product view
40433 the <link linkend="talkingtechappendix">Talking Tech
40434 Appendix</link>.</para>
40436 <section id="talkingtechsendcron">
40437 <title>Sending Notices File</title>
40440 misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
40442 <para>Does: Script to generate Spec C outbound notifications file
40443 for Talking Tech i-tiva phone notification system.</para>
40445 <para>Required by: <link
40446 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
40448 <para>Frequency suggestion: nightly</para>
40450 <section id="talkingsendcronperl">
40451 <title>Perl Documentation</title>
40453 <para><emphasis role="bold">USAGE</emphasis></para>
40455 <para>TalkingTech_itiva_outbound.pl</para>
40457 <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
40458 6 --output=/tmp/talkingtech/outbound.csv</para>
40460 <para>TalkingTech_itiva_outbound.pl --type=RESERVE
40461 --type=PREOVERDUE --lang=FR</para>
40463 <para>Script to generate Spec C outbound notifications file for
40464 Talking Tech i-tiva phone notification system.</para>
40466 <para>--help -h</para>
40468 <para>Prints this help</para>
40470 <para>-v Provide verbose log information.</para>
40472 <para>--output -o</para>
40474 <para>Destination for outbound notifications file (CSV format).
40475 If no value is specified, output is dumped to screen.</para>
40477 <para>--lang</para>
40479 <para>Sets the language for all outbound messages. Currently
40480 supported values are EN, FR and ES. If no value is specified, EN
40481 will be used by default.</para>
40483 <para>--type</para>
40485 <para>REQUIRED. Sets which messaging types are to be used. Can
40486 be given multiple times, to specify multiple types in a single
40487 output file. Currently supported values are RESERVE, PREOVERDUE
40488 and OVERDUE. If no value is given, this script will not produce
40489 any outbound notifications.</para>
40491 <para>--waiting-hold-day -w</para>
40493 <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
40494 has been set to waiting on which to call. Use switch as many
40495 times as desired. For example, passing "-w 0 -w 2 -w 6" will
40496 cause calls to be placed on the day the hold was set to waiting,
40497 2 days after the waiting date, and 6 days after. See example
40498 above. If this switch is not used with --type=RESERVE, calls
40499 will be placed every day until the waiting reserve is picked up
40500 or canceled.</para>
40502 <para>--library-code --code -c</para>
40504 <para>OPTIONAL The code of the source library of the message.
40505 The library code is used to group notices together for
40506 consortium purposes and apply library specific settings, such as
40507 prompts, to those notices. This field can be blank if all
40508 messages are from a single library.</para>
40512 <section id="talkingtechreceivecron">
40513 <title>Receiving Notices File</title>
40516 misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
40518 <para>Does: Script to process received Results files for Talking
40519 Tech i-tiva phone notification system.</para>
40521 <para>Required by: <link
40522 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
40524 <para>Frequency suggestion: nightly</para>
40526 <section id="talkingreceivecronperl">
40527 <title>Perl Documentation</title>
40529 <para><emphasis role="bold">USAGE</emphasis></para>
40531 <para>TalkingTech_itiva_inbound.pl</para>
40533 <para>TalkingTech_itiva_inbound.pl -v
40534 --input=/tmp/talkingtech/results.csv</para>
40536 <para>Script to process received Results files for Talking Tech
40537 i-tiva phone notification system.</para>
40539 <para>--help -h</para>
40541 <para>Prints this help</para>
40543 <para>-v Provide verbose log information.</para>
40545 <para>--input -i</para>
40547 <para>REQUIRED. Path to incoming results file.</para>
40553 <section id="proccartcron">
40554 <title>In Processing/Book Cart</title>
40556 <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
40558 <para>Does: Updates all items with a location of CART to the item's
40559 permanent location.</para>
40561 <para>Required by: <link
40562 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
40564 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
40565 & <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
40566 system preferences</para>
40568 <para>Frequency suggestion: hourly</para>
40570 <section id="proccartcronperl">
40571 <title>Perl Documentation</title>
40573 <para><emphasis role="bold">NAME</emphasis></para>
40575 <para>cart_to_shelf.pl cron script to set items with location of
40576 CART to original shelving location after X hours. Execute without
40577 options for help.</para>
40581 <section id="catalogcron">
40582 <title>Catalog</title>
40586 <section id="checkurlcron">
40587 <title>Check URLs</title>
40589 <para>Script path: misc/cronjobs/check-url.pl</para>
40591 <para>Does: checks URLs in 856$u field. Script output can now be
40592 formatted in CSV or HTML. The HTML version links directly to MARC
40593 biblio record editor.</para>
40595 <para>Frequency suggestion: monthly</para>
40597 <para>Learn more: <ulink
40598 url="http://wiki.koha-community.org/wiki/Check-url_enhancements">http://wiki.koha-community.org/wiki/Check-url_enhancements</ulink></para>
40600 <section id="checkurlcronperl">
40601 <title>Perl Documentation</title>
40603 <para><emphasis role="bold">NAME</emphasis></para>
40605 <para>C4::URL::Checker - base object for checking URL stored in
40608 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
40610 <programlisting>use C4::URL::Checker;
40612 my $checker = C4::URL::Checker->new( );
40613 $checker->{ host_default } = 'http://mylib.kohalibrary.com';
40614 my $checked_urls = $checker->check_biblio( 123 );
40615 foreach my $url ( @$checked_urls ) {
40616 print "url: ", $url->{ url A }, "\n",
40617 "is_success: ", $url->{ is_success }, "\n",
40618 "status: ", $url->{ status }, "\n";
40619 } </programlisting>
40621 <para><emphasis role="bold">FUNCTIONS</emphasis></para>
40625 <para>Create a URL Checker. The returned object can be used to set
40626 default host variable :</para>
40628 <programlisting>my $checker = C4::URL::Checker->new( );
40629 $checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
40631 <para>check_biblio</para>
40633 <para>Check all URL from a biblio record. Returns a pointer to an
40634 array containing all URLs with checking for each of them.</para>
40636 <programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
40638 <para>With 2 URLs, the returned array will look like that:</para>
40642 'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
40643 'is_success' => 1,
40644 'status' => 'ok'
40647 'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
40648 'is_success' => 0,
40649 'status' => '404 - Page not found'
40651 ], </programlisting>
40653 <para><emphasis role="bold">NAME</emphasis></para>
40655 <para>check-url.pl - Check URLs from 856$u field.</para>
40657 <para><emphasis role="bold">USAGE</emphasis></para>
40659 <para>check-url.pl [--verbose|--help]
40660 [--host=http://default.tld]</para>
40662 <para>Scan all URLs found in 856$u of bib records and display if
40663 resources are available or not.</para>
40665 <para><emphasis role="bold">PARAMETERS</emphasis></para>
40667 <para>--host=http://default.tld</para>
40669 <para>Server host used when URL doesn't have one, ie doesn't begin
40670 with 'http:'. For example, if --host=http://www.mylib.com, then
40671 when 856$u contains 'img/image.jpg', the url checked is:
40672 http://www.mylib.com/image.jpg'.</para>
40674 <para>--verbose|-v</para>
40676 <para>Outputs both successful and failed URLs.</para>
40678 <para>--html</para>
40680 <para>Formats output in HTML. The result can be redirected to a
40681 file accessible by http. This way, it's possible to link directly
40682 to biblio record in edit mode. With this parameter --host-pro is
40685 <para>--host-pro=http://koha-pro.tld</para>
40687 <para>Server host used to link to biblio record editing
40690 <para>--help|-h</para>
40692 <para>Print this help page.</para>
40696 <section id="mergeauthcron">
40697 <title>Merge Authorities</title>
40699 <para>Script path: misc/migration_tools/merge_authorities.pl</para>
40701 <para>Does: Updates biblio data with changes to authorities
40704 <para>Required by: <link linkend="dontmerge">dontmerge</link> system
40707 <para>Frequency suggestion: nightly</para>
40710 <section id="serialscron">
40711 <title>Serials Update</title>
40713 <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
40715 <para>Does: checks if there is a "late" issue on active
40716 subscriptions, and if there is, the script will set it as late, and
40717 add the next one as expected.</para>
40719 <para>Frequency suggestion: nightly</para>
40723 <section id="opaccrons">
40724 <title>OPAC</title>
40728 <section id="customrssfeedcron">
40729 <title>RSS Feeds</title>
40731 <para>Script path: misc/cronjobs/rss/rss.pl</para>
40733 <para>Does: Produces an RSS XML document for any SQL query (not used
40734 for search results RSS feed). <link linkend="customrss">Learn
40735 more</link>.</para>
40737 <para>Frequency suggestion: hourly</para>
40740 <section id="authbrowsercron">
40741 <title>Authorities Browser</title>
40743 <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
40745 <para>Does: Generate content for authorities browse in OPAC</para>
40747 <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link> system preference<important>
40748 <para>This preference and cron job should only be used on French systems.</para>
40749 </important></para>
40752 <section id="keywordclouds">
40753 <title>Subject/Author Clouds</title>
40755 <para>Script path: misc/cronjobs/cloud-kw.pl</para>
40757 <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
40758 misc/cronjobs/cloud-sample.conf has a sample of how this script
40761 <para>Frequency: This is the type of script you can run once a month
40762 or so, the content generated isn't going to change very much over
40765 <section id="keywordcloudsperl">
40766 <title>Perl Documentation</title>
40768 <para><emphasis role="bold">NAME</emphasis></para>
40770 <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
40773 <para><emphasis role="bold">USAGE</emphasis></para>
40775 <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
40777 <para>Creates multiple HTML files containing keywords cloud with
40778 top terms sorted by their logarithmic weight. cloud.conf is a YAML
40779 configuration file driving cloud generation process.</para>
40781 <para><emphasis role="bold">PARAMETERS</emphasis></para>
40783 <para>--conf=configuration file</para>
40785 <para>Specify configuration file name</para>
40787 <para>--verbose|-v</para>
40789 <para>Enable script verbose mode.</para>
40791 <para>--help|-h</para>
40793 <para>Print this help page.</para>
40795 <para><emphasis role="bold">CONFIGURATION</emphasis></para>
40797 <para>Configuration file looks like that:</para>
40799 <para><programlisting> ---
40800 # Koha configuration file for a specific installation
40801 # If not present, defaults to KOHA_CONF
40802 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
40803 # Zebra index to scan
40805 # Koha index used to link found kewords with an opac search URL
40807 # Number of top keyword to use for the cloud
40809 # Include CSS style directives with the cloud
40810 # This could be used as a model and then CSS directives are
40811 # put in the appropriate CSS file directly.
40813 # HTML file where to output the cloud
40814 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
40816 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
40817 ZebraIndex: Subject
40821 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis
40822 role="bold">IMPROVEMENTS</emphasis></para>
40824 <para>Generated top terms have more informations than those
40825 outputted from the time being. Some parameters could be easily
40826 added to improve this script:</para>
40828 <para>WithCount</para>
40830 <para>In order to output terms with the number of occurrences they
40831 have been found in Koha Catalogue by Zebra.</para>
40833 <para>CloudLevels</para>
40835 <para>Number of levels in the cloud. Now 24 levels are
40838 <para>Weighting</para>
40840 <para>Weighting method used to distribute terms in the cloud. We
40841 could have two values: Logarithmic and Linear. Now it's
40842 Logarithmic by default.</para>
40846 <para>Now terms are outputted in the lexical order. They could be
40847 sorted by their weight.</para>
40852 <section id="systemcron">
40853 <title>System Administration</title>
40857 <section id="cleandbcron">
40858 <title>Clean up Database</title>
40860 <para>Script path: misc/cronjobs/cleanup_database.pl</para>
40862 <para>Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs
40863 and staged MARC files.</para>
40867 <section id="acqcrons">
40868 <title>Acquisitions</title>
40870 <section id="cleansuggcron">
40871 <title>Clean up old suggestions</title>
40873 <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
40875 <para>Does: Removes old (defined by you) suggestions from the
40876 suggestion management area.</para>
40880 <section id="deprecatedcrons">
40881 <title>Deprecated scripts</title>
40883 <para>These should not be run without modification:</para>
40885 <para>Script path: misc/cronjobs/update_items.pl</para>
40887 <para>Script path:misc/cronjobs/smsoverdues.pl</para>
40889 <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
40891 <para>Script path:misc/cronjobs/reservefix.pl</para>
40893 <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
40898 <chapter id="webservices">
40899 <title>Web Services</title>
40903 <section id="OAI-PMHservice">
40904 <title>OAI-PMH</title>
40908 <section id="oaiconfsample">
40909 <title>Sample OAI Conf File</title>
40911 <para><programlisting> format:
40914 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
40915 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
40916 xsl_file: /usr/local/koha/xslt/vs.xsl
40918 metadataPrefix: marxml
40919 metadataNamespace: http://www.loc.gov/MARC21/slim
40920 http://www.loc.gov/standards/marcxml/schema/MARC21slim
40921 schema: http://www.loc.gov/MARC21/slim
40922 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
40924 metadataPrefix: oai_dc
40925 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
40926 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
40928 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
40934 <title>Using the SRU server</title>
40936 <section id="usingsru">
40939 <firstname>Nicolas</firstname>
40941 <surname>Morin</surname>
40944 <orgname>BibLibre</orgname>
40948 <pubdate>December 2009</pubdate>
40951 <title>Using the SRU server</title>
40953 <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
40954 information about the protocol itself can be found at <ulink
40955 url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
40956 The version implemented is version 1.1.</para>
40958 <section id="sru_explain">
40959 <title>Explain</title>
40961 <para>If you want to have information about the implementation of SRU
40962 on a given server, you should have access to the Explain file using a
40963 request to the server without any parameter. Like
40964 <http://myserver.com:9999/biblios/>. The response from the
40965 server is an XML file that should look like the following and will
40966 give you information about the default settings of the SRU
40970 <zs:explainResponse>
40971 <zs:version>1.1</zs:version>
40973 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
40974 <zs:recordPacking>xml</zs:recordPacking>
40975 <zs:recordData>
40976 <explain xml:base="zebradb/explain-biblios.xml">
40978 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
40980 <serverInfo protocol="SRW/SRU/Z39.50">
40981 <host>biblibre</host>
40982 <port>9999</port>
40983 <database>biblios</database>
40984 </serverInfo>
40985 <databaseInfo>
40986 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
40987 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
40989 <sru>http://biblibre:9999</sru>
40991 </databaseInfo>
40993 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
40994 <title>CQL Standard Set</title>
40996 <index search="true" scan="true" sort="false">
40997 <title lang="en">CQL Server Choice</title>
40999 <name set="cql">serverChoice</name>
41002 <attr type="1" set="bib1">text</attr>
41005 <index search="true" scan="true" sort="false">
41006 <title lang="en">CQL All</title>
41008 <name set="cql">all</name>
41011 <attr type="1" set="bib1">text</attr>
41014 <!-- Record ID index -->
41015 <index search="true" scan="true" sort="false">
41016 <title lang="en">Record ID</title>
41018 <name set="rec">id</name>
41021 <attr type="1" set="bib1">rec:id</attr>
41022 <attr type="4" set="bib1">3</attr>
41028 <section id="sru_search">
41029 <title>Search</title>
41032 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
41033 is composed of the following elements:</para>
41037 <para>base url of the SRU server :
41038 http://myserver.com:9999/biblios?</para>
41042 <para>search part with the 3 required parameters : version,
41043 operation and query. The parameters within the search part should
41044 be of the key=value form, and can be combined with the &
41049 <para>One can add optional parameters to the query, for instance
41050 maximumRecords indicating the maximum number of records to be returned
41052 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
41053 will only get the first 5 results results from the server.</para>
41056 url="http://www.loc.gov/standards/sru/sru1-1archive/search-retrieve-operation.html">http://www.loc.gov/standards/sru/sru1-1archive/search-retrieve-operation.html</ulink>
41057 gives more details about the search operations and in particular the
41058 list of optional parameters for searching.</para>
41060 <section id="sru_search_more_details">
41061 <title>More details about Search</title>
41063 <para>The "operation" key can take two values: scan or
41064 searchRetrieve.</para>
41066 <para>If operation=searchRetrieve, then the search key should be
41067 query. As in : operation=searchRetrieve&query=reefs</para>
41069 <para>If operation=scan, then the search key should be scanClause.
41070 As in : operation=scan&scanClause=reefs</para>
41072 <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
41073 that exist on your system. For instance you'll see that we have
41074 indexes for Subject and for Title: att 21 Subject and att 4 Title
41075 respectively.</para>
41077 <para>In the pqf.properties file located under
41078 etc/zebradb/pqf.properties I see that an access point already uses
41079 my Subject index (index.dc.subject = 1=21) while another uses my
41080 Title index (index.dc.title = 1=4) I know this is my Subject index
41081 because as I've seen just before in my bib1.att file, it's called
41082 with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
41083 my Subject index. And Title was called with 1=4 so index.dc.title =
41084 1=4 correctly points to my Title index. I can now construct my query
41085 just like I would in a search box, just preceding it with the
41086 "query" key: query=Subject=reefs and Title=coral searches "reefs" in
41087 the subject and "coral" in the title. The full url would be
41088 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
41089 and Title=coral If I want to limit the result set to just 5 records,
41091 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
41092 and Title=coral&maximumRecords=5</para>
41094 <para>I can also play with truncate, relations, etc. Those are also
41095 defined in my pqf.properties file. I can see for instance the
41096 position properties defined as:</para>
41099 position.first = 3=1 6=1
41101 position.any = 3=3 6=1
41102 # "any position in field"
41105 <para>So as an example if I want "coral" to be at the beginning of
41106 the title, I can do this query :
41107 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
41112 <section id="sru_retrieve">
41113 <title>Retrieve</title>
41115 <para>My search for
41116 http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
41117 reefs&maximumRecords=1 retrieves just on record. The response
41118 looks like this:</para>
41121 <zs:searchRetrieveResponse>
41122 <zs:version>1.1</zs:version>
41123 <zs:numberOfRecords>1</zs:numberOfRecords>
41126 <zs:recordPacking>xml</zs:recordPacking>
41127 <zs:recordData>
41128 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
41129 <leader> cam a22 4500</leader>
41130 <datafield tag="010" ind1=" " ind2=" ">
41131 <subfield code="a">2-603-01193-6</subfield>
41132 <subfield code="b">rel.</subfield>
41133 <subfield code="d">159 F</subfield>
41135 <datafield tag="020" ind1=" " ind2=" ">
41136 <subfield code="a">FR</subfield>
41137 <subfield code="b">00065351</subfield>
41139 <datafield tag="101" ind1="1" ind2=" ">
41140 <subfield code="c">ita</subfield>
41142 <datafield tag="105" ind1=" " ind2=" ">
41143 <subfield code="a">a z 00|y|</subfield>
41145 <datafield tag="106" ind1=" " ind2=" ">
41146 <subfield code="a">r</subfield>
41148 <datafield tag="100" ind1=" " ind2=" ">
41149 <subfield code="a">20091130 frey50 </subfield>
41151 <datafield tag="200" ind1="1" ind2=" ">
41152 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
41153 <subfield code="b">Texte imprimé</subfield>
41154 <subfield code="e">la faune sous-marine des coraux</subfield>
41155 <subfield code="f">A. et A. Ferrari</subfield>
41157 <datafield tag="210" ind1=" " ind2=" ">
41158 <subfield code="a">Lausanne</subfield>
41159 <subfield code="a">Paris</subfield>
41160 <subfield code="c">Delachaux et Niestlé</subfield>
41161 <subfield code="d">cop. 2000</subfield>
41162 <subfield code="e">impr. en Espagne</subfield>
41164 <datafield tag="215" ind1=" " ind2=" ">
41165 <subfield code="a">287 p.</subfield>
41166 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
41167 <subfield code="d">20 cm</subfield>
41171 <size>4725</size>
41172 <localnumber>2</localnumber>
41173 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
41176 </zs:recordData>
41177 <zs:recordPosition>1</zs:recordPosition>
41179 </zs:records>
41180 </zs:searchRetrieveResponse>
41187 <appendix id="sysprefdefaults">
41188 <title>System Preference Defaults</title>
41192 <section id="isbddefaults">
41193 <title>ISBD Defaults</title>
41197 <section id="isbddefault">
41198 <title>MARC Default</title>
41200 <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
41201 110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
41202 }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
41203 130t }|<br/><br/></para>
41205 <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
41206 245s }{ 245h }|</para>
41208 <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
41211 <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
41213 <para>#245||{ 245c }|</para>
41215 <para>#242||{ = 242c }|</para>
41217 <para>#250| - |{ 250a }{ 250b }|</para>
41219 <para>#254|, |{ 254a }|</para>
41221 <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
41224 <para>#256|, |{ 256a }|</para>
41226 <para>#257|, |{ 257a }|</para>
41228 <para>#258|, |{ 258a }{ 258b }|</para>
41230 <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
41232 <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
41235 <para>#306| - |{ 306a }|</para>
41237 <para>#307| - |{ 307a }{ 307b }|</para>
41239 <para>#310| - |{ 310a }{ 310b }|</para>
41241 <para>#321| - |{ 321a }{ 321b }|</para>
41243 <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
41244 }{ 340h }{ 340i }|</para>
41246 <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
41247 }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
41248 342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
41250 <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
41251 }{ 343h }{ 343i }|</para>
41253 <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
41255 <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
41256 }{ 352i }{ 352q }|</para>
41258 <para>#362| - |{ 362a }{ 351z }|</para>
41260 <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
41262 <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
41264 <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
41265 }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
41266 800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
41268 <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
41269 }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
41270 810s }{ 810t }{ 810u }{ 810v }|.</para>
41272 <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
41273 }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
41276 <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
41277 }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
41280 <para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
41282 <para>#501|<br/><br/>|{ 501a }|</para>
41284 <para>#502|<br/><br/>|{ 502a }|</para>
41286 <para>#504|<br/><br/>|{ 504a }|</para>
41288 <para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
41291 <para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
41292 506d }{ 506u }|</para>
41294 <para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
41296 <para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
41298 <para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
41301 <para>#511|<br/><br/>|{ 511a }|</para>
41303 <para>#513|<br/><br/>|{ 513a }{513b }|</para>
41305 <para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
41306 514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
41309 <para>#515|<br/><br/>|{ 515a }|</para>
41311 <para>#516|<br/><br/>|{ 516a }|</para>
41313 <para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
41315 <para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
41318 <para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
41320 <para>#522|<br/><br/>|{ 522a }|</para>
41322 <para>#524|<br/><br/>|{ 524a }|</para>
41324 <para>#525|<br/><br/>|{ 525a }|</para>
41326 <para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
41327 510d }{\n510x }|</para>
41329 <para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
41330 506d }{\n506u }|</para>
41332 <para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
41333 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
41335 <para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
41336 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
41339 <para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
41342 <para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
41345 <para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
41346 540d }{\n520u }|</para>
41348 <para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
41349 }{\n544d }{\n544e }{\n544n }|</para>
41351 <para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
41353 <para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
41355 <para>#547|<br/><br/>|{\n547a }|</para>
41357 <para>#550|<br/><br/>|{ 550a }|</para>
41359 <para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
41360 552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
41361 }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
41363 <para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
41364 555d }{ 555u }|</para>
41366 <para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
41368 <para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
41370 <para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
41371 565d }{ 565e }|</para>
41373 <para>#567|<br/><br/>|{ 567a }|</para>
41375 <para>#580|<br/><br/>|{ 580a }|</para>
41377 <para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
41379 <para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
41381 <para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
41383 <para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
41385 <para>#020|<br/><br/><label>ISBN: </label>|{
41386 020a }{ 020c }|</para>
41388 <para>#022|<br/><br/><label>ISSN: </label>|{
41391 <para>#222| = |{ 222a }{ 222b }|</para>
41393 <para>#210| = |{ 210a }{ 210b }|</para>
41395 <para>#024|<br/><br/><label>Standard No.:
41396 </label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
41398 <para>#027|<br/><br/><label>Standard Tech. Report.
41399 No.: </label>|{ 027a }|</para>
41401 <para>#028|<br/><br/><label>Publisher. No.:
41402 </label>|{ 028a }{ 028b }|</para>
41404 <para>#013|<br/><br/><label>Patent No.:
41405 </label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
41408 <para>#030|<br/><br/><label>CODEN: </label>|{
41411 <para>#037|<br/><br/><label>Source: </label>|{
41412 037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
41414 <para>#010|<br/><br/><label>LCCN: </label>|{
41417 <para>#015|<br/><br/><label>Nat. Bib. No.:
41418 </label>|{ 015a }{ 0152 }|</para>
41420 <para>#016|<br/><br/><label>Nat. Bib. Agency Control
41421 No.: </label>|{ 016a }{ 0162 }|</para>
41423 <para>#600|<br/><br/><label>Subjects--Personal
41424 Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
41425 }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
41426 }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
41427 }{--600x}{--600z}{--600y}{--600v}|</para>
41429 <para>#610|<br/><br/><label>Subjects--Corporate
41430 Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
41431 }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
41432 }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
41433 }{--610x}{--610z}{--610y}{--610v}|</para>
41435 <para>#611|<br/><br/><label>Subjects--Meeting Names:
41436 </label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
41437 }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
41438 611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
41440 <para>#630|<br/><br/><label>Subjects--Uniform
41441 Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
41442 }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
41443 630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
41445 <para>#648|<br/><br/><label>Subjects--Chronological
41446 Terms: </label>|{\n6483 }{\n648a
41447 }{--648x}{--648z}{--648y}{--648v}|</para>
41449 <para>#650|<br/><br/><label>Subjects--Topical Terms:
41450 </label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
41451 }{--650x}{--650z}{--650y}{--650v}|</para>
41453 <para>#651|<br/><br/><label>Subjects--Geographic
41454 Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
41455 }{--651x}{--651z}{--651y}{--651v}|</para>
41457 <para>#653|<br/><br/><label>Subjects--Index Terms:
41458 </label>|{ 653a }|</para>
41460 <para>#654|<br/><br/><label>Subjects--Facted Index
41461 Terms: </label>|{\n6543
41462 }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
41464 <para>#655|<br/><br/><label>Index Terms--Genre/Form:
41465 </label>|{\n6553 }{\n655a}{--655b}{--655x
41466 }{--655z}{--655y}{--655v}|</para>
41468 <para>#656|<br/><br/><label>Index Terms--Occupation:
41469 </label>|{\n6563
41470 }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
41472 <para>#657|<br/><br/><label>Index Terms--Function:
41473 </label>|{\n6573
41474 }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
41476 <para>#658|<br/><br/><label>Index Terms--Curriculum
41478 </label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
41480 <para>#050|<br/><br/><label>LC Class. No.:
41481 </label>|{ 050a }{ / 050b }|</para>
41483 <para>#082|<br/><br/><label>Dewey Class. No.:
41484 </label>|{ 082a }{ / 082b }|</para>
41486 <para>#080|<br/><br/><label>Universal Decimal Class.
41487 No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
41489 <para>#070|<br/><br/><label>National Agricultural
41490 Library Call No.: </label>|{ 070a }{ / 070b }|</para>
41492 <para>#060|<br/><br/><label>National Library of
41493 Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
41495 <para>#074|<br/><br/><label>GPO Item No.:
41496 </label>|{ 074a }|</para>
41498 <para>#086|<br/><br/><label>Gov. Doc. Class. No.:
41499 </label>|{ 086a }|</para>
41501 <para>#088|<br/><br/><label>Report. No.:
41502 </label>|{ 088a }|</para>
41505 <section id="unimarcdefault">
41506 <title>UNIMARC Default</title>
41508 <para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
41509 200i}|</h2></para>
41511 <para>#461|<label class="ipt">A part of : </label>|<a
41512 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
41513 461h} {v. 461v}{(461d)}<br/>|</para>
41515 <para>#200b|<label class="ipt">Material Designation :
41516 </label>| {200b }|<br/></para>
41518 <para>#101a|<label class="ipt">Language(s): </label>|<a
41519 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
41521 <para>#200f|<label class="ipt">Authors : </label>|<a
41522 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
41523 ; }</a>|<br/></para>
41525 <para>#200g|<label class="ipt">Co-authors : </label>|<a
41526 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
41527 ; }</a>|<br/></para>
41529 <para>#210a|<br/><label class="ipt">Place of pubblication
41530 : </label>|<a
41531 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
41533 <para>#210c|<label class="ipt">Publisher : </label>|<a
41534 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
41535 ; }</a>|<br/></para>
41537 <para>#210d|<label class="ipt">Date of pubblication :
41538 </label>|{ 210d}|<br/></para>
41540 <para>#215|<label class="ipt">Description :
41541 </label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
41543 <para>#225a|<label class="ipt">Series :</label>|<a
41544 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
41545 ;}</a> |</para>
41547 <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
41548 225v}|<br/></para>
41550 <para>#686|<label>Classification : </label>|{ 686a
41551 }|<br/></para>
41553 <para>#608|<label>Form, Genre : </label>|<a
41554 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
41555 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
41556 title="Search on {608a}">{
41557 608a}</a>|<br/><br/></para>
41559 <para>#200||<label class="ipt">Subjects :
41560 </label><br/>|<ul></para>
41562 <para>#600|<label class="ipt">Person(s)
41563 </label><br/> |<li><a
41564 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
41565 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
41566 title="Search on {600a}">{
41567 600a}</a></li>|<br/></para>
41569 <para>#601|<label class="ipt">Organisation(s)
41570 </label><br/>|<li><a
41571 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
41572 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
41573 title="Search on {601a}">{
41574 601a}</a></li>|<br/></para>
41576 <para>#606|<label class="ipt">Term(s)
41577 </label><br/>|<li><a
41578 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
41579 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
41580 title="Search on {606a}">{
41581 606a}</a></li>|<br/></para>
41583 <para>#607|<label class="ipt">Place(s)
41584 </label><br/>|<li><a
41585 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
41586 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
41587 title="Search on {607a}">{
41588 607a}</a></li>|<br/></para>
41590 <para>#610|<label>Keywords</label><br/>|<li><a
41591 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
41592 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
41593 title="Search on {610a}">{ 610a}</a></li>|</para>
41595 <para>#200||</ul>|</para>
41597 <para>#856|<label class="ipt">Electronic resource :
41598 </label>|<a href="{856u}">click here</a> to go to
41599 the external resource<br/></para>
41601 <para>#010|<label class="ipt">ISBN : </label>|{010a
41602 ;}|<br/></para>
41604 <para>#011|<label class="ipt">ISSN : </label>|{011a
41605 ;}|<br/></para>
41607 <para>#200||<label class="ipt">Notes :
41608 </label>|<br/><ul></para>
41610 <para>#300||<li>{300a}</li>|</para>
41612 <para>#307||<li>{307a}</li>|</para>
41614 <para>#310||<li>{310a}</li>|</para>
41616 <para>#326||<li>{326a}</li>|</para>
41618 <para>#327||<li>{327a}</li>|</para>
41620 <para>#333|<li>Public : |{333a}</li>|</para>
41622 <para>#200||</ul>|</para>
41624 <para>#330||<label class="ipt">Abstract :
41625 </label>|<br/></para>
41627 <para>#330||{330a}|<br/></para>
41629 <para>#200||<br/><h2>Items</h2>|</para>
41631 <para>#200|<table>|<th>Call
41632 number</th><th>Copy
41633 note</th><th>Fonds</th><th>Genre
41634 detail</th><th>Circulation
41635 type</th><th>Barcode</th>|</para>
41637 <para>#995||<tr><td> {995k}</td><td>
41638 {995u}</td><td>
41639 {995y}</td><td>{995e} </td><td>
41640 {995o}</td><td>{995f}</td></tr>|</table></para>
41645 <appendix id="receiptprint">
41646 <title>Configuring Receipt Printers</title>
41648 <para>The following instructions are for specific receipt printers, but
41649 can probably be used to help with setup of other brands as well.</para>
41651 <section id="epsonprinters">
41653 <corpauthor>NEKLS</corpauthor>
41655 <pubdate>2008</pubdate>
41657 <bibliosource><ulink
41658 url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
41661 <title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
41665 <section id="epsonprintdriver">
41666 <title>In the Print Driver</title>
41668 <para>For these instructions, we are using version 5,0,3,0 of the
41669 Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
41670 Register at the <ulink
41671 url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
41672 Center website</ulink> to gain access to the drivers; go to Technical
41673 Resources, then choose the printer model from the Printers drop-down
41676 <para>Click Start > Printers and Faxes > Right click the receipt
41677 printer > Properties:</para>
41681 <para>Advanced Tab, click Printing Defaults button</para>
41685 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
41689 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
41690 Printable Width</para>
41694 <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
41695 window that appears. Fit to Printable Width should be
41696 automatically selected.</para>
41700 <para>OK your way out of there.</para>
41705 <section id="epsonfirefox">
41706 <title>In Firefox</title>
41708 <para>Under File > Page Setup:</para>
41712 <para>Shrink to fit page on Format & Options tab</para>
41716 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
41717 makes the receipts use all available space on the paper
41722 <para>Set all Headers/Footers to -blank-. This removes all of the
41723 gunk you might normally find on a print from Firefox, such as the
41724 URL, number of pages, etc.</para>
41728 <para>Click OK</para>
41732 <para>Set the default printer settings in Firefox so you don't see a
41733 "Print" dialog:</para>
41737 <para>Go to File > Print</para>
41741 <para>Set the Printer to the receipt printer.</para>
41745 <para>Click the Advanced (or Properties) button</para>
41749 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
41753 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
41754 Printable Width</para>
41758 <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
41759 window that appears. Fit to Printable Width should be
41760 automatically selected.</para>
41764 <para>OK your way out, go ahead and print whatever page you are
41769 <para>Type about:config, in the address bar. Click "I'll be
41770 careful, I promise!" on the warning message.</para>
41774 <para>Type, print.always in Filter.</para>
41778 <para>Look for print.always_print_silent.</para>
41782 <para>If the preference is there then set the value to
41789 <para>If the preference is not there (and it shouldn't be in most
41790 browsers) you have to add the preference.</para>
41794 <para>Right click the preference area and select New >
41799 <para>Type print.always_print_silent in the dialog box and set
41800 the value to True. This sets the print settings in Firefox to
41801 always use the same settings and print without showing a
41809 <para>Setting the print.always_print_silent setting in about:config
41810 DISABLES the ability to choose a printer in Firefox.</para>
41815 <section id="epson2">
41817 <corpauthor>NEKLS</corpauthor>
41819 <pubdate>2008</pubdate>
41821 <bibliosource><ulink
41822 url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
41825 <title>For Epson TM-T88II (2) Printers</title>
41827 <para>Register at the <ulink
41828 url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
41829 Center website</ulink> to gain access to the drivers; go to Technical
41830 Resources, then choose the printer model from the Printers drop-down
41833 <section id="epson2firefox">
41834 <title>In Firefox</title>
41836 <para>Under File > Page Setup:</para>
41840 <para>Shrink to fit page on Format & Options tab</para>
41844 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
41845 makes the receipts use all available space on the paper
41850 <para>Set all Headers/Footers to -blank-. This removes all of the
41851 gunk you might normally find on a print from Firefox, such as the
41852 URL, number of pages, etc.</para>
41856 <para>Click OK</para>
41860 <para>Set the default printer settings in Firefox so you don't see a
41861 "Print" dialog:</para>
41865 <para>Go to File > Print</para>
41869 <para>Set the Printer to the receipt printer.</para>
41873 <para>Print whatever page you are on.</para>
41877 <para>Type about:config, in the address bar. Click "I'll be
41878 careful, I promise!" on the warning message.</para>
41882 <para>Type, print.always in Filter.</para>
41886 <para>Look for, print.always_print_silent.</para>
41890 <para>If the preference is there then set the value to
41897 <para>If the preference is not there (and it shouldn't be in most
41898 browsers) you have to add the preference.</para>
41902 <para>Right click the preference area and select New >
41907 <para>Type, print.always_print_silent in the dialog box and
41908 set the value to True. This sets the print settings in Firefox
41909 to always use the same settings and print without showing a
41917 <para>Setting the print.always_print_silent setting in about:config
41918 DISABLES the ability to choose a printer in Firefox.</para>
41923 <section id="starprinter">
41925 <corpauthor>RHCL</corpauthor>
41928 <firstname>Nicole C.</firstname>
41930 <surname>Engard</surname>
41933 <pubdate>2010</pubdate>
41936 <title>For Star SP542 Printers</title>
41938 <section id="installstarprinter">
41939 <title>Installing the Printer</title>
41941 <para>While the following comments are based on the Star SP542 receipt
41942 printer, they probably apply to all printers in the SP5xx
41945 <para>The Star SP542 receipt printer works well with Koha and <emphasis role="bold">Firefox
41946 on Windows XP SP3</emphasis>. This printer, with either the parallel or USB interface,
41947 is fairly easy to install and configure. You will need the following executable file which
41948 is available from numerous places on the Internet:</para>
41950 <para>linemode_2k-xp_20030205.exe</para>
41952 <para>This executable actually does all of the installation; you will
41953 not need to use the Microsoft Windows "Add Printer" program. We
41954 recommend that when installing, the option for the software monitor
41955 not be selected; we have experienced significant pauses and delays in
41956 printing with it. Instead, simply choose to install the receipt
41957 printer without the monitor.</para>
41959 <para>Additionally, the install program may not put the printer on the
41960 correct port, especially if using the USB interface. This is easily
41961 corrected by going to "Start -> Printers and Faxes -> Properties
41962 for the SP542 printer -> Ports", then check the appropriate
41965 <para>A reboot may be required, even if not indicated by the
41966 installation software or the operating system.</para>
41967 <para><emphasis role="bold">Windows 7</emphasis> users should refer to this page: <ulink
41968 url="http://www.starmicronics.com/supports/win7.aspx"
41969 >http://www.starmicronics.com/supports/win7.aspx</ulink>.
41974 <section id="firefoxreceipt">
41976 <corpauthor>VOKAL</corpauthor>
41979 <firstname>Nicole C.</firstname>
41981 <surname>Engard</surname>
41984 <pubdate>2010</pubdate>
41986 <bibliosource><ulink
41987 url="https://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Setting_up_your_SLIP_printer_1_18087191815760117">https://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Setting_up_your_SLIP_printer_1_18087191815760117</ulink></bibliosource>
41990 <title>Configuring Firefox to Print to Receipt Printer</title>
41994 <para>Open File > Page Setup</para>
41998 <para>Make all the headers and footers blank</para>
42002 <para>Set the margins to 0 (zero)</para>
42006 <para>In the address bar of Firefox, type about:config</para>
42010 <para>Search for print.always_print_silent and double click
42015 <para>Change it from false to true</para>
42019 <para>This lets you skip the Print pop up box that comes up, as
42020 well as skipping the step where you have to click OK,
42021 automatically printing the right sized slip.</para>
42027 <para>If print.always_print_silent does not come up</para>
42031 <para>Right click on a blank area of the preference
42036 <para>Select new > Boolean</para>
42040 <para>Enter "print.always_print_silent" as the name (without
42045 <para>Click OK</para>
42049 <para>Select true for the value</para>
42055 <para>You may also want to check what is listed for
42056 print.print_printer</para>
42060 <para>You may have to choose Generic/Text Only (or whatever your
42061 receipt printer might be named)</para>
42069 <appendix id="samplenotice">
42070 <title>Example Notice</title>
42072 <para>Nicole Engard</para>
42074 <para>410 Library Rd.</para>
42076 <para>Philadelphia, PA 19107</para>
42078 <para>Dear Nicole Engard (23529000035726),</para>
42080 <para>According to our records, at the time of this notice, you have items
42081 that are overdue. Please return or renew them as soon as possible to avoid
42082 increasing late fines.</para>
42084 <para>If you have registered a password with the library, you may use it
42085 with your library card number to renew online.</para>
42087 <para>If you believe you have returned the items below please call at and
42088 library staff will be happy to help resolve the issue.</para>
42090 <para>The following item(s) are currently overdue:</para>
42092 <para>07/08/2008 Creating drug-free schools and communities : 502326000054
42093 Fox, C. Lynn.</para>
42095 <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
42097 <para>Sincerely, Library Staff</para>
42100 <appendix id="sampleserialsapp">
42101 <title>Sample Serials</title>
42105 <section id="readersdigestsample">
42106 <title>Reader's Digest (0034-0375)</title>
42110 <para>Published 12 times a year (monthly)</para>
42114 <para>The Volume number changes every 6 months and the numbers
42115 continues on (requires an advanced pattern).</para>
42118 <screeninfo>Sample Reader's Digest Subscription</screeninfo>
42122 <imagedata fileref="images/serialssamples/readersserial.png"/>
42132 <section id="peoplesample">
42133 <title>People Weekly (1076-0091)</title>
42137 <para>Published weekly</para>
42141 <para>The website says "on Saturday except the first week of
42142 August, Thanksgiving week, the first and last weeks of the year"
42143 but this does not match the pattern for 2007 or 2008</para>
42149 <para>In the Jul-Dec there are 26 issues</para>
42153 <para>In the Jan-Jun there are 25 issues (no issue for the first
42154 week of January)</para>
42158 <para>Since the irregularity on the first # 26 does not skip a week,
42159 this would be set up as to roll over on issue 25. The 26th issue in the
42160 second half of the year would have to be received as a
42161 supplemental.</para>
42163 <para>The irregularity check will complain that 52 issues were expected,
42164 but 25 entered. The current irregularity check can only check that the
42165 first position of the numbering pattern matches the expected issue count
42166 of the periodicity. But we do need to trigger the rollover on the
42167 volume, so we need to define the last two weeks of the year as
42168 irregularities. So we receive 50 issues the first 50 weeks, then one
42169 supplemental issue in week 51, which we have to define the enumeration
42170 for, then the next predicted issue will be the following year's first
42174 <section id="hebrewserialsample">
42175 <title>Et-Mol</title>
42177 <para>This journal is published with the following rules:</para>
42181 <para>6 issues a year (every 2 months)</para>
42185 <para>year changes every 6 issues</para>
42189 <para>we start in 2011</para>
42193 <para>the issue number goes up indefinitely</para>
42197 <para>starting from issue 215</para>
42201 <para>The planning would look like this:</para>
42204 <screeninfo>Sample for this Hebrew Journal</screeninfo>
42208 <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
42213 <section id="backpackerserial">
42214 <title>Backpacker (0277-867X)</title>
42215 <para>Published 9 times a year irregularly. The issues continues while the volume and number
42216 rolls over every 9 issues. If you're holding Volume 41, Number 3, Issue 302 in your hand
42217 the prediction would look like this:<screenshot>
42218 <screeninfo>Backpacker numbering pattern</screeninfo>
42221 <imagedata fileref="images/serialssamples/backpacker.png"/>
42224 </screenshot></para>
42225 <para>And the received issues would number like this:</para>
42226 <para>v. 41, no. 3, iss. 302 </para>
42227 <para>v. 41, no. 4, iss. 303 </para>
42228 <para>v. 41, no. 5, iss. 304 </para>
42229 <para>v. 41, no. 6, iss. 305 </para>
42230 <para>v. 41, no. 7, iss. 306 </para>
42231 <para>v. 41, no. 8, iss. 307</para>
42232 <para>v. 41, no. 9, iss. 308 </para>
42233 <para>v. 42, no. 1, iss. 309 </para>
42234 <para>v. 42, no. 2, iss. 310 </para>
42235 <para>v. 42, no. 3, iss. 311 </para>
42236 <para>v. 42, no. 4, iss. 312</para>
42238 <section id="keatsserial">
42239 <title>Keats-Shelley Journal (0453-4387)</title>
42240 <para>This journal is published once per year in July. The numbering follows this pattern: <itemizedlist>
42242 <para>Vol. 61 2013</para>
42245 <para>Vol. 62 2014</para>
42248 <para>Vol. 63 2015</para>
42250 </itemizedlist> Setup should look like this (if you're starting in July 2013):<screenshot>
42251 <screeninfo>Serial planning</screeninfo>
42254 <imagedata fileref="images/serialssamples/keatsplanning.png"/>
42257 </screenshot><screenshot>
42258 <screeninfo>Advanced pattern</screeninfo>
42261 <imagedata fileref="images/serialssamples/keatsadvanced.png"/>
42264 </screenshot><screenshot>
42265 <screeninfo>Subscription info</screeninfo>
42268 <imagedata fileref="images/serialssamples/keatsnumber.png"/>
42271 </screenshot></para>
42273 <para>The prediction test will not show the right pattern, but once you receive you will see
42274 that the above does generate the right pattern.</para>
42279 <appendix id="kohacms">
42280 <title>Using Koha as a Content Management System (CMS)</title>
42284 <section id="kohacmssetup">
42285 <title>Setup</title>
42287 <para>These are instructions for taking a default install of Koha and allowing it to function
42288 as a little content management system. This will allow a library to publish an arbitrary
42289 number of pages based on a template. This example uses the template for the main opac page,
42290 but you could just as well use any template you wish with a bit more editing. This may be
42291 appropriate if you have a small library, want to allow librarians to easily add pages, and
42292 do not want to support a complete CMS. </para>
42296 <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
42297 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same directory) </para>
42301 <para>Edit pages.pl in an editor</para>
42305 <para>At approximately line 36 change this code: </para>
42307 <programlisting>template_name => "opac-main.tt",</programlisting>
42311 <para>To this code:</para>
42313 <programlisting>template_name => "pages.tt", </programlisting>
42317 <para>At approximately line 54 after this code: </para>
42318 <programlisting>$template->param(
42319 koha_news => $all_koha_news,
42320 koha_news_count => $koha_news_count
42321 );</programlisting>
42324 <para>Add these lines: </para>
42325 <programlisting> my $page = "page_" . $cgi->param('p'); # go for "p" value in URL and do the concatenation
42326 my $preference = C4::Context->preference($page); # Go for preference
42327 $template->{VARS}->{'page_test'} = $preference # pass variable to template pages.tt</programlisting>
42331 <para>Note pages.pl file must have Webserver user execution permissions, you can use
42332 <ulink url="http://en.wikipedia.org/wiki/Chmod">chmod</ulink> command if you are
42333 actually logged in as such user:
42334 <programlisting> $chmod 711 pages.pl</programlisting></para>
42338 <para>Copy /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/opac-main.tt to
42339 /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tt </para>
42342 <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tt </para>
42345 <para>At approximately line 38, change this:</para>
42346 <programlisting> [% IF ( OpacMainUserBlock ) %]<div id="opacmainuserblock" class="container">[% OpacMainUserBlock %]</div>[% END %]</programlisting>
42347 <para>To this:</para>
42348 <programlisting> [% IF ( page_test ) %]<div id="opacmainuserblock" class="container">[% page_test %]</div>[% END %]</programlisting>
42352 <para>In the browser go to Home > Administration > System Preferences > Local Use and add
42353 a New Preference called "page_test" </para>
42357 <para>Fill it out as so</para>
42361 <para>Explanation: test page for pages tiny cms</para>
42365 <para>Variable: page_test</para>
42369 <para>Value: Lorem ipsum</para>
42373 <para>Click the TextArea link (or enter "TextArea" into the
42374 input field below it)</para>
42378 <para>variable options (last field): 80|50</para>
42384 <para>In a browser go to http://youraddress/cgi-bin/koha/pages.pl?p=test The page should
42385 come up with the words "Lorem ipsum" in the main content area of the page. (replace
42386 "youraddress" with localhost, 127.0.0.1, or your domain name depending on how you have
42387 Apache set up.) </para>
42391 <para>To add more pages simply create a system preference where the title begins with
42392 "page_" followed by any arbitrary letters. You can add any markup you want as the value
42393 of the field. Reference the new page by changing the value of the "p" parameter in the
42397 <para>To learn more visit the Koha wiki page on this topic: <ulink
42398 url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS"
42399 >http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
42401 <section id="kohacmstrouble">
42402 <title>Troubleshooting</title>
42404 <para>If you have problems check file permissions on pages.pl and
42405 pages.tmpl. They should have the same user and group as other Koha
42406 files like opac-main.pl.</para>
42409 <section id="kohacmsbonus">
42410 <title>Bonus Points</title>
42412 <para>Instead of using the address
42413 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
42414 http://youraddress/pages.pl?p=test Just open up
42415 /etc/koha/koha-httpd.conf and add the follow at about line
42416 13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
42418 <para>Then restart Apache.</para>
42422 <section id="kohacmsusage">
42423 <title>Usage</title>
42425 <para>After setting up Koha as a CMS you can create new pages following
42426 these instructions:</para>
42428 <section id="kohacmspages">
42429 <title>Adding Pages</title>
42431 <para>To add a new page you need to add a system preference under
42436 <para>Get there: More > Administration > Global System
42437 Preferences > Local Use</para>
42441 <para>Click 'New Preference'</para>
42445 <para>Enter in a description in the Explanation field</para>
42449 <para>Enter a value that starts with 'page_' in the Variable
42454 <para>Enter starting HTML in the Value field</para>
42457 <screeninfo>Add a new preference</screeninfo>
42461 <imagedata fileref="images/appendix-cms/newpreference.png"/>
42468 <para>Set the Variable Type to Textarea</para>
42472 <para>Set the Variable options to something like 20|20 for 20 rows
42473 and 20 columns</para>
42476 <screeninfo>Settings for the new preference</screeninfo>
42480 <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
42488 <section id="kohacmsview">
42489 <title>Viewing your page</title>
42491 <para>You can view your new page at
42492 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
42493 the part you entered after 'page_' in the Variable field.</para>
42496 <section id="kohacmsexpage">
42497 <title>Example</title>
42499 <para>This process can be used to create recommended reading lists
42500 within Koha. So once the code changes have been made per the
42501 instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
42502 instructions above to great a page for 'Recommended Reading
42506 <screeninfo>Create page by modifying a system
42507 preference</screeninfo>
42511 <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
42516 <para>Next we need to create pages for our various classes (or
42517 categories). To do this, return to the 'Adding a New Page' section and
42518 create a preference for the first class.</para>
42521 <screeninfo>Add a new sys pref for another page</screeninfo>
42525 <imagedata fileref="images/appendix-cms/class101-pref.png"/>
42530 <para>Next you'll want to link your first page to your new second
42531 page, go to the page_recommend preference and click 'Edit.' Now you
42532 want to edit the HTML to include a link to your newest page:</para>
42535 <screeninfo>Edit original preference to add new page</screeninfo>
42539 <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
42545 <section id="examplecms">
42546 <title>Live Examples</title>
42550 <para>The Crawford Library at Dallas Christian College is using
42551 this method for their recommended reading lists: <ulink
42552 url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
42559 <appendix id="resetkohadb">
42560 <title>Resetting the Koha Database</title>
42562 <para>These notes on how to reset the database for Koha 3 were derived
42563 from the following email thread: <ulink
42564 url="http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html">http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html</ulink></para>
42566 <para>Resetting the database may be useful if you install Koha with the
42567 sample data, and then wish to use real data without reinstalling the
42570 <section id="truncate">
42571 <title>Truncate Tables</title>
42573 <para>Use your preferred MySQL client to <ulink
42574 url="http://dev.mysql.com/doc/refman/5.0/en/truncate.html">truncate</ulink>
42575 the following tables:</para>
42583 <para>biblioitems</para>
42591 <para>auth_header</para>
42595 <para>sessions</para>
42599 <para>zebraqueue</para>
42604 <section id="resetzebra">
42605 <title>Reset the Zebra Index</title>
42607 <para>Run the following commands to reset the authorities and biblios
42608 Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
42609 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
42613 <appendix id="importantlinks">
42614 <title>Important Links</title>
42618 <section id="koharelatedlinks">
42619 <title>Koha Related</title>
42623 <para>Report Koha Bugs - <ulink
42624 url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
42628 <para>Koha Versioning Control - <ulink
42629 url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
42633 <para>Database Structure - <ulink
42634 url="http://git.koha-community.org/cgi-bin/gitweb.cgi?p=koha.git;a=blob_plain;f=installer/data/mysql/kohastructure.sql;hb=HEAD">http://git.koha-community.org/cgi-bin/gitweb.cgi?p=koha.git;a=blob_plain;f=installer/data/mysql/kohastructure.sql;hb=HEAD</ulink></para>
42638 <para>Koha as a CMS - <ulink
42639 url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
42643 <para>Kyles's Koha Tools - <ulink
42644 url="http://millruntech.com/koha">http://millruntech.com/koha</ulink></para>
42648 <para>Koha Bibliography - <ulink
42649 url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
42653 <para>Koha Shared Links - <ulink
42654 url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
42658 <para>Koha Presentations - <ulink
42659 url="http://www.slideshare.net/group/koha-ils/slideshows">http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
42664 <section id="catalogrelatedlinks">
42665 <title>Cataloging Related</title>
42669 <para>Koha MARC Tutorials - <ulink
42670 url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
42674 <para>Z39.50 Server Search - <ulink
42675 url="http://targettest.indexdata.com/">http://targettest.indexdata.com/</ulink></para>
42679 <para>Z39.50 Server List - <ulink
42680 url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm">http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
42684 <para>Library of Congress Authorities - <ulink
42685 url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
42689 <para>MARC Country Codes - <ulink
42690 url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
42694 <para>Search the MARC Code List for Organizations - <ulink
42695 url="http://www.loc.gov/marc/organizations/org-search.php">http://www.loc.gov/marc/organizations/org-search.php</ulink></para>
42699 <para>Search for Canadian MARC Codes - <ulink
42700 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1</ulink></para>
42704 <para>Z39.50 Bib-1 Attribute - <ulink
42705 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink></para>
42710 <section id="enhancedcontentlinks">
42711 <title>Enhanced Content Related</title>
42715 <para>Amazon Associates - <ulink
42716 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
42720 <para>Amazon Web Services - <ulink
42721 url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
42725 <para>WorldCat Affiliate Tools - <ulink
42726 url="http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister">http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister</ulink></para>
42730 <para>XISBN - <ulink
42731 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
42735 <para>LibraryThing for Libraries - <ulink
42736 url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
42741 <section id="opaclinks">
42742 <title>Design Related</title>
42746 <para>JQuery Library - <ulink
42747 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
42751 <para>Owen Leonard's Koha Blog - <ulink
42752 url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
42757 <section id="reportlinks">
42758 <title>Reports Related</title>
42762 <para>SQL Reports Library - <ulink
42763 url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink></para>
42767 <para>Database Schema - <ulink
42768 url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
42772 <para>Sample reports from NEKLS - <ulink
42773 url="http://www.nexpresslibrary.org/training/reports-training/"
42774 >http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
42779 <section id="installlinks">
42780 <title>Installation Guides</title>
42784 <para>Installing Koha 3 on Ubuntu - <ulink
42785 url="http://www.blazingmoon.org/guides/k3-on-u810-1.html">http://www.blazingmoon.org/guides/k3-on-u810-1.html</ulink></para>
42789 <para>Koha on Debian installation documentation - <ulink
42790 url="http://openlib.org/home/krichel/courses/lis508/doc/koha_installation_overview.html">http://openlib.org/home/krichel/courses/lis508/doc/koha_installation_overview.html</ulink></para>
42794 <para>Koha 3.2 on Debian Squeeze - <ulink
42795 url="http://wiki.koha-community.org/wiki/Koha_3.2_on_Debian_Squeeze">http://wiki.koha-community.org/wiki/Koha_3.2_on_Debian_Squeeze</ulink></para>
42800 <section id="misclinks">
42801 <title>Misc</title>
42805 <para>Zotero - <ulink
42806 url="http://zotero.org">http://zotero.org</ulink></para>
42810 <para>SOPAC - <ulink
42811 url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
42817 <appendix id="XSLTiTypes">
42818 <title>Koha XSLT Item Types</title>
42820 <para>When you have any of the XSLT system preferences (<link
42821 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>, <link
42822 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>, <link
42823 linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>, and/or <link
42824 linkend="XSLTResultsDisplay">XSLTResultsDisplay</link>) along with the
42825 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
42826 preference turned on you will see item type icons on the related screen.
42828 <para>These images are coming from values found in your leader, if
42829 your leader is not cataloged properly it might be best to turn off the
42830 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
42831 preference (which can be done while leaving the other XSLT preferences
42833 </important></para>
42836 <screeninfo>Book image</screeninfo>
42840 <imagedata fileref="images/appendix-xslt/book.png"/>
42847 <para>Book [BK]</para>
42851 <para>leader6 = a (and one of the leader7 values below)</para>
42855 <para>leader7 = a</para>
42859 <para>leader7 = c</para>
42863 <para>leader7 = d</para>
42867 <para>leader7 = m</para>
42873 <para>leader6 = t</para>
42880 <screeninfo>Computer Image</screeninfo>
42884 <imagedata fileref="images/appendix-xslt/comp.png"/>
42891 <para>Computer File [CF]</para>
42895 <para>leader6 = m</para>
42902 <screeninfo>Continuing Resource Image</screeninfo>
42906 <imagedata fileref="images/appendix-xslt/cr.png"/>
42913 <para>Continuing Resource [CR]</para>
42917 <para>leader7 = b</para>
42921 <para>leader7 = i</para>
42925 <para>leader7 = s</para>
42932 <screeninfo>Map Image</screeninfo>
42936 <imagedata fileref="images/appendix-xslt/map.png"/>
42943 <para>Map [MP]</para>
42947 <para>leader6 = e</para>
42951 <para>leader6 = f</para>
42958 <screeninfo>Mixed Materials Image</screeninfo>
42962 <imagedata fileref="images/appendix-xslt/mixed.png"/>
42969 <para>Mixed [MX]</para>
42973 <para>leader6 = p</para>
42980 <screeninfo>Sound Image</screeninfo>
42984 <imagedata fileref="images/appendix-xslt/sound.png"/>
42991 <para>Sound [MU]</para>
42995 <para>leader6 = c</para>
42999 <para>leader6 = d</para>
43003 <para>leader6 = i</para>
43007 <para>leader6 = j</para>
43014 <screeninfo>Visual Material Image</screeninfo>
43018 <imagedata fileref="images/appendix-xslt/visual.png"/>
43025 <para>Visual Material [VM]</para>
43029 <para>leader6 = g</para>
43033 <para>leader6 = k</para>
43037 <para>leader6 = r</para>
43044 <screeninfo>Kit Image</screeninfo>
43048 <imagedata fileref="images/appendix-xslt/kit.png"/>
43059 <para>leader6 = o</para>
43066 <appendix id="marcedit">
43067 <title>MarcEdit</title>
43069 <para>Download MarcEdit : <ulink url="http://marcedit.reeset.net/"
43070 >http://marcedit.reeset.net/</ulink></para>
43072 <section id="marceditprefix">
43073 <title>Adding a prefix to call numbers</title>
43075 <para>When bringing data into Koha, you may want to first clean it up.
43076 One common action among Koha users is to add a prefix to the call
43081 <para>Open MarcEdit</para>
43084 <screeninfo>MarcEdit</screeninfo>
43088 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
43095 <para>Click 'MarcEditor'</para>
43099 <para>Go to Tools > Edit Subfield Data</para>
43102 <screeninfo>Edit subfield data</screeninfo>
43106 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
43113 <para>To prepend data the special character is: ^b To simply
43114 prepend data to the beginning of a subfield, add ^b to the Field
43115 Data: textbox and the data to be appended in the Replace</para>
43118 <screeninfo>Prepend data to a field</screeninfo>
43122 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
43129 <para>To prepend data to the beginning of the subfield while
43130 replacing a text string, add ^b[string to replace] to the Field
43131 Data textbox and the data to be appended in the Replace With
43139 <section id="marceditexcel">
43142 <firstname>Kanika</firstname>
43144 <surname>Goyal</surname>
43147 <orgname>Delhi Technological University</orgname>
43152 <firstname>Nicole C.</firstname>
43154 <surname>Engard</surname>
43157 <pubdate>2010</pubdate>
43159 <bibliosource><ulink
43160 url="http://www.botskool.com/geeks/how-import-excel-data-koha">http://www.botskool.com/geeks/how-import-excel-data-koha</ulink></bibliosource>
43163 <title>Importing Excel data into Koha</title>
43165 <para>Suppose you have records of your library in excel data sheet
43166 format and want them to import into Koha. But how will you do this? Koha
43167 will not let you import excel records directly. Well here is a very
43168 simple solution for you which will let you import your excel records in
43169 Koha easily. First, we will convert excel file into Marc file and then
43170 will import it into Koha.</para>
43172 <para>Follow the given steps to import your excel records into
43175 <section id="convertexcel">
43176 <title>Converting from Excel format into .mrk format</title>
43179 <para>First, we will convert excel format into .mrk format. For this we will use MarcEdit.
43180 You can download it from <ulink url="http://marcedit.reeset.net/"
43181 >http://marcedit.reeset.net/</ulink></para>
43183 <para>Now open it and select Add-ins-->Delimited Text
43187 <screeninfo>Delimited Text Translator</screeninfo>
43191 <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
43196 <para>Click Next when the following window appears.</para>
43199 <screeninfo>Delimited Text Translator</screeninfo>
43203 <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
43208 <para>Browse for your excel file.</para>
43211 <screeninfo>Delimited Text Translator</screeninfo>
43215 <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
43220 <para>Locate your excel file by choosing the format Excel
43221 File(*.xls).</para>
43224 <screeninfo>Delimited Text Translator</screeninfo>
43228 <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
43233 <para>Similarly, fill all the other entries such as Output File, Excel
43234 Sheet Name and check UTF-8 Encoded (if required) and Click
43238 <screeninfo>Delimited Text Translator</screeninfo>
43242 <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
43247 <para>Now you will be prompted for mapping the fields to recognise the
43248 fields by standard marc format.</para>
43250 <para>Suppose for Field 0 that is first column I entered Map to:
43251 022$a( Valid ISSN for the continuing resource) and then click on
43255 <screeninfo>Delimited Text Translator</screeninfo>
43259 <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
43265 <para>You can customize Indicators and all other things, for more
43266 information on marc21 format visit the <ulink
43267 url="http://www.loc.gov/marc/bibliographic/">official library of
43268 congress site</ulink>.</para>
43271 <para>Similarly map all other fields and then Click on Finish.</para>
43274 <screeninfo>Delimited Text Translator</screeninfo>
43278 <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
43283 <para>And then a window will appear indicating that your Marc Text
43284 File(*.mrk) has been created.</para>
43287 <screeninfo>Delimited Text Translator</screeninfo>
43291 <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
43296 <para>Click Close and we have created a .mrk file from .xls file in
43297 this step. You can view the file by double clicking on it.</para>
43300 <section id="convertmrk">
43301 <title>Convert .mrk file to .mrc</title>
43303 <para>We will convert .mrk file that we have created in the above step
43304 into raw Marc format that can be directly imported into Koha.</para>
43306 <para>For this again open MarcEdit and Select MARC Tools.</para>
43309 <screeninfo>MARC Tools</screeninfo>
43313 <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
43318 <para>Next Select MarcMaker to convert .mrk file into .mrc
43322 <screeninfo>MarcMaker</screeninfo>
43326 <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
43331 <para>Locate your input file and name your output file. Then Click
43335 <screeninfo>MarcMaker</screeninfo>
43339 <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
43344 <para>And it will show you the Result.</para>
43347 <screeninfo>MarcMaker</screeninfo>
43351 <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
43356 <para>Click Close and now we have raw Marc records with us (.mrc
43360 <section id="importmrc">
43361 <title>Import .mrc into Koha</title>
43363 <para>More information on importing records into Koha can be found in
43364 the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
43365 section of this manual.</para>
43367 <para>Finally we will import above created .mrc file into Koha.</para>
43369 <para>Click on Tools in your Koha staff client.</para>
43372 <screeninfo>Koha Staff Client</screeninfo>
43376 <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
43381 <para>Next Click on Stage MARC Records for Import.</para>
43384 <screeninfo>Stage MARC Records for Import</screeninfo>
43388 <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
43393 <para>After this, choose your previously created .mrc file and click
43397 <screeninfo>Stage File</screeninfo>
43401 <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
43406 <para>You can also add comment about file and finally click on Stage
43410 <screeninfo>Stage for Import</screeninfo>
43414 <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
43419 <para>When the import is done, you will get a result something like
43423 <screeninfo>Staged Records Summary</screeninfo>
43427 <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
43432 <para>Next, click on Manage staged records.</para>
43434 <para>Here you can even change matching rules.</para>
43437 <screeninfo>Manage Staged Records</screeninfo>
43441 <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
43446 <para>Click on Import this batch into catalog when you are
43449 <para>Thats it. After all the records get imported, check Status and
43450 it should read "imported"</para>
43453 <screeninfo>Finalize Import</screeninfo>
43457 <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
43462 <para>You can even undo the Import operation.</para>
43464 <para>And within few minutes, we have imported around 10,000 records
43470 <appendix id="talkingtechappendix">
43471 <title>Talking Tech</title>
43473 <para>Talking Tech I-tiva is a third party, proprietary, product that
43474 libraries can subscribe to. Learn more here: <ulink
43475 url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
43477 <section id="talkingtechinstall">
43478 <title>Installation and Setup Instructions</title>
43480 <para>Be sure you've run
43481 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
43482 to install the required data pack (new syspref, notice placeholders and
43483 messaging transport preferences)</para>
43485 <para>To use, <link
43486 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
43487 syspref must be turned on.</para>
43489 <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
43491 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
43492 system preference turned on, and patrons to have filled in a preference
43493 for receiving these notices by phone.</para>
43495 <para>For OVERDUE messages, overdue notice triggers must be configured
43496 under Koha -> Tools -> <link linkend="noticetriggers">Overdue
43497 Notice Triggers</link>. Either branch-specific triggers or the default
43498 level triggers may be used (script will select whichever is
43499 appropriate).</para>
43502 <section id="talkingtechsend">
43503 <title>Sending Notices File</title>
43507 <para>Add the <link
43508 linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
43509 script to your crontab</para>
43513 <para>Add an FTP/SFTP or other transport method to send the output
43514 file to the I-tiva server</para>
43518 <para>If you wish, archive the sent notices file in another
43519 directory after sending</para>
43523 <para>Run TalkingTech_itiva_outbound.pl --help for more
43527 <section id="talkingtechreceive">
43528 <title>Receiving Results File</title>
43532 <para>Add an FTP/SFTP or other transport method to send the Results
43533 file to a known directory on your Koha server</para>
43537 <para>Add the <link
43538 linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
43539 script to your crontab, aimed at that directory</para>
43543 <para>If you wish, archive the results file in another directory
43544 after processing</para>
43548 <para>Run TalkingTech_itiva_inbound.pl --help for more
43552 <appendix id="oclcappendix">
43553 <title>OCLC Connexion Gateway</title>
43554 <para>Koha can be set to work with the OCLC Connextion Gateway. This allows libraries to use
43555 OCLC Connexion as their cataloging tool and simply send those records to Koha with a single
43556 click. The following instructions will help you set up the OCLC Connexion Gateway, if you
43557 have a system administrator you will want to consult with them on this process.</para>
43558 <section id="oclckohasetup">
43561 <firstname>D. Ruth</firstname>
43563 <surname>Bavousett</surname>
43567 <orgname>ByWater Solutions.com</orgname>
43570 <othercredit role="copyeditor">
43571 <firstname>Nicole C.</firstname>
43573 <surname>Engard</surname>
43575 <contrib>Changed content where necessary.</contrib>
43578 <pubdate>2012</pubdate>
43580 <title>Setting up OCLC service on Koha</title>
43581 <para>First, you'll need to create a file somewhere on your system with configuration
43582 information. You could put this anywhere that is visible to the account that will be
43583 running the service. </para>
43584 <para>The file contains 11 lines. The first 6 will be about your Koha
43585 system:<programlisting>host: The IP address of your Koha server
43586 port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
43587 koha: The full URL of your staff client
43588 log: The location (full file specification) of your log for the service
43589 user: The default Koha username to use for importing
43590 password: The password that goes with that username</programlisting></para>
43591 <para>The remaining lines describe how to do the staging:
43592 <programlisting>match: The name of the matching rule from your system to use
43593 overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
43594 nomatch_action: "create_new" or "ignore"-- what to do if there is no match
43595 item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
43596 import_mode: "direct" or "stage"</programlisting></para>
43597 <para> A sample file would look like
43598 this:<programlisting>host: 1.2.3.4
43600 log: /home/koha/koha-dev/var/log/connexion.log
43601 koha: http://kohastaff.myuniversity.edu
43602 user: koha_generic_staff
43605 overlay_action: replace
43606 nomatch_action: create_new
43607 item_action: ignore
43608 import_mode: direct</programlisting></para>
43609 <para>When choosing an 'import_mode' if you use "direct" then the staged record will be
43610 immediately imported into Koha, and should be searchable after your indexes catch up. If
43611 you choose "stage", then the record will be placed in a staged batch for you to later go the
43612 <link linkend="managestaged">Managed Staged MARC Records</link> tool to finish the import. </para>
43613 <para>If you import multiple records, they'll be in the same batch, until that batch is
43614 imported, then a new batch will be created. </para>
43615 <para>In "direct" mode, each record will be in its' own batch. </para>
43616 <para>To start the service, run the script:
43617 <programlisting>/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf</programlisting></para>
43620 <section id="oclcdesktopsetup">
43623 <firstname>D. Ruth</firstname>
43625 <surname>Bavousett</surname>
43629 <orgname>ByWater Solutions.com</orgname>
43632 <othercredit role="copyeditor">
43633 <firstname>Nicole C.</firstname>
43635 <surname>Engard</surname>
43637 <contrib>Changed content where necessary.</contrib>
43640 <pubdate>2012</pubdate>
43642 <title>Setting up your OCLC desktop client</title>
43643 <para> To set up the OCLC Connexion desktop client to connect to Koha, go to Tools/Options,
43644 then choose the Export tab. <itemizedlist>
43646 <para>Click the "Create..." button to set up a new destination, then choose "OCLC
43647 Gateway Export" and click OK.</para>
43650 <para>Enter the host name or IP address (host: from your config file) and the port
43651 (port: <link linkend="oclckohasetup">from above</link>). </para>
43654 <para>Make sure that the "Notify Host Before Disconnect" box is checked, and that
43655 "Permanent Connection" and "Print Results to Default Printer" are not.</para>
43658 <para>Set the three numeric parameters: Timeout: 100 Retries: 3 Delay: 0 </para>
43661 <para>In the "Local System Authorization" box, click the "Send Local System Login Id and
43662 Password" box, then enter the Koha login and password you want to use.</para>
43665 <para>Click "OK" to save this connection.</para>
43668 <para>Click on "Record Characteristics" and make sure that the bibliographic records are
43669 using MARC21, UTF-8 Unicode, and click OK to save. </para>
43671 </itemizedlist></para>
43672 <para>You should be ready to go! To export a record from OCLC Connexion Client to Koha, just
43673 press F5 while the record is on-screen. The export dialog will pop up, and you'll see
43674 Connexion attempting to talk to Koha. You should get a message that the record was added or
43675 overlaid, including its biblio number, and a URL that you can copy into your web browser to
43676 jump straight to the record. </para>
43680 <appendix id="faqs">
43681 <title>FAQs</title>
43685 <section id="displayfaq">
43686 <title>Display</title>
43690 <section id="customicons">
43691 <title>Custom Item Type/Authorized Value Icons</title>
43693 <para><emphasis role="bold">Question:</emphasis> Can I have my own set
43694 of item type images (or authorized value icons)?</para>
43696 <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
43697 additional icons to your system you simply add a new directory to
43698 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
43699 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
43700 directory. Your icons will show up in a new tab as soon as they are in
43701 the folders.</para>
43706 <para>Remember to put the icons in both places (on the OPAC and
43707 the intranet).</para>
43713 <section id="customkohaimages">
43714 <title>Customizing Koha Images</title>
43716 <para><emphasis role="bold">Question</emphasis>: Can I customize the
43717 images in the OPAC?</para>
43719 <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
43720 with a series of original images that you can alter to meet your
43721 needs. The originals can be found in the misc/interface_customization/
43725 <section id="opacdisplayfaq">
43726 <title>OPAC Display Fields</title>
43728 <para><emphasis role="bold">Question</emphasis>: What MARC fields
43729 print to the different OPAC screens in Koha?</para>
43731 <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
43732 must be set as follows for the following fields to show</para>
43737 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
43738 using XSLT stylesheets</para>
43743 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
43744 using XSLT stylesheets</para>
43749 linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
43754 <para>The OPAC Results page shows:</para>
43762 <para>100, 110, 111</para>
43766 <para>700, 710, 711</para>
43786 <para>The OPAC Details page shows:</para>
43794 <para>100, 110, 111</para>
43798 <para>700, 710, 711</para>
43802 <para>440, 490</para>
43830 <para>130, 240</para>
43870 <para>plus all of the 5xx fields in the Notes tab at the
43876 <section id="displaysubtitle">
43877 <title>Subtitle Display on Bib Records</title>
43879 <para><emphasis role="bold">Question</emphasis>: How do I get the
43880 subtitle to display on the detail pages for my bib records?</para>
43882 <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
43883 depends on there being a <link linkend="keywordmapping">keyword
43884 mapping</link> for the MARC field in question. Adding a mapping for
43885 "subtitle" -> "245b" for an item's framework results in display of
43886 the subtitle in OPAC and staff client search and detail pages
43887 (although not in all instances where subtitles might be displayed,
43888 e.g. the Cart).</para>
43891 <section id="customlogo">
43894 <firstname>Owen</firstname>
43896 <surname>Leonard</surname>
43899 <orgname>Athens County Public Library</orgname>
43903 <pubdate>July 2010</pubdate>
43906 <title>Customize Logo on Staff Client</title>
43908 <para><emphasis role="bold">Question</emphasis>: How do I change the
43909 Koha logo on the Staff Client login page?</para>
43911 <para><emphasis role="bold">Answer</emphasis>: <link
43912 linkend="opacsmallimage">Opacsmallimage</link> controls the display of
43913 the Koha logo in the OPAC, but there is no system preference
43914 controlling the logo on the staff client login page. Luckily the logo
43915 is displayed via CSS so it can be easily customized through some
43918 <para>These are the relevant parts of the staff client default CSS:
43919 <programlisting>#login h1 {
43920 background:url("../../img/koha-logo.gif") no-repeat scroll center
43922 margin-bottom:0.5em;
43927 border-bottom:medium none;
43930 text-indent:-1000px;
43931 }</programlisting></para>
43933 <para>If you have access to the file system on your Koha server you
43934 can add a custom CSS file and specify that file using the <link
43935 linkend="intranetcolorstylesheet">intranetcolorstylesheet</link>
43936 system preference.</para>
43938 <para>There is no analogue to the <link
43939 linkend="OPACUserCSS">OPACUserCSS</link> preference in the staff
43940 client, but you can get around this by putting this in the <link
43941 linkend="intranetuserjs">intranetuserjs</link> preference:
43942 <programlisting>//]]>
43944 <style type="text/css">
43945 /* inline styles */
43947 <script type="text/javascript">
43948 //<![CDATA[</programlisting></para>
43950 <para>In the above snippet where it says /* inline styles */ we'll
43951 redeclare the relevant properties from the styles of the login
43952 image:<programlisting>//]]>
43954 <style type="text/css">
43955 /* inline styles */
43958 background:url("../../img/koha-logo.gif") no-repeat scroll center
43966 <script type="text/javascript">
43968 </programlisting></para>
43970 <para>I've only reproduced the properties necessary to make the change
43971 we want. You can see that the "background:" property sets the path to
43972 the default logo. You can change this to point to any image you want,
43973 on the Koha server or anywhere else. Then you just need to change the
43974 #login h1 a's "height" property to match the height of the image you
43977 <para>For example:</para>
43979 <para><programlisting>//]]>
43981 <style type="text/css">
43982 /* inline styles */
43985 background:url("http://www.myacpl.org/sites/all/themes/npl/logo.png")
43986 no-repeat scroll center top transparent;
43993 <script type="text/javascript">
43994 //<
projects / kohadocs.git / blob