1 <?xml version="1.0" encoding="US-ASCII"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
6 <title>Koha 3.8 Manual (en)</title>
8 <author id="manualauthor">
9 <firstname>Nicole C.</firstname>
11 <surname>Engard</surname>
14 <orgname>ByWater Solutions/BibLibre</orgname>
18 <copyright id="manualcopy">
21 <holder>Nicole C. Engard/ByWater Solutions/BibLibre</holder>
24 <legalnotice id="manuallegal">
25 <para>This manual is licensed under the <ulink
26 url="http://www.gnu.org/licenses/gpl.html">GNU General Public License,
27 version 3</ulink> or later</para>
29 <para>Learn more about this license in the <link linkend="gpl">GPL3
30 Appendix</link></para>
33 <pubdate id="manualpubdate">2012</pubdate>
36 <chapter id="administration">
37 <title>Administration</title>
39 <section id="globalsysprefs">
40 <title>Global System Preferences</title>
42 <para>Global system preferences control the way your Koha system works
43 in general. Set these preferences before anything else in Koha.</para>
47 <para><emphasis>Get there:</emphasis> More > Administration >
48 Global System Preferences</para>
53 <screeninfo>Global System Preferences Link and Search</screeninfo>
57 <imagedata fileref="images/admin/globalprefs/prefsearch.png"/>
62 <para>System preferences can be searched (using any part of the
63 preference name or description) using the search box on the
64 'Administration' page or the search box at the top of each system
65 preferences page.</para>
68 <screeninfo>Preferences search at the top of System Preference
73 <imagedata fileref="images/admin/globalprefs/prefsearch1.png"/>
78 <para>When editing preferences a '(modified)' tag will appear next to
79 items you change until you click the 'Save All' button:</para>
82 <screeninfo>After editing TagsModeration the '(modified)' label
87 <imagedata fileref="images/admin/globalprefs/saveallprefs.png"/>
92 <para>After saving your preferences you'll get a confirmation message
93 telling you what preferences were saved:</para>
96 <screeninfo>Preference save confirmation message</screeninfo>
100 <imagedata fileref="images/admin/globalprefs/saveconfirmation.png"/>
105 <para>Each section of preferences can be sorted alphabetically by
106 clicking the small down arrow to the right of the word 'Preference' in
107 the header column</para>
110 <screeninfo>Sort option at the top right of each section of
111 preferences</screeninfo>
115 <imagedata fileref="images/admin/globalprefs/sortprefs.png"/>
120 <para>If the preference refers to monetary values (like <link
121 linkend="maxoutstanding">maxoutstanding</link>) the currency displayed
122 will be the default you set in your <link
123 linkend="currexchangeadmin">Currency and Exchange Rate</link>
124 administration area. In the examples to follow they will all read USD
125 for U.S. Dollars.</para>
127 <section id="acqprefs">
128 <title>Acquisitions</title>
130 <para><emphasis>Get there:</emphasis> More > Administration >
131 Global System Preferences > Acquisitions</para>
133 <section id="acqprefspolicy">
134 <title>Policy</title>
136 <section id="AcqCreateItem">
137 <title>AcqCreateItem</title>
139 <para>Default: placing an order</para>
141 <para>Asks: Create an item when ___.</para>
147 <para>cataloging a record</para>
151 <para>placing an order</para>
155 <para>receiving an order</para>
159 <para>Description:</para>
163 <para>This preference lets you decide when you'd like to
164 create an item record in Koha. If you choose to add an item
165 record when 'placing an order' then you will enter item
166 information in as you place records in your basket. If you
167 choose to add the item when 'receiving an order' you will be
168 asked for item record information when you're receiving orders
169 in acquisitions. If you choose to add the item when
170 'cataloging a record' then item records will not be created in
171 acquisitions at all, you will need to go to the cataloging
172 module to add the items.</para>
177 <section id="AcqViewBaskets">
178 <title>AcqViewBaskets</title>
180 <para>Default: created by staff member</para>
182 <para>Asks: Show baskets ___</para>
188 <para>created by staff member</para>
192 <para>from staff member's branch</para>
196 <para>in system, regardless of owner</para>
200 <para>Description:</para>
204 <para>When in acquisitions this preference allows you to
205 control whose baskets you can see when looking at a vendor.
206 The default value of 'created by staff member' makes it so
207 that you only see the baskets you created. Choosing to see
208 baskets 'from staff member's branch' will show you the baskets
209 created by anyone at the branch you're logged in at. Finally,
210 you can choose to set this preference to show you all baskets
211 regardless of who created it ('in system, regardless of
212 owner). Regardless of which value you choose for this
213 preference, superlibrarians can see all baskets created in the
219 <section id="BasketConfirmations">
220 <title>BasketConfirmations</title>
222 <para>Default: always ask for confirmation</para>
224 <para>Asks: When closing or reopening a basket, ___.</para>
230 <para>always ask for confirmation</para>
234 <para>do not ask for confirmation</para>
238 <para>Descriptions:</para>
242 <para>This preference adds the option to skip confirmations on
243 closing and reopening a basket. If you skip the confirmation,
244 you do not create a new basket group.</para>
249 <section id="CurrencyFormat">
250 <title>CurrencyFormat</title>
252 <para>Default: 360,000.00 (US)</para>
254 <para>Asks: Display currencies using the following format
261 <para>360,000.00 (US)</para>
265 <para>360 000,00 (FR)</para>
273 <para>Default: 0</para>
275 <para>Asks: The default tax rate is ___</para>
277 <para>Description:</para>
281 <para>This preference will allow the library to define a
282 default Goods and Services Tax rate. The default of value of 0
283 will disable this preference.</para>
288 <para>Enter this value as a number (.06) versus a percent
293 <section id="UniqueItemFields">
294 <title>UniqueItemFields</title>
296 <para>Default: barcode</para>
298 <para>Asks:___ (space-separated list of fields that should be
299 unique for items, must be valid SQL fields of <ulink
300 url="http://schema.koha-community.org/tables/items.html">items</ulink>
303 <para>Description:</para>
307 <para>If this preference is left blank when adding items in
308 acquisitions there will be no check for uniqueness. This means
309 that a duplicate barcode can be created in acquisitions which
310 will cause errors later when checking items in and out.</para>
316 <section id="acqprefsprinting">
317 <title>Printing</title>
319 <section id="OrderPdfFormat">
320 <title>OrderPdfFormat</title>
322 <para>Default: pdfformat::layout2pages</para>
324 <para>Asks: Use ___ when printing basket groups.</para>
329 <section id="adminprefs">
330 <title>Administration</title>
332 <para>These preferences are general settings for your system.</para>
334 <para><emphasis>Get there:</emphasis> More > Administration >
335 Global System Preferences > Administration</para>
337 <section id="casauthentication">
338 <title>CAS Authentication</title>
340 <para>The Central Authentication Service (CAS) is a single sign-on
341 protocol for the web. If you don't know what this is, leave these
342 preferences set to their defaults.</para>
344 <section id="AllowPkiAuth">
345 <title>AllowPkiAuth</title>
347 <para>Default: no</para>
349 <para>Asks: Use ___ field for SSL client certificate
350 authentication</para>
360 <para>the Common name</para>
364 <para>the EmailAddress</para>
369 <section id="casAuthentication">
370 <title>casAuthentication</title>
372 <para>Default: Don't use</para>
374 <para>Asks: ___ CAS for login authentication.</para>
377 <section id="casLogout">
378 <title>casLogout</title>
380 <para>Default: Don't logout</para>
382 <para>Asks: ___ of CAS when logging out of Koha.</para>
385 <section id="casServerUrl">
386 <title>casServerUrl</title>
388 <para>Asks: The CAS Authentication Server can be found at
393 <section id="adminprefsinterface">
394 <title>Interface options</title>
396 <para>These preference are related to your Koha interface</para>
398 <section id="DebugLevel">
399 <title>DebugLevel</title>
401 <para>Default: lots of</para>
403 <para>Asks: Show ___ debugging information in the browser when an
404 internal error occurs.</para>
410 <para>lots of - will show as much information as
415 <para>no - will only show basic error messages</para>
419 <para>some - will show only some of the information
424 <para>Description:</para>
428 <para>This preference determines how much information will be
429 sent to the user's screen when the system encounters an error.
430 The most detail will be sent when the value level is set at 2,
431 some detail will be sent when the value is set at 1, and only
432 a basic error message will display when the value is set at 0.
433 This setting is especially important when a system is new and
434 the administration is interested in working out the bugs
435 (errors or problems) quickly. Having detailed error messages
436 makes quick fixes more likely in problem areas.</para>
441 <section id="delimiter">
442 <title>delimiter</title>
444 <para>Default: semicolons</para>
446 <para>Asks: Separate columns in an exported report file with ___
457 <para>backslashes</para>
465 <para>semicolons</para>
477 <para>Description:</para>
481 <para>This preference determines how reports exported from
482 Koha will separate data. In many cases you will be able to
483 change this option when exporting if you'd like.</para>
488 <section id="KohaAdminEmailAddress">
489 <title>KohaAdminEmailAddress</title>
491 <para>This is the default 'From' address for emails unless there
492 is one for the particular branch, and is referred to when an
493 internal error occurs.</para>
495 <para>Asks: Use ___ as the email address for the administrator of
498 <para>Description:</para>
502 <para>This preference allows one email address to be used in
503 warning messages set to the OPAC. If no email address is set
504 for the branch this address will receive messages from patrons
505 regarding modification requests, purchase suggestions, and
506 questions or information regarding overdue notices. It is
507 recommended that a email address that can be accessed by
508 multiple staff members be used for this purpose so that if one
509 librarian is out the others can address these requests. This
510 email address can be changed when needed.</para>
515 <section id="noItemTypeImages">
516 <title>noItemTypeImages</title>
518 <para>Default: Show</para>
520 <para>Asks: ___ itemtype icons in the catalog.</para>
530 <para>Don't show</para>
534 <para>Description:</para>
538 <para>This preference allows the system administrator to
539 determine if users will be able to set and see an <link
540 linkend="itemtypeadmin">item type icon</link> the catalog on
541 both the OPAC and the Staff Client. The images will display in
542 both the OPAC and the Staff Client/Intranet. If images of item
543 types are disabled, text labels for item types will still
544 appear in the OPAC and Staff Client.</para>
549 <section id="virtualshelves">
550 <title>virtualshelves</title>
552 <para>Default: Allow</para>
554 <para>Asks: ___ staff and patrons to create and view saved lists
565 <para>Don't Allow</para>
569 <para>Description:</para>
573 <para>This preference controls whether the lists functionality
574 will be available in the staff client and OPAC. If this is set
575 to "Don't allow" then no one will be able to save items to
576 public or private lists.</para>
582 <section id="adminprefslogin">
583 <title>Login options</title>
585 <para>These preferences are related to logging into your Koha
588 <section id="AutoLocation">
589 <title>AutoLocation</title>
591 <para>Default: Don't require</para>
593 <para>Asks: ___ staff to log in from a computer in the IP address
594 range specified by their library (if any).</para>
598 <para>Set IP address range in the library administration
603 <para><emphasis>Get there:</emphasis> More >
604 Administration > Basic Parameters > <link
605 linkend="libsgroups">Libraries & Groups</link></para>
615 <para>Don't require</para>
623 <para>Description:</para>
627 <para>This preference protects the system by blocking
628 unauthorized users from accessing the staff client program and
629 settings. Authorized and unauthorized users are determined by
630 their computer's IP addresses. When the preference is set to
631 'Require', IP authorization is in effect and unauthorized IP
632 addresses will be blocked. This means that staff cannot work
633 from home unless their IP address has been authorized. When
634 set to 'Don't require', anyone with a staff client login will
635 have access no matter which IP address they are using.</para>
640 <section id="IndependantBranches">
641 <title>IndependantBranches</title>
643 <para>Default: Don't prevent</para>
645 <para>Asks: ___ staff (but not superlibrarians) from modifying
646 objects (holds, items, patrons, etc.) belonging to other
653 <para>Don't prevent</para>
661 <para>Description:</para>
665 <para>This preference should only be used by library systems
666 which are sharing a single Koha installation among multiple
667 branches but are considered independent organizations, meaning
668 they do not share material or patrons with other branches and
669 do not plan to change that in the future. If set to 'Prevent'
670 it increases the security between library branches by:
671 prohibiting staff users from logging into another branch from
672 within the staff client, filtering out patrons from patron
673 searches who are not a part of the login branch conducting the
674 search, limiting the location choices to the login branch when
675 adding or modifying an item record, preventing users from
676 other branch locations from placing holds or checking out
677 materials from library branches other than their own, and
678 preventing staff from editing item records which belong to
679 other library branches. All of these security safeguards can
680 be overridden only by the superlibrarian, the highest level of
686 <para>It is important that this value be set before going live
687 and that it NOT be changed</para>
691 <section id="insecure">
692 <title>insecure</title>
694 <para>Default: Don't allow</para>
696 <para>Asks: ___ staff to access the staff client without logging
707 <para>Don't allow</para>
711 <para>Description:</para>
715 <para>This preference controls whether or not authentication
716 (user login) will be required to gain access to the staff
717 client. If set to 'Allow', all authentication is bypassed. If
718 set to 'Don't allow' authentication (login) on the staff
719 client is required.</para>
724 <para>Setting this to 'Allow' is dangerous, and should not be
725 done in production environments.</para>
729 <section id="SessionStorage">
730 <title>SessionStorage</title>
732 <para>Default: in the MySQL database</para>
734 <para>Asks: Store login session information ___</para>
740 <para>as temporary files</para>
744 <para>in the MySQL database</para>
748 <para>in the PostgreSQL database</para>
753 <para>PostgreSQL is not yet supported</para>
760 <para>Description:</para>
764 <para>This preference allows administrators to choose what
765 format session data is stored in during web sessions.</para>
770 <section id="timeout">
771 <title>timeout</title>
773 <para>Default: 12000000</para>
775 <para>Asks: Automatically log out users after ___ milliseconds of
778 <para>Description:</para>
782 <para>This preference sets the length of time the Staff Client
783 or OPAC accounts can be left inactive before re-logging in is
784 necessary. The value of this preference is in seconds. At this
785 time, the amount of time before a session times out must be
786 the same for both the Staff Client and the OPAC.</para>
793 <section id="authprefs">
794 <title>Authorities</title>
796 <para><emphasis>Get there:</emphasis> More > Administration >
797 Global System Preferences > Authorities</para>
799 <section id="generalauthorities">
800 <title>General</title>
802 <section id="AutoCreateAuthorities">
803 <title>AutoCreateAuthorities</title>
805 <para>Default: do not generate</para>
807 <para>Asks: When editing records, ___ authority records that are
814 <para>do not generate</para>
818 <para>generate</para>
824 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
825 must be set to "allow" for this to have any effect</para>
828 <para>Description:</para>
832 <para>When this and <link
833 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
834 are both turned on, automatically create authority records for
835 headings that don't have any authority link when cataloging.
836 When BiblioAddsAuthorities is on and AutoCreateAuthorities is
837 turned off, do not automatically generate authority records,
838 but allow the user to enter headings that don't match an
839 existing authority. When BiblioAddsAuthorities is off, this
840 has no effect.</para>
845 <section id="BiblioAddsAuthorities">
846 <title>BiblioAddsAuthorities</title>
848 <para>Default: allow</para>
850 <para>Asks: When editing records, ___ them to automatically create
851 new authority records if needed, rather than having to reference
852 existing authorities.</para>
862 <para>This setting allows you to type values in the fields
863 controlled by authorities and then adds a new authority if
864 one does not exist</para>
870 <para>don't allow</para>
874 <para>This setting will lock the authority controlled
875 fields, forcing you to search for an authority versus
876 allowing you to type the information in yourself.</para>
883 <section id="dontmerge">
884 <title>dontmerge</title>
886 <para>Default: Don't</para>
888 <para>Asks: ___ automatically update attached biblios when
889 changing an authority record.</para>
903 <para>Description:</para>
907 <para>This preference tells Koha how to handle changes to your
908 Authority records. If you edit an authority record and this
909 preference is set to 'Do' Koha will update all of the bib
910 records linked to the authority with the new authority
911 record's data. If this is set to "Don't" then Koha won't edit
912 bib records when changes are made to authorities.</para>
917 <para>If this is set to merge you will need to ask your
918 administrator to enable the <link
919 linkend="mergeauthcron">merge_authorities.pl
920 cronjob</link>.</para>
924 <section id="MARCAuthorityControlField008">
925 <title>MARCAuthorityControlField008</title>
927 <para>Default: || aca||aabn | a|a d</para>
929 <para>Asks: Use the following text for the contents of MARC
930 authority control field 008 position 06-39 (fixed length data
934 <para>Do not include the date (position 00-05) in this
935 preference, Koha will calculate automatically and put that in
936 before the values in this preference.</para>
937 </important>Description:</para>
941 <para>This preference controls the default value in the 008
942 field on Authority records. It does not effect bibliographic
948 <section id="UseAuthoritiesForTracings">
949 <title>UseAuthoritiesForTracings</title>
951 <para>Default: Don't use</para>
953 <para>Asks: ___ authority record numbers instead of text strings
954 for searches from subject tracings.</para>
960 <para>Don't use</para>
964 <para>Search links look for subject/author keywords
965 (example: opac-search.pl?q=su:Business%20networks)</para>
975 <para>Search links look for an authority record (example:
976 opac-search.pl?q=an:354)</para>
982 <para>Description:</para>
986 <para>For libraries that have authority files, they may want
987 to make it so that when a link to an authorized subject or
988 author is clicked on the OPAC or staff client it takes the
989 searcher only to a list of results with that authority record.
990 Most libraries do not have complete authority files and so
991 setting this preference to 'Don't use' will allow searchers to
992 click on links to authors and subject headings and perform a
993 keyword search against those fields, finding all possible
994 relevant results instead.</para>
1000 <section id="linkerauthorities">
1001 <title>Linker</title>
1003 <para>These preference will control how Koha links bibliographic
1004 records to authority records. All bibliographic records added to
1005 Koha after these preferences are set will link automatically to
1006 authority records, for records added before these preferences are
1007 set there is a script (misc/link_bibs_to_authorities.pl) that your
1008 system administrator can run to link records together.</para>
1010 <section id="CatalogModuleRelink">
1011 <title>CatalogModuleRelink</title>
1013 <para>Default: Do not</para>
1015 <para>Asks: ___ automatically relink headings that have previously
1016 been linked when saving records in the cataloging module.</para>
1018 <para>Values:</para>
1030 <para>Description:</para>
1034 <para>Longtime users of Koha don't expect the authority and
1035 bib records to link consistently. This preference makes it
1036 possible to disable authority relinking in the cataloging
1037 module only (i.e. relinking is still possible if
1038 link_bibs_to_authorities.pl is run). Note that though the
1039 default behavior matches the previous behavior of Koha
1040 (retaining links to outdated authority records), it does not
1041 match the intended behavior (updating biblio/authority link
1042 after bibliographic record is edited). Libraries that want the
1043 intended behavior of authority control rather than the way
1044 Koha used to handle linking should set CatalogModuleRelink to
1045 'Do'. Once setting this to 'Do' the following preferences can
1051 <section id="LinkerKeepStale">
1052 <title>LinkerKeepStale</title>
1054 <para>Default: Do not</para>
1056 <para>Asks: ___ keep existing links to authority records for
1057 headings where the linker is unable to find a match.</para>
1059 <para>Values:</para>
1071 <para>Description:</para>
1075 <para>When set to 'Do', the linker will never remove a link to
1076 an authority record, though, depending on the value of <link
1077 linkend="LinkerRelink">LinkerRelink</link>, it may change the
1083 <section id="LinkerModule">
1084 <title>LinkerModule</title>
1086 <para>Default: Default</para>
1088 <para>Asks: Use the ___ linker module for matching headings to
1089 authority records.</para>
1091 <para>Values:</para>
1095 <para>Default</para>
1099 <para>Retains Koha's previous behavior of only creating
1100 links when there is an exact match to one and only one
1101 authority record; if the <link
1102 linkend="LinkerOptions">LinkerOptions</link> preference is
1103 set to 'broader_headings', it will try to link headings to
1104 authority records for broader headings by removing
1105 subfields from the end of the heading</para>
1111 <para>First match</para>
1115 <para>Creates a link to the first authority record that
1116 matches a given heading, even if there is more than one
1117 authority record that matches</para>
1123 <para>Last match</para>
1127 <para>Creates a link to the last authority record that
1128 matches a given heading, even if there is more than one
1129 record that matches</para>
1135 <para>Description:</para>
1139 <para>This preference tells Koha which match to use when
1140 searching for authority matches when saving a record.</para>
1145 <section id="LinkerOptions">
1146 <title>LinkerOptions</title>
1148 <para>Asks: Set the following options for the authority linker
1150 <para>This feature is experimental and shouldn't be used in a
1151 production environment until further expanded upon.</para>
1154 <para>Description:</para>
1158 <para>This is a pipe separated (|) list of options. At the
1159 moment, the only option available is "broader_headings." With
1160 this option set to "broader_headings", the linker will try to
1161 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1163 <para>First: Camins-Esakov, Jared--Coin
1164 collections--Catalogs--Early works to 1800</para>
1166 <para>Next: Camins-Esakov, Jared--Coin
1167 collections--Catalogs</para>
1169 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1171 <para>Next: Camins-Esakov, Jared (matches! if a previous
1172 attempt had matched, it would not have tried this)</para>
1177 <section id="LinkerRelink">
1178 <title>LinkerRelink</title>
1180 <para>Default: Do</para>
1182 <para>Asks: ___ relink headings that have previously been linked
1183 to authority records.</para>
1185 <para>Values:</para>
1197 <para>Description:</para>
1201 <para>When set to 'Do', the linker will confirm the links for
1202 headings that have previously been linked to an authority
1203 record when it runs, correcting any incorrect links it may
1204 find. When set to 'Do not', any heading with an existing link
1205 will be ignored, even if the existing link is invalid or
1213 <section id="catprefs">
1214 <title>Cataloging</title>
1216 <para><emphasis>Get there:</emphasis> More > Administration >
1217 Global System Preferences > Cataloging</para>
1219 <section id="catdisplayprefs">
1220 <title>Display</title>
1224 <section id="authoritysep">
1225 <title>authoritysep</title>
1227 <para>Default: --</para>
1229 <para>Asks: Separate multiple displayed authors, series or
1230 subjects with ___.</para>
1233 <section id="hide_marc">
1234 <title>hide_marc</title>
1236 <para>Default: Display</para>
1238 <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1241 <para>Values:</para>
1245 <para>Display -- shows the tag numbers on the cataloging
1249 <screeninfo>MARC editor with tags showing</screeninfo>
1253 <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1260 <para>Don't display -- shows just descriptive text when
1264 <screeninfo>MARC editor without tags showing</screeninfo>
1268 <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1276 <section id="IntranetBiblioDefaultView">
1277 <title>IntranetBiblioDefaultView</title>
1279 <para>Default: ISBD form</para>
1281 <para>Asks: By default, display biblio records in ___</para>
1283 <para>Values:</para>
1287 <para>ISBD form -- displays records in the staff client in the
1288 old card catalog format</para>
1292 <para>See <link linkend="isbdpref">ISBD</link> preference
1293 for more information</para>
1299 <para>Labelled MARC form -- displays records in the staff
1300 client in MARC with text labels to explain the different
1305 <para>MARC form -- displays records in the staff client in
1310 <para>normal form -- visual display in the staff client (for
1311 the average person)</para>
1315 <para>Description:</para>
1319 <para>This setting determines the bibliographic record display
1320 when searching the catalog on the staff client. This setting
1321 does not affect the display in the OPAC which is changed using
1322 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1323 preference under the OPAC preference tab. This setting changes
1324 the look of the record when first displayed. The MARC and ISBD
1325 views can still be seen by clicking in the sidebar.</para>
1330 <section id="isbdpref">
1333 <para>Default: <link linkend="isbddefault">MARC21 Default
1334 Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1335 Appendix</link></para>
1337 <para>Asks: Use the following as the ISBD template:</para>
1339 <para>Description:</para>
1343 <para>This determines how the ISBD information will display.
1344 Elements in the list can be reordered to produce a different
1345 ISBD view. ISBD, the International Standard Bibliographic
1346 Description, was first introduced by IFLA (International
1347 Federation of Library Associations) in 1969 in order to
1348 provide guidelines for descriptive cataloging. The purpose of
1349 ISBD is to aid the international exchange of bibliographic
1350 records for a variety of materials.</para>
1355 <section id="LabelMARCView">
1356 <title>LabelMARCView</title>
1358 <para>Default: Don't</para>
1360 <para>Asks: ___ collapse repeated tags of the same type into one
1363 <para>Values:</para>
1367 <para>Do -- will combine all identical tag numbers under one
1368 heading in the MARC view in the OPAC and Staff Client</para>
1371 <screeninfo>MARC View in the Staff Client with LabelMARCView
1372 set to Do</screeninfo>
1376 <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
1383 <para>Don't -- will list all of the tags individually in the
1384 MARC view in the OPAC and Staff Client</para>
1387 <screeninfo>MARC View in the Staff Client with LabelMARCView
1388 set to Don't</screeninfo>
1392 <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
1400 <section id="OpacSuppression">
1401 <title>OpacSuppression</title>
1403 <para>Default: Don't hide</para>
1405 <para>Asks: ___ items marked as suppressed from OPAC search
1408 <para>Values:</para>
1412 <para>Don't hide -- will show items in OPAC search results if
1413 they are marked suppressed</para>
1417 <para>Hide -- will not show items in OPAC search results if
1418 they're marked as suppressed</para>
1422 <para>Each bib record with items you want to hide from the
1423 OPAC simply need to have the 942n field set to 1. The
1424 index then hides it from display in OPAC but will still
1425 display it in the Staff Client</para>
1431 <para>Description:</para>
1435 <para>An <link linkend="authorizedvalues">authorized
1436 value</link> for 942$n field should be set to eliminate
1437 errors. One example would be to create an authorized value
1438 titled SUPPRESS with a value of 0 for don't suppress and 1 for
1444 <para>If this preference is set to 'hide' and you have the 942n
1445 field set to 1, it will hide the entire bib record - not just an
1446 individual item.</para>
1450 <para>You must have the Suppress index set up in Zebra and at
1451 least one suppressed item, or your searches will be
1456 <section id="URLLinkText">
1457 <title>URLLinkText</title>
1459 <para>Default: Online Resource</para>
1461 <para>Asks: Show ___ as the text of links embedded in MARC
1464 <para>Description:</para>
1468 <para>If the 856 field does not have a subfield 3 or y
1469 defined, the OPAC will say 'Click here to access online.' If
1470 you would like the field to say something else enter that in
1476 <section id="UseControlNumber">
1477 <title>UseControlNumber</title>
1479 <para>Default: Don't use</para>
1481 <para>Asks: ___ record control number ($w subfields) and control
1482 number (001) for linking of bibliographic records.</para>
1484 <para>Values:</para>
1488 <para>Don't use</para>
1492 <para>When clicking on links to titles that appear next to
1493 'Continues' and 'Continued by' in the detail display Koha
1494 will perform a title search</para>
1504 <para>When clicking on links to titles that appear next to
1505 'Continues' and 'Continued by' in the detail display Koha
1506 will perform a control number (MARC field 001)
1514 <para>Unless you are going in and manually changing 773$w to
1515 match your rigorously-defined bibliographic relationships, you
1516 should set this preference to "Don't use" and instead set <link
1517 linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
1521 <para>Description:</para>
1525 <para>If you have a serial called "Journal of Interesting
1526 Things" which has a separate record from when it was called
1527 "Transactions of the Interesting Stuff Society," you could add
1528 linking fields to indicate the relationship between the two
1529 records. UseControlNumber allows you to use your local
1530 accession numbers for those links. In MARC21, the relevant
1531 sections of the two records might look like
1532 this:<programlisting> =001 12345
1533 =110 2_$aInteresting Stuff Society.
1534 =245 10$aTransactions of the Interesting Stuff Society.
1535 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1538 =110 2_$aInteresting Stuff Society.
1539 =245 10$aJournal of Interesting Things.
1540 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
1542 <para>With UseControlNumber set to 'Use', the 78x links will
1543 use the Control Numbers is subfield $w, instead of doing a
1544 title search on "Journal of Interesting Things" and
1545 "Transactions of the Interesting Stuff Society"
1546 respectively.</para>
1552 <section id="catinterfaceprefs">
1553 <title>Interface</title>
1557 <section id="advancedMARCeditor">
1558 <title>advancedMARCeditor</title>
1560 <para>Default: Don't display</para>
1562 <para>Asks: ___ descriptions of fields and subfields in the MARC
1565 <para>Description:</para>
1569 <para>This preference determines whether or not MARC field
1570 names will be present when editing or creating MARC
1575 <para>Values:</para>
1579 <para>Display</para>
1582 <screeninfo>MARC editor with text labels</screeninfo>
1586 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
1593 <para>Don't display</para>
1596 <screeninfo>MARC editor without text labels</screeninfo>
1600 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
1608 <section id="DefaultClassificationSource">
1609 <title>DefaultClassificationSource</title>
1611 <para>Default: Dewey Decimal System</para>
1613 <para>Asks: Use ___ as the default classification source.</para>
1615 <para>Values:</para>
1619 <para>ANSCR (Sound Recordings)</para>
1623 <para>Dewey Decimal Classification</para>
1627 <para>Library of Congress Classification</para>
1631 <para>Other/Generic Classification Scheme</para>
1635 <para>SuDoc Classification (U.S. GPO)</para>
1639 <para>Universal Decimal Classification</para>
1644 <section id="EasyAnalyticalRecords">
1647 <firstname id="analyticsauthor">Linda</firstname>
1649 <surname>Culberson</surname>
1652 <orgname>Ms. Dept. of Archives and History</orgname>
1656 <pubdate id="analyticspubdate">October 2011</pubdate>
1658 <othercredit id="analyticseditor" role="copyeditor">
1659 <firstname>Nicole C.</firstname>
1661 <surname>Engard</surname>
1663 <contrib id="analyticscredit">Fixed typos, changed content
1664 where necessary and added new screenshots.</contrib>
1668 <title>EasyAnalyticalRecords</title>
1670 <para>Asks: ___ easy ways to create analytical record
1671 relationships</para>
1673 <para>Default: Don't Display</para>
1675 <para>Values:</para>
1679 <para>Display</para>
1683 <para>Don't Display</para>
1688 <para>If you decide to use this feature you'll want to make sure
1690 linkend="UseControlNumber">UseControlNumber</link> preference is
1691 set to "Don't use" or else the "Show analytics" links in the
1692 staff client and the OPAC will be broken.</para>
1695 <para>Description:</para>
1699 <para>An analytic entry in a catalog is one that describes a
1700 part of a larger work that is also described in the catalog.
1701 In bibliographic cataloging, analytic entries may be made for
1702 chapters in books or special issues of articles in
1703 periodicals. In archival cataloging, analytic entries may be
1704 made for series or items within a collection. This feature in
1705 Koha allows for an easy way of linking analytic entries to the
1706 host records, and this system preference adds several new menu
1707 options to the staff cataloging detail pages to allow that to
1714 <section id="catrecordprefs">
1715 <title>Record Structure</title>
1719 <section id="AlternateHoldingsField">
1720 <title>AlternateHoldingsField &
1721 AlternateHoldingsSeparator</title>
1723 <para>Asks: Display MARC subfield ___ as holdings information for
1724 records that do not have items, with the subfields separated by
1727 <para>Description:</para>
1731 <para>Sometimes libraries migrate to Koha with their holding
1732 info in the 852 field (OCLC holdings information field) and
1733 choose not to transfer that information into the 952 (Koha
1734 holdings information field) because they don't plan on
1735 circulating those items. For those libraries or other
1736 libraries that have data in the 852 fields of their records
1737 that they want to display, these preferences let you choose to
1738 display holdings info from a field other than the 952 field.
1739 The AlternateHoldingsField preference can contain multiple
1740 subfields to look in; for instance 852abhi would look in 852
1741 subfields a, b, h, and i.</para>
1745 <para>With AlternateHoldingsField set to 852abhi and
1746 AlternateHoldingsSeparator set to a space the holdings would
1747 look like the following:</para>
1750 <screeninfo>Alternate Holdings Display</screeninfo>
1754 <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
1762 <section id="autoBarcode">
1763 <title>autoBarcode</title>
1765 <para>Default: generated in the form
1766 <branchcode>yymm0001</para>
1768 <para>Asks: Barcodes are ___</para>
1770 <para>Values:</para>
1774 <para>generated in the form <branchcode>yymm0001</para>
1778 <para>generated in the form <year>-0001</para>
1782 <para><year>-0002. generated in the form 1, 2, 3</para>
1786 <para>not generated automatically</para>
1790 <para>Description:</para>
1794 <para>This setting is for libraries wishing to generate
1795 barcodes from within Koha (as opposed to scanning in
1796 pre-printed barcodes or manually assigning them).</para>
1801 <section id="item-level_itypes">
1802 <title>item-level_itypes</title>
1804 <para>Default: specific item</para>
1806 <para>Asks: Use the item type of the ___ as the authoritative item
1807 type (for determining circulation and fines rules, etc).</para>
1809 <para>Values:</para>
1813 <para>biblio record</para>
1817 <para>specific item</para>
1821 <para>Description:</para>
1825 <para>This preference determines whether the item type Koha
1826 uses for issuing rules will be an attribute of the
1827 bibliographic record or the item record. Most libraries refer
1828 to the item record for item types. It also determines if the
1829 item type icon appears on the OPAC search results. If you have
1830 the preference set to 'biblio record' then Koha displays the
1831 item type icon on the search results to the left of the result
1835 <screeninfo>Item Type Icons to the Left of Result
1836 Information</screeninfo>
1840 <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
1848 <section id="itemcallnumber">
1849 <title>itemcallnumber</title>
1851 <para>Default: 082ab</para>
1853 <para>Asks: Map the MARC subfield to an item's callnumber.</para>
1856 <para>This can contain multiple subfields to look in; for
1857 instance 082ab would look in 082 subfields a and b.</para>
1860 <para>Description:</para>
1864 <para>This setting determines which MARC field will be used to
1865 determine the call number that will be entered into item
1866 records automatically (952$o). The value is set by providing
1867 the MARC field code (050, 082, 090, 852 are all common) and
1868 the subfield codes without the delimiters ($a, $b would be
1873 <para>Examples:</para>
1877 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
1878 item record: 852hi</para>
1883 <section id="marcflavour">
1884 <title>marcflavour</title>
1886 <para>Default: MARC21</para>
1888 <para>Asks: Interpret and store MARC records in the ___
1891 <para>Description:</para>
1895 <para>This preference defines global MARC style (MARC21 or
1896 UNIMARC) used for encoding. MARC21 is the standard style for
1897 the US, Canada and Britain. UNIMARC is a variation of MARC21
1898 that is used in France, Italy, Russia, and many other
1903 <para>Values:</para>
1911 <para>UNIMARC</para>
1916 <section id="MARCOrgCode">
1917 <title>MARCOrgCode</title>
1919 <para>Default: OSt</para>
1921 <para>Asks: Fill in the MARC organization code ___ by default in
1922 new MARC records (leave blank to disable).</para>
1924 <para>Description:</para>
1928 <para>The MARC Organization Code is used to identify libraries
1929 with holdings of titles and more.</para>
1933 <para>Learn more and find your library's code on the <ulink
1934 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC
1935 Code list for Organizations</ulink> or in Canada on the <ulink
1936 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
1937 Symbols Directory</ulink>.</para>
1940 <section id="NewItemsDefaultLocation">
1941 <title>NewItemsDefaultLocation</title>
1943 <para>Asks: When items are created, give them the temporary
1944 location of ___ (should be a location code, or blank to
1948 <section id="z3950NormalizeAuthor">
1949 <title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
1951 <para>Defaults: Don't copy & 701,702,700</para>
1953 <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
1954 commas) to the correct author tags when importing a record using
1957 <para>Description for z3950NormalizeAuthor:</para>
1961 <para>This preference allows for ‘Personal Name
1962 Authorities' to replace authors as the bibliographic
1963 authority. This preference should only be considered by
1964 libraries using UNIMARC.</para>
1968 <para>Values for z3950NormalizeAuthor:</para>
1976 <para>Don't copy</para>
1980 <para>Description for z3950AuthorAuthFields:</para>
1984 <para>This preference defines which MARC fields will be used
1985 for ‘Personal Name Authorities' to replace authors as
1986 the bibliographic authorities. This preference only applies to
1987 those using UNIMARC encoding. The MARC fields selected here
1988 will only be used if ‘z3950NormalizeAuthor' is set to
1989 “Copy". The default field are 700, 701, and 702.</para>
1995 <section id="catspineprefs">
1996 <title>Spine Labels</title>
2000 <section id="SpineLabelAutoPrint">
2001 <title>SpineLabelAutoPrint</title>
2003 <para>Default: don't</para>
2005 <para>Asks: When using the quick spine label printer, ___
2006 automatically pop up a print dialog.</para>
2008 <para>Values:</para>
2021 <section id="SpineLabelFormat">
2022 <title>SpineLabelFormat</title>
2024 <para>Default: <itemcallnumber><copynumber></para>
2026 <para>Asks: Include the following fields on a quick-printed spine
2027 label: (Enter in columns from the biblio, biblioitems or items
2028 tables, surrounded by < and >.)</para>
2031 <section id="SpineLabelShowPrintOnBibDetails">
2032 <title>SpineLabelShowPrintOnBibDetails</title>
2034 <para>Default: Don't display</para>
2036 <para>Asks: ___ buttons on the bib details page to print item
2037 spine labels.</para>
2039 <para>Values:</para>
2043 <para>Display</para>
2046 <screeninfo>'Print Label' link appears on bibliographic
2047 record in the staff client</screeninfo>
2051 <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2058 <para>Don't display</para>
2065 <section id="circprefs">
2066 <title>Circulation</title>
2068 <para><emphasis>Get there:</emphasis> More > Administration >
2069 Global System Preferences > Circulation</para>
2071 <section id="circcheckoutpolicy">
2072 <title>Checkout Policy</title>
2076 <section id="AllFinesNeedOverride">
2077 <title>AllFinesNeedOverride</title>
2079 <para>Default: Require</para>
2081 <para>Asks: ___ staff to manually override all fines, even fines
2083 linkend="noissuescharge">noissuescharge</link>.</para>
2085 <para>Values:</para>
2089 <para>Don't require</para>
2093 <para>Require</para>
2097 <para>Description:</para>
2101 <para>This preference let's you decide if you want to always
2102 be warned that the patron has fines when checking out. If you
2103 have it set to 'Require' then no matter how much money the
2104 patron owes a message will pop up warning you that the patron
2110 <section id="AllowFineOverride">
2111 <title>AllowFineOverride</title>
2113 <para>Default: Don't allow</para>
2115 <para>Asks: ___ staff to manually override and check out items to
2116 patrons who have more than <link
2117 linkend="noissuescharge">noissuescharge</link> in fines.</para>
2119 <para>Values:</para>
2127 <para>Don't allow</para>
2131 <para>Description:</para>
2135 <para>This preference lets you decide if you staff can check
2136 out to patrons who owe more money than you usually let them
2137 carry on their account. If set to 'Allow' staff will be warned
2138 that the patrons owes money, but it won't stop the staff from
2139 checking out to the patron.</para>
2144 <section id="AllowItemsOnHoldCheckout">
2145 <title>AllowItemsOnHoldCheckout</title>
2147 <para>Default: Don't allow</para>
2149 <para>Asks: ___ checkouts of items reserved to someone else. If
2150 allowed do not generate RESERVE_WAITING and RESERVED warning. This
2151 allows self checkouts for those items.</para>
2153 <para>Values:</para>
2161 <para>Don't allow</para>
2166 <para>This system preference relates only to SIP based self
2167 checkout, not Koha's web based self checkout.</para>
2170 <para>Description:</para>
2174 <para>When this preference is set to 'Allow' patrons will be
2175 able to use your external self check machine to check out a
2176 book to themselves even if it's on hold for someone else. If
2177 you would like Koha to prevent people from checking out books
2178 that are on hold for someone else set this preference to
2179 "Don't allow."</para>
2184 <section id="AllowNotForLoanOverride">
2185 <title>AllowNotForLoanOverride</title>
2187 <para>Default: Allow</para>
2189 <para>Asks: ___ staff to override and check out items that are
2190 marked as not for loan.</para>
2192 <para>Values:</para>
2200 <para>Don't allow</para>
2204 <para>Description:</para>
2208 <para>This parameter is a binary setting which controls the
2209 ability of staff (patrons will always be prevented from
2210 checking these items out) to check out items that are marked
2211 as “not for loan". Setting it to “Allow" would
2212 allow such items to be checked out, setting it to “Don't
2213 allow" would prevent this. This setting determines whether
2214 items meant to stay in the library, such as reference
2215 materials, and other library resources can be checked out by
2221 <section id="AllowRenewalLimitOverride">
2222 <title>AllowRenewalLimitOverride</title>
2224 <para>Default: Allow</para>
2226 <para>Asks: ___ staff to manually override the renewal limit and
2227 renew a checkout when it would go over the renewal limit.</para>
2229 <para>Values:</para>
2237 <para>Don't allow</para>
2241 <para>Description:</para>
2245 <para>This preference is a binary setting which controls the
2246 ability of staff to override the limits placed on the number
2247 of times an item can be renewed. Setting it to “Allow"
2248 would allow such limits to be overridden, setting it to
2249 “Don't allow" would prevent this. This is a preference
2250 in which if it is set to “allow" it would allow the
2251 library staff to use their judgment for overriding the renew
2252 limit for special cases, setting it to “Don't allow"
2253 prevents an opportunity for abuse by the library staff.</para>
2258 <section id="AutomaticItemReturn">
2259 <title>AutomaticItemReturn</title>
2261 <para>Default: Do</para>
2263 <para>Asks: ___ automatically transfer items to their home branch
2264 when they are returned.</para>
2266 <para>Values:</para>
2278 <para>Description:</para>
2282 <para>This preference is a binary setting which determines
2283 whether an item is returned to its home branch automatically
2284 or not. If set to “Don't", the staff member checking an
2285 item in at a location other than the item's home branch will
2286 be asked whether the item will remain at the non-home branch
2287 (in which case the new location will be marked as a holding
2288 location) or returned. Setting it to “Do" will ensure
2289 that items checked in at a branch other than their home branch
2290 will be sent to that home branch.</para>
2295 <section id="CircControl">
2296 <title>CircControl</title>
2298 <para>Default: the library the item is from</para>
2300 <para>Asks: Use the checkout and fines rules of ___</para>
2302 <para>Values:</para>
2306 <para>the library the item is from</para>
2310 <para>The circulation and fines policies will be
2311 determined by the library that owns the item</para>
2317 <para>the library the patron is from</para>
2321 <para>The circulation and fines policies will be
2322 determined the patron's home library</para>
2328 <para>the library you are logged in at</para>
2332 <para>The circulation and fines policies will be
2333 determined by the library that checked the item out to the
2341 <section id="HomeOrHoldingBranch">
2342 <title>HomeOrHoldingBranch</title>
2344 <para>Default: the library the item was checked out from</para>
2346 <para>Asks: Use the checkout and fines rules of ___</para>
2348 <para>Description:</para>
2352 <para>This preference establishes what may be done with a
2353 loaned item once the item has been returned. It deals with
2354 situations in which one library branch has borrowed materials
2355 from a different branch. Essentially it decides whether a
2356 library may check the borrowed item back out to its patron or
2357 if it must immediately send the item back to the owning
2362 <para>Values:</para>
2366 <para>the library the item is from</para>
2370 <para>the library the item was checked out from</para>
2375 <para>It is not recommend that this setting be changed after
2376 initial setup of Koha</para>
2380 <para>This preference does nothing unless the
2381 IndependantBranches preference is set to 'Prevent'.</para>
2386 <para><emphasis>Get there: </emphasis>More > Administration
2387 > Global System Preferences > Admin > <link
2388 linkend="IndependantBranches">IndependantBranches</link></para>
2393 <section id="InProcessingToShelvingCart">
2394 <title>InProcessingToShelvingCart</title>
2396 <para>Default: Don't move</para>
2398 <para>Asks: ___ items that have the location PROC to the location
2399 CART when they are checked in.</para>
2401 <para>Values:</para>
2405 <para>Don't move</para>
2414 <section id="IssuingInProcess">
2415 <title>IssuingInProcess</title>
2417 <para>Default: Don't prevent</para>
2419 <para>Asks: ___ patrons from checking out an item whose rental
2420 charge would take them over the limit.</para>
2422 <para>Values:</para>
2426 <para>Don't prevent</para>
2430 <para>Prevent</para>
2434 <para>Description:</para>
2438 <para>This preference determines if a patron can check items
2439 out if there is an overdue fine on the account and any of the
2440 materials the patron wishes to check out will potentially tip
2441 the account balance over the maximum fines policy the library
2442 has in place.</para>
2446 <para>Example: Your library has a $5 limit set for 'fines' (ie,
2447 after incurring $5 in fines, a patron can no longer check out
2448 items). A patron comes to the desk with 5 items to check out (4
2449 books and a video) The patron has $4 in charges already on their
2450 account. One of the videos has a rental charge of $1, therefore
2451 making the total fines on the patron's account suddenly $5 (the
2455 <section id="maxoutstanding">
2456 <title>maxoutstanding</title>
2458 <para>Default: 5</para>
2460 <para>Asks: Prevent patrons from making holds on the OPAC if they
2461 owe more than ___ USD in fines.</para>
2464 <section id="noissuescharge">
2465 <title>noissuescharge</title>
2467 <para>Default: 5</para>
2469 <para>Asks: Prevent patrons from checking out books if they have
2470 more than ___ USD in fines.</para>
2472 <para>Description:</para>
2476 <para>This preference is the maximum amount of money owed to
2477 the library before the user is banned from borrowing more
2478 items. This also coincides with <link
2479 linkend="maxoutstanding">maxoutstanding</link> that limits
2480 patrons from placing holds when the maximum amount is owed to
2486 <section id="OverduesBlockCirc">
2487 <title>OverduesBlockCirc</title>
2489 <para>Default: Ask for confirmation</para>
2491 <para>Asks: ___ when checking out to a borrower that has overdues
2494 <para>Values:</para>
2498 <para>Ask for confirmation</para>
2502 <para>Will not let you check an item out to patrons with
2503 overdues until a librarian confirms that it is okay</para>
2513 <para>Block all patrons with overdue items from being able
2520 <para>Don't block</para>
2524 <para>Allow all patrons with overdue items to continue to
2532 <section id="OverdueNoticeBcc">
2533 <title>OverdueNoticeBcc</title>
2535 <para>Asks: Send all notices as a BCC to this email address
2538 <para>This preference makes it so that a librarian can get a copy
2539 of every notice sent out to patrons.<tip>
2540 <para>If you'd like more than one person to receive the blind
2541 copy you can simply enter in multiple email addresses
2542 separated by commas.</para>
2546 <section id="PrintNoticesMaxLines">
2547 <title>PrintNoticesMaxLines</title>
2549 <para>Asks: Include up to ___ item lines in a printed overdue
2553 <para>If the number of items is greater than this number, the
2554 notice will end with a warning asking the borrower to check
2555 their online account for a full list of overdue items.</para>
2559 <para>Set to 0 to include all overdue items in the notice, no
2560 matter how many there are.</para>
2564 <para>This preference only refers to the print notices, not
2565 those sent via email.</para>
2569 <section id="RenewalPeriodBase">
2570 <title>RenewalPeriodBase</title>
2572 <para>Default: the old due date of the checkout</para>
2574 <para>Asks: When renewing checkouts, base the new due date on
2577 <para>Values:</para>
2581 <para>the old due date of the checkout</para>
2585 <para>the current date</para>
2590 <section id="ReturnBeforeExpiry">
2591 <title>ReturnBeforeExpiry</title>
2593 <para>Default: Don't require</para>
2595 <para>Asks: ___ patrons to return books before their accounts
2596 expire (by restricting due dates to before the patron's expiration
2599 <para>Values:</para>
2603 <para>Don't require</para>
2607 <para>Require</para>
2611 <para>Description:</para>
2615 <para>This is preference may prevent a patron from having
2616 items checked out after their library card has expired. If
2617 this is set to “Require", then a due date of any checked
2618 out item can not be set for a date which falls after the
2619 patron's card expiration. If the setting is left “Don't
2620 require" then item check out dates may exceed the expiration
2621 date for the patron's library card.</para>
2626 <section id="ReturnToShelvingCart">
2627 <title>ReturnToShelvingCart</title>
2629 <para>Default: Don't move</para>
2631 <para>Asks: ___ all items to the location CART when they are
2634 <para>Values:</para>
2638 <para>Don't move</para>
2647 <section id="TransfersMaxDaysWarning">
2648 <title>TransfersMaxDaysWarning</title>
2650 <para>Default: 3</para>
2652 <para>Asks: Show a warning on the "Transfers to Receive" screen if
2653 the transfer has not been received ___ days after it is
2656 <para>Description:</para>
2660 <para>The TransferMaxDaysWarning preference is set at a
2661 default number of days. This preference allows for a warning
2662 to appear after a set amount of time if an item being
2663 transferred between library branches has not been received.
2664 The warning will appear in the <link
2665 linkend="transferstoreceive">Transfers to Receive</link>
2671 <section id="UseBranchTransferLimits">
2672 <title>UseBranchTransferLimits &
2673 BranchTransferLimitsType</title>
2675 <para>Defaults: Don't enforce & collection code</para>
2677 <para>Asks: ___ branch transfer limits based on ___</para>
2679 <para>UseBranchTransferLimits Values:</para>
2683 <para>Don't enforce</para>
2687 <para>Enforce</para>
2691 <para>BranchTransferLimitsType Values:</para>
2695 <para>collection code</para>
2699 <para>item type</para>
2703 <para>BranchTransferLimitsType Description:</para>
2707 <para>This parameter is a binary setting which determines
2708 whether items are transferred according to item type or
2709 collection code. This value determines how the library manager
2710 is able to restrict what items can be transferred between the
2716 <section id="useDaysMode">
2717 <title>useDaysMode</title>
2719 <para>Default: Don't include</para>
2721 <para>Asks: Calculate the due date using ___.</para>
2723 <para>Values:</para>
2727 <para>circulation rules only.</para>
2731 <para>the calendar to push the due date to the next open
2736 <para>the calendar to skip all days the library is
2741 <para>Description:</para>
2745 <para>This preference controls how scheduled library closures
2746 affect the due date of a material. The 'the calendar to skip
2747 all days the library is closed' setting allows for a scheduled
2748 closure not to count as a day in the loan period, the
2749 'circulation rules only' setting would not consider the
2750 scheduled closure at all, and 'the calendar to push the due
2751 date to the next open day' would only effect the due date if
2752 the day the item is due would fall specifically on the day of
2757 <para>Example:</para>
2761 <para>The library has put December 24th and 25th in as
2762 closures on the calendar. A book checked out by a patron has a
2763 due date of December 25th according to the circulation and
2764 fine rules. If this preference is set to 'circulation rules
2765 only' then the item will remain due on the 25th. If the
2766 preference is set to 'the calendar to push the due date to the
2767 next open day' then the due date will be December 26th. If the
2768 preference is set to 'the calendar to skip all days the
2769 library is closed' then the due date will be pushed to the
2770 27th of December to accommodate for the two closed
2775 <para>The calendar is defined on a branch by branch basis. To
2776 learn more about the calendar, check out the '<link
2777 linkend="calholidays">Calendar & Holidays</link>' section of
2782 <section id="circfinespolicy">
2783 <title>Fines Policy</title>
2787 <section id="finesCalendar">
2788 <title>finesCalendar</title>
2790 <para>Default: not including the days the library is closed</para>
2792 <para>Asks: Calculate fines based on days overdue ___</para>
2794 <para>Values:</para>
2798 <para>directly</para>
2802 <para>not including the days the library is closed</para>
2806 <para>Description:</para>
2810 <para>This preference will determine whether or not fines will
2811 be accrued during instances when the library is closed.
2812 Examples include holidays, library in-service days, etc.
2813 Choosing 'not including the days the library is closed"
2814 setting will enable Koha to access its <link
2815 linkend="calholidays">Calendar</link> module and be
2816 considerate of dates when the library is closed. To make use
2817 of this setting the administrator must first access Koha's
2818 calendar and mark certain days as “holidays" ahead of
2823 <para>The calendar is defined on a branch by branch basis. To
2824 learn more about the calendar, check out the '<link
2825 linkend="calholidays">Calendar & Holidays</link>' section of
2829 <section id="finesMode">
2830 <title>finesMode</title>
2832 <para>Default: Calculate (but only for mailing to the
2835 <para>Asks: ___ fines</para>
2837 <para>Values:</para>
2841 <para>Calculate (but only for mailing to the admin)</para>
2845 <para>Calculate and charge</para>
2849 <para>Don't calculate</para>
2854 <para>Requires that you have the fines cron job running
2855 (misc/cronjobs/fines.pl)</para>
2860 <section id="circholdspolicy">
2861 <title>Holds Policy</title>
2865 <section id="AllowHoldDateInFuture">
2866 <title>AllowHoldDateInFuture</title>
2868 <para>Default: Allow</para>
2870 <para>Asks: ___ hold requests to be placed that do not enter the
2871 waiting list until a certain future date.</para>
2873 <para>Values:</para>
2881 <para>Don't allow</para>
2886 <section id="AllowHoldsOnDamagedItems">
2887 <title>AllowHoldsOnDamagedItems</title>
2889 <para>Default: Allow</para>
2891 <para>Asks: ___ hold requests to be placed on damaged
2894 <para>Values:</para>
2902 <para>Don't allow</para>
2906 <para>Description:</para>
2910 <para>This parameter is a binary setting which controls
2911 whether or not hold requests can be placed on items that are
2912 marked as “damaged" (items are marked as damaged by
2913 editing subfield 4 on the item record). Setting this value to
2914 “Don't allow" will prevent anyone from placing a hold on
2915 such items, setting it to “Allow" will allow it. This
2916 preference is important because it determines whether or not a
2917 patron can place a request for an item that might be in the
2918 process of being repaired or not in good condition. The
2919 library may wish to set this to “Don't allow" if they
2920 were concerned about their patrons not receiving the item in a
2921 timely manner or at all (if it is determined that the item is
2922 beyond repair). Setting it to “Allow" would allow a
2923 patron to place a hold on an item and therefore receive it as
2924 soon as it becomes available.</para>
2929 <section id="AllowHoldPolicyOverride">
2930 <title>AllowHoldPolicyOverride</title>
2932 <para>Default: Allow</para>
2934 <para>Asks: ___ staff to override hold policies when placing
2937 <para>Values:</para>
2945 <para>Don't allow</para>
2949 <para>Description:</para>
2953 <para>This preference is a binary setting which controls
2954 whether or not the library staff can override the circulation
2955 and fines rules as they pertain to the placement of holds.
2956 Setting this value to “Don't allow" will prevent anyone
2957 from overriding, setting it to “Allow" will allow it.
2958 This setting is important because it determines how strict the
2959 libraries rules for placing holds are. If this is set to
2960 “Allow", exceptions can be made for patrons who are
2961 otherwise normally in good standing with the library, but
2962 there is opportunity for the staff to abuse this function. If
2963 it is set to “Don't allow", no abuse of the system is
2964 possible, but it makes the system entirely inflexible in
2965 respect to holds.</para>
2970 <section id="AllowOnShelfHolds">
2971 <title>AllowOnShelfHolds</title>
2973 <para>Default: Allow</para>
2975 <para>Asks: ___ hold requests to be placed on items that are not
2978 <para>Values:</para>
2986 <para>Don't Allow</para>
2990 <para>Description:</para>
2994 <para>This preference is a binary setting which controls the
2995 ability of patrons to place holds on items that are not
2996 currently checked out. Setting it to “Don't allow"
2997 allows borrowers to place holds on items that are checked out
2998 but not on items that are on the shelf (or assumed available
2999 in the library), setting it to “Allow" allows borrowers
3000 to place holds on any item that is available for loan whether
3001 it is checked out or not. This setting might be set to "Allow"
3002 if the library system is a multi branch system and patrons
3003 used the hold system to request items from other libraries, or
3004 if the library wanted to allow users to place holds on items
3005 from home through the OPAC. Setting it to “Don't allow"
3006 would enforce a first come, first served standard.</para>
3011 <section id="AutoResumeSuspendedHolds">
3012 <title>AutoResumeSuspendedHolds</title>
3014 <para>Default: Allow</para>
3016 <para>Asks: ___ suspended holds to be automatically resumed by a
3019 <para>Values:</para>
3027 <para>Don't allow</para>
3031 <para>Description:</para>
3035 <para>If this preference is set to 'Allow' then all suspended
3036 holds will be able to have a date at which they automatically
3037 become unsuspended. If you have this preference set to 'Allow'
3038 you will also need the <link
3039 linkend="unsuspendholdcron">Unsuspend Holds</link> cron job
3045 <section id="canreservefromotherbranches">
3046 <title>canreservefromotherbranches</title>
3048 <para>Default: Allow</para>
3050 <para>Asks: ___ a user from one library to place a hold on an item
3051 from another library</para>
3053 <para>Description:</para>
3057 <para>This preference is a binary setting which determines
3058 whether patrons can place holds on items from other branches.
3059 If the preference is set to “Allow" patrons can place
3060 such holds, if it is set to “Don't allow" they cannot.
3061 This is an important setting because it determines if users
3062 can use Koha to request items from another branch. If the
3063 library is sharing an installation of Koha with other
3064 independent libraries which do not wish to allow interlibrary
3065 borrowing it is recommended that this parameter be set to
3066 “Don't allow".</para>
3070 <para>Values:</para>
3078 <para>Don't allow (with <link
3079 linkend="IndependantBranches">independent
3080 branches</link>)</para>
3085 <section id="DisplayMultiPlaceHold">
3086 <title>DisplayMultiPlaceHold</title>
3088 <para>Default: Don't enable</para>
3090 <para>Asks: ___ the ability to place holds on multiple biblio from
3091 the search results</para>
3093 <para>Values:</para>
3097 <para>Don't enable</para>
3106 <section id="emailLibrarianWhenHoldIsPlaced">
3107 <title>emailLibrarianWhenHoldIsPlaced</title>
3109 <para>Default: Don't enable</para>
3111 <para>Asks: ___ sending an email to the Koha administrator email
3112 address whenever a hold request is placed.</para>
3114 <para>Values:</para>
3118 <para>Don't enable</para>
3126 <para>Description:</para>
3130 <para>This preference enables Koha to email the library staff
3131 whenever a patron requests an item to be held. While this
3132 function will immediately alert the librarian to the patron's
3133 need, it is extremely impractical in most library settings. In
3134 most libraries the hold lists are monitored and maintained
3135 from a separate interface. That said, many libraries that
3136 allow on shelf holds prefer to have this preference turned on
3137 so that they are alerted to pull an item from the
3143 <para>In order for this email to send you must have a <link
3144 linkend="notices">notice</link> template with the code of
3149 <para>This notice will only be sent if the <link
3150 linkend="msgqueuecron">process_message_queue.pl cronjob</link>
3151 being run periodically to send the messages.</para>
3155 <section id="ExpireReservesMaxPickUpDelay">
3156 <title>ExpireReservesMaxPickUpDelay</title>
3158 <para>Default: Don't allow</para>
3160 <para>Asks: ___ holds to expire automatically if they have not
3161 been picked by within the time period specified in <link
3162 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
3164 <para>Values:</para>
3172 <para>Don't allow</para>
3176 <para>Description:</para>
3180 <para>If set to 'allow' this will cancel holds that have been
3181 waiting for longer than the number of days specified in the
3183 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
3184 system preference. Holds will only be cancelled if the <link
3185 linkend="expiredholdscron">Expire Holds cron job</link> is
3191 <section id="ExpireReservesMaxPickUpDelayCharge">
3192 <title>ExpireReservesMaxPickUpDelayCharge</title>
3194 <para>Default: 0</para>
3196 <para>Asks: If using <link
3197 linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
3198 charge a borrower who allows his or her waiting hold to expire a
3199 fee of ___ USD</para>
3201 <para>Description:</para>
3205 <para>If you are expiring holds that have been waiting too
3206 long you can use this preference to charge the patron for not
3207 picking up their hold. If you don't charge patrons for items
3208 that aren't picked up you can leave this set to the default
3209 which is 0. Holds will only be cancelled and charged if the
3210 <link linkend="expiredholdscron">Expire Holds cron job</link>
3216 <section id="maxreserves">
3217 <title>maxreserves</title>
3219 <para>Default: 50</para>
3221 <para>Asks: Patrons can only have ___ holds at once.</para>
3224 <section id="OPACAllowHoldDateInFuture">
3225 <title>OPACAllowHoldDateInFuture</title>
3227 <para>Default: Allow</para>
3229 <para>Asks: ___ patrons to place holds that don't enter the
3230 waiting list until a certain future date.</para>
3232 <para>Values:</para>
3241 linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
3242 must also be enabled for this to work</para>
3248 <para>Don't allow</para>
3253 <section id="OPACAllowUserToChooseBranch">
3254 <title>OPACAllowUserToChooseBranch</title>
3256 <para>Default: Allow</para>
3258 <para>Asks: ___ a user to choose the branch to pick up a hold
3261 <para>Values:</para>
3269 <para>Don't allow</para>
3273 <para>Description:</para>
3277 <para>Changing this preference will not prevent staff from
3278 being able to transfer titles from one branch to another to
3279 fill a hold, it will only prevent patrons from saying they
3280 plan on picking a book up at a branch other than their home
3286 <section id="ReservesControlBranch">
3287 <title>ReservesControlBranch</title>
3289 <para>Default: item's home library</para>
3291 <para>Asks: Check the ___ to see if the patron can place a hold on
3294 <para>Values:</para>
3298 <para>item's home library.</para>
3302 <para>patron's home library.</para>
3307 <section id="ReservesMaxPickUpDelay">
3308 <title>ReservesMaxPickUpDelay</title>
3310 <para>Default: 7</para>
3312 <para>Asks: Mark a hold as problematic if it has been waiting for
3313 more than ___ days.</para>
3315 <para>Description:</para>
3319 <para>This preference (based on calendar days, not the <link
3320 linkend="calholidays">Koha holiday calendar</link>) puts an
3321 expiration date on an item a patron has on hold. After this
3322 expiration date the staff will have the option to release the
3323 unclaimed hold which then may be returned to the library shelf
3324 or issued to the next patron on the item's hold list. Items
3325 that are 'expired' by this preference are moved to the 'Holds
3326 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
3327 Pickup</link>' report.</para>
3332 <section id="ReservesNeedReturns">
3333 <title>ReservesNeedReturns</title>
3335 <para>Default: Don't automatically</para>
3337 <para>Asks: ___ mark holds as found and waiting when a hold is
3338 placed specifically on them and they are already checked
3341 <para>Values:</para>
3345 <para>Automatically</para>
3349 <para>Don't automatically</para>
3353 <para>Description:</para>
3357 <para>This preference refers to ‘item specific' holds
3358 where the item is currently on the library shelf. This
3359 preference allows a library to decide whether an ‘item
3360 specific' hold is marked as “Waiting" at the time the
3361 hold is placed or if the item will be marked as
3362 “Waiting" after the item is checked in. This preference
3363 will tell the patron that their item is ‘Waiting' for
3364 them at their library and ready for check out.</para>
3369 <section id="holdqueueweight">
3370 <title>StaticHoldsQueueWeight &
3371 RandomizeHoldsQueueWeight</title>
3373 <para>StaticHoldsQueueWeight Default: 0</para>
3375 <para>RandomizeHoldsQueueWeight Default: in that order</para>
3377 <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
3378 separated by commas; if empty, uses all libraries) ___</para>
3380 <para>RandomizeHoldsQueueWeight Values:</para>
3384 <para>in random order</para>
3388 <para>If StaticHoldsQueueWeight is left at the default
3389 Koha will randomize all libraries, otherwise it will
3390 randomize the libraries listed.</para>
3396 <para>in that order</para>
3400 <para>If StaticHoldsQueueWeight is left at the default
3401 then this will use all of your branches in alphabetical
3402 order, otherwise it will use the branches in the order
3403 that you entered them in the StaticHoldsQueueWeight
3410 <para>Descriptions:</para>
3414 <para>These preferences control how the <link
3415 linkend="holdsqueue">Holds Queue report</link> is generated
3416 using <link linkend="buildholdscron">a cron job</link>.</para>
3418 <para>If you do not want all of your libraries to participate
3419 in the on-shelf holds fulfillment process, you should list the
3420 the libraries that *do* participate in the process here by
3421 inputting all the participating library's branchcodes,
3422 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
3424 <para>By default, the holds queue will be generated such that
3425 the system will first attempt to hold fulfillment using items
3426 already at the pickup library if possible. If there are no
3427 items available at the pickup library to fill a hold,
3428 build_holds_queue.pl will then use the list of libraries
3429 defined in StaticHoldsQueueWeight. If
3430 RandomizeHoldsQueueWeight is disabled ( which it is by default
3431 ), the script will assign fulfillment requests in the order
3432 the branches are placed in the StaticHoldsQueueWeight system
3435 <para>For example, if your system has three libraries, of
3436 varying sizes ( small, medium and large ) and you want the
3437 burden of holds fulfillment to be on larger libraries before
3438 smaller libraries, you would want StaticHoldsQueueWeight to
3439 look something like "LRG,MED,SML".</para>
3441 <para>If you want the burden of holds fulfillment to be spread
3442 out equally throughout your library system, simply enable
3443 RandomizeHoldsQueueWeight. When this system preference is
3444 enabled, the order in which libraries will be requested to
3445 fulfill an on-shelf hold will be randomized each time the list
3446 is regenerated.</para>
3448 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
3449 at this time. Doing so will cause the build_holds_queue script
3450 to ignore RandomizeHoldsQueueWeight, causing the script to
3451 request hold fulfillment not randomly, but by alphabetical
3457 <section id="SuspendHoldsIntranet">
3458 <title>SuspendHoldsIntranet</title>
3460 <para>Default: Allow</para>
3462 <para>Asks: ___ holds to be suspended from the intranet.</para>
3464 <para>Values:</para>
3472 <para>Don't allow</para>
3476 <para>Description:</para>
3480 <para>The holds suspension feature can be turned on and off in
3481 the staff client by altering this system preference. If this
3482 is set to 'allow' you will want to set the <link
3483 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
3484 system preference.</para>
3489 <section id="SuspendHoldsOpac">
3490 <title>SuspendHoldsOpac</title>
3492 <para>Default: Allow</para>
3494 <para>Asks: ___ holds to be suspended from the OPAC.</para>
3496 <para>Values:</para>
3504 <para>Don't allow</para>
3508 <para>Description:</para>
3512 <para>The holds suspension feature can be turned on and off in
3513 the OPAC by altering this system preference. If this is set to
3514 'allow' you will want to set the <link
3515 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
3516 system preference.</para>
3522 <section id="circinterfaceprefs">
3523 <title>Interface</title>
3527 <section id="AllowAllMessageDeletion">
3528 <title>AllowAllMessageDeletion</title>
3530 <para>Default: Don't allow</para>
3532 <para>Asks: ___ staff to delete messages added from other
3535 <para>Values:</para>
3543 <para>Don't allow</para>
3548 <section id="CircAutocompl">
3549 <title>CircAutocompl</title>
3551 <para>Default: Try</para>
3553 <para>Asks: ___ to automatically fill in the member when entering
3554 a patron search on the circulation screen.</para>
3556 <para>Description:</para>
3560 <para>This preference is a binary setting which determines
3561 whether auto-completion of fields is enabled or disabled for
3562 the circulation input field. Setting it to “Try" would
3563 enable a staff member to begin typing a name or other value
3564 into the field and have a menu pop up with suggestions for
3565 completing it. Setting it to “Don't try" would disable
3566 this feature. This preference can make staff members' jobs
3567 easier or it could potentially slow down the page loading
3572 <para>Values:</para>
3576 <para>Don't try</para>
3583 <screeninfo>When CircAutocompl is turned on search results
3584 will appear below the search box</screeninfo>
3588 <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
3596 <section id="CircAutoPrintQuickSlip">
3597 <title>CircAutoPrintQuickSlip</title>
3599 <para>Default: open a print quick slip window</para>
3601 <para>Asks: When an empty barcode field is submitted in
3602 circulation ___</para>
3604 <para>Values:</para>
3608 <para>clear the screen</para>
3612 <para>open a print quick slip window</para>
3616 <para>Description:</para>
3620 <para>If this preference is set to open a quick slip for
3621 printing it will eliminate the need for the librarian to click
3622 the print button to generate a checkout receipt for the patron
3623 they're checking out to. If the preference is set to clear the
3624 screen then "checking out" an empty barcode will clear the
3625 screen of the patron you were last working with.</para>
3630 <section id="FilterBeforeOverdueReport">
3631 <title>FilterBeforeOverdueReport</title>
3633 <para>Default: Don't require</para>
3635 <para>Asks: ___ staff to choose which checkouts to show before
3636 running the overdues report.</para>
3638 <para>Description:</para>
3642 <para>Koha's overdue report shows you all of the overdue items
3643 in your library system. If you have a large library system
3644 you'll want to set this preference to 'Require' to force those
3645 running the report to first limit the data generated to a
3646 branch, date range, patron category or other such filter.
3647 Requiring that the report be filtered before it's run prevents
3648 your staff from running a system heavy report and slowing down
3649 other operations in the system.</para>
3652 <screeninfo>Overdue Report Filters</screeninfo>
3656 <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
3663 <para>Values:</para>
3667 <para>Don't require</para>
3671 <para>Require</para>
3676 <section id="FineNotifyAtCheckin">
3677 <title>FineNotifyAtCheckin</title>
3679 <para>Default: Don't notify</para>
3681 <para>Asks: ___ librarians of overdue fines on the items they are
3684 <para>Values:</para>
3688 <para>Don't notify</para>
3696 <para>Description:</para>
3700 <para>With this preference set to 'Notify' all books that have
3701 overdue fines owed on them will pop up a warning when checking
3702 them in. This warning will need to acknowledged before you can
3703 continue checking items in. With this preference set to 'Don't
3704 notify,' you will still see fines owed on the patron record,
3705 you just won't have an additional notification at check
3709 <screeninfo>Fine notification at checkin</screeninfo>
3713 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
3721 <section id="DisplayClearScreenButton">
3722 <title>DisplayClearScreenButton</title>
3724 <para>Default: Show</para>
3726 <para>Asks: ___ a button to clear the current patron from the
3727 screen on the circulation screen.</para>
3729 <para>Values:</para>
3733 <para>Don't show</para>
3736 <screeninfo>No X in the top right</screeninfo>
3740 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
3750 <screeninfo>X in the top right will clear the
3755 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
3763 <section id="itemBarcodeInputFilter">
3764 <title>itemBarcodeInputFilter</title>
3766 <para>Default: Don't filter</para>
3768 <para>Asks: ___ scanned patron barcodes.</para>
3770 <para>Values:</para>
3774 <para>Convert from CueCat format</para>
3778 <para>Don't filter</para>
3782 <para>Remove spaces from</para>
3786 <para>Remove the first number from T-prefix style</para>
3790 <para>This format is common among those libraries
3791 migrating from Follett systems</para>
3798 <section id="NoticeCSS">
3799 <title>NoticeCSS</title>
3801 <para>Asks: Include the stylesheet at ___ on Notices.<important>
3802 <para>This should be a complete URL, starting with
3806 <para>Description:</para>
3810 <para>If you would like to style your notices with a
3811 consistent set of fonts and colors you can use this preference
3812 to point Koha to a stylesheet specifically for your
3818 <section id="numReturnedItemsToShow">
3819 <title>numReturnedItemsToShow</title>
3821 <para>Default: 20</para>
3823 <para>Asks : Show the ___ last returned items on the checkin
3827 <section id="previousIssuesDefaultSortOrder">
3828 <title>previousIssuesDefaultSortOrder</title>
3830 <para>Default: earliest to latest</para>
3832 <para>Asks: Sort previous checkouts on the circulation page from
3833 ___ due date.</para>
3835 <para>Values:</para>
3839 <para>earliest to latest</para>
3843 <para>latest to earliest</para>
3848 <section id="RecordLocalUseOnReturn">
3849 <title>RecordLocalUseOnReturn</title>
3851 <para>Default: Don't record</para>
3853 <para>Asks: ___ local use when an unissued item is checked
3856 <para>Values:</para>
3860 <para>Don't record</para>
3868 <para>Description:</para>
3872 <para>When this preference is set to "Don't record" you can
3873 record local use of items by checking items out to the
3874 statistical patron. With this preference set to "Record" you
3875 can record local use by checking out to the statistical patron
3876 and/or by checking in a book that is not currently checked
3882 <section id="soundon">
3883 <title>soundon</title>
3885 <para>Default: Don't enable</para>
3887 <para>Asks: ___ circulation sounds during checkin and checkout in
3888 the staff interface.</para>
3890 <para>Values:</para>
3894 <para>Don't enable</para>
3903 <para>This feature is not supported by all browsers. Requires
3904 an HTML5 compliant browser.</para>
3908 <section id="SpecifyDueDate">
3909 <title>SpecifyDueDate</title>
3911 <para>Default: Allow</para>
3913 <para>Asks: ___ staff to specify a due date for a checkout.</para>
3915 <para>Due dates are calculated using your circulation and fines
3916 rules, but staff can override that if you allow them to specify a
3917 due date at checkout.</para>
3919 <para>Description:</para>
3923 <para>This preference allows for circulation staff to change a
3924 due date from the automatic due date to another calendar date.
3925 This option would be used for circumstances in which the due
3926 date may need to be decreased or extended in a specific
3927 circumstance. The “Allow" setting would allow for this
3928 option to be utilized by staff, the “Don't allow"
3929 setting would bar staff from changing the due date on
3934 <para>Values:</para>
3941 <screeninfo>Specify Due Date Box Shows</screeninfo>
3945 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
3952 <para>Don't allow</para>
3955 <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
3959 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
3967 <section id="todaysIssuesDefaultSortOrder">
3968 <title>todaysIssuesDefaultSortOrder</title>
3970 <para>Default: latest to earliest</para>
3972 <para>Asks: Sort today's checkouts on the circulation page from
3973 ___ due date.</para>
3975 <para>Values:</para>
3979 <para>earliest to latest</para>
3983 <para>latest to earliest</para>
3988 <section id="UseTablesortForCirc">
3989 <title>UseTablesortForCirc</title>
3991 <para>Default: Don't enable</para>
3993 <para>Asks: ___ the sorting of current patron checkouts on the
3994 circulation screen.</para>
3996 <para>Values:</para>
4000 <para>Don't enable</para>
4009 <para>Enabling this function may slow down circulation time for
4010 patrons with many checkouts.</para>
4014 <section id="WaitingNotifyAtCheckin">
4015 <title>WaitingNotifyAtCheckin</title>
4017 <para>Default: Don't notify</para>
4019 <para>Asks: ___ librarians of waiting holds for the patron whose
4020 items they are checking in.</para>
4022 <para>Values:</para>
4026 <para>Don't notify</para>
4033 <screeninfo>Notification that a hold is waiting</screeninfo>
4037 <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
4044 <para>Description:</para>
4048 <para>When checking in books you can choose whether or not to
4049 have a notice pop up if the patron who returned the book has a
4050 hold waiting for pick up. If you choose 'Notify' for
4051 WaitingNotifyAtCheckin then every time a hold is found for the
4052 patron who had the book out last a message will appear on your
4053 check in screen.</para>
4059 <section id="circscoprefs">
4060 <title>Self Checkout</title>
4064 <section id="AllowSelfCheckReturns">
4065 <title>AllowSelfCheckReturns</title>
4067 <para>Default: Don't allow</para>
4069 <para>Asks: ___ patrons to return items through web-based self
4070 checkout system.</para>
4072 <para>Values:</para>
4080 <para>Don't allow</para>
4084 <para>Description:</para>
4088 <para>This preference is used to determine if you want patrons
4089 to be allowed to return items through your self check
4090 machines. By default Koha's self check interface is simply for
4091 checking items out.</para>
4096 <section id="AutoSelfCheckAllowed">
4097 <title>AutoSelfCheckAllowed, AutoSelfCheckID &
4098 AutoSelfCheckPass</title>
4101 <para>Most libraries will want to leave this set to 'Don't
4102 allow.' This preference turns off the requirement to log into
4103 the self checkout machine with a staff username and password by
4104 storing the username and password for automatic login.</para>
4107 <para>AutoSelfCheckAllowed Default: Don't allow</para>
4109 <para>Asks: ___ the web-based self checkout system to
4110 automatically login with this staff login ___ and this password
4113 <para>AutoSelfCheckAllowed Values:</para>
4121 <para>Don't allow</para>
4125 <para>AutoSelfCheckID needs to be set to the username of a staff
4126 member with 'circulate' <link
4127 linkend="patronpermissions">permissions</link>.</para>
4129 <para>AutoSelfCheckPass needs to be set to the password of a staff
4130 member with 'circulate' <link
4131 linkend="patronpermissions">permissions</link>.</para>
4134 <section id="SelfCheckHelpMessage">
4135 <title>SelfCheckHelpMessage</title>
4137 <para>Asks: Include the following HTML in the Help page of the
4138 web-based self checkout system</para>
4140 <para>Description:</para>
4144 <para>Clicking the 'Help' link in the top right of the self
4145 checkout interface opens up a three step process for using the
4146 self check interface. Adding HTML to this system preference
4147 will print that additional help text above what's already
4153 <section id="SelfCheckoutByLogin">
4154 <title>SelfCheckoutByLogin</title>
4156 <para>Default: Barcode</para>
4158 <para>Asks: Have patrons login into the web-based self checkout
4159 system with their ___</para>
4161 <para>Values:</para>
4165 <para>Barcode</para>
4168 <screeninfo>Self Checkout Patron Card Number</screeninfo>
4172 <imagedata fileref="images/circ/selfcheckout.png"/>
4179 <para>Username and password</para>
4182 <screeninfo>Shelf checkout by login</screeninfo>
4186 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
4193 <para>Description:</para>
4197 <para>This preference lets you decide how your patrons will
4198 log in to the self checkout machine. Barcode is the patron's
4199 card number and their username and password is set using the
4200 opac/staff username and password fields on the patron
4206 <section id="SelfCheckTimeout">
4207 <title>SelfCheckTimeout</title>
4209 <para>Default: 120</para>
4211 <para>Asks: Time out the current patron's web-based self checkout
4212 system login after ___ seconds.</para>
4214 <para>Description:</para>
4218 <para>After the machine is idle for the time entered in this
4219 preference the self check out system will log out the current
4220 patron and return to the starting screen.</para>
4225 <section id="ShowPatronImageInWebBasedSelfCheck">
4226 <title>ShowPatronImageInWebBasedSelfCheck</title>
4228 <para>Default: Don't show</para>
4230 <para>Asks: ___ the patron's picture (if one has been added) when
4231 they use the web-based self checkout.</para>
4233 <para>Values:</para>
4237 <para>Don't show</para>
4246 <section id="WebBasedSelfCheck">
4247 <title>WebBasedSelfCheck</title>
4249 <para>Default: Don't enable</para>
4251 <para>Asks: ___ the web-based self checkout system.</para>
4253 <para>Values:</para>
4257 <para>Don't enable</para>
4265 <para>Enabling this preference will allow access to the <link
4266 linkend="selfcheckout">self checkout</link> module in Koha.</para>
4271 <section id="creatorprefs">
4272 <title>Creators</title>
4274 <para>These preferences have to do with creating content.</para>
4276 <para><emphasis>Get there:</emphasis> More > Administration >
4277 Global System Preferences > Creators</para>
4279 <section id="creatorpatcardprefs">
4280 <title>Patron Cards</title>
4282 <para>These preferences are in reference to the <link
4283 linkend="patroncardcreator">Patron Card Creator</link> tool.</para>
4285 <section id="ImageLimit">
4286 <title>ImageLimit</title>
4288 <para>Asks: Limit the number of creator images stored in the
4289 database to ___ images.</para>
4294 <section id="enhancedcontent">
4295 <title>Enhanced Content</title>
4297 <para><emphasis>Get there:</emphasis> More > Administration >
4298 Global System Preferences > Enhanced Content</para>
4301 <para>Always read the terms of service associated with external data
4302 sources to be sure that you are using the products within the
4303 allowed limits.</para>
4307 <para>You cannot have more than one service for cover images
4308 (including local cover images) set up. If you set up more than one
4309 you will get multiple cover images. Instead choose only one source
4310 for cover images.</para>
4313 <section id="frbrenhancedprefs">
4318 <section id="FRBRizeEditions">
4319 <title>FRBRizeEditions</title>
4321 <para>Default: Don't show</para>
4323 <para>Asks: ___ other editions of an item on the staff
4326 <para>Values:</para>
4330 <para>Don't show</para>
4337 <screeninfo>Editions tab in staff client</screeninfo>
4341 <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
4348 <para>Description:</para>
4352 <para>Using the rules set forth in the Functional Requirements
4353 for Bibliographic records, this option, when enabled, pulls
4354 all editions of the same title available in your collection
4355 regardless of material type. Items will appear under an
4356 'Editions' tab on the detail page for the title in question..
4357 According to <emphasis>Libraries Unlimited's Online Dictionary
4358 for Library and Information Science</emphasis> (<ulink
4359 url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>),
4360 FRBRizing the catalog involves collating MARC records of
4361 similar materials. FRBRization brings together entities (sets
4362 of Works, Expressions, or Manifestations), rather than just
4363 sets of Items. It can aid patrons in selecting related items,
4364 expressions, and manifestations that will serve their needs.
4365 When it is set to "Show", the OPAC will query one or more ISBN
4366 web services for associated ISBNs and display an Editions tab
4367 on the details pages. Once this preference is enabled, the
4368 library must select one of the ISBN options (<link
4369 linkend="ThingISBN">ThingISBN</link> or <link
4370 linkend="XISBN">XISBN</link>). This option is only for the
4371 Staff Client; the OPACFRBRizeEditions option must be enabled
4372 to have the Editions tab appear on the OPAC.</para>
4377 <para>Requires that you turn on one or more of the ISBN services
4378 (<link linkend="ThingISBN">ThingISBN</link> or <link
4379 linkend="XISBN">XISBN</link>)</para>
4383 <section id="OPACFRBRizeEditions">
4384 <title>OPACFRBRizeEditions</title>
4386 <para>Default: Don't show</para>
4388 <para>Asks: ___ other editions of an item on the OPAC.</para>
4390 <para>Description:</para>
4394 <para>Using the rules set forth in the Functional Requirements
4395 for Bibliographic records, this option, when enabled, pulls
4396 all editions of the same title available in your collection
4397 regardless of material type. Items will appear under an
4398 'Editions' tab on the detail page for the title in question..
4399 According to <emphasis>Libraries Unlimited's Online Dictionary
4400 for Library and Information Science</emphasis> (<ulink
4401 url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>),
4402 FRBRizing the catalog involves collating MARC records of
4403 similar materials. FRBRization brings together entities (sets
4404 of Works, Expressions, or Manifestations), rather than just
4405 sets of Items. It can aid patrons in selecting related items,
4406 expressions, and manifestations that will serve their needs.
4407 When it is set to "Show", the OPAC will query one or more ISBN
4408 web services for associated ISBNs and display an Editions tab
4409 on the details pages. Once this preference is enabled, the
4410 library must select one of the ISBN options (<link
4411 linkend="ThingISBN">ThingISBN</link> or <link
4412 linkend="XISBN">XISBN</link>). This option is only for the
4413 OPAC; the 'FRBRizeEditions' option must be turned “On"
4414 to have the Editions tab appear on the Staff Client.</para>
4418 <para>Values:</para>
4422 <para>Don't show</para>
4429 <screeninfo>Editions tab in the OPAC</screeninfo>
4433 <imagedata fileref="images/admin/globalprefs/editions.png"/>
4440 <para>This preference pulls all editions of the same title
4441 available in your collection regardless of material type. Items
4442 will appear under an 'Editions' tab on the detail page for the
4443 title in question.</para>
4446 <para>Requires that you turn on one or more of the ISBN services
4447 (<link linkend="ThingISBN">ThingISBN</link> or <link
4448 linkend="XISBN">XISBN</link>)</para>
4453 <section id="amazonprefs">
4454 <title>Amazon</title>
4458 <section id="AmazonEnabled">
4459 <title>AmazonEnabled</title>
4461 <para>Default: Don't use</para>
4463 <para>Asks: ___ data from Amazon on the staff interface (including
4464 reviews and "Search Inside" links on item detail pages).</para>
4466 <para>Values:</para>
4470 <para>Don't use</para>
4479 <para>This requires that you have signed up for and entered an
4485 <para>Sign up at: <ulink
4486 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4490 <para>Enter your key in the <link
4491 linkend="AWSAccessKeyID">AWSAccessKeyID</link> system
4496 <para>Description:</para>
4500 <para>This preference does not display any content but instead
4501 enables other Amazon-related preferences (<link
4502 linkend="AmazonCoverImages">AmazonCoverImages</link>, <link
4503 linkend="AmazonSimilarItems">AmazonSimilarItems</link>, <link
4504 linkend="AmazonReviews">AmazonReviews</link>). Before turning
4505 this feature to "Use", the library must first set <link
4506 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4507 linkend="AWSPrivateKey">AWSPrivateKey</link>. Furthermore, if
4508 Amazon content is enabled, other jacket services should be
4509 disabled to avoid interference. This preference applies only
4510 to the Staff Client. In order to display Amazon content on the
4511 OPAC, please set the <link
4512 linkend="OPACAmazonEnabled">OPACAmazonEnabled</link>
4518 <section id="OPACAmazonEnabled">
4519 <title>OPACAmazonEnabled</title>
4521 <para>Default: Don't use</para>
4523 <para>Asks: ___ data from Amazon on the OPAC (including reviews
4524 and "Search Inside" links on item detail pages).</para>
4526 <para>Values:</para>
4530 <para>Don't use</para>
4539 <para>This requires that you have signed up for and entered an
4545 <para>Sign up at: <ulink
4546 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4550 <para>Set your enter your key in the <link
4551 linkend="AWSAccessKeyID">AWSAccessKeyID</link> system
4556 <para>Description:</para>
4560 <para>This preference does not display any content but instead
4561 enables other Amazon-related preferences (<link
4562 linkend="AmazonCoverImages">AmazonCoverImages</link>, <link
4563 linkend="AmazonSimilarItems">AmazonSimilarItems</link>, <link
4564 linkend="AmazonReviews">AmazonReviews</link>). Before turning
4565 this feature to "Use", the library must first set <link
4566 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4567 linkend="AWSPrivateKey">AWSPrivateKey</link>. Furthermore, if
4568 Amazon content is enabled, other jacket services should be
4569 disabled to avoid interference. This preference applies only
4570 to the OPAC. In order to display Amazon content on the Staff
4571 Client, please set the <link
4572 linkend="AmazonEnabled">AmazonEnabled</link>
4578 <section id="AmazonLocale">
4579 <title>AmazonLocale</title>
4581 <para>Default: American</para>
4583 <para>Asks: Use Amazon data from its ___ website.</para>
4589 <para>American</para>
4593 <para>British</para>
4597 <para>Canadian</para>
4609 <para>Japanese</para>
4614 <section id="AWSAccessKeyID">
4615 <title>AWSAccessKeyID</title>
4617 <para>Asks: Access Amazon content using the access key ___</para>
4619 <para>Sign up at: <ulink
4620 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4622 <para>Description:</para>
4626 <para>If the library has signed up for an Amazon Web Services
4627 (AWS) account, it will be assigned an Access Key ID. In order
4628 to enable Amazon content, cover images, reviews, and similar
4629 item suggestions, the library's Access Key ID must be entered
4634 <para>Once signed up your keys can be accessed by logging into
4635 your account and going to the 'Security Credentials' page. Your
4636 Access Key will be listed next to the date it was created.</para>
4639 <screeninfo>Amazon Access Keys</screeninfo>
4643 <imagedata fileref="images/admin/globalprefs/amazonkeys.png"/>
4649 <section id="AWSPrivateKey">
4650 <title>AWSPrivateKey</title>
4652 <para>Asks: Access Amazon content (other than book jackets) using
4653 the private key ___</para>
4655 <para>Sign up at: <ulink
4656 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4658 <para>Description:</para>
4662 <para>If the library has signed up for an Amazon Web Services
4663 (AWS) account, it will be assigned a Secret Access Key. In
4664 order to enable Amazon reviews and similar item suggestions,
4665 the library's Secret Access Key must be entered here.</para>
4669 <para>Once signed up your keys can be accessed by logging into
4670 your account and going to the 'Security Credentials' page. Next to
4671 your Access key is a link that says 'Show,' clicking this will
4672 open up your secret access key or your AWSPrivateKey.</para>
4675 <screeninfo>Amazon Private Key</screeninfo>
4679 <imagedata fileref="images/admin/globalprefs/amazonkeys.png"/>
4685 <section id="AmazonAssocTag">
4686 <title>AmazonAssocTag</title>
4688 <para>Asks: Put the associate tag ___ on links to Amazon.</para>
4691 <para>This can net your library referral fees if a patron
4692 decides to buy an item after clicking through to Amazon from
4696 <para>Description:</para>
4700 <para>An Amazon Associates Tag allows a library to earn a
4701 percentage of all purchases made on Amazon when a patron
4702 accesses Amazon's site via links on the library's website.
4703 More information about the Amazon Associates program is
4704 available at Amazon's Affiliate Program's website, <ulink
4705 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
4706 Before a tag can be obtained, however, the library must first
4707 apply for an Amazon Web Services (AWS) account. Applications
4708 are free of charge and can be made at <ulink
4709 url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
4710 Once an AWS account has been established, the library can then
4711 obtain the Amazon Associates Tag.</para>
4715 <para>Sign up at: <ulink
4716 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
4719 <section id="AmazonCoverImages">
4720 <title>AmazonCoverImages</title>
4722 <para>Default: Don't show</para>
4724 <para>Asks: ___ cover images from Amazon on search results and
4725 item detail pages on the staff interface.</para>
4727 <para>Values:</para>
4731 <para>Don't show</para>
4739 <para>Description:</para>
4743 <para>This preference makes it possible to either allow or
4744 prevent Amazon cover images from being displayed in the Staff
4745 Client. Cover images are retrieved by Amazon, which pulls the
4746 content based on the first ISBN number in the item's MARC
4747 record. Amazon offers this service free of charge, but
4748 interested libraries must first establish an Amazon Web
4749 Services (AWS) account (<ulink
4750 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4751 the value for this preference is set to "Show", the cover
4752 images will appear in the Staff Client, and if it is set to
4753 "Don't show", the images will not appear. If activating this
4754 feature, the library must first set <link
4755 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4756 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4757 you're using Amazon cover images, all other cover image
4758 services must be disabled. If they are not disabled, they will
4759 prevent AmazonCoverImages from functioning properly.</para>
4764 <para>Requires that <link
4765 linkend="AmazonEnabled">AmazonEnabled</link> is set to
4770 <section id="AmazonReviews">
4771 <title>AmazonReviews</title>
4773 <para>Default: Don't show</para>
4775 <para>Asks: ___ reviews from Amazon on item detail pages on the
4776 staff interface.</para>
4778 <para>Values:</para>
4782 <para>Don't show</para>
4790 <para>Description:</para>
4794 <para>This preference makes it possible to either allow or
4795 prevent Amazon reviews from being displayed in the Staff
4796 Client. Amazon offers this service free of charge, but
4797 interested libraries must first establish an Amazon Web
4798 Services (AWS) account (<ulink
4799 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4800 the value is set to "Show", the reviews will appear in the
4801 Staff Client, and if it is set to "Don't show", the reviews
4802 will not appear. Before setting this to "Show", the library
4803 must first set <link
4804 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4805 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4806 AmazonReviews is enabled, all other review services should be
4807 disabled to avoid interference.</para>
4812 <para>Since a change in terms of service by Amazon, this feature
4813 no longer works.</para>
4817 <section id="AmazonSimilarItems">
4818 <title>AmazonSimilarItems</title>
4820 <para>Default: Don't show</para>
4822 <para>Asks: ___ similar items, as determined by Amazon, on item
4823 detail pages on the staff interface.</para>
4825 <para>Values:</para>
4829 <para>Don't show</para>
4837 <para>This will use Amazon data to determine if you have
4838 similar items in your collection - it will not show items
4839 that you do not already have cataloged at your
4846 <para>Description:</para>
4850 <para>This preference makes it possible to either allow or
4851 prevent Amazon's suggestions for Similar Items from being
4852 displayed in the Staff Client. Amazon offers this service free
4853 of charge, but interested libraries must first establish an
4854 Amazon Web Services (AWS) account (<ulink
4855 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4856 the value is set to "Show", the Similar Items suggestions will
4857 appear in the Staff Client, and if it is set to "Don't show",
4858 the suggestions will not appear. Before enabling this
4859 preference, the library must first set <link
4860 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4861 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4862 AmazonSimilarItems is enabled, all other similar item services
4863 should be disabled to avoid interference.</para>
4868 <para>Since a change in terms of service by Amazon, this feature
4869 no longer works.</para>
4873 <section id="OPACAmazonCoverImages">
4874 <title>OPACAmazonCoverImages</title>
4876 <para>Default: Don't show</para>
4878 <para>Asks: ___ cover images from Amazon on search results and
4879 item detail pages on the OPAC.</para>
4881 <para>Values:</para>
4885 <para>Don't show</para>
4893 <para>Description:</para>
4897 <para>This preference makes it possible to either allow or
4898 prevent Amazon cover images from being displayed in the OPAC.
4899 Cover images are retrieved by Amazon, which pulls the content
4900 based on the first ISBN number in the item's MARC record.
4901 Amazon offers this service free of charge, but interested
4902 libraries must first establish an Amazon Web Services (AWS)
4904 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4905 the value for this preference is set to "Show", the cover
4906 images will appear in the OPAC, and if it is set to "Don't
4907 show", the images will not appear. If activating this feature,
4908 the library must first set <link
4909 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4910 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4911 you're using Amazon cover images, all other cover image
4912 services must be disabled. If they are not disabled, they will
4913 prevent AmazonCoverImages from functioning properly.</para>
4918 <para>Requires that <link
4919 linkend="OPACAmazonEnabled">OPACAmazonEnabled</link> is set to
4924 <section id="OPACAmazonSimilarItems">
4925 <title>OPACAmazonSimilarItems</title>
4927 <para>Default: Don't show</para>
4929 <para>Asks: ___ similar items, as determined by Amazon, on item
4930 detail pages on the OPAC.</para>
4932 <para>Values:</para>
4936 <para>Don't show</para>
4944 <para>This will use Amazon data to determine if you have
4945 similar items in your collection - it will not show items
4946 that you do not already have cataloged at your
4953 <para>Description:</para>
4957 <para>This preference makes it possible to either allow or
4958 prevent Amazon's suggestions for Similar Items from being
4959 displayed in the OPAC. Amazon offers this service free of
4960 charge, but interested libraries must first establish an
4961 Amazon Web Services (AWS) account (<ulink
4962 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4963 the value is set to "Show", the Similar Items suggestions will
4964 appear in the OPAC, and if it is set to "Don't show", the
4965 suggestions will not appear. Before enabling this preference,
4966 the library must first set <link
4967 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4968 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4969 AmazonSimilarItems is enabled, all other similar item services
4970 should be disabled to avoid interference.</para>
4975 <para>Since a change in terms of service by Amazon, this feature
4976 no longer works.</para>
4980 <section id="OPACAmazonReviews">
4981 <title>OPACAmazonReviews</title>
4983 <para>Default: Don't show</para>
4985 <para>Asks: ___ reviews from Amazon on item detail pages on the
4988 <para>Values:</para>
4992 <para>Don't show</para>
5000 <para>Description:</para>
5004 <para>This preference makes it possible to either allow or
5005 prevent Amazon reviews from being displayed in the OPAC.
5006 Amazon offers this service free of charge, but interested
5007 libraries must first establish an Amazon Web Services (AWS)
5009 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
5010 the value is set to "Show", the reviews will appear in the
5011 OPAC, and if it is set to "Don't show", the reviews will not
5012 appear. Before setting this to "Show", the library must first
5013 set <link linkend="AWSAccessKeyID">AWSAccessKeyID</link> and
5014 <link linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally,
5015 if AmazonReviews is enabled, all other review services should
5016 be disabled to avoid interference.</para>
5021 <para>Since a change in terms of service by Amazon, this feature
5022 no longer works.</para>
5027 <section id="Babelthequeprefs">
5028 <title>Babelthèque</title>
5032 <section id="Babeltheque">
5033 <title>Babeltheque</title>
5035 <para>Default: Don't</para>
5037 <para>Asks: ___ include information (such as reviews and
5038 citations) from Babelthèque in item detail pages on the
5041 <para>Description:</para>
5045 <para>This preference makes it possible to display a
5046 Babeltheque tab in the OPAC, allowing patrons to access tags,
5047 reviews, and additional title information provided by
5048 Babeltheque. The information which Babeltheque supplies is
5049 drawn from the French language-based <ulink
5050 url="http://www.babelio.com/">Babelio.com</ulink>, a French
5051 service similar to LibraryThing for Libraries. More
5052 information about Babeltheque is available through its
5054 url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
5055 Libraries that wish to allow access to this information must
5056 first register for the service at <ulink
5057 url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
5058 Please note that this information is only provided in
5063 <para>Values:</para>
5070 <screeninfo>Data from Babelthèque on the bib
5075 <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
5087 <section id="Babeltheque_url_js">
5088 <title>Babeltheque_url_js</title>
5090 <para>Asks: ___ Defined the url for the Babeltheque javascript
5091 file (eg. http://www.babeltheque.com/bw_XX.js)</para>
5094 <section id="Babeltheque_url_update">
5095 <title>Babeltheque_url_update</title>
5097 <para>Asks: ___ Defined the url for the Babeltheque update
5099 http://www.babeltheque.com/.../file.csv.bz2).</para>
5103 <section id="btcontentprefs">
5104 <title>Baker & Taylor</title>
5107 <para>This is a pay service, you must contact Baker & Taylor
5108 to subscribe to this service before setting these options.</para>
5111 <section id="BakerTaylorEnabled">
5112 <title>BakerTaylorEnabled</title>
5114 <para>Default: Don't add</para>
5116 <para>Asks: ___ Baker and Taylor links and cover images to the
5117 OPAC and staff client. This requires that you have entered in a
5118 username and password (which can be seen in image links).</para>
5120 <para>Values:</para>
5128 <para>Don't add</para>
5132 <para>Description:</para>
5136 <para>This preference makes it possible to display Baker &
5137 Taylor content (book reviews, descriptions, cover images,
5138 etc.) in both the Staff Client and the OPAC. Libraries that
5139 wish to display Baker & Taylor content must first register
5140 and pay for this service with Baker & Taylor (<ulink
5141 url="http://www.btol.com">http://www.btol.com</ulink>). If
5142 Baker & Taylor content is enabled be sure to turn off
5143 other cover and review services to prevent
5144 interference.</para>
5149 <para>To use this you will need to also set the <link
5150 linkend="btuserpass">BakerTaylorUsername &
5151 BakerTaylorPassword</link> system preferences</para>
5155 <section id="BakerTaylorBookstoreURL">
5156 <title>BakerTaylorBookstoreURL</title>
5158 <para>Asks: Baker and Taylor "My Library Bookstore" links should
5159 be accessed at https:// ___ isbn</para>
5161 <para>Description:</para>
5165 <para>Some libraries generate additional funding for the
5166 library by selling books and other materials that are
5167 purchased from or have been previously leased from Baker &
5168 Taylor. These materials can be accessed via a link on the
5169 library's website. This service is often referred to as
5170 “My Library Bookstore." In order to participate in this
5171 program, the library must first register and pay for the
5172 service with Baker & Taylor. Additional information about
5173 this and other services provided by Baker & Taylor is
5174 available at the Baker & Taylor website, <ulink
5175 url="http://www.btol.com">http://www.btol.com</ulink>. The
5176 BakerTaylorBookstoreURL preference establishes the URL in
5177 order to link to the library's Baker & Taylor-backed
5178 online bookstore, if such a bookstore has been established.
5179 The default for this field is left blank; if no value is
5180 entered, the links to My Library Bookstore will remain
5181 inactive. If enabling this preference, enter the library's
5182 Hostname and Parent Number in the appropriate location within
5183 the URL. The “key" value (key=) should be appended to
5184 the URL, and https:// should be prepended.</para>
5188 <para>This should be filled in with something like
5189 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
5192 <para>Leave it blank to disable these links.</para>
5196 <para>Be sure to get this information from Baker & Taylor
5197 when subscribing.</para>
5201 <section id="btuserpass">
5202 <title>BakerTaylorUsername & BakerTaylorPassword</title>
5204 <para>Asks: Access Baker and Taylor using username ___ and
5207 <para>Descriptions:</para>
5211 <para>This setting in only applicable if the library has a
5212 paid subscription to the external Content Café service
5213 from Baker & Taylor. Use the box provided to enter in the
5214 library's Content Café username and password. Also,
5215 ensure that the <link
5216 linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
5218 linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
5219 settings are properly set. The Content Café service is
5220 a feed of enhanced content such as cover art, professional
5221 reviews, and summaries that is displayed along with Staff
5222 Client/OPAC search results. For more information on this
5223 service please see the Baker & Taylor website: <ulink
5224 url="http://www.btol.com">http://www.btol.com</ulink></para>
5229 <para>Be sure to get this information from Baker & Taylor
5230 when subscribing.</para>
5235 <section id="googleprefs">
5236 <title>Google</title>
5240 <section id="GoogleJackets">
5241 <title>GoogleJackets</title>
5243 <para>Default: Don't add</para>
5245 <para>Asks: ___ cover images from Google Books to search results
5246 and item detail pages on the OPAC.</para>
5248 <para>Values:</para>
5256 <para>Don't add</para>
5260 <para>Description:</para>
5264 <para>This setting controls the display of applicable cover
5265 art from the free Google Books database, via the Google Books
5266 API. Please note that to use this feature, all other cover
5267 services should be turned off.</para>
5273 <section id="librarythingprefs">
5274 <title>LibraryThing</title>
5276 <para>LibraryThing for Libraries is a pay service. You must first
5277 contact LibraryThing directly for pricing and subscription
5278 information. Learn more at <ulink
5279 url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
5280 Also, for further configuration instructions please see the
5281 LibraryThing Wiki: <ulink
5282 url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
5284 <section id="ThingISBN">
5285 <title>ThingISBN</title>
5287 <para>Default: Don't use</para>
5289 <para>Asks: ___ the ThingISBN service to show other editions of a
5292 <para>Values:</para>
5296 <para>Don't use</para>
5304 <para>Description:</para>
5308 <para>Set to 'Use' to display an “Editions" tab on the
5309 item's detail page. Editions are listed, complete with cover
5310 art (if you have one of the cover services enabled) and
5311 bibliographic information. The feed comes from LibraryThing's
5312 ThingISBN web service. This is a free service to
5313 non-commercial sites with fewer than 1,000 requests per
5319 <para>Requires <link
5320 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5321 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
5326 <para>This is separate from Library Thing for Libraries and does
5327 not have a cost associated with it.</para>
5331 <section id="LibraryThingForLibrariesEnabled">
5332 <title>LibraryThingForLibrariesEnabled</title>
5334 <para>Default: Don't show</para>
5336 <para>Asks: ___ reviews, similar items, and tags from Library
5337 Thing for Libraries on item detail pages on the OPAC.</para>
5339 <para>Values:</para>
5343 <para>Don't show</para>
5351 <para>Description:</para>
5355 <para>This setting is only applicable if the library has a
5356 paid subscription to the external LibraryThing for Libraries
5357 service. This service can provide patrons with the display of
5358 expanded information on catalog items such as book
5359 recommendations. It also can offer advanced features like
5360 tagged browsing, patron written reviews, and a virtual library
5361 display accessed from the details tab.</para>
5366 <para>If this is set to 'show' you will need to enter a value in
5368 linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
5369 system preference.</para>
5373 <section id="LibraryThingForLibrariesID">
5374 <title>LibraryThingForLibrariesID</title>
5376 <para>Asks: Access Library Thing for Libraries using the customer
5379 <para>Description:</para>
5383 <para>This setting is only applicable if the library has a
5384 paid subscription to the external LibraryThing for Libraries
5385 service. Use the box provided to enter in the library's
5386 LibraryThing for Libraries ID as provided to the library by
5387 LibraryThing. The ID number is a series of numbers in the form
5388 ###-#########, and can be found on the library's account page
5389 at LibraryThing for Libraries. This service can provide
5390 patrons with the display of expanded information on catalog
5391 items such as book recommendations and cover art. It also can
5392 offer advanced features like tagged browsing, patron written
5393 reviews, and a virtual library display accessed from the
5399 <section id="LibraryThingForLibrariesTabbedView">
5400 <title>LibraryThingForLibrariesTabbedView</title>
5402 <para>Default: in line with bibliographic information</para>
5404 <para>Asks: Show Library Thing for Libraries content ___</para>
5406 <para>Values:</para>
5410 <para>in line with bibliographic information</para>
5414 <para>in tabs</para>
5418 <para>Description:</para>
5422 <para>This setting is only applicable if the library has a
5423 paid subscription to the external LibraryThing for Libraries
5424 service. This service can provide patrons with the display of
5425 expanded information on catalog items such as book
5426 recommendations and cover art. It also can offer advanced
5427 features like tagged browsing, patron written reviews, and a
5428 virtual library display accessed from the details tab.</para>
5434 <section id="localimages">
5435 <title>Local Cover Images</title>
5439 <section id="AllowMultipleCovers">
5440 <title>AllowMultipleCovers</title>
5442 <para>Default: Don't allow</para>
5444 <para>Asks: ___ multiple images to be attached to each
5445 bibliographic record.</para>
5447 <para>Values:</para>
5455 <para>Don't allow</para>
5459 <para>Description:</para>
5463 <para>If this preference is set to 'Allow' then you can upload
5464 multiple images that will appear in the images tab on the bib
5465 record in the OPAC and the staff client. This preference
5466 requires that either one or both <link
5467 linkend="LocalCoverImages">LocalCoverImages</link> and <link
5468 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
5469 set to 'Display.'</para>
5472 <screeninfo>Multiple cover images</screeninfo>
5476 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
5484 <section id="LocalCoverImages">
5485 <title>LocalCoverImages</title>
5487 <para>Default: Don't display</para>
5489 <para>Asks: ___ local cover images on intranet search and details
5492 <para>Values:</para>
5496 <para>Display</para>
5500 <para>Don't display</para>
5504 <para>Description:</para>
5508 <para>Setting this preference to 'Display' allows you to
5509 upload your own cover images to bib records and display them
5510 on the detail page in the staff client. At this time the cover
5511 will only show under the 'Images' tab on the holdings table on
5512 the detail display, not next to the title at the top left or
5513 on the search results.</para>
5518 <section id="OPACLocalCoverImages">
5519 <title>OPACLocalCoverImages</title>
5521 <para>Default: Don't display</para>
5523 <para>Asks: ___ local cover images on OPAC search and details
5526 <para>Values:</para>
5530 <para>Display</para>
5534 <para>Don't display</para>
5538 <para>Description:</para>
5542 <para>Setting this preference to 'Display' allows you to
5543 upload your own cover images to bib records and display them
5544 on the detail page and search results in the OPAC.</para>
5550 <section id="novelistselect">
5551 <title>Novelist Select</title>
5553 <para>Novelist Select is not a free service. Contact your Ebsco
5554 representitive to get your log in information to embed this content
5555 in the OPAC.<important>
5556 <para>Novelist Select does not include cover images for the
5557 search results and bibliographic detail pages. You can choose
5558 any other cover image service for this content.</para>
5561 <section id="NovelistSelectEnabled">
5562 <title>NovelistSelectEnabled</title>
5564 <para>Default: Don't add</para>
5566 <para>Asks: ___ Novelist Select content to the OPAC.</para>
5568 <para>Values:</para>
5576 <para>Don't add</para>
5581 <para>Enabling this requires that you have entered in a user
5582 profile and password in the <link
5583 linkend="NovelistSelectProfile">NovelistSelectProfile &
5584 NovelistSelectPassword</link> preferences</para>
5585 </important>Description:</para>
5589 <para>Novelist Select from Ebsco is a subscription service
5590 that can provide additional content in the OPAC.</para>
5595 <section id="NovelistSelectProfile">
5596 <title>NovelistSelectProfile & NovelistSelectPassword</title>
5598 <para>Asks: Access Novelist Select using user profile ___ and
5599 password ___.</para>
5602 <para>This information will be visible if someone views the
5603 source code on your OPAC.</para>
5606 <para>Description:</para>
5610 <para>Novelist Select from Ebsco is a subscription service
5611 that can provide additional content in the OPAC.</para>
5616 <section id="NovelistSelectView">
5617 <title>NovelistSelectView</title>
5619 <para>Default: in an OPAC tab</para>
5621 <para>Asks: Display Novelist Select content ___</para>
5623 <para>Description:</para>
5627 <para>Novelist Select provides a lot of content, for that
5628 reason you have four choices of where to display this content.
5629 The default view is in a tab in the holdings table.</para>
5632 <screeninfo>Novelist Select in a tab</screeninfo>
5636 <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
5641 <para>The content is the same if you choose to show it above
5642 the holdings table or below it. If shown in the right column
5643 of the page it's the same content, but displays a bit
5644 differently since space is limited.</para>
5647 <screeninfo>Novelist Select on the side</screeninfo>
5651 <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
5658 <para>Values:</para>
5662 <para>above the holdings table</para>
5666 <para>below the holdings table</para>
5670 <para>in an OPAC tab</para>
5674 <para>under the Save Record dropdown on the right</para>
5680 <section id="oclcprefs">
5685 <section id="XISBN">
5686 <title>XISBN</title>
5688 <para>Default: Don't use</para>
5690 <para>Asks: ___ the OCLC xISBN service to show other editions of a
5693 <para>Description:</para>
5697 <para>Set to 'Use' to display an “Editions" tab on the
5698 item's detail page. Editions are listed, complete with cover
5699 art and bibliographic information. The feed comes from OCLC's
5700 xISBN web service. The feed limit for non-commercial sites is
5701 1000 requests per day.</para>
5705 <para>Values:</para>
5709 <para>Don't use</para>
5718 <para>Requires <link
5719 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5720 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
5725 <section id="OCLCAffiliateID">
5726 <title>OCLCAffiliateID</title>
5728 <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
5731 <para>Description:</para>
5735 <para>This setting is only applicable if the library has an
5736 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
5737 via the XISBN programming interface. Simply enter the
5738 library's OCLC Affiliate ID in the box provided. Please note
5739 that using this data is only necessary if <link
5740 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5741 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
5742 <link linkend="XISBN">XISBN</link> settings are enabled. For
5743 more information on this service please visit the OCLC
5745 url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
5750 <para>Unless you have signed up for an ID with OCLC, you are
5751 limited to 1000 requests per day. Available at: <ulink
5752 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
5756 <section id="XISBNDailyLimit">
5757 <title>XISBNDailyLimit</title>
5759 <para>Default: 999</para>
5761 <para>Asks: Only use the xISBN service ___ times a day.</para>
5764 <para>Unless you have signed up for an ID with OCLC, you are
5765 limited to 1000 requests per day. Available at: <ulink
5766 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
5771 <section id="OpenLibraryPrefs">
5772 <title>Open Library</title>
5774 <section id="OpenLibraryCovers">
5775 <title>OpenLibraryCovers</title>
5777 <para>Default: Don't add</para>
5779 <para>Asks: ___ cover images from Open Library to search results
5780 and item detail pages on the OPAC.</para>
5782 <para>Values:</para>
5790 <para>Don't add</para>
5794 <para>Description:</para>
5798 <para>This setting controls the display of applicable cover
5799 art from the free Open Library database, via the Open Library
5800 API. Please note that to use this feature, all other cover
5801 services should be turned off.</para>
5807 <section id="Syndeticsprefs">
5808 <title>Syndetics</title>
5810 <para>Syndetics is a pay service. You must first contact Syndetics
5811 directly for pricing and subscription information.</para>
5813 <section id="SyndeticsEnabled">
5814 <title>SyndeticsEnabled</title>
5816 <para>Default: Don't use</para>
5818 <para>Asks: ___ content from Syndetics.</para>
5820 <para>Values:</para>
5824 <para>Don't use</para>
5832 <para>Description:</para>
5836 <para>When this option is enabled any of the Syndetics options
5842 <para>Requires that you enter your <link
5843 linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
5844 this content will appear.</para>
5848 <section id="SyndeticsClientCode">
5849 <title>SyndeticsClientCode</title>
5851 <para>Asks: Use the client code ___ to access Syndetics.</para>
5853 <para>Description:</para>
5857 <para>Once the library signs up for Syndetics' services,
5858 Syndetics will provide the library with an access code. (Visit
5859 the Syndetics homepage at <ulink
5860 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
5861 for more information.) This is the code that must be entered
5862 to access Syndetics' subscription services. Syndetics is a
5863 paid subscription service. This value must be entered before
5864 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
5865 be enabled. If the code is lost, corrupted, or forgotten, a
5866 new one can be obtained from <ulink
5867 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
5872 <para>You will need to get your client code directly from
5877 <section id="SyndeticsCoverImages">
5878 <title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
5880 <para>SyndeticsCoverImages Default: Don't show</para>
5882 <para>SyndeticsCoverImageSize Default: medium</para>
5884 <para>Asks: ___ cover images from Syndetics on search results and
5885 item detail pages on the OPAC in a ___ size.</para>
5887 <para>Descriptions:</para>
5891 <para>When enabled, SyndeticsCoverImages, allows libraries to
5892 display Syndetics' collection of full-color cover images for
5893 books, videos, DVDs and CDs on their OPAC. For each book or
5894 item that comes up during a user search, the cover image for
5895 that title will be displayed. Since these cover images come in
5896 three sizes, the optimum size must be selected using the
5897 SyndeticsCoverImageSize preference after SyndeticsCoverImages
5898 are enabled. Syndetics cover images come in two sizes:
5899 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
5900 Syndetics is a paid subscription service. The <link
5901 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
5902 be entered and the <link
5903 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
5904 be activated before this service can be used. Other cover
5905 image preferences should also be disabled to avoid
5906 interference.</para>
5910 <para>SyndeticsCoverImages Values:</para>
5914 <para>Don't show</para>
5922 <para>SyndeticsCoverImageSize Values:</para>
5935 <section id="SyndeticsAuthorNotes">
5936 <title>SyndeticsAuthorNotes</title>
5938 <para>Default: Don't show</para>
5940 <para>Asks: ___ notes about the author of a title from Syndetics
5941 on item detail pages on the OPAC.</para>
5943 <para>Values:</para>
5947 <para>Don't show</para>
5955 <para>Description:</para>
5959 <para>When this option is set to "Show", Syndetics provides
5960 notes and short author biographies for more that 300,000
5961 authors, in both fiction and nonfiction. With this option
5962 enabled the library can display Syndetics Author Notes on the
5963 OPAC. According to the Syndetics Solutions website (<ulink
5964 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
5965 Author Notes include lists of contributors for many
5966 multi-author texts and compilations. The <link
5967 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
5968 be entered and the <link
5969 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
5970 be activated before this service can be used.</para>
5975 <section id="SyndeticsAwards">
5976 <title>SyndeticsAwards</title>
5978 <para>Default: Don't show</para>
5980 <para>Asks: ___ information from Syndetics about the awards a
5981 title has won on item detail pages on the OPAC.</para>
5983 <para>Values:</para>
5987 <para>Don't show</para>
5995 <para>Description:</para>
5999 <para>When this option is set to "Show", Syndetics provides
6000 its clients with a list of awards that any title has won. With
6001 this service enabled the library can display those awards for
6002 each book on its website. For each book or item that comes up
6003 during a user search, the list of awards for that title will
6004 be displayed. When a user clicks on a given award, information
6005 about that award is presented along with a list of the other
6006 titles that have won that award. If the user clicks on any
6007 title in the list, they will see holdings information about
6008 that title in their region. This option is a paid subscription
6010 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6011 be entered and the <link
6012 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6013 be activated before this service can be used.</para>
6018 <section id="SyndeticsEditions">
6019 <title>SyndeticsEditions</title>
6021 <para>Default: Don't show</para>
6023 <para>Asks: ___ information about other editions of a title from
6024 Syndetics on item detail pages on the OPAC</para>
6026 <para>Description:</para>
6030 <para>When enabled this option shows information on other
6031 editions of a title from Syndetics on the item detail pages of
6032 the OPAC. Syndetics is a paid subscription service. The <link
6033 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6034 be entered and the <link
6035 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6036 be activated before this service can be used.</para>
6040 <para>Values:</para>
6044 <para>Don't show</para>
6053 <para>Requires <link
6054 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
6059 <section id="SyndeticsExcerpt">
6060 <title>SyndeticsExcerpt</title>
6062 <para>Default: Don't show</para>
6064 <para>Asks: ___ excerpts from of a title from Syndetics on item
6065 detail pages on the OPAC.</para>
6067 <para>Values:</para>
6071 <para>Don't show</para>
6079 <para>Description:</para>
6083 <para>This preference allows Syndetics to display excerpts
6084 given to them from selected publishers. The excerpts are
6085 available from prominently reviewed new titles, both fiction
6086 and non-fiction. The excerpts include poems, essays, recipes,
6087 forwards and prefaces. Automatic links provided by the ISBNs
6088 within local MARC records are required to integrate Syndetics
6089 secured, high-speed Internet servers to the library OPACs. For
6090 more information see (<ulink
6091 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6096 <section id="SyndeticsReviews">
6097 <title>SyndeticsReviews</title>
6099 <para>Default: Don't show</para>
6101 <para>Asks: ___ reviews of a title from Syndetics on item detail
6102 pages on the OPAC.</para>
6104 <para>Values:</para>
6108 <para>Don't show</para>
6116 <para>Description:</para>
6120 <para>Syndetics Reviews is an accumulation of book reviews
6121 available from a variety of journals and serials. The reviews
6122 page displays colored images of reviewed books dust jackets,
6123 partnered with the names of the journal or serial providing
6124 the review. Clicking on an icon opens a window revealing the
6125 book title, author's name, book cover icon and the critic's
6126 opinion of the book. Automatic links provided by the ISBNs
6127 within local MARC records are required to integrate Syndetics
6128 secured, high-speed Internet servers to the library OPACs. For
6129 more information see (<ulink
6130 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6135 <section id="SyndeticsSeries">
6136 <title>SyndeticsSeries</title>
6138 <para>Default: Don't show</para>
6140 <para>Asks: ___ information on other books in a title's series
6141 from Syndetics on item detail pages on the OPAC.</para>
6143 <para>Values:</para>
6147 <para>Don't show</para>
6155 <para>Description:</para>
6159 <para>Each fiction title within a series is linked to the
6160 complete series record. The record displays each title in
6161 reading order and also displays the publication order, if
6162 different. Alternate series titles are also displayed.
6163 Automatic links provided by the ISBNs within local MARC
6164 records are required to integrate Syndetics secured, high-
6165 speed Internet servers to the library OPACs. For more
6166 information see (<ulink
6167 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6172 <section id="SyndeticsSummary">
6173 <title>SyndeticsSummary</title>
6175 <para>Default: Don't show</para>
6177 <para>Asks: ___ a summary of a title from Syndetics on item detail
6178 pages on the OPAC.</para>
6180 <para>Values:</para>
6184 <para>Don't show</para>
6192 <para>Description:</para>
6196 <para>Providing more than 5.6 million summaries and
6197 annotations derived from book jackets, edited publisher copy,
6198 or independently written annotations from Book News, Inc.
6199 Covering fiction and non-fiction, this summaries option
6200 provides annotations on both trade and scholarly titles. For
6201 more information see (<ulink
6202 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6207 <section id="SyndeticsTOC">
6208 <title>SyndeticsTOC</title>
6210 <para>Default: Don't show</para>
6212 <para>Asks: ___ the table of contents of a title from Syndetics on
6213 item detail pages on the OPAC.</para>
6215 <para>Values:</para>
6219 <para>Don't show</para>
6227 <para>Description:</para>
6231 <para>This preference allows staff and patrons to review the
6232 Table of Contents from a wide variety of publications from
6233 popular self-help books to conference proceedings. Specific
6234 Information access is the main purpose for this option,
6235 allowing patrons guidance to their preferred section of the
6236 book. Special arrangements with selected book services is used
6237 to obtain the table of contents for new publications each
6238 year. Automatic links provided by the ISBNs within local MARC
6239 records are required to integrate Syndetics secured,
6240 high-speed Internet servers to the library OPACs. For more
6241 information see (<ulink
6242 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6248 <section id="taggingprefs">
6249 <title>Tagging</title>
6251 <section id="TagsEnabled">
6252 <title>TagsEnabled</title>
6254 <para>Default: Allow</para>
6256 <para>Asks: ___ patrons and staff to put tags on items.</para>
6258 <para>Values:</para>
6266 <para>Don't allow</para>
6270 <para>Description:</para>
6274 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
6275 added to identify an item. Tags allow patrons to classify
6276 materials on their own. TagsEnabled is the main switch that
6277 permits the tagging features. TagsEnable must be set to
6278 'Allow' to allow for other tagging features.</para>
6283 <section id="TagsModeration">
6284 <title>TagsModeration</title>
6286 <para>Default: Don't require</para>
6288 <para>Asks: ___ that tags submitted by patrons be reviewed by a
6289 staff member before being shown.</para>
6291 <para>Values:</para>
6295 <para>Don't require</para>
6299 <para>Require</para>
6303 <para>Description:</para>
6307 <para>When set to 'Require,' all tags to be first filtered by
6308 the tag moderator. Only approved tags will be visible to
6309 patrons. When set to 'Don't require' tags will bypass the tag
6310 moderator and patrons' tags to be immediately visible. When
6311 this preference is enabled the moderator, a staff member,
6312 would approve the tag in the Staff Client. The moderator will
6313 have the option to approve or reject each pending tag
6318 <para>When moderation is required all tags go through the tag
6319 moderation tool before becoming visible.</para>
6323 <para><emphasis>Get there:</emphasis> More > Tools >
6324 <link linkend="tagsmoderation">Tags</link></para>
6329 <section id="TagsShowOnList">
6330 <title>TagsShowOnList</title>
6332 <para>Default: 6</para>
6334 <para>Asks: Show ___ tags on search results on the OPAC.</para>
6337 <para>Set the value to 0 (zero) to turn this feature off.</para>
6341 <section id="TagsInputOnList">
6342 <title>TagsInputOnList</title>
6344 <para>Default: Allow</para>
6346 <para>Asks: ___ patrons to input tags on search results on the
6349 <para>Values:</para>
6356 <screeninfo>Tags on Search Results</screeninfo>
6360 <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
6367 <para>Don't allow</para>
6372 <section id="TagsShowOnDetail">
6373 <title>TagsShowOnDetail</title>
6375 <para>Default: 10</para>
6377 <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
6380 <para>Set the value to 0 (zero) to turn this feature off.</para>
6384 <section id="TagsInputOnDetail">
6385 <title>TagsInputOnDetail</title>
6387 <para>Default: Allow</para>
6389 <para>Asks: ___ patrons to input tags on item detail pages on the
6392 <para>Values:</para>
6399 <screeninfo>Add Tags on Detail</screeninfo>
6403 <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
6410 <para>Don't allow</para>
6415 <section id="TagsExternalDictionary">
6416 <title>TagsExternalDictionary</title>
6418 <para>Asks: Allow tags in the dictionary of the ispell executable
6419 ___ on the server to be approved without moderation.</para>
6421 <para>Description:</para>
6425 <para>The dictionary includes a list of accepted and rejected
6426 tags. The accepted list includes all the tags that have been
6427 pre-allowed. The rejected list includes tags that are not
6428 allowed. This preference identifies the "accepted" dictionary
6429 used. Ispell is an open source dictionary which can be used as
6430 a list of accepted terms. Since the dictionary allows for
6431 accurately spelled obscenities, the libraries policy may
6432 dictate that modifications are made to the Ispell dictionary
6433 if this preference is use. For more information about Ispell
6435 url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
6436 Enter the path on your server to a local ispell executable,
6437 used to set $Lingua::Ispell::path.</para>
6444 <section id="l18nprefs">
6445 <title>I18N/L10N</title>
6447 <para><emphasis><emphasis>These preferences control your
6448 Internationalization and Localization
6449 settings.</emphasis></emphasis></para>
6451 <para><emphasis>Get there:</emphasis> More > Administration >
6452 Global System Preferences > I18N/L10N</para>
6454 <section id="CalendarFirstDayOfWeek">
6455 <title>CalendarFirstDayOfWeek</title>
6457 <para>Default: Sunday</para>
6459 <para>Asks: Use ___ as the first day of week in the calendar.</para>
6461 <para>Values:</para>
6473 <para>Description:</para>
6477 <para>Using this preference you can control what day shows as
6478 the first day of the week in the calendar pop ups throughout
6479 Koha and on the Calendar tool. If you change this preference and
6480 don't see a change in your browser try clearing your cache since
6481 it makes changes to the Javascript on these pages.</para>
6486 <section id="dateformat">
6487 <title>dateformat</title>
6489 <para>Default: mm/dd/yyyy</para>
6491 <para>Asks: Format dates like ___</para>
6493 <para>Values:</para>
6497 <para>dd/mm/yyyy</para>
6501 <para>mm/dd/yyyy</para>
6505 <para>yyyy/mm/dd</para>
6509 <para>Description:</para>
6513 <para>This preference controls how the date is displayed. The
6514 options are the United States method, mm/dd/yyyy (04/24/2010),
6515 the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
6516 International Standard of Organization, yyyy/mm/dd (2010/04/24).
6517 The International Standard of Organization would primarily be
6518 used by libraries with locations in multiple nations that may
6519 use different date formats, to have a single display type, or if
6520 the library would be in a region that does not use the United
6521 States or metric method. More information regarding the ISO date
6522 format can be found at <ulink
6523 url="http://www.iso.org/iso/iso_catalogue.htm">http://www.iso.org/iso/iso_catalogue.htm</ulink>.</para>
6528 <section id="languagepref">
6529 <title>language</title>
6531 <para>Default: English</para>
6533 <para>Asks: Enable the following languages on the staff
6536 <para>Values:</para>
6540 <para>English</para>
6544 <para>To install additional languages you need to run
6545 misc/translation/install-code.pl. For example, to install French you
6546 would run the following command <emphasis>install-code.pl
6547 fr-FR</emphasis> to make the templates, once they exist and are in
6548 the right place then they will show up as an option in this
6552 <section id="opaclanguages">
6553 <title>opaclanguages</title>
6555 <para>Default: English</para>
6557 <para>Asks: Enable the following languages on the OPAC</para>
6559 <para>Values:</para>
6563 <para>English</para>
6567 <para>To install additional languages you need to run
6568 misc/translation/install-code.pl. For example, to install French you
6569 would run the following command <emphasis>install-code.pl
6570 fr-FR</emphasis> to make the templates, once they exist and are in
6571 the right place then they will show up as an option in this
6575 <section id="opaclanguagesdisplay">
6576 <title>opaclanguagesdisplay</title>
6578 <para>Default: Don't allow</para>
6580 <para>Asks: ___ patrons to select their language on the OPAC.</para>
6582 <para>Values:</para>
6589 <screeninfo>When this preference is on, patrons can choose
6590 their language from a list at the bottom of the
6595 <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
6602 <para>Don't allow</para>
6608 <section id="localprefs">
6609 <title>Local Use</title>
6611 <para><emphasis><emphasis>These preferences are defined
6612 locally.</emphasis></emphasis></para>
6614 <para><emphasis>Get there:</emphasis> More > Administration >
6615 Global System Preferences > Local Use<tip>
6616 <para>Sometimes preferences which are either new or outdated will
6617 appear in this tab, if you didn't add any preferences to this tab
6618 then it's best to ignore preferences listed here.</para>
6625 <para>Logs keep track of transaction on the system. You can decide
6626 which actions you want to log and which you don't using these
6629 <para><emphasis>Get there:</emphasis> More > Administration >
6630 Global System Preferences > Logs</para>
6632 <section id="AuthoritiesLog">
6633 <title>AuthoritiesLog</title>
6635 <para>Default: Don't log</para>
6637 <para>Asks: ___ changes to authority records.</para>
6639 <para>Values:</para>
6643 <para>Don't log</para>
6652 <section id="BorrowersLog">
6653 <title>BorrowersLog</title>
6655 <para>Default: Log</para>
6657 <para>Asks: ___ changes to patron records.</para>
6659 <para>Values:</para>
6663 <para>Don't log</para>
6672 <section id="CataloguingLog">
6673 <title>CataloguingLog</title>
6675 <para>Default: Don't log</para>
6677 <para>Asks: ___ any changes to bibliographic or item records.</para>
6679 <para>Values:</para>
6683 <para>Don't log</para>
6692 <para>Since this occurs whenever a book is cataloged, edited, or
6693 checked in or out it can be very resource intensive - slowing down
6698 <section id="FinesLog">
6699 <title>FinesLog</title>
6701 <para>Default: Log</para>
6703 <para>Asks: ___ when overdue fines are charged or automatically
6706 <para>Values:</para>
6710 <para>Don't log</para>
6719 <section id="IssueLog">
6720 <title>IssueLog</title>
6722 <para>Default: Log</para>
6724 <para>Asks: ___ when items are checked out.</para>
6726 <para>Values:</para>
6730 <para>Don't log</para>
6739 <section id="LetterLog">
6740 <title>LetterLog</title>
6742 <para>Default: Log</para>
6744 <para>Asks: ___ when an automatic claim notice is sent.</para>
6746 <para>Values:</para>
6750 <para>Don't log</para>
6759 <para>This log tracks all notices that go to patrons including the
6760 overdue notices.</para>
6764 <section id="ReturnLog">
6765 <title>ReturnLog</title>
6767 <para>Default: Log</para>
6769 <para>Asks: ___ when items are returned.</para>
6771 <para>Values:</para>
6775 <para>Don't log</para>
6784 <section id="SubscriptionLog">
6785 <title>SubscriptionLog</title>
6787 <para>Default: Log</para>
6789 <para>Asks: ___ when serials are added, deleted or changed.</para>
6791 <para>Values:</para>
6795 <para>Don't log</para>
6805 <section id="opacprefs">
6808 <para><emphasis>Get there:</emphasis> More > Administration >
6809 Global System Preferences > OPAC</para>
6811 <section id="opacappearanceprefs">
6812 <title>Appearance</title>
6814 <para>These preferences control how things appear in the
6817 <section id="AuthorisedValueImages">
6818 <title>AuthorisedValueImages</title>
6820 <para>Default: Don't show</para>
6822 <para>Asks: ___ images for authorized values (such as lost
6823 statuses and locations) in search results and item detail pages on
6826 <para>Values:</para>
6830 <para>Don't show</para>
6838 <para><emphasis>Get there:</emphasis> More > Administration
6839 > <link linkend="authorizedvalues">Authorized
6840 Values</link></para>
6843 <section id="BiblioDefaultView">
6844 <title>BiblioDefaultView</title>
6846 <para>Default: in simple form</para>
6848 <para>Asks: By default, show bib records ___</para>
6850 <para>Values:</para>
6854 <para>as specified in the ISBD template.</para>
6858 <para>See <link linkend="isbdpref">ISBD</link> preference
6859 for more information</para>
6865 <para>in simple form.</para>
6869 <para>in their MARC format.</para>
6873 <para>Description:</para>
6877 <para>This preference determines the level of bibliographic
6878 detail that the patron will see on the OPAC detail page. The
6879 simple form displays the graphical interface; MARC format
6880 displays the MARC21 cataloging view; ISBD displays the ISBD
6881 (International Standard Bibliographic Description, AACR2)
6887 <section id="COinSinOPACResults">
6888 <title>COinSinOPACResults</title>
6890 <para>Default: Include</para>
6892 <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
6895 <para>Values:</para>
6899 <para>Don't include</para>
6903 <para>If you choose not to include COinS on the search
6904 results, it will still be loaded on the individual
6905 bibliographic records.</para>
6911 <para>Include</para>
6915 <para>Enabling this feature will slow OPAC search response
6922 <para>Description:</para>
6926 <para>COinS stands for ContextObjects in Spans. COinS is a
6927 method to embed bibliographic metadata in the HTML code of web
6928 pages. This allows bibliographic software to publish
6929 machine-readable bibliographic items and client reference
6930 management software (such as Zotero) to retrieve bibliographic
6931 metadata. The metadata can also be sent to an OpenURL
6932 resolver. This allows, for instance, searching for a copy of a
6933 book in one's own library.</para>
6938 <section id="DisplayOPACiconsXSLT">
6939 <title>DisplayOPACiconsXSLT</title>
6941 <para>Default: Don't show</para>
6943 <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
6944 ___ icons for itemtype and authorized values.<important>
6946 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
6948 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
6949 must be set to use an XSLT stylesheet for this to show
6950 (default or custom)</para>
6953 <para>Values:</para>
6957 <para>Don't show</para>
6964 <screeninfo>DisplayOPACiconsXSLT</screeninfo>
6968 <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
6976 <para>See the <link linkend="XSLTiTypes">XSLT Icon
6977 Guide</link> for more information on these icons.</para>
6981 <section id="hidelostitems">
6982 <title>hidelostitems</title>
6984 <para>Default: Don't show</para>
6986 <para>Asks: ___ lost items on search and detail pages.</para>
6988 <para>Description:</para>
6992 <para>Items that are marked lost by the library can either be
6993 shown or not shown on the OPAC. By setting the value to
6994 “Don't show," the lost item is not shown on the OPAC. By
6995 setting the value “Show," the lost item is shown on the
6996 OPAC for patrons to view with a status of 'lost.'</para>
7000 <para>Values:</para>
7004 <para>Don't show</para>
7011 <screeninfo>Lost item showing in the OPAC</screeninfo>
7015 <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
7023 <section id="LibraryName">
7024 <title>LibraryName</title>
7026 <para>Asks: Show ___ as the name of the library on the
7030 <para>This value will appear in the title bar of the
7035 <para>Edit '<link linkend="opacheader">opacheader</link>' if
7036 you'd like to add a library name above your search box on the
7041 <screeninfo>Browser title and address bar</screeninfo>
7045 <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
7051 <section id="OpacAddMastheadLibraryPulldown">
7052 <title>OpacAddMastheadLibraryPulldown</title>
7054 <para>Default: Don't add</para>
7056 <para>Asks: ___ a library select pulldown menu on the OPAC
7059 <para>Values:</para>
7066 <screeninfo>Library select box on Koha OPAC</screeninfo>
7070 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
7077 <para>Don't Add</para>
7080 <screeninfo>No library select box on Koha OPAC</screeninfo>
7084 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
7092 <section id="OPACBaseURL">
7093 <title>OPACBaseURL</title>
7095 <para>Asks: The OPAC is located at http:// ___</para>
7098 <para>This must be filled in correctly for RSS, unAPI, and
7099 search plugins to work.</para>
7103 <para>This must be filled in to show 'OPAC View' links from bib
7104 records in the staff client:</para>
7108 <screeninfo>With OPACBaseURL set, links to the OPAC will appear
7109 on each individual bib record in the staff client</screeninfo>
7113 <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
7119 <section id="opaccolorstylesheet">
7120 <title>opaccolorstylesheet</title>
7122 <para>Asks: Include the additional CSS stylesheet ___ to override
7123 specified settings from the default stylesheet.</para>
7125 <para>Description:</para>
7129 <para>The preference can look for stylesheets in the template
7130 directory for your OPAC language, for instance:
7131 /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file,
7132 opac-mystyles.css to this directory, you can specify it by
7133 entering opac-mystyles.css in your opaccolorstylesheet system
7134 preference. This adds your custom stylesheet as a linked
7135 stylesheet alongside the OPAC's default CSS files. This method
7136 is preferable because linked stylesheets are cached by the
7137 user's browser, meaning upon repeat visits to your site the
7138 user's browser will not have to re-download the stylesheet,
7139 instead using the copy in the browser's cache.</para>
7143 <para>If you would rather, you can upload your CSS to another
7144 server and enter the full URL pointing to it's location
7145 remember to begin the URL with http://</para>
7150 <para>Leave this field blank to disable it</para>
7154 <para>This file will add a linked CSS, not replace the
7155 existing default CSS.</para>
7159 <section id="opaccredits">
7160 <title>opaccredits</title>
7162 <para>Asks: Include the following HTML in the footer of all pages
7166 <para>Click the 'Click to edit; link to enter HTML to appear at
7167 the bottom of every page in the OPAC</para>
7171 <screeninfo>HTML version of a footer for your OPAC</screeninfo>
7175 <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
7181 <screeninfo>A sample of what can appear in your OPAC
7182 credits/footer</screeninfo>
7186 <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
7191 <para>Description:</para>
7195 <para>This setting is for credits that will appear at the
7196 bottom of your OPAC pages. Credits traditionally encompass
7197 copyright information, last date updated, hyperlinks or other
7198 information represented in an HTML format. This is static
7199 information and any updates must be entered manually.</para>
7203 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7204 Regions</link> section.</para>
7207 <section id="OPACDisplay856uAsImage">
7208 <title>OPACDisplay856uAsImage</title>
7210 <para>Default: Neither details or results page</para>
7212 <para>Asks: Display the URI in the 856u field as an image on:
7215 <para>Values:</para>
7219 <para>Both results and details pages</para>
7224 <para>Not implemented yet</para>
7231 <para>Detail page only</para>
7237 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
7238 needs to be on for this preference to work.</para>
7244 <screeninfo>Showing the 856u as an image</screeninfo>
7248 <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
7255 <para>Neither details or results page</para>
7259 <para>Results page only</para>
7264 <para>Not yet implemented</para>
7271 <para>Description:</para>
7275 <para>In addition to this option being set, the corresponding
7276 XSLT option must be turned on. Also, the corresponding 856q
7277 field must have a valid MIME image extension (e.g., "jpg") or
7278 MIME image type (i.e. starting with "image/"), or the generic
7279 indicator "img" entered in the field. When all of the
7280 requirements are met, an image file will be displayed instead
7281 of the standard link text. Clicking on the image will open it
7282 in the same way as clicking on the link text. When you click
7283 on the image it should open to full size, in the current
7284 window or in a new window depending on the value in the system
7286 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
7289 <screeninfo>Sample 856 in MARC Record</screeninfo>
7293 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
7301 <section id="OPACDisplayRequestPriority">
7302 <title>OPACDisplayRequestPriority</title>
7304 <para>Default: Don't</para>
7306 <para>Asks: ___ patrons the priority level of their holds in the
7309 <para>Values:</para>
7313 <para>Don't show</para>
7320 <screeninfo>Patron record in the OPAC shows where in line
7321 the patron waits for their hold.</screeninfo>
7325 <imagedata fileref="images/admin/globalprefs/OPACDisplayRequestPriority.png"/>
7332 <para><link linkend="opacuserlogin">opacuserlogin</link>
7333 needs to be set to 'allow'</para>
7340 <section id="OpacExportOptions">
7341 <title>OpacExportOptions</title>
7344 bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
7346 <para>Asks: List export options that should be available from OPAC
7347 detail page separated by |: ___</para>
7349 <para>Description:</para>
7353 <para>In the OPAC on the right of each bib record there is a
7354 menu that allows for saving the record in various formats.
7355 This patch will allow you to define which options are in the
7356 pull down menu. Available options are: BIBTEX (bibtex), Dublin
7357 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
7358 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
7359 without local use -9xx, x9x, xx9- fields and subfields
7360 (marcstd), MODS (mods), and RIS (ris).</para>
7365 <section id="OpacFavicon">
7366 <title>OpacFavicon</title>
7368 <para>Asks: Use the image at ___ for the OPAC's favicon.
7370 <para>This should be a complete URL, starting with
7375 <para>Turn your logo into a favicon with the <ulink
7376 url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
7379 <para>Description:</para>
7383 <para>The favicon is the little icon that appears next to the
7384 URL in the address bar in most browsers. The default value for
7385 this field (if left blank) is the small 'K' in the Koha
7389 <screeninfo>Default Koha Favicon</screeninfo>
7393 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
7401 <section id="opacheader">
7402 <title>opacheader</title>
7404 <para>Asks: Include the following HTML in the header of all pages
7408 <screeninfo>Sample HTML to be displayed at the top of my
7413 <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
7419 <para>This value will appear above the main content of your
7424 <screeninfo>OPAC display of the value from
7425 'opacheader'</screeninfo>
7429 <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
7435 <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
7436 you'd like to edit the contents of the <title> tag</para>
7439 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7440 Regions</link> section.</para>
7443 <section id="OpacHighlightedWords">
7444 <title>OpacHighlightedWords</title>
7446 <para>Default: Don't highlight</para>
7448 <para>Asks: ___ words the patron searched for in their search
7451 <para>Values:</para>
7455 <para>Don't highlight</para>
7459 <para>Highlight</para>
7464 <section id="OpacKohaUrl">
7465 <title>OpacKohaUrl</title>
7467 <para>Default: Don't show</para>
7469 <para>Values:</para>
7473 <para>Don't show</para>
7481 <para>Description:</para>
7485 <para>When this preference is set to 'Show' text will appear
7486 in the bottom right of the OPAC footer stating 'Powered by
7487 Koha' and linking to the official Koha website.</para>
7490 <screeninfo>Powered by Koha</screeninfo>
7494 <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
7502 <section id="opaclayoutstylesheet">
7503 <title>opaclayoutstylesheet</title>
7505 <para>Default: opac.css</para>
7507 <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
7508 OPAC, instead of the default</para>
7510 <para>Description:</para>
7514 <para>This setting's function is to point to the *.css file
7515 used to define the OPAC layout. A *.css file is a cascading
7516 stylesheet which is used in conjunction with HTML to set how
7517 the HTML page is formatted and will look on the OPAC. There
7518 are two stylesheets that come with the system; opac.css and
7519 opac2.css. A custom stylesheet may also be used. A style sheet
7520 designated in the <link
7521 linkend="opacstylesheet">opacstylesheet</link> preference will
7522 override the stylesheet listed here. The stylesheets listed in
7523 the opaclayoutstylesheet preference are held on the Koha
7529 <para>Leave this field blank to disable it and let Koha use the
7530 default file instead</para>
7534 <section id="OpacMaintenance">
7535 <title>OpacMaintenance</title>
7537 <para>Default: Don't show</para>
7539 <para>Asks: ___ a warning that the OPAC is under maintenance,
7540 instead of the OPAC itself. <note>
7541 <para>this shows the same warning as when the database needs
7542 to be upgraded, but unconditionally.</para>
7545 <para>Description:</para>
7549 <para>This preference allows the system administrator to turn
7550 off the OPAC during maintenance and display a message to
7551 users. When this preference is switched to “Show" the
7552 OPAC is not usable. The text of this message is not editable
7553 at this time.</para>
7557 <para>Values:</para>
7561 <para>Don't show</para>
7569 <para>When this preference is set to show the maintenance
7570 message the ability to search the OPAC is disabled and a
7571 message appears</para>
7574 <screeninfo>OPAC Maintenance Message</screeninfo>
7578 <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
7588 <section id="OpacMainUserBlock">
7589 <title>OpacMainUserBlock</title>
7591 <para>Default: Welcome to Koha... <hr></para>
7593 <para>Asks: Show the following HTML in its own column on the main
7594 page of the OPAC</para>
7596 <para>HTML entered in this field will appear in the center of the
7597 main page of your OPAC</para>
7600 <screeninfo>Sample OpacMainUserBlock appears below the search
7605 <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
7610 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7611 Regions</link> section.</para>
7614 <section id="OPACMySummaryHTML">
7615 <title>OPACMySummaryHTML</title>
7617 <para>Asks: Include a "Links" column on the "my summary" tab when
7618 a user is logged in to the OPAC, with the following HTML (leave
7619 blank to disable).</para>
7621 <para>Description:</para>
7625 <para>In this preference you can enter HTML that will appear
7626 on the 'Checked Out' tab on the 'My Summary' section when
7627 logged in to the OPAC. The placeholders {BIBLIONUMBER},
7628 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
7629 from the displayed record. This can be used to enter in
7630 'share' links for social networks or generate searches against
7631 other library catalogs.</para>
7634 <screeninfo>Example of 'Links' column with a value in the
7635 OPACMySummaryHTML preference</screeninfo>
7639 <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
7646 <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>
7647 <br />TITLE: {TITLE}
7648 <br />AUTHOR: {AUTHOR}
7649 <br />ISBN: {ISBN}
7650 <br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
7653 <section id="OpacNav">
7654 <title>OpacNav</title>
7656 <para>Default: Important links here.</para>
7658 <para>Asks: Show the following HTML on the left hand column of the
7659 main page and patron account on the OPAC (generally navigation
7663 <screeninfo>Sample navigation links</screeninfo>
7667 <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
7672 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7673 Regions</link> section.</para>
7676 <section id="OpacNavBottom">
7677 <title>OpacNavBottom</title>
7679 <para>Asks: Show the following HTML on the left hand column of the
7680 main page and patron account on the OPAC, after <link
7681 linkend="OpacNav">OpacNav</link>, and before patron account links
7682 if available:</para>
7684 <para>Description: When a patron is logged in to their account
7685 they see a series of tabs to access their account information.
7686 <link linkend="OpacNav">OpacNav</link> appears above this list of
7687 tabs and OpacNavBottom will appear below them. When not on the
7688 patron account pages the HTML in OpacNavBottom will just appear
7689 right below <link linkend="OpacNav">OpacNav</link>.</para>
7692 <screeninfo>OpacNav and OpacNavBottom on Patron
7693 Account</screeninfo>
7697 <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
7703 <section id="OPACNoResultsFound">
7704 <title>OPACNoResultsFound</title>
7706 <para>No Default</para>
7708 <para>Asks: Display this HTML when no results are found for a
7709 search in the OPAC</para>
7711 <para>This HTML will display below the existing notice that no
7712 results were found for your search.</para>
7715 <screeninfo>HTML in OPACNoResultsFound will appear below lines
7716 that look like this</screeninfo>
7720 <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
7726 <section id="OpacPublic">
7727 <title>OpacPublic</title>
7729 <para>Default: Enable</para>
7731 <para>Asks: ___ Koha OPAC as public. Private OPAC requires
7732 authentication before accessing the OPAC.</para>
7734 <para>Values:</para>
7738 <para>Don't enable</para>
7746 <para>Description:</para>
7750 <para>This preference determines if your OPAC is accessible
7751 and searchable by anyone or only by members of the library. If
7752 set to 'Don't enable' only members who are logged into the
7753 OPAC can search. Most libraries will leave this setting at its
7754 default of 'Enable' to allow their OPAC to be searched by
7755 anyone and only require login for access to personalized
7761 <section id="OPACResultsSidebar">
7762 <title>OPACResultsSidebar</title>
7764 <para>Asks: Include the following HTML under the facets in OPAC
7765 search results</para>
7767 <para>Description:</para>
7771 <para>The HTML entered in this preference will appear on the
7772 search results pages below the list of facets on the left side
7773 of the screen.</para>
7778 <section id="OPACSearchForTitleIn">
7779 <title>OPACSearchForTitleIn</title>
7781 <para>Default: <li><a
7782 href="http://worldcat.org/search?q={TITLE}"
7783 target="_blank">Other Libraries (WorldCat)</a></li>
7785 href="http://www.scholar.google.com/scholar?q={TITLE}"
7786 target="_blank">Other Databases (Google
7787 Scholar)</a></li> <li><a
7788 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
7789 target="_blank">Online Stores
7790 (Bookfinder.com)</a></li></para>
7792 <para>Asks: Include a "More Searches" box on the detail pages of
7793 items on the OPAC, with the following HTML (leave blank to
7797 <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
7798 {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
7799 from the displayed record.</para>
7803 <para>You can use this field to add social networking share
7804 links by using code similar to this</para>
7806 <programlisting></ul></div></div><div class="detailtagcell">
7808 src="http://connect.facebook.net/en_US/all.js#xfbml=1"></script><fb:like
7809 href="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}" show_faces="true"
7810 width="450" font=""></fb:like>
7811 <div><a href="http://twitter.com/share" class="twitter-share-button"
7812 data-url="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}" data-text="I'm reading
7813 this" data-count="horizontal">Tweet</a><script type="text/javascript"
7814 src="http://platform.twitter.com/widgets.js"></script></div></div><div><div><ul></programlisting>
7816 <para>The starting </ul> is necessary to break out of the
7817 'Search for this Title In' pull down menu</para>
7820 <screeninfo>OPACSearchForTitleIn with Social Networking
7825 <imagedata fileref="images/admin/globalprefs/OPACSearchForTitleIn.png"/>
7832 <section id="OPACShowCheckoutName">
7833 <title>OPACShowCheckoutName</title>
7835 <para>Default: Don't show</para>
7837 <para>Asks: ___ the name of the patron that has an item checked
7838 out on item detail pages on the OPAC.</para>
7840 <para>Values:</para>
7844 <para>Don't show</para>
7852 <para>Description:</para>
7856 <para>This preference allows all patrons to see who has the
7857 item checked out if it is checked out. In small corporate
7858 libraries (where the OPAC is behind a firewall and not
7859 publicly available) this can be helpful so coworkers can just
7860 contact the patron with the book themselves. In larger public
7861 and academic libraries setting this to 'Show' would pose
7862 serious privacy issues.</para>
7867 <section id="OpacShowRecentComments">
7868 <title>OpacShowRecentComments</title>
7870 <para>Default: Don't show</para>
7872 <para>Asks: ___ a link to recent comments in the OPAC
7875 <para>Values:</para>
7879 <para>Don't show</para>
7887 <para>Description:</para>
7891 <para>If you have chosen to allow comments in your OPAC by
7892 setting <link linkend="reviewson">reviewson</link> to 'Allow'
7893 you can include a link to the recent comments under the search
7894 box at the top of your OPAC with this preference.</para>
7897 <screeninfo>Recent Comments link on OPAC</screeninfo>
7901 <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
7909 <section id="opacsmallimage">
7910 <title>opacsmallimage</title>
7912 <para>Asks: Use the image at ___ in the OPAC header, instead of
7913 the Koha logo. If this image is a different size than the Koha
7914 logo, you will need to customize the CSS.</para>
7916 <para>Description:</para>
7920 <para>The opacsmallimage system pref is a little tricky to
7921 deal with because you really have to tweak some CSS at the
7922 same time. The default CSS defines a region just large enough
7923 to display the Koha logo, and if your logo doesn't match the
7924 Koha logo's dimensions (120 pixels wide by 38 pixels high), it
7925 won't display correctly.</para>
7930 <para>This should be a complete URL, starting with
7935 <section id="OpacStarRatings">
7936 <title>OpacStarRatings</title>
7938 <para>Default: no</para>
7940 <para>Asks: Show star-ratings on ___ pages.</para>
7942 <para>Values:</para>
7950 <para>only details</para>
7953 <screeninfo>Star Ratings on the Details Page</screeninfo>
7957 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
7964 <para>results and details</para>
7967 <screeninfo>OPAC Star Ratings on the Search
7968 Results</screeninfo>
7972 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
7979 <para>Description:</para>
7983 <para>Star ratings are a way for your patrons to leave ratings
7984 without having to leave a full review. Patrons who are not
7985 logged in will only be able to see the stars, once logged in
7986 patrons can click on the stars on the details page to leave
7987 their own rating. Clicking on the stars on the search results
7988 will not submit a rating.</para>
7993 <section id="opacstylesheet">
7994 <title>opacstylesheet</title>
7996 <para>Asks: Use the remote CSS stylesheet ___ on all pages in the
7997 OPAC, instead of the default.</para>
7999 <para>Description:</para>
8003 <para>This preference allows the administrator to completely
8004 replace the default stylesheet with their own alternate
8005 stylesheet. This allows the administrator to completely
8006 customize the look of the OPAC. To change the stylesheet,
8007 enter a complete URL, including the http:// to the custom
8008 stylesheet. Content in the custom/alternate stylesheet will
8009 overwrite any data in the default stylesheet defined in the
8011 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link>
8012 setting. The default stylesheet will likely be found at
8013 http://your_koha_address/opac-
8014 tmpl/prog/en/css/opac.css</para>
8019 <para>Leave this field blank to disable it and let Koha use the
8020 default file instead</para>
8024 <para>This should be a complete URL, starting with
8029 <section id="opacthemes">
8030 <title>opacthemes</title>
8032 <para>Default: prog</para>
8034 <para>Asks: Use the ___ theme on the OPAC.</para>
8036 <para>Values:</para>
8045 <section id="OPACURLOpenInNewWindow">
8046 <title>OPACURLOpenInNewWindow</title>
8048 <para>Default: don't</para>
8050 <para>Asks: When patrons click on a link to another website from
8051 your OPAC (like Amazon or OCLC), ___ open the website in a new
8054 <para>Values:</para>
8066 <para>Description:</para>
8070 <para>This preference determines if URLs in the OPAC will open
8071 in a new window or not. When clicking on a link in the OPAC, a
8072 patron does not need to worry about navigating away from their
8073 search results.</para>
8078 <section id="OPACUserCSS">
8079 <title>OPACUserCSS</title>
8081 <para>Asks: Include the following CSS on all pages in the
8084 <para>Description:</para>
8088 <para>OPACUserCSS allows the administrator to enter styles
8089 that will overwrite the OPAC's default CSS as defined in
8090 ‘opaclayoutstylesheet' or ‘opacstylesheet'. Styles
8091 may be entered for any of the selectors found in the default
8092 style sheet. The default stylesheet will likely be found at
8093 http://your_koha_address/opac-tmpl/prog/en/css/opac.css.
8095 linkend="opaccolorstylesheet">opaccolorstylesheet</link>,
8097 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> and
8098 <link linkend="opacstylesheet">opacstylesheet</link> this
8099 preference will embed the CSS directly on your OPAC
8105 <section id="opacuserjs">
8106 <title>opacuserjs</title>
8108 <para>Asks: Include the following JavaScript on all pages in the
8112 <screeninfo>OPAC login box before opacuserjs edit</screeninfo>
8116 <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
8122 <screeninfo>JavaScript in opacuserjs to change the OPAC login
8127 <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
8133 <screeninfo>New OPAC login box after editing
8134 opacuserjs</screeninfo>
8138 <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
8143 <para>Description:</para>
8147 <para>This preference allows the administrator to enter
8148 JavaScript or JQuery that will be embedded across all pages of
8149 the OPAC. Administrators may use this preference to customize
8150 some of the interactive sections of Koha, customizing the text
8151 for the login prompts, for example. Sample JQuery scripts used
8152 by Koha libraries can be found on the wiki: <ulink
8153 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
8158 <section id="OPACXSLTDetailsDisplay">
8159 <title>OPACXSLTDetailsDisplay</title>
8161 <para>Default: default</para>
8163 <para>Asks: Display OPAC details using XSLT stylesheet at
8166 <para>Values:</para>
8170 <para>leave empty to not use the XSLT stylesheet</para>
8174 <para>In previous versions of Koha this was the setting
8175 that read 'normally'</para>
8181 <para>enter "default" for the default one</para>
8185 <para>put a path to define a XSLT file</para>
8189 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
8193 <para>If in a multi-language system you can enter
8194 {langcode} in the path to tell Koha to look in the right
8195 language folder</para>
8200 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
8205 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
8213 <para>put an URL for an external specific stylesheet</para>
8217 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
8223 <para>Description:</para>
8227 <para>XSLT stylesheets allow for the customization of the
8228 details shows on the screen when viewing a bib record. This
8229 preference will allow you either use the default look that
8230 comes with Koha or design your own stylesheet.</para>
8235 <section id="OPACXSLTResultsDisplay">
8236 <title>OPACXSLTResultsDisplay</title>
8238 <para>Default: default</para>
8240 <para>Asks: Display OPAC results using XSLT stylesheet at
8243 <para>Values:</para>
8247 <para>leave empty to not use the XSLT stylesheet</para>
8251 <para>In previous versions of Koha this was the setting
8252 that read 'normally'</para>
8258 <para>enter "default" for the default one</para>
8262 <para>put a path to define a XSLT file</para>
8266 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
8270 <para>If in a multi-language system you can enter
8271 {langcode} in the path to tell Koha to look in the right
8272 language folder</para>
8277 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
8282 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
8290 <para>put an URL for an external specific stylesheet</para>
8294 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
8300 <para>Description:</para>
8304 <para>XSLT stylesheets allow for the customization of the
8305 details shows on the screen when viewing the search results.
8306 This preference will allow you either use the default look
8307 that comes with Koha or design your own stylesheet.</para>
8313 <section id="opacfeaturesprefs">
8314 <title>Features</title>
8318 <section id="numSearchRSSResults">
8319 <title>numSearchRSSResults</title>
8321 <para>Default: 50</para>
8323 <para>Asks: Display ___ search results in the RSS feed.</para>
8325 <para>Description:</para>
8329 <para>By default the RSS feed that is automatically generated
8330 for every search results page will list 50 items. This can
8331 sometimes be too much for some RSS feed readers and for some
8332 people this isn't enough. This preference allows you to adjust
8333 this number to show the best number of results for your
8339 <section id="OpacAuthorities">
8340 <title>OpacAuthorities</title>
8342 <para>Default: Allow</para>
8344 <para>Asks: ___ patrons to search your authority records.</para>
8346 <para>Description:</para>
8350 <para>This preference displays the link on the OPAC for the
8351 authority search (titled 'Browse by Subject'). By setting the
8352 preference to “Allow" patrons can use this search link
8358 <para>While labeled 'Browse' it is important to note that this
8359 is in fact an authority search, not an authority browse.</para>
8362 <screeninfo>Authority Search in the OPAC</screeninfo>
8366 <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
8372 <para>Values:</para>
8380 <para>A link labeled 'Browse by Subject' will appear at
8381 the top of your OPAC under the search box</para>
8384 <screeninfo>'Browse by Subject' link under search box on
8389 <imagedata fileref="images/admin/globalprefs/OpacAuthorities.png"/>
8398 <para>Don't allow</para>
8403 <section id="opacbookbag">
8404 <title>opacbookbag</title>
8406 <para>Default: Allow</para>
8408 <para>Asks: ___ patrons to store items in a temporary "Cart" on
8411 <para>Values:</para>
8419 <para>Don't allow</para>
8423 <para>Description:</para>
8427 <para>This preference allows the user to temporarily save a
8428 list of items found on the catalog. By using the Book Bag, or
8429 Cart, the user can print out or email a list of items found.
8430 The user does not need to be logged in. This list is temporary
8431 and will be emptied, or cleared, at the end of the
8437 <section id="OpacBrowser">
8438 <title>OpacBrowser</title>
8441 <para>This preference only applies to French systems at this
8445 <para>Default: Don't allow</para>
8447 <para>Asks: ___ patrons to browse subject authorities on
8450 <para>Values:</para>
8458 <para>Don't allow</para>
8463 <para>run the <link linkend="authbrowsercron">Authorities
8464 Browser Cron Job</link> to create the browser list</para>
8468 <section id="OpacBrowseResults">
8469 <title>OpacBrowseResults</title>
8471 <para>Default: enable</para>
8473 <para>Asks: ___ browsing and paging search results from the OPAC
8476 <para>Values:</para>
8480 <para>disable</para>
8487 <screeninfo>Browsing and Paging Search Results</screeninfo>
8491 <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
8498 <para>Description:</para>
8502 <para>This preference will control the option to return to
8503 your results and/or browse them from the detail page in the
8509 <section id="OPACFinesTab">
8510 <title>OPACFinesTab</title>
8512 <para>Default: Allow</para>
8514 <para>Asks: ___ patrons to access the Fines tab on the My Account
8515 page on the OPAC.</para>
8517 <para>Values:</para>
8525 <para><link linkend="opacuserlogin">opacuserlogin</link>
8526 needs to be set to 'allow'</para>
8532 <para>Don't allow</para>
8537 <section id="OpacPasswordChange">
8538 <title>OpacPasswordChange</title>
8540 <para>Default: Allow</para>
8542 <para>Asks: ___ patrons to change their own password on the
8545 <para>Values:</para>
8553 <para><link linkend="opacuserlogin">opacuserlogin</link>
8554 needs to be set to 'allow'</para>
8560 <para>Don't allow</para>
8565 <para>Enabling this will break LDAP authentication.</para>
8569 <section id="OPACPatronDetails">
8570 <title>OPACPatronDetails</title>
8572 <para>Default: Allow</para>
8574 <para>Asks: ___ patrons to notify the library of changes to their
8575 contact information from the OPAC.</para>
8577 <para>Values:</para>
8585 <para><link linkend="opacuserlogin">opacuserlogin</link>
8586 needs to be set to 'allow'</para>
8592 <para>Don't allow</para>
8596 <para>Description:</para>
8600 <para>If patrons are allowed to notify the library of changes
8601 an email will be sent to the library administration email
8602 address with the changes. Lines that start with the field name
8603 in all caps are the lines that the patron made changes
8609 <section id="OPACpatronimage">
8610 <title>OPACpatronimage</title>
8612 <para>Default: Don't show</para>
8614 <para>Asks: ___ patron images on the patron information page in
8617 <para>Values:</para>
8621 <para>Don't show</para>
8629 <para>Description:</para>
8633 <para>If <link linkend="patronimages">patronimages</link> is
8634 set to allow the upload of patron images via the staff client,
8635 then setting this preference to 'show' will show the patron
8636 what image you have on file for them when they view their
8637 personal information on their account in the OPAC.</para>
8642 <section id="OpacTopissue">
8643 <title>OpacTopissue</title>
8645 <para>Default: Don't allow</para>
8647 <para>Asks: ___ patrons to access a list of the most checked out
8648 items on the OPAC.</para>
8650 <para>Values:</para>
8658 <para>A link to 'Most Popular' will appear at the top of
8662 <screeninfo>'Most Popular' link under the search
8667 <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
8676 <para>Don't allow</para>
8680 <para>Description:</para>
8684 <para>This preference allows the administrator to choose to
8685 show the “Most Popular" link at the top of the OPAC
8686 under the search box. The “Most Popular" page shows the
8687 top circulated items in the library, as determined by the
8688 number of times a title has been circulated. This allows users
8689 to see what titles are popular in their community. It is
8690 recommended that you leave this preference set to 'Don't
8691 allow' until you have been live on Koha for a couple of
8692 months, otherwise the data that it shows will not be an
8693 accurate portrayal of what's popular in your library.</para>
8696 <screeninfo>Sample top issues page</screeninfo>
8700 <imagedata fileref="images/admin/globalprefs/topissues.png"/>
8708 <section id="opacuserlogin">
8709 <title>opacuserlogin</title>
8711 <para>Default: Allow</para>
8713 <para>Asks: ___ patrons to log in to their accounts on the
8716 <para>Values:</para>
8724 <para>Don't allow</para>
8728 <para>The OPAC will still be searchable if patrons can't
8729 log in, this just disables the patron account access via
8737 <section id="RequestOnOpac">
8738 <title>RequestOnOpac</title>
8740 <para>Default: Allow</para>
8742 <para>Asks: ___ patrons to place holds on items from the
8745 <para>Values:</para>
8753 <para><link linkend="opacuserlogin">opacuserlogin</link>
8754 needs to be set to 'allow'</para>
8760 <para>Don't allow</para>
8765 <section id="reviewson">
8766 <title>reviewson</title>
8768 <para>Default: Allow</para>
8770 <para>Asks: ___ patrons to make comments on items on the
8773 <para>Values:</para>
8781 <para>Patrons comments/reviews all require moderation
8782 before they appear in the OPAC</para>
8786 <para><link linkend="opacuserlogin">opacuserlogin</link>
8787 needs to be set to 'Allow'</para>
8793 <para>Don't allow</para>
8797 <para>Description:</para>
8801 <para>This button allows the patrons to submit comments on
8802 books they have read via the OPAC. If this preference is set
8803 to “Allow" reviews are first sent to the staff client
8804 for staff approval before the review is displayed in the OPAC.
8805 The staff member who reviews and approves comments may find
8806 the pending comments on the <link
8807 linkend="comments">Comments</link> tool. The staff member can
8808 then choose to approve or delete the comments.</para>
8813 <section id="ShowReviewer">
8814 <title>ShowReviewer</title>
8816 <para>Default: full name</para>
8818 <para>Asks: Show ___ of commenter with comments in OPAC.</para>
8820 <para>Values:</para>
8824 <para>first name</para>
8828 <para>first name and last initial</para>
8832 <para>full name</para>
8836 <para>last name</para>
8840 <para>no name</para>
8844 <para>username</para>
8848 <para>Description:</para>
8852 <para>If you would like to protect your patron's privacy in
8853 the OPAC you can choose to hide their names or parts of their
8854 names from any of the comments they leave on bib records in
8855 your system. <link linkend="reviewson">reviewson</link> needs
8856 to be set to 'Allow' for this to preference to come in to
8862 <section id="ShowReviewerPhoto">
8863 <title>ShowReviewerPhoto</title>
8865 <para>Default: Show</para>
8867 <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
8869 <para>Values:</para>
8881 <para><link linkend="reviewson">reviewson</link> needs to
8882 be set to 'Allow' and <link
8883 linkend="ShowReviewer">ShowReviewer</link> needs to be set
8884 to 'Show' for this to preference to come in to play</para>
8887 <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
8891 <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
8900 <para>Description:</para>
8904 <para>This system preference allows libraries to show avatars
8905 next to patron's comments in the OPAC. These avatars are
8906 pulled from the <ulink
8907 url="https://www.libravatar.org">Libravatar</ulink> library,
8908 an open source powered product that allows Internet users to
8909 choose a small icon to display next to their name on various
8910 different websites. The library has no control over the images
8911 the patron chooses to display.</para>
8916 <section id="SocialNetworks">
8917 <title>SocialNetworks</title>
8919 <para>Default: Disable</para>
8921 <para>Asks: ___ social network links in opac detail pages</para>
8923 <para>Values:</para>
8927 <para>Disable</para>
8934 <screeninfo>Social Networks</screeninfo>
8938 <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
8945 <para>Description:</para>
8949 <para>This preference will enable a line of social network
8950 share buttons below the right hand column on the detail pages
8951 of records in the OPAC.</para>
8956 <para>In order for these share buttons to work when clicked you
8957 must have filled in your <link
8958 linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
8962 <section id="suggestionspref">
8963 <title>suggestion</title>
8965 <para>Default: Allow</para>
8967 <para>Asks: ___ patrons to make purchase suggestions on the
8970 <para>Values:</para>
8978 <para><link linkend="opacuserlogin">opacuserlogin</link>
8979 needs to be set to 'allow' unless <link
8980 linkend="AnonSuggestions">AnonSuggestions</link> is set to
8987 <para>Don't allow</para>
8993 <section id="opacpolicyprefs">
8994 <title>Policy</title>
8998 <section id="AllowPurchaseSuggestionBranchChoice">
8999 <title>AllowPurchaseSuggestionBranchChoice</title>
9001 <para>Default: Don't allow</para>
9003 <para>Asks: ___ patrons to select branch when making a purchase
9006 <para>Values:</para>
9014 <para>Don't allow</para>
9018 <para>Description:</para>
9022 <para>If your library system lets patrons make purchase
9023 suggestions for a specific branch you can set this preference
9024 to 'Allow' to add a branch selection option to the purchase
9025 suggestion form.</para>
9030 <section id="OpacAllowPublicListCreation">
9031 <title>OpacAllowPublicListCreation</title>
9033 <para>Default: Allow</para>
9035 <para>Asks: ___ opac users to create public lists</para>
9037 <para>Values:</para>
9045 <para>Don't allow</para>
9049 <para>Description:</para>
9053 <para>Public lists are visible to anyone who visits your OPAC.
9054 With this preference you can control whether or now patrons
9055 are allowed to create these public lists. If this is set to
9056 "Don't allow" then only staff will be able to create public
9062 <para>This preference will only be taken in to account if you
9063 have <link linkend="virtualshelves">virtualshelves</link> set to
9068 <section id="OpacAllowSharingPrivateLists">
9069 <title>OpacAllowSharingPrivateLists</title>
9072 <para>This feature is not active yet but will be released
9076 <para>Default: Don't allow</para>
9078 <para>Asks: ___ opac users to share private lists with other
9081 <para>Values:</para>
9089 <para>Don't allow</para>
9093 <para>Description:</para>
9097 <para>This feature will add the option for patrons to share
9098 their lists with other patrons.</para>
9103 <section id="OPACFineNoRenewals">
9104 <title>OPACFineNoRenewals</title>
9106 <para>Default: 99999</para>
9108 <para>Asks: Only allow patrons to renew their own books on the
9109 OPAC if they have less than ___ USD in fines</para>
9112 <para>Leave this field blank to disable</para>
9116 <para>To allow renewals in the OPAC, <link
9117 linkend="opacuserlogin">opacuserlogin</link> needs to be set to
9122 <section id="OpacHiddenItems">
9123 <title>OpacHiddenItems</title>
9125 <para>Asks: Allows to define custom rules for hiding specific
9126 items at opac. <tip>
9127 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
9128 directory for more information</para>
9131 <para>Description:</para>
9135 <para>In this field you can enter criteria for items you would
9136 like to hide from display in the OPAC. This field takes any
9137 combination of item fields (from the items table in the Koha
9138 database) for blocking. For example a value of:</para>
9140 <para><programlisting>itype: [07, 10]
9141 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
9142 07 or 10 as well as items that have a shelving location of
9143 STAFF or ISO.</para>
9145 <para>In items my items.itype 07 is defined in Item Types
9146 Administration as Staff Assigned My items.itype 10 in Item
9147 Types is Archival Copy The locations STAFF and ISO are in
9148 Authorized Values for category=LOC STAFF means it's assigned
9149 to the staff reading room and ISO means it is in the isolation
9155 <section id="OPACItemHolds">
9156 <title>OPACItemHolds</title>
9158 <para>Default: Allow</para>
9160 <para>Asks: ___ patrons to place holds on specific items in the
9163 <para>Values:</para>
9171 <para>Patrons can place holds on specific items as well as
9172 the next available item.</para>
9176 <para><link linkend="opacuserlogin">opacuserlogin</link>
9177 needs to be set to 'allow'</para>
9183 <para>Don't allow</para>
9187 <para>If this is disabled, users can only put a hold on
9188 the next available item.</para>
9195 <section id="OpacRenewalAllowed">
9196 <title>OpacRenewalAllowed</title>
9198 <para>Default: Don't allow</para>
9200 <para>Asks: ___ patrons to renew their own books on the
9203 <para>Values:</para>
9211 <para><link linkend="opacuserlogin">opacuserlogin</link>
9212 needs to be set to 'allow'</para>
9218 <para>Don't allow</para>
9222 <para>Staff will still be able to renew items for patrons
9223 via the staff client</para>
9229 <para>Description:</para>
9233 <para>This preference allows the administration to choose if
9234 patrons can renew their checked out materials via their
9235 checked out history in the OPAC. It allows patrons to renew
9236 their materials without having to contact the library or
9237 having to return to the library.</para>
9242 <section id="OpacRenewalBranch">
9243 <title>OpacRenewalBranch</title>
9245 <para>Default: the branch the item was checked out from</para>
9247 <para>Asks: Use ___ as branchcode to store in the statistics
9250 <para>Values:</para>
9258 <para>'OPACRenew'</para>
9262 <para>the item's home branch</para>
9266 <para>the patron's home branch</para>
9270 <para>the branch the item was checked out from</para>
9274 <para>Description:</para>
9278 <para>This value is used in the statistics table to help with
9279 reporting. The statistics table in Koha keeps track of all
9280 checkouts and renewals, this preference defines which branch
9281 is entered in to the table when a patron renews an item for
9282 themselves via the OPAC.</para>
9287 <section id="OPACViewOthersSuggestions">
9288 <title>OPACViewOthersSuggestions</title>
9290 <para>Default: Don't show</para>
9292 <para>Asks: ___ purchase suggestions from other patrons on the
9295 <para>Values:</para>
9299 <para>Don't show</para>
9307 <para><link linkend="opacuserlogin">opacuserlogin</link>
9308 needs to be set to 'allow'</para>
9315 <section id="SearchMyLibraryFirst">
9316 <title>SearchMyLibraryFirst</title>
9318 <para>Default: Don't limit</para>
9320 <para>Asks: ___ patrons' searches to the library they are
9321 registered at.</para>
9323 <para>Values:</para>
9327 <para>Don't limit</para>
9331 <para>Searching the OPAC will show results from all
9336 <para>If you're a one branch system, choose 'Don't
9347 <para>Patrons will still be able to search other libraries
9348 via the Advanced search page - but will be limited to
9349 searches for their library only from the basic search
9354 <para><link linkend="opacuserlogin">opacuserlogin</link>
9355 needs to be set to 'allow'</para>
9362 <section id="singleBranchMode">
9363 <title>singleBranchMode</title>
9365 <para>Default: Don't allow</para>
9367 <para>Asks: ___ patrons to select their branch on the OPAC.</para>
9369 <para>Values:</para>
9377 <para><link linkend="opacuserlogin">opacuserlogin</link>
9378 needs to be set to 'allow'</para>
9384 <para>Don't allow</para>
9388 <para>Description:</para>
9392 <para>This preference is for libraries that have branches but
9393 do not want to share their items among other branches within
9394 their system. If the preference is set to “Don't allow"
9395 then holdings will be shown for all branches within a system.
9396 On the “Home" screen of the OPAC users have the choice
9397 of narrowing down results by item location. Setting this
9398 preference to “Allow" will display only one branch's
9405 <section id="opacprivacyprefs">
9406 <title>Privacy</title>
9410 <section id="AnonSuggestions">
9411 <title>AnonSuggestions</title>
9413 <para>Default: Don't allow</para>
9415 <para>Asks: ___ patrons that aren't logged in to make purchase
9416 suggestions. <important>
9417 <para>If set to 'Allow', suggestions are connected to the
9418 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
9421 <para>Values:</para>
9429 <para>Don't allow</para>
9434 <section id="AnonymousPatron">
9435 <title>AnonymousPatron</title>
9437 <para>Default: 0</para>
9439 <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for
9440 anonymous suggestions and reading history) <tip>
9441 <para>Before setting this preference <link
9442 linkend="addnewpatron">create a patron</link> to be used for
9443 all anonymous suggestions and/or reading history items. This
9444 patron can be any type and should be named something to make
9445 it clear to you that they're anonymous (ex. Anonymous
9450 <section id="EnableOpacSearchHistory">
9451 <title>EnableOpacSearchHistory</title>
9453 <para>Default: Keep</para>
9455 <para>Asks: ___ patron search history in the OPAC.</para>
9457 <para>Values:</para>
9461 <para>Don't keep</para>
9470 <section id="OPACPrivacy">
9471 <title>OPACPrivacy</title>
9473 <para>Default: Don't allow</para>
9475 <para>Asks: ___ patrons to choose their own privacy settings for
9476 their reading history. <important>
9477 <para>This requires <link
9478 linkend="opacreadinghistory">opacreadinghistory</link> set to
9480 linkend="AnonymousPatron">AnonymousPatron</link> to be set to
9481 your anonymous patron's borrowernumber.</para>
9484 <para>Values:</para>
9492 <para>Don't allow</para>
9497 <section id="opacreadinghistory">
9498 <title>opacreadinghistory</title>
9500 <para>Default: Allow</para>
9502 <para>Asks: ___ patrons to see what books they have checked out in
9506 <para>Enabling this will make it so that patrons can view their
9507 circulation history in the OPAC unless you have OPACPrivacy set
9512 <para>This data is stored in the system regardless of your
9513 choice, unless your patrons have chosen to never have their
9514 reading history kept.</para>
9519 <section id="shelfbrowseprefs">
9520 <title>Shelf Browser</title>
9524 <section id="OPACShelfBrowser">
9525 <title>OPACShelfBrowser</title>
9527 <para>Default: Show</para>
9529 <para>Asks: ___ a shelf browser on item details pages, allowing
9530 patrons to see what's near that item on the shelf.</para>
9532 <para>Values:</para>
9536 <para>Don't show</para>
9543 <screeninfo>OPACShelfBrowser</screeninfo>
9547 <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
9554 <para>Description:</para>
9558 <para>This preference allows patrons to view what is located
9559 on the shelf near the item they looked up. The shelf browser
9560 option appears on the details page to the right of each items'
9561 call number. Clicking the 'Browse Shelf' link allows for a
9562 virtual shelf browsing experience via the OPAC and lets
9563 patrons see other books that may relate to their search and
9564 items that sit on the shelf near the item they are looking
9570 <para>This uses up a fairly large amount of resources on your
9571 server, and should be avoided if your collection has a large
9572 number of items.</para>
9576 <section id="ShelfBrowserUsesCcode">
9577 <title>ShelfBrowserUsesCcode</title>
9579 <para>Default: Don't use</para>
9581 <para>Asks: ___ the item collection code when finding items for
9582 the shelf browser.</para>
9584 <para>Values:</para>
9588 <para>Don't use</para>
9596 <para>Description:</para>
9600 <para>If your library uses collection codes then you might
9601 want the shelf browser to take into consideration what
9602 collection the books belong to when populating the virtual
9603 shelf browser.</para>
9608 <section id="ShelfBrowserUsesHomeBranch">
9609 <title>ShelfBrowserUsesHomeBranch</title>
9611 <para>Default: Use</para>
9613 <para>Asks: ___ the item home branch when finding items for the
9614 shelf browser.</para>
9616 <para>Values:</para>
9620 <para>Don't use</para>
9628 <para>Description:</para>
9632 <para>If you have a multiple branch system you may want to
9633 make sure that Koha takes into consideration what branch owns
9634 the books when populating the virtual shelf browser for
9640 <section id="ShelfBrowserUsesLocation">
9641 <title>ShelfBrowserUsesLocation</title>
9643 <para>Default: Use</para>
9645 <para>Asks: ___ the item location when finding items for the shelf
9648 <para>Values:</para>
9652 <para>Don't use</para>
9660 <para>Description:</para>
9664 <para>If your library uses shelving locations then you might
9665 want the shelf browser to take into consideration what
9666 shelving location the books belong to when populating the
9667 virtual shelf browser.</para>
9674 <section id="patronprefs">
9675 <title>Patrons</title>
9677 <para><emphasis>Get there:</emphasis> More > Administration >
9678 Global System Preferences > Patrons</para>
9680 <section id="AddPatronLists">
9681 <title>AddPatronLists</title>
9683 <para>Default: specific categories</para>
9685 <para>Asks: List ___ under the new patron menu.</para>
9687 <para>Values:</para>
9691 <para>general patron types</para>
9694 <screeninfo>Add patron options with AddPatronLists set to
9695 general patron types</screeninfo>
9699 <imagedata fileref="images/admin/globalprefs/AddPatronLists-category.png"/>
9706 <para>specific categories</para>
9709 <screeninfo>Add patron options with AddPatronLists set to
9710 specific categories</screeninfo>
9714 <imagedata fileref="images/admin/globalprefs/AddPatronLists-specific.png"/>
9722 <section id="AutoEmailOPACUser">
9723 <title>AutoEmailOpacUser</title>
9725 <para>Default: Don't send</para>
9727 <para>Asks: ___ an email to newly created patrons with their account
9730 <para>Description:</para>
9734 <para>AutoEmailOpacUser allows library users to be notified by
9735 email of their account details when a new account is opened at
9736 the email address specified in the <link
9737 linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
9738 preference. The email contains the username and password given
9739 to or chosen by the patron when signing up for their account and
9740 can be customized by editing the <link
9741 linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
9745 <para>Values:</para>
9749 <para>Don't send</para>
9758 <section id="AutoEmailPrimaryAddress">
9759 <title>AutoEmailPrimaryAddress</title>
9761 <para>Default: alternate</para>
9763 <para>Asks: Use ___ patron email address for sending out
9766 <para>Values:</para>
9770 <para>alternate</para>
9774 <para>first valid</para>
9786 <para>Description:</para>
9790 <para>If you choose 'first valid' as the value for
9791 AutoEmailPrimaryAddress the system will check the email fields
9792 in this order: home, work, then alternate. Otherwise the system
9793 will use the email address you specify.</para>
9798 <section id="autoMemberNum">
9799 <title>autoMemberNum</title>
9801 <para>Default: Do</para>
9803 <para>Asks: ___ default the card number field on the patron addition
9804 screen to the next available card number</para>
9806 <para>Values:</para>
9814 <para>If the largest currently used card number is
9815 26345000012941, then this field will default to
9816 26345000012942 for the next patron</para>
9826 <para>Description:</para>
9830 <para>This preference determines if the patron's barcode is
9831 automatically calculated. This prevents the person setting up
9832 the library card account from having to assign a number to the
9833 new card. If set to 'Do' the system will calculate a new patron
9834 barcode by adding 1 to the maximum barcode already present in
9835 the database.</para>
9840 <section id="BorrowerMandatoryField">
9841 <title>BorrowerMandatoryField</title>
9843 <para>Default: surname|cardnumber|barcode</para>
9845 <para>Asks: The following database columns must be filled in on the
9846 patron entry screen: ___</para>
9848 <para>Description:</para>
9852 <para>This preference enables the system administrator to choose
9853 which fields your library would like required for patron
9854 accounts. Enter field names separated by | (bar). This ensures
9855 that basic information is included in each patron record. If a
9856 patron leaves one of the required fields blank an error message
9857 will issue and the account will not be created.</para>
9862 <para>Separate columns with |</para>
9866 <para>For help with field names, ask your system administrator or
9868 url="http://schema.koha-community.org/tables/borrowers.html">view
9869 the database structure</ulink> associated with the borrowers
9874 <section id="borrowerRelationship">
9875 <title>borrowerRelationship</title>
9877 <para>Default: father|mother</para>
9879 <para>Asks: Guarantors can be the following of those they guarantee
9882 <para>Description:</para>
9886 <para>This preference enables the system administrator to define
9887 valid relationships between a guarantor (usually a parent) &
9888 a guarantee (usually a child). Defining values for this field
9889 does not make the guarantor field required when adding a
9890 guarantee type patron. This preference creates a drop down list
9891 identifying the relationship of the guarantor to the guarantee.
9892 To disable the ability to add children types in Koha you can
9893 leave this field blank.</para>
9898 <para>Input multiple choices separated by |</para>
9902 <section id="BorrowerRenewalPeriodBase">
9903 <title>BorrowerRenewalPeriodBase</title>
9905 <para>Default: current date</para>
9907 <para>Asks: When renewing borrowers, base the new expiry date on
9910 <para>Values:</para>
9914 <para>current date.</para>
9918 <para>current membership expiry date.</para>
9922 <para>Description:</para>
9926 <para>This preference controls what the patron's new expiration
9927 date will be when you renew their card. Using the 'current date'
9928 will add the subscription period to today's date when
9929 calculating the new expiration date. Using 'current membership
9930 expiry date' will add the subscription period to the old
9931 expiration date for the patron when renewing their
9937 <section id="BorrowersTitles">
9938 <title>BorrowersTitles</title>
9940 <para>Default: Mr|Mrs|Miss|Ms</para>
9942 <para>Asks: Borrowers can have the following titles ___</para>
9944 <para>Description:</para>
9948 <para>This preference allows the staff to choose the titles that
9949 can be assigned to patrons. The choices present as a drop down
9950 list when creating a patron record.</para>
9955 <para>Input multiple choices separated by |</para>
9959 <section id="BorrowerUnwantedField">
9960 <title>BorrowerUnwantedField</title>
9962 <para>Asks: The following database columns will not appear on the
9963 patron entry screen: ___</para>
9965 <para>Description:</para>
9969 <para>This preference enables the system administrator to choose
9970 which fields your library doesn't need to see on the patron
9971 entry form. Enter field names separated by | (bar).</para>
9976 <para>Separate columns with |</para>
9980 <para>For help with field names, ask your system administrator or
9982 url="http://schema.koha-community.org/tables/borrowers.html">view
9983 the database structure</ulink> associated with the borrowers
9988 <section id="checkdigit">
9989 <title>checkdigit</title>
9991 <para>Default: Don't</para>
9993 <para>Asks: ___ check and construct borrower card numbers in the
9994 Katipo style.</para>
9996 <para>Values:</para>
10009 <para>This overrides <link
10010 linkend="autoMemberNum">autoMemberNum</link> if on.</para>
10014 <section id="EnhancedMessagingPreferences">
10015 <title>EnhancedMessagingPreferences</title>
10017 <para>Default: Allow</para>
10019 <para>Asks: ___ patrons to choose which notices they receive and
10020 when they receive them.</para>
10022 <para>Values:</para>
10030 <para>Don't allow</para>
10035 <para>This only applies to certain kinds of notices, overdue
10036 notices will be sent based on the library's rules, not the
10037 patron's choice.</para>
10040 <para>Description:</para>
10044 <para>These messages are in addition to the overdue notices that
10045 the library sends. The difference between these notices and
10046 overdues is that the patron can opt-in and out of these. Setting
10047 this preference to 'Allow' will allow patrons to choose to
10048 receive any one of the following messages:</para>
10052 <para>Item Checkout : A notice that lists all the of the
10053 items the patron has just checked out, this is an electronic
10054 form of the checkout receipt</para>
10058 <para>Item Due : A notice on the day and item is due back at
10063 <para>Hold Filled : A notice when you have confirmed the
10064 hold is waiting for the patron</para>
10068 <para>Item Checkin : A notice that lists all the of the
10069 items the patron has just checked in</para>
10073 <para>Advanced Notice : A notice in advance of the patron's
10074 items being due (The patron can choose the number of days in
10082 <section id="ExtendedPatronAttributes">
10083 <title>ExtendedPatronAttributes</title>
10085 <para>Default: Enable</para>
10087 <para>Asks: ___ searching, editing and display of custom attributes
10090 <para>Values:</para>
10094 <para>Don't enable</para>
10098 <para>Enable</para>
10102 <para>Define attributes in Koha administration</para>
10106 <para>Get there: More > Administration > <link
10107 linkend="patronattributetypes">Patron Attribute
10108 Types</link></para>
10114 <para>Description:</para>
10118 <para>Patron attributes are library-defined custom fields that
10119 can be applied to patron records.</para>
10124 <para>Use custom attributes for fields that the default patron
10125 record does not support such as driver's license number or student
10130 <section id="intranetreadinghistory">
10131 <title>intranetreadinghistory</title>
10133 <para>Default: Allow</para>
10135 <para>Asks: ___ staff to access a patron's checkout
10137 <para>If you have the <link
10138 linkend="OPACPrivacy">OPACPrivacy</link> preference set to
10139 'Allow' and the patron has decided to not have their history
10140 kept staff will only see currently checked out items.</para>
10141 </important></para>
10143 <para>Values:</para>
10151 <para>Don't allow</para>
10156 <para>This data is stored in the system regardless of your
10161 <section id="MaxFine">
10162 <title>MaxFine</title>
10164 <para>Default: 9999</para>
10166 <para>Asks: The late fine for a specific checkout will only go up to
10170 <section id="memberofinstitution">
10171 <title>memberofinstitution</title>
10173 <para>Default: Don't</para>
10175 <para>Asks: ___ allow patrons to be linked to institutions</para>
10177 <para>Values:</para>
10190 <para>In order to allow this, the library must have Institution
10191 patrons to link members to</para>
10195 <section id="minPasswordLength">
10196 <title>minPasswordLength</title>
10198 <para>Default: 3</para>
10200 <para>Asks: Login passwords for staff and patrons must be at least
10201 ___ characters long.</para>
10204 <para>This applies to both the staff login and the patron OPAC
10209 <section id="NotifyBorrowerDeparture">
10210 <title>NotifyBorrowerDeparture</title>
10212 <para>Default: 30</para>
10214 <para>Asks: Show a notice that a patron is about to expire ___ days
10217 <para>Description:</para>
10221 <para>When the patron attempts to check out materials, a warning
10222 will appear in the check out window of the Staff Client telling
10223 the librarian that the patrons account is about to
10229 <para>This notice will appear on the patron's record in the staff
10234 <section id="patronimages">
10235 <title>patronimages</title>
10237 <para>Default: Allow</para>
10239 <para>Asks: ___ images to be uploaded and shown for patrons on the
10240 staff client.</para>
10242 <para>Values:</para>
10250 <para>Don't allow</para>
10255 <section id="PatronsPerPage">
10256 <title>PatronsPerPage</title>
10258 <para>Default: 20</para>
10260 <para>Asks: By default, show ___ results per page in the staff
10264 <section id="SMSSendDriver">
10265 <title>SMSSendDriver</title>
10267 <para>Asks: Use the SMS::Send:: ___ driver to send SMS
10270 <para>Some examples of values are:</para>
10274 <para>SMS::Send::Us::Ipipi</para>
10278 <para>SMS::Send::US::TMobile</para>
10282 <para>SMS::Send::US::Verizon</para>
10286 <para>Additional values can be found here: <ulink
10287 url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
10291 <para>Only drivers available as Perl modules will work in this
10292 preference, so make sure a Perl module is available before
10293 choosing an SMS service.</para>
10296 <para>Once a driver is entered in the preference an option will
10297 appear in the staff client and the OPAC on the patron messaging form
10298 to choose to receive messages as SMS</para>
10301 <screeninfo>SMSSendDriver Options</screeninfo>
10305 <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
10311 <para>You must allow <link
10312 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
10313 for this to work.</para>
10317 <section id="TalkingTechItivaPhoneNotification">
10318 <title>TalkingTechItivaPhoneNotification</title>
10320 <para>Default: Disable</para>
10322 <para>Asks: ___ patron phone notifications using Talking Tech i-tiva
10323 (overdues, predues and holds notices currently supported).</para>
10325 <para>Values:</para>
10329 <para>Disable</para>
10333 <para>Enable</para>
10337 <para>Description:</para>
10341 <para>To learn more about setting up this third party product
10342 view the <link linkend="talkingtechappendix">Talking Tech
10343 Appendix</link>.</para>
10348 <para>Requires that you have <link
10349 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
10350 set to Allow to use.</para>
10354 <section id="uppercasesurnames">
10355 <title>uppercasesurnames</title>
10357 <para>Default: Don't</para>
10359 <para>Asks: ___ store and display surnames (last names) in upper
10362 <para>Values:</para>
10376 <section id="searchingprefs">
10377 <title>Searching</title>
10379 <para><emphasis>Get there:</emphasis> More > Administration >
10380 Global System Preferences > Searching</para>
10382 <section id="searchfeatureprefs">
10383 <title>Features</title>
10387 <section id="NoZebra">
10388 <title>NoZebra</title>
10390 <para>Default: Use</para>
10392 <para>Asks: ___ the Zebra search engine. Searches are very slow on
10393 even modest sized collections when Zebra is off.</para>
10395 <para>Values:</para>
10399 <para>Don't use</para>
10408 <section id="NoZebraIndexes">
10409 <title>NoZebraIndexes</title>
10411 <para>Default: See the <link linkend="nozebradefault">Systems
10412 Preferences Appendix</link></para>
10415 <section id="OpacGroupResults">
10416 <title>OpacGroupResults</title>
10418 <para>Default: Don't use</para>
10420 <para>Asks: ___ PazPar2 to group similar results on the
10423 <para>Values:</para>
10427 <para>Don't use</para>
10436 <para>This requires that <ulink
10437 url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
10438 and running.</para>
10442 <section id="QueryAutoTruncate">
10443 <title>QueryAutoTruncate</title>
10445 <para>Default: automatically</para>
10447 <para>Asks: Perform wildcard searching (where, for example, Har
10448 would match Harry and harp) ___ (The * character would be used
10449 like so: Har* or *logging.)</para>
10451 <para>Values:</para>
10455 <para>automatically</para>
10459 <para>only if * is added</para>
10463 <para>Description:</para>
10467 <para>This setting allows for searches to be automatically
10468 truncated or for additional characters to be added to the end
10469 of a search string. When set to "automatically" the search
10470 string automatically ends with a wildcard function. For
10471 example, a search for the word “invent" with auto
10472 truncation enabled will also retrieve results for inventor,
10473 invention, inventory, etc. If you don't want this to happen
10474 automatically you can still be perform wildcard searches
10475 manually by adding an asterisk (*). Typing “invent*"
10476 even with auto truncation disabled will retrieve the same
10477 inventor, invention, inventory results. Auto truncation
10478 bypasses the necessity to type long search strings in their
10484 <section id="QueryFuzzy">
10485 <title>QueryFuzzy</title>
10487 <para>Default: Try</para>
10489 <para>Asks: ___ to match similarly spelled words in a search (for
10490 example, a search for flang would also match flange and
10493 <para>Values:</para>
10497 <para>Don't try</para>
10505 <para>Description:</para>
10509 <para>This preference enables “fuzzy" searching, in
10510 which the search engine returns results that are similar to,
10511 but not exactly matching, the word or words entered by the
10512 user. This preference enables the search function to
10513 compensate for slightly misspelled names or phrases.</para>
10518 <para>Requires that <link linkend="NoZebra">NoZebra</link> is
10519 set to 'Use' and <link linkend="UseICU">UseICU</link> set to
10524 <section id="QueryRemoveStopwords">
10525 <title>QueryRemoveStopwords</title>
10527 <para>Default: Don't remove</para>
10529 <para>Asks: ___ stop words specified in Koha from searches.</para>
10531 <para>Values:</para>
10535 <para>Don't remove</para>
10540 <para>If <link linkend="NoZebra">NoZebra</link> is set
10541 to 'Use' leave this preference set to 'Don't
10549 <para>Remove</para>
10553 <para>Requires that you have updated your Koha <link
10554 linkend="stopwordsadmin">Stop Words</link> list</para>
10561 <para>Requires that NoZebra is set to 'Don't use'</para>
10565 <para>Zebra, on its own, handles a few of the most common stop
10570 <section id="QueryStemming">
10571 <title>QueryStemming</title>
10573 <para>Default: Try</para>
10575 <para>Asks: ___ to match words of the same base in a search</para>
10577 <para>Values:</para>
10581 <para>Don't try</para>
10589 <para>A search for enabling would also match enable and
10596 <para>Description:</para>
10600 <para>This preference enables word stemming. Stemming allows
10601 the search function to return multiple versions of the same
10602 word, as well as related terms (i.e., both fish and fishing
10603 would be returned).</para>
10608 <para>Requires that <link linkend="NoZebra">NoZebra</link> is
10609 set to 'Use'</para>
10613 <section id="QueryWeightFields">
10614 <title>QueryWeightFields</title>
10616 <para>Default: Enable</para>
10618 <para>Asks: ___ ranking of search results by relevance</para>
10620 <para>Values:</para>
10624 <para>Disable</para>
10628 <para>Enable</para>
10633 <para>Requires that <link linkend="NoZebra">NoZebra</link> is
10634 set to 'Use'</para>
10638 <section id="TraceCompleteSubfields">
10639 <title>TraceCompleteSubfields</title>
10641 <para>Default: Force</para>
10643 <para>Asks: ___ subject tracings in the OPAC and Staff Client to
10644 search only for complete-subfield matches.</para>
10646 <para>Values:</para>
10650 <para>Don't force</para>
10654 <para>Searches for subject keywords (example:
10655 opac-search.pl?q=su:World%20Wide%20Web)</para>
10665 <para>Searches for complete subject fields (example:
10666 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
10672 <para>Description:</para>
10676 <para>When TraceCompleteSubfields is set to "force," clicking
10677 on links in non-authority controlled subject tracings will
10678 only find other records where the entire subfields match.
10679 Leaving it at "don't force" does a keyword search of the
10680 subject indexes.</para>
10685 <para>This preference assumes that you're using XSLT stylesheets
10686 as set in the <link
10687 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
10692 <section id="TraceSubjectSubdivisions">
10693 <title>TraceSubjectSubdivisions</title>
10695 <para>Default: Include</para>
10697 <para>Asks: ___ subdivisions for searches generated by clicking on
10698 subject tracings.</para>
10700 <para>Values:</para>
10704 <para>Don't include</para>
10708 <para>Searches for subject keywords (example:
10709 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
10715 <para>Include</para>
10719 <para>Searches for complete subject fields (example:
10720 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
10726 <para>Description:</para>
10730 <para>When TraceSubjectSubdivisions is set to "Include," if
10731 you click on a subject with subdivisions (subfields other than
10732 'a') they will be searched along with the subject heading
10733 (subfield 'a'). To have only the subject heading (subfield
10734 'a') searched, set this preference to "Don't include."</para>
10739 <para>This preference assumes that you're using XSLT stylesheets
10740 as set in the <link
10741 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
10746 <section id="UseICU">
10747 <title>UseICU</title>
10749 <para>Default: Not using</para>
10751 <para>Asks: ___ ICU Zebra indexing.</para>
10753 <para>Values:</para>
10757 <para>Not using</para>
10765 <para>Description:</para>
10769 <para>ICU is a set of code libraries providing Unicode and
10770 Globalization support for software applications. What this
10771 means is ICU Zebra indexing is only necessary if you use
10772 non-roman characters in your cataloging. If using ICU Zebra
10773 indexing you will want to not use <link
10774 linkend="QueryFuzzy">QueryFuzzy</link>.</para>
10779 <para>This setting will not affect Zebra indexing, it should
10780 only be used to tell Koha that you have activated ICU indexing
10781 if you have actually done so, since there is no way for Koha to
10782 figure this out on its own.</para>
10786 <para>Talk to your system administrator when changing this
10787 preference to make sure that your system is set up properly for
10788 this to work.</para>
10793 <section id="searchresultsprefs">
10794 <title>Results Display</title>
10798 <section id="defaultSortField">
10799 <title>defaultSortField & defaultSortOrder</title>
10801 <para>defaultSortField Default: author</para>
10803 <para>defaultSortOrder Default: ascending</para>
10805 <para>Asks: By default, sort search results in the staff client by
10808 <para>Description:</para>
10812 <para>These preferences set the default sort field and sort
10813 order for searches on the staff side. Regardless of your
10814 choice, the other sort options are still available in the drop
10815 down list on the advanced search page.</para>
10819 <para>defaultSortField Values:</para>
10823 <para>author</para>
10827 <para>call number</para>
10831 <para>date added</para>
10835 <para>date of publication</para>
10839 <para>relevance</para>
10847 <para>total number of checkouts</para>
10851 <para>defaultSortOrder Values:</para>
10855 <para>ascending</para>
10859 <para>descending</para>
10863 <para>from A to Z</para>
10867 <para>from Z to A</para>
10872 <section id="displayFacetCount">
10873 <title>displayFacetCount</title>
10875 <para>Default: Don't show</para>
10877 <para>Asks: ___ facet counts.</para>
10879 <para>Description:</para>
10883 <para>This preference lets you decide if you show how many
10884 times a facet is used in your search results in the OPAC and
10885 the staff client. The relevance of these numbers highly
10886 depends on the value of the <link
10887 linkend="maxRecordsForFacets">maxRecordsForFacets</link>
10888 preference. Showing these numbers can potentially effect the
10889 performance of your searching, so test your system with
10890 different values for this preference to see what works
10895 <para>Values:</para>
10899 <para>Don't show</para>
10906 <screeninfo>Number of times each Facet is found in
10907 results</screeninfo>
10911 <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
10919 <section id="FacetLabelTruncationLength">
10920 <title>FacetLabelTruncationLength</title>
10922 <para>Default: 20</para>
10924 <para>Asks: Truncate facets length to ___ characters, in
10925 OPAC/staff interface.</para>
10927 <para>Description:</para>
10931 <para>In the OPAC and the staff client your facets are cut off
10932 at 20 characters by default. Depending on your layout this may
10933 be too many or two few letters, this preference lets you
10934 decide what number is best for your library's design.</para>
10939 <section id="maxItemsInSearchResults">
10940 <title>maxItemsInSearchResults</title>
10942 <para>Default: 20</para>
10944 <para>Asks: Show up to ___ items per biblio in the search
10947 <para>Description:</para>
10951 <para>This preference will let you set how many results
10952 display by default when a search is run on the Staff
10958 <section id="maxRecordsForFacets">
10959 <title>maxRecordsForFacets</title>
10961 <para>Default: 20</para>
10963 <para>Asks: Build facets based on ___ records from the search
10966 <para>Description:</para>
10970 <para>By default Koha only bases facets on the first page of
10971 results (usually 20 results). This preference lets you tell
10972 Koha to based the facet descriptions and numbers on any number
10973 of search results returned. The higher this number the longer
10974 it will take for your search results to return, so test with
10975 various different values to find the best balance for your
10981 <section id="numSearchResults">
10982 <title>numSearchResults</title>
10984 <para>Default: 20</para>
10986 <para>Asks: By default, show ___ results per page in the staff
10990 <section id="opacdefaultsort">
10991 <title>OPACdefaultSortField & OPACdefaultSortOrder</title>
10993 <para>OPACdefaultSortField Default: relevance</para>
10995 <para>OPACdefaultSortOrder Default: ascending</para>
10997 <para>Asks: By default, sort search results in the OPAC by ___,
11000 <para>Description:</para>
11004 <para>These preferences set the default sort field and sort
11005 order for searches on the OPAC. Regardless of your choice, the
11006 other sort options are still available in the drop down list
11007 on the advanced search page.</para>
11011 <para>OPACdefaultSortField Values:</para>
11015 <para>author</para>
11019 <para>call number</para>
11023 <para>date added</para>
11027 <para>date of publication</para>
11031 <para>relevance</para>
11039 <para>total number of checkouts</para>
11043 <para>OPACdefaultSortOrder Values:</para>
11047 <para>ascending</para>
11051 <para>descending</para>
11055 <para>from A to Z</para>
11059 <para>from Z to A</para>
11066 <section id="OPACItemsResultsDisplay">
11067 <title>OPACItemsResultsDisplay</title>
11069 <para>Default: Don't show</para>
11071 <para>Asks: ___ an item's branch, location and call number in OPAC
11072 search results.</para>
11074 <para>Values:</para>
11078 <para>Don't show</para>
11086 <para>Description:</para>
11090 <para>This setting selects the information about an item that
11091 will display in the search results page of the OPAC. The
11092 results can display the status of an item and/or full details
11093 including branch, location, and call number. While the 'Show'
11094 option allows for more information to be displayed on the
11095 search results page, the information can be overwhelming for
11096 large collections with multiple branches.</para>
11101 <section id="OPACnumSearchResults">
11102 <title>OPACnumSearchResults</title>
11104 <para>Default: 20</para>
11106 <para>Asks: By default, show ___ results per page in the
11111 <section id="searchformprefs">
11112 <title>Search Form</title>
11114 <section id="AdvancedSearchTypes">
11115 <title>AdvancedSearchTypes</title>
11117 <para>Default: itemtype</para>
11119 <para>Asks: Show tabs in OPAC and staff-side advanced search for
11120 limiting searches on the ___ fields (separate values with
11123 <para>Description:</para>
11127 <para>On the advanced search page you can choose to allow
11128 filters on one or all of the following: Item types
11129 (itemtypes), Collection Codes (ccode) and Shelving Location
11130 (loc). If you would like to be able to limit searches on item
11131 type and shelving location for example you would enter
11132 itemtypes|loc in the preference input box. The order of these
11133 fields will determine the order of the tabs in the OPAC and
11134 staff client advanced search screens. Values within the search
11135 type are OR'ed together, while each different search type is
11136 AND'ed together in the query limits. The current stored values
11137 are supported without any required modification.Each set of
11138 advanced search fields are displayed in tabs in both the OPAC
11139 and staff client. The first value in the AdvancedSearchTypes
11140 syspref is the selected tab; if no values are present,
11141 "itemtypes" is used. For non-itemtype values, the value in
11142 AdvancedSearchTypes must match the Authorised Value name, and
11143 must be indexed with 'mc-' prefixing that name.</para>
11146 <screeninfo>Searching by Item Type and Shelving
11147 Location</screeninfo>
11151 <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
11159 <section id="expandedSearchOption">
11160 <title>expandedSearchOption</title>
11162 <para>Default: don't show</para>
11164 <para>Asks: By default, ___ "More options" on the OPAC and staff
11165 advanced search pages.</para>
11167 <para>Values:</para>
11171 <para>don't show</para>
11182 <section id="serialsprefs">
11183 <title>Serials</title>
11185 <para><emphasis>Get there:</emphasis> More > Administration >
11186 Global System Preferences > Serials</para>
11188 <section id="opacSerialDefaultTab">
11189 <title>opacSerialDefaultTab</title>
11191 <para>Default: Subscriptions tab</para>
11193 <para>Asks: Show ___ as default tab for serials in OPAC. <important>
11194 <para>Please note that the Serial Collection tab is currently
11195 available only for systems using the UNIMARC standard.</para>
11196 </important></para>
11198 <para>Values:</para>
11202 <para>Holdings tab</para>
11206 <para>Serial Collection tab</para>
11210 <para>Subscriptions tab</para>
11215 <section id="OPACSerialIssueDisplayCount">
11216 <title>OPACSerialIssueDisplayCount</title>
11218 <para>Default: 3</para>
11220 <para>Asks: Show the ___ previous issues of a serial on the
11223 <para>Description:</para>
11227 <para>This preference allows the administrator to select the
11228 number of recent issues for each serial which appear in the OPAC
11229 when the serial is accessed. This is just the default value,
11230 patrons can always click to see a full list of serials.</para>
11235 <section id="RenewSerialAddsSuggestion">
11236 <title>RenewSerialAddsSuggestion</title>
11238 <para>Default: Don't add</para>
11240 <para>Asks: ___ a suggestion for a biblio when its attached serial
11243 <para>Values:</para>
11251 <para>Don't add</para>
11255 <para>Description:</para>
11259 <para>If set to "Add", this preference will automatically add a
11260 serial to the Acquisitions Purchase Suggestions menu when
11261 clicking the 'renew' option. If you don't use the Acquisitions
11262 module to manage serials purchases it's best to leave this set
11263 as 'Don't add.'</para>
11268 <section id="RoutingListAddReserves">
11269 <title>RoutingListAddReserves</title>
11271 <para>Default: Place</para>
11273 <para>Asks: ___ received serials on hold if they are on a routing
11276 <para>Values:</para>
11284 <para>Don't place</para>
11289 <section id="RoutingListNote">
11290 <title>RoutingListNote</title>
11292 <para>Asks: Include following note on all routing lists</para>
11294 <para>Description:</para>
11298 <para>Text entered in this box will appear below the routing
11299 list information.</para>
11304 <section id="RoutingSerials">
11305 <title>RoutingSerials</title>
11307 <para>Default: Don't add</para>
11309 <para>Asks: ___ received serials to the routing list.</para>
11311 <para>Description:</para>
11315 <para>This preference determines if serials routing lists are
11316 enabled or disabled for the library. When set to “Add",
11317 serials routing is enabled and a serial can be directed through
11318 a list of people by identifying who should receive it next. The
11319 list of people can be established for each serial to be passed
11320 using the Serials module. This preference can be used to ensure
11321 each person who needs to see a serial when it arrives at the
11322 library will get it. Learn more in the <link
11323 linkend="routinglist">routing list</link> section of this
11328 <para>Values:</para>
11336 <para>Don't add</para>
11341 <section id="StaffSerialIssueDisplayCount">
11342 <title>StaffSerialIssueDisplayCount</title>
11344 <para>Default: 3</para>
11346 <para>Asks: Show the ___ previous issues of a serial on the staff
11349 <para>Description:</para>
11353 <para>This preference allows the administrator to select the
11354 number of recent issues for each serial which appear in the
11355 Staff Client when the serial is accessed. This is just the
11356 default value, staff members can always click to see a full list
11362 <section id="SubscriptionDuplicateDroppedInput">
11363 <title>SubscriptionDuplicateDroppedInput</title>
11365 <para>Asks: List of fields which must not be rewritten when a
11366 subscription is duplicated (Separated by pipe |) ___</para>
11368 <para>Description:</para>
11372 <para>When duplicating a subscription sometimes you don't want
11373 all of the fields duplicated, using this preference you can list
11374 the fields that you don't want to be duplicated. These field
11375 names come from the subscription table in the Koha database.
11376 Learn what fields are in that table on the <ulink
11377 url="http://schema.koha-community.org/tables/subscription.html">Koha
11378 DB Schema</ulink> site.</para>
11383 <section id="SubscriptionHistory">
11384 <title>SubscriptionHistory</title>
11386 <para>Default: full history</para>
11388 <para>Asks: When showing the subscription information for a
11389 bibliographic record, preselect ___ view of serial issues.</para>
11391 <para>Values:</para>
11395 <para>brief history</para>
11398 <screeninfo>Brief History</screeninfo>
11402 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
11409 <para>full history</para>
11412 <screeninfo>Full History</screeninfo>
11416 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
11423 <para>Description:</para>
11427 <para>This preference determines what information appears in the
11428 OPAC when the user clicks the More Details option. The
11429 ‘brief' option displays a one-line summary of the volume
11430 and issue numbers of all issues of that serial held by the
11431 library. The ‘full' option displays a more detailed
11432 breakdown of issues per year, including information such as the
11433 issue date and the status of each issue.</para>
11439 <section id="staffprefs">
11440 <title>Staff Client</title>
11442 <para><emphasis>Get there:</emphasis> More > Administration >
11443 Global System Preferences > Staff Client</para>
11445 <section id="staffappearprefs">
11446 <title>Appearance</title>
11450 <section id="Display856uAsImage">
11451 <title>Display856uAsImage</title>
11453 <para>Default: Neither details or results page</para>
11455 <para>Asks: Display the URI in the 856u field as an image on:
11458 <para>Values:</para>
11462 <para>Both results and details pages</para>
11467 <para>Not implemented yet</para>
11474 <para>Detail page only</para>
11480 linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
11481 needs to be on for this preference to work.</para>
11487 <screeninfo>Showing the 856u as an image</screeninfo>
11491 <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
11498 <para>Neither details or results page</para>
11502 <para>Results page only</para>
11507 <para>Not yet implemented</para>
11514 <para>Description:</para>
11518 <para>In addition to this option being set, the corresponding
11519 XSLT option must be turned on. Also, the corresponding 856q
11520 field must have a valid MIME image extension (e.g., "jpg") or
11521 MIME image type (i.e. starting with "image/"), or the generic
11522 indicator "img" entered in the field. When all of the
11523 requirements are met, an image file will be displayed instead
11524 of the standard link text. Clicking on the image will open it
11525 in the same way as clicking on the link text. When you click
11526 on the image it should open to full size, in the current
11527 window or in a new window depending on the value in the system
11529 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
11532 <screeninfo>Sample 856 Field</screeninfo>
11536 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
11544 <section id="intranet_includes">
11545 <title>intranet_includes</title>
11547 <para>Default: includes</para>
11549 <para>Asks: Use include files from the ___ directory in the
11550 template directory, instead of includes/. (Leave blank to
11554 <section id="intranetcolorstylesheet">
11555 <title>intranetcolorstylesheet</title>
11557 <para>Asks: Include the stylesheet /intranet-tmpl/prog/en/css/ ___
11558 on all pages in the staff interface.</para>
11560 <para>Description:</para>
11564 <para>This preference is used to set the background color and
11565 style of the Staff Client. The value is a .css file. The
11566 system administrator should determine which file is
11567 appropriate.</para>
11572 <para>Leave this field blank to disable.</para>
11576 <section id="IntranetFavicon">
11577 <title>IntranetFavicon</title>
11579 <para>Asks: Use the image at ___ for the Staff Client's favicon.
11581 <para>This should be a complete URL, starting with
11583 </important></para>
11586 <para>Turn your logo into a favicon with the <ulink
11587 url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
11590 <para>Description:</para>
11594 <para>The favicon is the little icon that appears next to the
11595 URL in the address bar in most browsers. The default value for
11596 this field (if left blank) is the small 'K' in the Koha
11600 <screeninfo>Default Koha Favicon</screeninfo>
11604 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
11612 <section id="IntranetmainUserblock">
11613 <title>IntranetmainUserblock</title>
11615 <para>Asks: Show the following HTML in its own column on the main
11616 page of the staff client</para>
11619 <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
11623 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
11629 <screeninfo>Message from IntranetmainUserblock as it appears on
11630 the Staff Client main page</screeninfo>
11634 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
11640 <section id="IntranetNav">
11641 <title>IntranetNav</title>
11643 <para>Asks: Show the following HTML in the More menu at the top of
11644 each page on the staff client (should be a list of links or
11648 <section id="intranetstylesheet">
11649 <title>intranetstylesheet</title>
11651 <para>Asks: Include the stylesheet at ___ on all pages in the
11652 staff interface, instead of the default.</para>
11654 <para>Description:</para>
11658 <para>The Intranetstylesheet preference is a layout and design
11659 feature for the intranet or staff client. To change the
11660 stylesheet from the original, place in this preference the
11661 file path to the style sheet - include the entire url starting
11662 with http://. This preference allows a library to customize
11663 the appearance of the Staff Client.</para>
11668 <para>This should be a complete URL, starting with
11673 <section id="IntranetUserCSS">
11674 <title>IntranetUserCSS</title>
11676 <para>Asks: Include the following CSS on all pages in the staff
11680 <section id="intranetuserjs">
11681 <title>intranetuserjs</title>
11683 <para>Asks: Include the following JavaScript on all pages in the
11684 staff interface</para>
11687 <screeninfo>Sample JavaScript to alter the staff client
11692 <imagedata fileref="images/admin/globalprefs/intranetuserjs-code.png"/>
11698 <screeninfo>Link to Self Checkout appears on staff client login
11699 because of JavaScript</screeninfo>
11703 <imagedata fileref="images/admin/globalprefs/intranetuserjs.png"/>
11708 <para>Description:</para>
11712 <para>This preference allows the administrator to enter
11713 JavaScript or JQuery that will be embedded across all pages of
11714 the Staff Client. Administrators may use this preference to
11715 customize some of the interactive sections of Koha,
11716 customizing the text for the login prompts, for example.
11717 Sample JQuery scripts used by Koha libraries can be found on
11719 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
11724 <section id="SlipCSS">
11725 <title>SlipCSS</title>
11727 <para>Asks: Include the stylesheet at ___ on Issue and Reserve
11729 <para>This should be a complete URL, starting with
11731 </important></para>
11733 <para>Description:</para>
11737 <para>If you would like to style your receipts or slips with a
11738 consistent set of fonts and colors you can use this preference
11739 to point Koha to a stylesheet specifically for your
11745 <section id="StaffAuthorisedValueImages">
11746 <title>StaffAuthorisedValueImages</title>
11748 <para>Default: Show</para>
11750 <para>Asks: ___ images for authorized values (such as lost
11751 statuses and locations) in search results.</para>
11753 <para>Values:</para>
11757 <para>Don't show</para>
11766 <section id="staffClientBaseURL">
11767 <title>staffClientBaseURL</title>
11769 <para>Asks: The staff client is located at http:// ___</para>
11772 <section id="template">
11773 <title>template</title>
11775 <para>Default: prog</para>
11777 <para>Asks: Use the ___ theme on the staff interface.</para>
11779 <para>Values:</para>
11788 <section id="XSLTDetailsDisplay">
11789 <title>XSLTDetailsDisplay</title>
11791 <para>Default: default</para>
11793 <para>Asks: Display details in the staff client using XSLT
11794 stylesheet at ___</para>
11796 <para>Values:</para>
11800 <para>leave empty to not use the XSLT stylesheet</para>
11804 <para>In previous versions of Koha this was the setting
11805 that read 'normally'</para>
11808 <screeninfo>Detail display without XSLT
11809 stylesheets</screeninfo>
11813 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
11822 <para>enter "default" for the default one</para>
11825 <screeninfo>Detail display using XSLT
11826 stylesheets</screeninfo>
11830 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
11837 <para>put a path to define a XSLT file</para>
11841 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
11845 <para>If in a multi-language system you can enter
11846 {langcode} in the path to tell Koha to look in the right
11847 language folder</para>
11852 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
11857 http://mykoha.org/{langcode}/stylesheet.xsl</para>
11865 <para>put an URL for an external specific stylesheet</para>
11869 <para>ex: http://mykoha.org/stylesheet.xsl</para>
11875 <para>Description:</para>
11879 <para>XSLT stylesheets allow for the customization of the
11880 details shows on the screen when viewing a bib record. This
11881 preference will allow you either use the default look that
11882 comes with Koha or design your own stylesheet.</para>
11887 <section id="XSLTResultsDisplay">
11888 <title>XSLTResultsDisplay</title>
11890 <para>Default: default</para>
11892 <para>Asks: Display results in the staff client using XSLT
11893 stylesheet at ___</para>
11895 <para>Values:</para>
11899 <para>leave empty to not use the XSLT stylesheet</para>
11903 <para>In previous versions of Koha this was the setting
11904 that read 'normally'</para>
11910 <para>enter "default" for the default one</para>
11914 <para>put a path to define a XSLT file</para>
11918 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
11922 <para>If in a multi-language system you can enter
11923 {langcode} in the path to tell Koha to look in the right
11924 language folder</para>
11929 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
11934 http://mykoha.org/{langcode}/stylesheet.xsl</para>
11942 <para>put an URL for an external specific stylesheet</para>
11946 <para>ex: http://mykoha.org/stylesheet.xsl</para>
11952 <para>Description:</para>
11956 <para>XSLT stylesheets allow for the customization of the
11957 details shows on the screen when viewing the search results.
11958 This preference will allow you either use the default look
11959 that comes with Koha or design your own stylesheet.</para>
11964 <section id="yuipath">
11965 <title>yuipath</title>
11967 <para>Default: included with Koha</para>
11969 <para>Asks: Use the Yahoo UI libraries ___</para>
11971 <para>Values:</para>
11975 <para>from Yahoo's servers</para>
11979 <para>With this option there is less demand on your
11980 servers, but if the Internet goes down there will be
11987 <para>included with Koha</para>
11991 <para>With this option calls are made faster, and they
11992 will still work if the Internet goes down</para>
11998 <para>Description:</para>
12002 <para>The yuipath preference allows for the user to define a
12003 local path or web URL to the Yahoo User Interface Library
12005 url="http://developer.yahoo.com/yui/2/">http://developer.yahoo.com/yui/2/</ulink>).
12006 This library is a resource of developer tools including
12007 JavaScript and style sheets.</para>
12013 <section id="staffoptsprefs">
12014 <title>Options</title>
12016 <section id="HidePatronName">
12017 <title>HidePatronName</title>
12019 <para>Default: Show</para>
12021 <para>Asks: ___ the names of patrons that have items checked out
12022 or on hold on detail pages or the "Place Hold" screen.</para>
12024 <para>Values:</para>
12028 <para>Don't show</para>
12037 <section id="intranetbookbag">
12038 <title>intranetbookbag</title>
12040 <para>Default: Show</para>
12042 <para>Asks: ___ the cart option in the staff client.</para>
12044 <para>Values:</para>
12048 <para>Don't show</para>
12057 <section id="viewISBD">
12058 <title>viewISBD</title>
12060 <para>Default: Allow</para>
12062 <para>Asks: ___ staff to view records in ISBD form on the staff
12065 <para>Values:</para>
12073 <para>Don't allow</para>
12078 <section id="viewLabeledMARC">
12079 <title>viewLabeledMARC</title>
12081 <para>Default: Allow</para>
12083 <para>Asks: ___ staff to view records in labeled MARC form on the
12084 staff client.</para>
12086 <para>Values:</para>
12094 <para>Don't allow</para>
12099 <section id="viewMARC">
12100 <title>viewMARC</title>
12102 <para>Default: Allow</para>
12104 <para>Asks: ___ staff to view records in plain MARC form on the
12105 staff client.</para>
12107 <para>Values:</para>
12115 <para>Don't allow</para>
12122 <section id="webserviceprefs">
12123 <title>Web Services</title>
12125 <para><emphasis>Get there:</emphasis> More > Administration >
12126 Global System Preferences > Web Services</para>
12128 <section id="ilsdiprefs">
12129 <title>ILS-DI</title>
12133 <section id="ILS-DI">
12134 <title>ILS-DI</title>
12136 <para>Default: Disable</para>
12138 <para>Asks: ___ ILS-DI services for OPAC users</para>
12140 <para>Values:</para>
12144 <para>Disable</para>
12148 <para>Enable</para>
12153 <section id="ILS-DIAuthorized_IPs">
12154 <title>ILS-DI:AuthorizedIPs</title>
12156 <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
12160 <section id="oaiprefs">
12161 <title>OAI-PMH</title>
12165 <section id="OAI-PMH">
12166 <title>OAI-PMH</title>
12168 <para>Default: Disable</para>
12170 <para>Asks: ___ Koha's OAI-PMH server.</para>
12172 <para>Values:</para>
12176 <para>Disable</para>
12180 <para>Enable</para>
12184 <para>Description:</para>
12188 <para>For the Open Archives Initiative-Protocol for Metadata
12189 Harvesting (OAI-PMH) there are two groups of
12190 ‘participants': Data Providers and Service Providers.
12191 Data Providers (open archives, repositories) provide free
12192 access to metadata, and may, but do not necessarily, offer
12193 free access to full texts or other resources. OAI-PMH provides
12194 an easy to implement, low barrier solution for Data Providers.
12195 Service Providers use the OAI interfaces of the Data Providers
12196 to harvest and store metadata. Note that this means that there
12197 are no live search requests to the Data Providers; rather,
12198 services are based on the harvested data via OAI-PMH. Koha at
12199 present can only act as a Data Provider. It can not harvest
12200 from other repositories. The biggest stumbling block to having
12201 Koha harvest from other repositories is that MARC is the only
12202 metadata format that Koha indexes natively. Visit <ulink
12203 url="http://www.oaforum.org/tutorial/english/page3.htm">http://www.oaforum.org/tutorial/english/page3.htm</ulink>
12204 for diagrams of how OAI-PMH works.</para>
12208 <para>Learn more about OAI-PMH at: <ulink
12209 url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
12212 <section id="OAI-PMHarchiveID">
12213 <title>OAI-PMH:archiveID</title>
12215 <para>Default: KOHA-OAI-TEST</para>
12217 <para>Asks: Identify records at this site with the prefix ___
12221 <section id="OAI-PMHAutoUpdateSets">
12222 <title>OAI-PMH:AutoUpdateSets</title>
12224 <para>Default: Disable</para>
12226 <para>Asks: ___ automatic update of OAI-PMH sets when a
12227 bibliographic record is created or updated.</para>
12229 <para>Values:</para>
12233 <para>Disable</para>
12237 <para>Enable</para>
12242 <section id="OAI-PMHConfFile">
12243 <title>OAI-PMH:ConfFile</title>
12245 <para>If this preference is left empty, Koha's OAI Server operates
12246 in normal mode, otherwise it operates in extended mode. In
12247 extended mode, it's possible to parameter other formats than
12248 marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
12249 configuration file which list available metadata formats and XSL
12250 file used to create them from marcxml records.</para>
12252 <para>For more information, see the <link
12253 linkend="oaiconfsample">sample conf file</link> in the
12257 <section id="OAI-PMHMaxCount">
12258 <title>OAI-PMH:MaxCount</title>
12260 <para>Default: 50</para>
12262 <para>Asks: Only return ___ records at a time in response to a
12263 ListRecords or ListIdentifiers query.</para>
12265 <para>Description:</para>
12269 <para>This is the maximum number of records that would be
12270 returned based on ListRecord or ListIdentifier queries from
12271 harvesters. ListRecords harvest the entire records while the
12272 ListIdentifier is an abbreviated form of ListRecords,
12273 retrieving only headers rather than records.</para>
12281 <section id="basicparams">
12282 <title>Basic Parameters</title>
12284 <para><emphasis>Get there:</emphasis> More > Administration</para>
12287 <para>Configure all 'parameters' in the order they appear.</para>
12290 <section id="libsgroups">
12291 <title>Libraries & Groups</title>
12293 <para>When setting up your Koha system you will want to add
12294 information for every library that will be sharing your system. This
12295 data is used in several areas of Koha.</para>
12299 <para><emphasis>Get there:</emphasis> More > Administration
12300 > Basic Parameters > Libraries and Groups</para>
12304 <para>When visiting this page you are presented with a list of the
12305 libraries and groups that have already been added to the
12309 <screeninfo>Library List</screeninfo>
12313 <imagedata fileref="images/admin/basicparams/librarylist.png"/>
12319 <screeninfo>Group Lists</screeninfo>
12323 <imagedata fileref="images/admin/basicparams/grouplists.png"/>
12328 <section id="addingalibrary">
12329 <title>Adding a Library</title>
12331 <para>To add a new library:</para>
12335 <para>Click 'New Library'</para>
12339 <para>The top of the form asks for some basics about the
12343 <screeninfo>Basic Library Info</screeninfo>
12347 <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
12354 <para>The library code should not contain any spaces and be
12355 10 or fewer characters. This code will be used as a unique
12356 identifier in the database.</para>
12360 <para>The name will be displayed on the OPAC wherever the
12361 library name displays to the public and should be a name
12362 that makes sense to your patrons.</para>
12366 <para>If you have <link
12367 linkend="addinglibgroup">groups</link> set up you can choose
12368 what group this library belongs to after entering in the
12369 code and name</para>
12375 <para>Next you can enter basic contact info about the
12379 <screeninfo>Library Contact Info</screeninfo>
12383 <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
12390 <para>The address and contact fields can be used to make
12391 notices custom for each library</para>
12395 <para>The email address field is not required, but it should
12396 be filled for every library in your system</para>
12401 <para>Be sure to enter a library email address to make
12402 sure that notices are sent to and from the right
12410 <para>If the URL field is populated then the library name
12411 will be linked in the holdings table on the OPAC</para>
12414 <screeninfo>Linked Library Name</screeninfo>
12418 <imagedata fileref="images/admin/basicparams/librarylink.png"/>
12425 <para>The OPAC Info box is for you to put information about
12426 the library that will appear in the OPAC when the branch
12427 name is moused over in the holdings table</para>
12430 <screeninfo>OPAC Info</screeninfo>
12434 <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
12441 <para>IP Address does not have be filled in unless you plan
12442 on limiting access to your staff client to a specific IP
12448 <para>An IP address is required if you have enabled
12450 linkend="AutoLocation">AutoLocation</link></para>
12457 <para>Finally, if you have any notes you can put them here.
12458 These will not show in the OPAC</para>
12465 <para>Of the fields listed, only 'Library code' and 'Name' are
12472 <section id="editingalibrary">
12473 <title>Editing/Deleting a Library</title>
12475 <para>You will be unable to delete any library that has patrons or
12476 items attached to it.</para>
12479 <screeninfo>Staff will be presented with a warning when trying to
12480 delete a library that is being used</screeninfo>
12484 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
12489 <para>Each library will have an 'Edit' link to the right of it.
12490 Click this link to edit/alter details associated with the library in
12494 <para>You will be unable to edit the 'Library code'</para>
12498 <section id="addinglibgroup">
12499 <title>Adding a group</title>
12501 <para>To add a Search Domain or Library Property Group click the
12502 'New Group' button at the top of the screen</para>
12505 <screeninfo>Add group form</screeninfo>
12509 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
12514 <para>Of the fields on the group form, 'Category code' and 'Name'
12515 are the only required fields</para>
12517 <section id="searchdomaingroups">
12518 <title>Search Domain Groups</title>
12520 <para>Search Domain Groups allow you to search a group of
12521 libraries at the same time instead of searching just one library
12522 or all libraries.</para>
12525 <screeninfo>Search Domain Groups</screeninfo>
12529 <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
12534 <para>To see Search Domain Groups in action visit the staff client
12535 advanced search page in your Koha system:</para>
12538 <screeninfo>Library group search on staff client</screeninfo>
12542 <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
12548 <section id="libpropertygroups">
12549 <title>Library Property Groups</title>
12551 <para>You can assign specific categories to your libraries by
12552 adding groups for them</para>
12555 <screeninfo>Library Property Groups</screeninfo>
12559 <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
12564 <para>Properties are then applied to libraries via the add or edit
12565 library form</para>
12568 <screeninfo>Groups on the Add/Modify library form</screeninfo>
12572 <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
12580 <section id="itemtypeadmin">
12581 <title>Item Types</title>
12583 <para>Koha allows you to organize your collection by item types and
12584 collection codes.</para>
12588 <para><emphasis>Get there:</emphasis> More > Administration
12589 > Basic Parameters > Item Types</para>
12593 <para>Item types typically refer to the material type (book, cd, dvd,
12594 etc), but can be used in any way that works for your library.</para>
12597 <screeninfo>Item Types</screeninfo>
12601 <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
12606 <section id="additemtype">
12607 <title>Adding Item Types</title>
12609 <para>To add a new item type, simply click the 'New Item Type'
12610 button at the top of the Item Types page.</para>
12613 <screeninfo>Sample DVD Item Type</screeninfo>
12617 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
12624 <para>In the 'Item Type' field, enter a short code for your item
12629 <para>The description is the plain text definition of the item
12634 <para>You can choose to have an image associated with your item
12639 <para>You can choose from a series of image
12644 <para>You can link to a remote image</para>
12648 <para>Or you can just have no image associated with the item
12654 <para>To have your item type images appear in the OPAC you
12655 need to set noItemTypeImages to 'Show'</para>
12660 <para><emphasis>Get there: </emphasis>More >
12661 Administration > Global System Preferences > <link
12662 linkend="adminprefs">Admin</link></para>
12670 <para>For items that do not circulate, check the 'Not for loan'
12675 <para>Items marked 'Not for loan' will appear in the
12676 catalog, but cannot be checked out to patrons</para>
12682 <para>Enter the total number of renewals allowed for the item
12683 type in the 'Renewals' box</para>
12687 <para id="rentalcharge">For items that you charge a rental fee
12688 for, enter the total fee you charge in the 'Rental charge'
12694 <para>Do not enter symbols in this field, only numbers and
12695 decimal points (ex. $5.00 should be entered as 5 or
12701 <para>This will charge the patron on checkout</para>
12707 <para>When finished, click 'Save Changes'</para>
12712 <para>All fields, with the exception of the 'Item Type'
12713 will be editable from the Item Types list</para>
12720 <para>Your new item type will now appear on the list</para>
12723 <screeninfo>New DVD Item Type</screeninfo>
12727 <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
12735 <section id="edititemtype">
12736 <title>Editing Item Types</title>
12738 <para>Each item type has an Edit button beside it. To edit an item
12739 simply click the 'Edit' link.</para>
12742 <para>You will not be able to edit the code you assigned as the
12743 'Item Type' but you will be able to edit the description for the
12748 <section id="deleteitemtype">
12749 <title>Deleting Item Types</title>
12751 <para>Each item has a Delete button beside it. To delete an item,
12752 simply click the 'Delete' link.</para>
12755 <para>You will not be able to delete item types that are being
12756 used by items within your system.</para>
12760 <screeninfo>Warning when you try to delete an item that is in
12765 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
12772 <section id="authorizedvalues">
12773 <title>Authorized Values</title>
12775 <para>Authorized values can be used in several areas of Koha. One
12776 reason you would add an authorized value category would be to control
12777 the values that can be entered into MARC fields by catalogers.</para>
12781 <para><emphasis>Get there:</emphasis> More > Administration
12782 > Basic Parameters > Authorized Values</para>
12786 <section id="existingauthvalues">
12787 <title>Existing Values</title>
12789 <para>Koha installs with pre-defined values that your library is
12790 likely to use, for instance 'Lost'.</para>
12794 <para>Asort1</para>
12798 <para>Used for acquisitions statistical purposes</para>
12804 <para>Asort2</para>
12808 <para>Used for acquisitions statistical purposes</para>
12814 <para id="bornotes">BOR_NOTES</para>
12818 <para>Values for custom patron notes that appear on the
12819 circulation screen and the OPAC</para>
12825 <para>Bsort1</para>
12829 <para>Used for patron statistical purposes</para>
12835 <para>Bsort2</para>
12839 <para>Used for patron statistical purposes</para>
12849 <para>Is the shelving cart location, used by <link
12850 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
12852 linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
12858 <para id="ccode">CCODE</para>
12862 <para>Collection codes (appears when cataloging and working
12869 <para>DAMAGED</para>
12873 <para>Descriptions for items marked as damaged (appears when
12874 cataloging and working with items)</para>
12880 <para>HINGS_AS</para>
12884 <para>General Holdings: Acquisition Status Designator ::
12885 This data element specifies acquisition status for the unit
12886 at the time of the holdings report.a</para>
12892 <para>HINGS_C</para>
12896 <para>General Holdings: Completeness Designator</para>
12902 <para>HINGS_PF</para>
12906 <para>Physical Form Designators</para>
12912 <para>HINGS_RD</para>
12916 <para>General Holdings: Retention Designator :: This data
12917 element specifies the retention policy for the unit at the
12918 time of the holdings report.</para>
12924 <para>HINGS_UT</para>
12928 <para>General Holdings: Type of Unit Designator</para>
12934 <para id="shelvelocvals">LOC</para>
12938 <para>Shelving location (usually appears when adding or
12939 editing an item)</para>
12945 <para id="lost">LOST</para>
12949 <para>Descriptions for the items marked as lost (appears
12950 when adding or editing an item)</para>
12955 <para>Values given to lost statuses should be numeric and
12956 not alphabetical in order for statuses to appear
12964 <para id="manualinvvals">MANUAL_INV</para>
12968 <para>Values for manual invoicing types</para>
12974 <para id="notforloan">NOT_LOAN</para>
12978 <para>Reasons why a title is not for loan</para>
12983 <para>Values given to lost statuses should be numeric and
12984 not alphabetical in order for statuses to appear
12991 <para>Negative number values will still allow holds (use
12992 for on order statuses for example) where as positive
12993 numbers will not allow holds or checkouts</para>
13004 <para>The location to be used for <link
13005 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>
13006 (change description as desired), also the location expected
13008 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>.</para>
13014 <para id="restricted">RESTRICTED</para>
13018 <para>Restricted status of an item</para>
13024 <para id="suggestauthorized">SUGGEST</para>
13028 <para>List of patron suggestion reject or accept reasons
13029 (appears when managing suggestions)</para>
13035 <para>WITHDRAWN</para>
13039 <para>Description of a withdrawn item (appears when adding
13040 or editing an item)</para>
13046 <para>YES_NO</para>
13050 <para>A generic authorized value field that can be used
13051 anywhere you need a simple yes/no pull down menu.</para>
13058 <section id="newauthvalcat">
13059 <title>Add new Authorized Value Category</title>
13061 <para>In addition to the existing categories that come by default
13062 with Koha, librarians can add their own authorized value categories
13063 to control data that is entered into the system. To add a new
13068 <para>Click 'New Category'</para>
13071 <screeninfo>New Authorized Category form</screeninfo>
13075 <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
13082 <para>Limit your Category to 10 characters (something short to
13083 make it clear what the category is for)</para>
13088 <para>Category cannot have spaces or special characters
13089 other than underscores and hyphens in it.</para>
13096 <para>When adding a new category you're asked to create at least
13097 one authorized value</para>
13101 <para>Enter a code for your Authorized Value into the
13102 'Authorized value' field</para>
13107 <para>Authorized value is limited to 80 characters and
13108 cannot have spaces or special characters other than
13109 underscores and hyphens in it.</para>
13116 <para>Use the Description field for the actual value that
13117 will be displayed. If you want something different to show
13118 in the OPAC, enter a 'Description (OPAC)'</para>
13122 <para>If you have <link
13123 linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
13125 linkend="AuthorisedValueImages">AuthorisedValueImages</link>
13126 set to show images for authorized values you can choose the
13127 image under 'Choose an icon'</para>
13133 <para>Click 'Save'</para>
13137 <para>Your new category and value will appear on the list of
13138 Authorized Values</para>
13141 <screeninfo>Custom Authorized Value on list of
13142 values</screeninfo>
13146 <imagedata fileref="images/admin/basicparams/authvallist.png"/>
13154 <section id="newauthval">
13155 <title>Add new Authorized Value</title>
13157 <para>New authorized values can be added to any existing or new
13158 category. To add a value:</para>
13162 <para>Click 'New authorized value for ...'</para>
13165 <screeninfo>New Authorized Value form</screeninfo>
13169 <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
13176 <para>Enter a code for your Authorized Value into the
13177 'Authorized value' field</para>
13182 <para>Authorized value is limited to 80 characters and
13183 cannot have spaces or special characters other than
13184 underscores and hyphens in it.</para>
13191 <para>Use the Description field for the actual value that will
13192 be displayed. If you want something different to show in the
13193 OPAC, enter a 'Description (OPAC)'</para>
13197 <para>If you have <link
13198 linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
13200 linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
13201 to show images for authorized values you can choose the image
13202 under 'Choose an icon'</para>
13206 <para>Click 'Save'</para>
13210 <para>The new value will appear in the list along with existing
13214 <screeninfo>List of authorized values in MARC504
13215 category</screeninfo>
13219 <imagedata fileref="images/admin/basicparams/authvals.png"/>
13229 <section id="patscirc">
13230 <title>Patrons & Circulation</title>
13232 <para>Settings for controlling circulation and patron
13233 information.</para>
13235 <section id="patcats">
13236 <title>Patron Categories</title>
13238 <para>Patron categories allow you to organize your patrons into
13239 different roles, age groups, and patron types.</para>
13243 <para><emphasis>Get there:</emphasis> More > Administration
13244 > Patrons & Circulation > Patron Categories</para>
13249 <screeninfo>Patron category list</screeninfo>
13253 <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
13258 <para>Patrons are assigned to one of six main categories:</para>
13266 <para>Most common patron type, usually used for a general
13267 'Patron' category.</para>
13277 <para>Children patrons can have a guardian to be attached to
13288 <para>Librarians (and library workers) should be assigned the
13289 staff category so that you can <link
13290 linkend="patronpermissions">set their permissions</link> and
13291 give them access to the staff client.</para>
13297 <para>Organizational</para>
13301 <para>Organizational patrons are organizations. Organizations
13302 can be used as guarantors for Professional patrons.</para>
13308 <para>Professional</para>
13312 <para>Professional patrons can be linked to Organizational
13319 <para>Statistical</para>
13323 <para>This patron type is used strictly for statistical
13324 purposes, such as in house use of items.</para>
13330 <section id="addingpatroncat">
13331 <title>Adding a patron category</title>
13333 <para>To add a new patron category click 'New Category' at the top
13337 <screeninfo>New patron category form</screeninfo>
13341 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
13348 <para>The 'Category Code' is an identifier for your new
13354 <para>The category code is limited to 10 characters
13355 (numbers and letters)</para>
13361 <para>This field is required in order to save your patron
13362 category. If left blank you will be presented with an
13366 <screeninfo>Missing fields error</screeninfo>
13370 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13380 <para>Enter a plain text version of the category in the
13381 'Description' field.</para>
13386 <para>This field is required in order to save your patron
13387 category. If left blank you will be presented with an
13391 <screeninfo>Missing fields error</screeninfo>
13395 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13405 <para>Enrollment period (in months) should be filled in if you
13406 have a limited enrollment period for your patrons (eg. Student
13407 cards expire after 9 months or until a specific date)</para>
13412 <para>You cannot enter both a month limit and a date
13413 until. Choose to enter either one or the other.</para>
13419 <para>This field is required in order to save your patron
13420 category. If left blank you will be presented with an
13424 <screeninfo>Missing fields error</screeninfo>
13428 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13438 <para>Some patron categories can have a minimum age (in years)
13439 requirement associated with them, enter this age in the 'Age
13445 <para>This value will only be checked if <link
13446 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
13447 defines the dateofbirth as a required field on the patron
13455 <para>Patron categories can also have a maximum age (in years)
13456 associated with them (such as children), enter this age in the
13457 'Upperage limit'</para>
13462 <para>This value will only be checked if <link
13463 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
13464 defines the dateofbirth as a required field on the patron
13472 <para>If you charge a membership fee for your patrons (such as
13473 those who live in another region) you can enter that in the
13474 'Enrollment fee' field.</para>
13479 <para>Only enter numbers and decimals in this field</para>
13486 <para>If you want your patron to receive overdue notices, set
13487 the 'Overdue notice required' to 'Yes'</para>
13491 <para>You can decide on a patron category basis if lost items
13492 are shown in the staff client by making a choice from the 'Lost
13493 items in staff client' pull down</para>
13496 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
13500 <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
13508 <para>Note that this is only applicable in the staff
13509 client, so changing this value on patron categories who do
13510 not have access to the staff client won't make any
13518 <para>If you charge patrons for placing holds on items, enter
13519 the fee amount in the 'Hold fee' field.</para>
13524 <para>Only enter numbers and decimals in this field</para>
13531 <para>In the 'Category type' field choose one of the six main
13532 parent categories</para>
13535 <screeninfo>Six main patron categories</screeninfo>
13539 <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
13547 <para>This field is required in order to save your patron
13548 category. If left blank you will be presented with an
13552 <screeninfo>Missing fields error</screeninfo>
13556 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13566 <para>Finally you can assign advanced messaging preferences by
13567 default to a patron category</para>
13572 <para>Requires that you have <link
13573 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
13580 <para>These can be changed for individual patrons, this
13581 setting is just a default to make it easier to set up
13582 messages for an entire category</para>
13591 <section id="citytowns">
13592 <title>Cities and Towns</title>
13594 <para>To standardize patron input you can define cities or towns
13595 within your region so that when new patrons are added librarians
13596 simply have to select the town from a list instead of having to type
13597 the town and zip (or postal) code information.</para>
13601 <para><emphasis>Get there:</emphasis> More > Administration
13602 > Patrons & Circulation > Cities and Towns</para>
13606 <section id="addingcity">
13607 <title>Adding a City</title>
13609 <para>To add a new city, click the 'New City' button at the top of
13610 the page and enter the city name, state, zip/postal code and
13614 <screeninfo>New city entry form</screeninfo>
13618 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
13623 <para>One you click Submit, your city will be saved and will be
13624 listed on the Cities and Towns page</para>
13627 <screeninfo>List of Cities</screeninfo>
13631 <imagedata fileref="images/admin/patroncirc/cities.png"/>
13636 <para>Cities can be edited or deleted at any time.</para>
13639 <section id="citiesonpatform">
13640 <title>Viewing Cities on Patron Add Form</title>
13642 <para>If you have defined local cities using the New city form, then
13643 when adding or editing a patron record you will see those cities in
13644 a pull down menu to make city selection easy.</para>
13647 <screeninfo>Cities pull down on the patron record</screeninfo>
13651 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
13656 <para>This will allow for easy entry of local cities into the patron
13657 record without risking the potential for typos or mistaken
13658 zip/postal codes.</para>
13662 <section id="roadtypes">
13663 <title>Road Types</title>
13665 <para>To standardize patron input you can define road types within
13666 your region so that when new patrons are added librarians simply have
13667 to select the road from a list instead of having to type it in.</para>
13670 <para>If you want your patrons to have their road types abbreviated
13671 all of the time then you can enter the appropriate abbreviations
13672 here, if you'd like the road types to always be spelled out you can
13673 do that here as well.</para>
13676 <section id="addroadtype">
13677 <title>Adding Road Types</title>
13679 <para>To add a road type, click 'New Road Type' and then enter the
13680 road type the way you'd like it displayed.</para>
13683 <screeninfo>New Road</screeninfo>
13687 <imagedata fileref="images/admin/patroncirc/newroad.png"/>
13692 <para>Once you submit the form, your new road type will be listed on
13693 the Road Types page</para>
13696 <screeninfo>Roads in Koha</screeninfo>
13700 <imagedata fileref="images/admin/patroncirc/roads.png"/>
13706 <section id="roadtypeonpatform">
13707 <title>Viewing Road Types on Patron Add form</title>
13709 <para>When adding or editing a patron, if you have road types
13710 defined, there will be a pull down to choose the road type
13714 <screeninfo>Road types on patron record</screeninfo>
13718 <imagedata fileref="images/admin/patroncirc/patronroad.png"/>
13725 <section id="patronattributetypes">
13726 <title>Patron Attribute Types</title>
13728 <para>Patron attributes can be used to define custom fields to
13729 associate with your patron records. In order to enable the use of
13730 custom fields you need to set the <link
13731 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
13732 system preference.</para>
13736 <para><emphasis>Get there:</emphasis> More > Administration
13737 > Patrons & Circulation > Patron attribute types</para>
13741 <para>A common use for this field would be for a student ID number or
13742 a Driver's license number.</para>
13745 <screeninfo>List of Patron Attributes</screeninfo>
13749 <imagedata fileref="images/admin/patroncirc/attributes.png"/>
13754 <section id="addpatattributes">
13755 <title>Adding Patron Attributes</title>
13757 <para>To add a new Patron Attribute Type, click the 'New Patron
13758 Attribute Type' button at the top of the page</para>
13761 <screeninfo>Add Patron Attribute Type form</screeninfo>
13765 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
13772 <para>In the 'Patron attribute type code', enter a short code to
13773 identify this field</para>
13778 <para>This field is limited to 10 characters (numbers and
13779 letters only)</para>
13785 <para>This setting cannot be changed after an attribute is
13793 <para>In the 'Description' field, enter a longer (plain text)
13794 explanation of what this field will contain</para>
13798 <para>Check the box next to 'Repeatable' to let a patron record
13799 have multiple values of this attribute.</para>
13804 <para>This setting cannot be changed after an attribute is
13812 <para>If 'Unique identifier' is checked, the attribute will be a
13813 unique identifier which means, if a value is given to a patron
13814 record, the same value cannot be given to a different
13820 <para>This setting cannot be changed after an attribute is
13828 <para>Check 'Allow password' to make it possible to associate a
13829 password with this attribute.</para>
13833 <para>Check 'Display in OPAC' to display this attribute on a
13834 patron's details page in the OPAC.</para>
13838 <para>Check 'Searchable' to make this attribute searchable in
13839 the staff patron search.</para>
13843 <para>Check 'Display in check-out' to make this attribute
13844 visible in the patron's short detail display on the left of the
13845 checkout screen and other patron pages</para>
13848 <screeninfo>Show attribute in patron detail on the
13853 <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
13860 <para>Authorized value category; if one is selected, the patron
13861 record input page will only allow values to be chosen from the
13862 authorized value list.</para>
13866 <para>You will first need to add an authorized value list
13867 for it to appear in this menu</para>
13871 <para><emphasis>Get there: </emphasis>More >
13872 Administration > Basic Parameters > <link
13873 linkend="authorizedvalues">Authorized
13874 Values</link></para>
13881 <para>an authorized value list is not enforced during
13882 batch patron import.</para>
13889 <para>If you'd like to only show this attribute on patrons of
13890 one type choose that patron type from the 'Category' pull
13895 <para>If you have a lot of attributes it might be handy to group
13896 them so that you can easily find them for editing. If you create
13897 an <link linkend="authorizedvalues">Authorized Value</link> for
13898 PA_CLASS it will show in the 'Class' pull down and you can then
13899 change your attributes page to have sections of
13903 <screeninfo>Patron Attributes Sorted</screeninfo>
13907 <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
13914 <para>Click Save to save your new attribute</para>
13918 <para>Once added your attribute will appear on the list of
13919 attributes and also on the patron record add/edit form</para>
13922 <screeninfo>Patron Attributes list on the Patron add/edit
13927 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
13932 <para>If you have set up classes for organizing attributes they will
13933 appear that way on the add/edit patron form</para>
13936 <screeninfo>Grouped Attributes</screeninfo>
13940 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
13946 <section id="editpatattributes">
13947 <title>Editing/Deleting Patron Attributes</title>
13949 <para>Each patron attribute has an edit and a delete link beside it
13950 on the list of attributes.</para>
13952 <para>Some fields in the attribute will not be editable once
13957 <para>Patron attribute type code</para>
13961 <para>Repeatable</para>
13965 <para>Unique identifier</para>
13969 <para>You will be unable to delete an attribute if it's in
13973 <screeninfo>Warning when trying to delete an attribute that is in
13978 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
13985 <section id="circfinerules">
13986 <title>Circulation and Fine Rules</title>
13988 <para>These rules define how your items are circulated, how/when fines
13989 are calculated and how holds are handled.</para>
13993 <para><emphasis>Get there:</emphasis> More > Administration
13994 > Patrons & Circulation > Circulation and fines
13999 <para>The rules are applied from most specific to less specific, using
14000 the first found in this order:</para>
14004 <para>same library, same patron type, same item type</para>
14008 <para>same library, same patron type, all item type</para>
14012 <para>same library, all patron types, same item type</para>
14016 <para>same library, all patron types, all item types</para>
14020 <para>all libraries, same patron type, same item type</para>
14024 <para>all libraries, same patron type, all item types</para>
14028 <para>all libraries, all patron types, same item type</para>
14032 <para>all libraries, all patron types, all item types</para>
14037 <para>If you are a single library system choose your branch name
14038 before creating rules (sometimes having only rules for the 'all
14039 libraries' option can cause issues with holds)</para>
14043 <para>At the very least you will need to set a default circulation
14044 rule. This rule should be set for all item types, all libraries
14045 and all patron categories. That will catch all instances that do
14046 not match a specific rule. When checking out if you do not have a
14047 rule for all libraries, all item types and all patron types then
14048 you may see patrons getting blocked from placing holds. You will
14049 also want a rule for your specific library set for all item types
14050 and all patron types to avoid this holds issue. Koha needs to know
14051 what rule to fall back on.</para>
14052 </important></para>
14054 <section id="defaultcircrules">
14055 <title>Default Circulation Rules</title>
14057 <para>Using the issuing rules matrix you can define rules that
14058 depend on patron/item type combos. To set your rules, choose a
14059 library from the pull down (or 'all libraries' if you want to apply
14060 these rules to all branches):</para>
14063 <screeninfo>Libraries to apply the rules to</screeninfo>
14067 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
14072 <para>From the matrix you can choose any combination of patron
14073 categories and item types to apply the rules to</para>
14076 <screeninfo>Setting issuing rules for your libraries</screeninfo>
14080 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
14087 <para>First choose which patron category you'd like the rule to
14088 be applied to. If you leave this to 'All' it will apply to all
14089 patron categories</para>
14093 <para>Choose the 'Item Type' you would like this rule to apply
14094 to. If you leave this to 'All' it will apply to all item
14099 <para>Limit the number of items a patron can have checked out at
14100 the same time by entering a number in the 'Current Checkouts
14101 Allowed' field</para>
14105 <para>Define the period of time an item can be checked out to a
14106 patron by entering the number of units (days or hours) in the
14107 'Loan Period' box.</para>
14111 <para>Choose which unit of time, Days or Hours, that the loan
14112 period and fines will be calculate in</para>
14116 <para>You can also define a hard due date for a specific patron
14117 category and item type. A hard due date ignores your usual
14118 circulation rules and makes it so that all items of the type
14119 defined are due on, before or after the date you specify.</para>
14123 <para>'Fine Amount' should have the amount you would like to
14124 charge for overdue items</para>
14129 <para>Enter only numbers and decimal points (no currency
14137 <para>Enter the 'Fine Charging Interval' in the unit you set
14138 (ex. charge fines every 1 day, or every 2 hours)</para>
14142 <para>The 'Fine Grace Period' is the period of time an item can
14143 be overdue before you start charging fines.</para>
14148 <para>This can only be set for the Day unit, not in
14156 <para>If your library 'fines' patrons by suspending their
14157 account you can enter the number of days their fine should be
14158 suspended in the 'Suspension in Days' field</para>
14163 <para>This can only be set for the Day unit, not in
14171 <para>Next decide if the patron can renew this item type and if
14172 so, enter how many times they can renew it in the 'Renewals
14173 Allowed' box</para>
14177 <para>If the patron can place holds on this item type, enter the
14178 total numbers of items (of this type) that can be put on hold in
14179 the 'Holds Allowed' field</para>
14183 <para>Finally, if you charge a <link
14184 linkend="rentalcharge">rental fee</link> for the item type and
14185 want to give a specific patron type a discount on that fee,
14186 enter the percentage discount (without the % symbol) in the
14187 'Rental Discount' field</para>
14191 <para>When finished, click 'Add' to save your changes. To modify a
14192 rule, create a new one with the same patron type and item type. If
14193 you would like to delete your rule, simply click the 'Delete' link
14194 to the right of the rule.</para>
14196 <para>To save time you can clone rules from one library to another
14197 by choosing the clone option above the rules matrix.</para>
14200 <screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
14204 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
14209 <para>After choosing to clone you will be presented with a
14210 confirmation message.</para>
14213 <screeninfo>Circulation & Fine Rules Successfully Cloned
14214 Message</screeninfo>
14218 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
14224 <section id="defaultcheckoutpolicy">
14225 <title>Default Checkouts and Hold Policy</title>
14227 <para>You can set a default maximum number of checkouts and hold
14228 policy that will be used if none is defined below for a particular
14229 item type or category.</para>
14232 <screeninfo>Default Checkouts and Hold Policy</screeninfo>
14236 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
14241 <para>From this menu you can set a default to apply to all item
14242 types and patrons in the library.</para>
14246 <para>In 'Total Current Checkouts Allowed' enter the total
14247 number of items patrons can have checked out at one time</para>
14251 <para>Control where patrons can place holds from using the 'Hold
14252 Policy' menu</para>
14256 <para>From Any Library: Patrons from any library may put
14257 this item on hold. (default if none is defined)</para>
14261 <para>From Home Library: Only patrons from the item's home
14262 library may put this book on hold.</para>
14266 <para>No Holds Allowed: No patron may put this book on
14273 <para>Control where the item returns to once it is checked
14278 <para>Item returns home</para>
14282 <para>Item returns to issuing branch</para>
14286 <para>Item floats</para>
14290 <para>When an item floats it stays where it was checked
14291 in and does not ever return 'home'</para>
14299 <para>Once your policy is set, you can unset it by clicking the
14300 'Unset' link to the right of the rule</para>
14305 <section id="checkoutperpatron">
14306 <title>Checkouts Per Patron</title>
14308 <para>For this library, you can specify the maximum number of loans
14309 that a patron of a given category can make, regardless of the item
14313 <screeninfo>Set default checkouts per patron category</screeninfo>
14317 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
14323 <para>If the total amount loanable for a given patron category is
14324 left blank, no limit applies, except possibly for a limit you
14325 define for a specific item type.</para>
14329 <section id="holdpolicies">
14330 <title>Item Hold Policies</title>
14332 <para>For this library, you can edit rules for given itemtypes,
14333 regardless of the patron's category. Currently, this means hold
14337 <screeninfo>Hold policies per item type</screeninfo>
14341 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
14346 <para>The various Hold Policies have the following effects:</para>
14350 <para>From Any Library: Patrons from any library may put this
14351 item on hold. (default if none is defined)</para>
14355 <para>From Home Library: Only patrons from the item's home
14356 library may put this book on hold.</para>
14360 <para>No Holds Allowed: No patron may put this book on
14366 <para>Note that if the system preference <link
14367 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
14368 set to 'allow', these policies can be overridden by your
14369 circulation staff.</para>
14373 <para>These policies are based on the patron's home branch, not
14374 the branch that the reserving staff member is from.</para>
14377 <para>The various Return Policies have the following effects:</para>
14381 <para>Item returns home: The item will prompt the librarian to
14382 transfer the item to its home library</para>
14388 linkend="AutomaticItemReturn">AutomaticItemReturn</link>
14389 preference is set to automatically transfer the items
14390 home, then a prompt will not appear</para>
14397 <para>Item returns to issuing branch: The item will prompt the
14398 librarian to transfer the item back to the library where it was
14405 linkend="AutomaticItemReturn">AutomaticItemReturn</link>
14406 preference is set to automatically transfer the items
14407 home, then a prompt will not appear</para>
14414 <para>Item floats: The item will not be transferred from the
14415 branch it was checked in at, instead it will remain there until
14416 transferred manually or checked in at another branch</para>
14422 <section id="libtransferlimits">
14423 <title>Library Transfer Limits</title>
14425 <para>Limit the ability to transfer items between libraries based on
14426 the library sending, the library receiving, and the collection code
14431 <para><emphasis>Get there:</emphasis> More > Administration
14432 > Patrons & Circulation > Library Transfer Limits</para>
14436 <para>These rules only go into effect if the preference <link
14437 linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is
14438 set to 'enforce'.</para>
14440 <para>Before you begin you will want to choose which library you are
14441 setting these limits for.</para>
14444 <screeninfo>Choose the library you're setting limits
14449 <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
14454 <para>Transfer limits are set based on the collections codes you have
14455 applied via the <link linkend="authorizedvalues">Authorized
14456 Value</link> administration area.</para>
14459 <screeninfo>Collection Code values assigned in the Authorized Value
14464 <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
14469 <para>Collection codes will appear as tabs above the
14473 <screeninfo>Collection Code tabs</screeninfo>
14477 <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
14482 <para>Check the boxes for the libraries that you accept checkins from
14483 for the item type you have selected at the top (in the example below -
14487 <screeninfo>Example transfer limits set up</screeninfo>
14491 <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
14496 <para>In the above example, Centerville library will allow patrons to
14497 return items from all libraries except Liberty and Franklin to their
14501 <section id="itemcircalerts">
14502 <title>Item Circulation Alerts</title>
14504 <para>Libraries can decide if they want to have patrons automatically
14505 notified of circulation events (check ins and check outs).</para>
14509 <para><emphasis>Get there:</emphasis> More > Administration
14510 > Patrons & Circulation > Item Circulation Alerts</para>
14514 <para>These preferences are set based on patron types and item
14518 <para>These preference can be overwritten by changes in the
14519 individual patron's messaging preferences.</para>
14522 <para>To set up circulation alerts:</para>
14526 <para>Choose your library from the pull down at the top of the
14530 <screeninfo>Libraries to set Circulation Alerts</screeninfo>
14534 <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
14541 <para>To set preferences for all libraries, keep the menu set
14542 to 'Default'</para>
14548 <para>By default all item types and all patrons are notified of
14549 check ins and check outs. To change this, click on the item/patron
14550 type combo that you would like to stop notices for.</para>
14553 <screeninfo>Circulation Alert Matrix</screeninfo>
14557 <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
14564 <para>In the above example, Juveniles and Kids will not
14565 receive check out notices.</para>
14573 <section id="catadmin">
14574 <title>Catalog Administration</title>
14576 <para>Set these controls before you start cataloging on your Koha
14581 <para><emphasis>Get there:</emphasis> More > Administration >
14586 <section id="marcbibframeworks">
14587 <title>MARC Bibliographic Frameworks</title>
14589 <para>Think of Frameworks as templates for creating new bibliographic
14590 records. Koha comes with some predefined frameworks that can be edited
14591 or deleted, and librarians can create their own frameworks for content
14592 specific to their libraries.</para>
14596 <para><emphasis>Get there:</emphasis> More > Administration
14597 > Catalog > MARC Bibliographic Frameworks</para>
14602 <screeninfo>Frameworks List</screeninfo>
14606 <imagedata fileref="images/admin/cataloging/frameworks.png"/>
14612 <para>Do not delete or edit the Default Framework since this will
14613 cause problems with your cataloging records - always create a new
14614 template based on the Default Framework, or alter the other
14618 <para>After clicking the 'MARC structure' link to the right of each
14619 framework you can decide how many fields you want to see on one screen
14620 by using the pagination options at the top of the table.</para>
14623 <screeninfo>Pagination options</screeninfo>
14627 <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
14632 <section id="addframework">
14633 <title>Add New Framework</title>
14635 <para>To add a new framework</para>
14639 <para>Click 'New Framework'</para>
14642 <screeninfo>Add Framework Form</screeninfo>
14646 <imagedata fileref="images/admin/cataloging/addframework.png"/>
14653 <para>Enter a code of 4 or fewer characters</para>
14657 <para>Use the Description field to enter a more detailed
14658 definition of your framework</para>
14664 <para>Click 'Submit'</para>
14668 <para>Once your Framework is added click 'MARC structure' to the
14669 right of it on the list of Frameworks</para>
14672 <screeninfo>Choose basis for new Framework</screeninfo>
14676 <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
14683 <para>You will be asked to choose a Framework to base your
14684 new Framework off of, this will make it easier than starting
14685 from scratch</para>
14691 <para>Once your Framework appears on the screen you can edit or
14692 delete each field by following the instructions for <link
14693 linkend="editsubfields">editing subfields</link></para>
14698 <section id="editframeworks">
14699 <title>Edit Existing Frameworks</title>
14701 <para>Clicking 'Edit' to the right of a Framework will only allow
14702 you to edit the Description for the Framework:</para>
14705 <screeninfo>Edit Framework</screeninfo>
14709 <imagedata fileref="images/admin/cataloging/editframework.png"/>
14714 <para>To make edits to the fields associated with the Framework you
14715 must first click 'MARC Structure' and then follow the instructions
14716 for <link linkend="editsubfields">editing subfields</link></para>
14719 <section id="addsubfieldsframework">
14720 <title>Add subfields to Frameworks</title>
14722 <para>To add a field to a Framework click the 'New Tag' button at
14723 the top of the Framework definition</para>
14726 <screeninfo>New Tag Button</screeninfo>
14730 <imagedata fileref="images/admin/cataloging/newtag.png"/>
14735 <para>This will open up a blank form for entering MARC field
14739 <screeninfo>Add a new tag to framework</screeninfo>
14743 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
14748 <para>Enter the information about your new tag:</para>
14752 <para>The 'Tag' is the MARC field number</para>
14756 <para>The 'Label for lib' is the text that will appear in the
14757 staff client when in the cataloging module</para>
14761 <para>The 'Label for OPAC' is the text that will appear in the
14762 OPAC when viewing the MARC version of the record</para>
14766 <para>If this field can be repeated, check the 'Repeatable'
14771 <para>If this field is mandatory, check the 'Mandatory'
14776 <para>If you want this field to be a pull down with limited
14777 possible answers, choose which 'Authorized value' list you want
14782 <para>When you're finished, click 'Save Changes' and you will be
14783 presented with your new field</para>
14786 <screeninfo>New tag and link to subfields</screeninfo>
14790 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
14795 <para>To the right of the new field is a link to 'Subfields,' you
14796 will need to add subfields before this tag will appear in your MARC
14797 editor. The process of entering the settings for the new subfield is
14798 the same as those found in the <link linkend="editsubfields">editing
14799 subfields in frameworks</link> section of this manual.</para>
14802 <section id="editsubfields">
14803 <title>Edit Framework Subfields</title>
14805 <para>Frameworks are made up of MARC fields and subfields. To make
14806 edits to most Frameworks you must edit the fields and subfields.
14807 Clicking 'Edit' to the right of each subfield will allow you to make
14808 changes to the text associated with the field</para>
14811 <screeninfo>Modify MARC Field</screeninfo>
14815 <imagedata fileref="images/admin/cataloging/editfield.png"/>
14822 <para>Each field has a tag (which is the MARC tag)</para>
14826 <para>The 'Label for lib' is what will show in the staff
14827 client if you have <link
14828 linkend="advancedMARCeditor">advancedMARCeditor</link> set
14829 to display labels</para>
14833 <para>The 'Label for OPAC' is what will show on the MARC
14834 view in the OPAC</para>
14838 <para>If you check 'Repeatable' then the field will have a
14839 plus sign next to it allowing you to add multiples of that
14844 <para>If you check 'Mandatory' the record will not be
14845 allowed to save unless you have a value assigned to this
14850 <para>'Authorized value' is where you define an <link
14851 linkend="authorizedvalues">authorized value</link> that your
14852 catalogers can choose from a pull down to fill this field
14859 <para>To edit the subfields associated with the tag, click
14860 'Subfields' to the right of the tag on the 'MARC Structure'
14865 <para>From the list of subfields you can click 'Delete' to the
14866 right of each to delete the subfields</para>
14870 <para>To edit the subfields click 'Edit Subfields'</para>
14873 <screeninfo>Editing the 504 Subfield</screeninfo>
14877 <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
14884 <para>For each subfield you can set the following values</para>
14888 <para>Text for librarian</para>
14892 <para>what appears before the subfield in the librarian
14899 <para>Text for OPAC</para>
14903 <para>what appears before the field in the OPAC.</para>
14907 <para>If left empty, the text for librarian is used
14916 <para>Repeatable</para>
14920 <para>the field will have a plus sign next to it
14921 allowing you to add multiples of that tag</para>
14927 <para>Mandatory</para>
14931 <para>the record will not be allowed to save unless you
14932 have a value assigned to this tag</para>
14938 <para>Managed in tab</para>
14942 <para>defines the tab where the subfield is shown. All
14943 subfields of a given field must be in the same tab or
14944 ignored. Ignore means that the subfield is not
14951 <para>Default value</para>
14955 <para>defines what you want to appear in the field by
14956 default, this will be editable, but it saves time if you
14957 use the same note over and over or the same value in a
14958 field often.</para>
14964 <para>hidden</para>
14968 <para>allows you to select from 19 possible visibility
14969 conditions, 17 of which are implemented. They are the
14974 <para>-9 => Future use</para>
14978 <para>-8 => Flag</para>
14982 <para>-7 => OPAC !Intranet !Editor
14987 <para>-6 => OPAC Intranet !Editor
14992 <para>-5 => OPAC Intranet !Editor
14997 <para>-4 => OPAC !Intranet !Editor
15002 <para>-3 => OPAC !Intranet Editor
15007 <para>-2 => OPAC !Intranet Editor
15012 <para>-1 => OPAC Intranet Editor Collapsed</para>
15016 <para>0 => OPAC Intranet Editor !Collapsed</para>
15020 <para>1 => !OPAC Intranet Editor Collapsed</para>
15024 <para>2 => !OPAC !Intranet Editor
15029 <para>3 => !OPAC !Intranet Editor
15034 <para>4 => !OPAC Intranet Editor
15039 <para>5 => !OPAC !Intranet !Editor
15044 <para>6 => !OPAC Intranet !Editor
15049 <para>7 => !OPAC Intranet !Editor
15054 <para>8 => !OPAC !Intranet !Editor
15059 <para>9 => Future use • URL : if checked,
15060 the subfield is an URL, and can be clicked</para>
15066 <para>( ! means 'not visible' or in the case of
15067 Collapsed 'not Collapsed')</para>
15073 <para>Is a URL</para>
15077 <para>if checked, it means that the subfield is a URL
15078 and can be clicked</para>
15088 <para>If you enter a field/subfield here (200b), a link
15089 appears after the subfield in the MARC Detail view. This
15090 view is present only in the staff client, not the OPAC.
15091 If the librarian clicks on the link, a search is done on
15092 the database for the field/subfield with the same value.
15093 This can be used for 2 main topics :</para>
15097 <para>on a field like author (200f in UNIMARC), put
15098 200f here, you will be able to see all bib records
15099 with the same author.</para>
15103 <para>on a field that is a link (4xx) to reach
15104 another bib record. For example, put 011a in 464$x,
15105 will find the serials that are with this
15113 <para>This value should not change after data has been
15114 added to your catalog</para>
15121 <para>Koha link</para>
15125 <para>Koha is multi-MARC compliant. So, it does not know
15126 what the 245$a means, neither what 200$f (those 2 fields
15127 being both the title in MARC21 and UNIMARC). So, in this
15128 list you can "map" a MARC subfield to its meaning. Koha
15129 constantly maintains consistency between a subfield and
15130 its meaning. When the user want to search on "title",
15131 this link is used to find what is searched (245 if
15132 you're MARC21, 200 if you're UNIMARC).</para>
15138 <para>Authorized value</para>
15142 <para>means the value cannot by typed by the librarian,
15143 but must be chosen from a pull down generated by the
15144 <link linkend="authorizedvalues">authorized value</link>
15149 <para>In the example above, the 504a field will show the
15150 MARC504 Authorized Values when cataloging</para>
15153 <screeninfo>Example of an Authorized
15154 Subfield</screeninfo>
15158 <imagedata fileref="images/admin/cataloging/504auth.png"/>
15167 <para>Thesaurus</para>
15171 <para>means that the value is not free text, but must be
15172 searched in the authority/thesaurus of the selected
15179 <para>Plugin</para>
15183 <para>means the value is calculated or managed by a
15184 plugin. Plugins can do almost anything.</para>
15188 <para>For example, in UNIMARC there are plugins for
15189 every 1xx fields that are coded fields. The plugin is a
15190 huge help for cataloger ! There are also two plugins
15191 (unimarc_plugin_210c and unimarc_plugin_225a that can
15192 "magically" find the editor from an ISBN, and the
15193 collection list for the editor)</para>
15201 <para>To save your changes simply click the 'Save Changes'
15202 button at the top of the screen</para>
15209 <section id="importexportframeworks">
15210 <title>Import/Export Frameworks</title>
15212 <para>Next to each framework is a link to either import or export
15213 the framework.</para>
15215 <section id="exportframeworks">
15216 <title>Export Framework</title>
15218 <para>To export a framework simply click the 'Export' link to the
15219 right of framework title.</para>
15222 <screeninfo>Export link next to framework</screeninfo>
15226 <imagedata fileref="images/admin/cataloging/importexport.png"/>
15231 <para>When you click 'Export' you will be prompted to choose what
15232 format to export the file in.</para>
15235 <screeninfo>Export formats</screeninfo>
15239 <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
15244 <para>A framework exported this way can be imported into any other
15245 Koha installation using the import framework option.</para>
15248 <section id="importframeworks">
15249 <title>Import Framework</title>
15251 <para>An easy way to create a new framework is to import it from
15252 another Koha database. To import a framework you first need to
15253 create <link linkend="addframework">a new framework</link>. Once
15254 you have that framework, click 'Import' to the right of the new
15258 <screeninfo>Import link next to framework</screeninfo>
15262 <imagedata fileref="images/admin/cataloging/importexport.png"/>
15267 <para>You will be prompted to find a file on your computer to
15268 import into the framework.</para>
15271 <screeninfo>Choose a file to import</screeninfo>
15275 <imagedata fileref="images/admin/cataloging/importfile.png"/>
15280 <para>You will be asked to confirm your actions before the file is
15284 <screeninfo>Confirm your desire to import</screeninfo>
15288 <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
15293 <para>As your file is uploaded you will see an image that will
15294 confirm that the system is working.</para>
15297 <screeninfo>Import timer</screeninfo>
15301 <imagedata fileref="images/admin/cataloging/importtimer.png"/>
15306 <para>Once your import is complete you will be brought to the
15307 framework edit tool where you can make any changes you need to the
15308 framework you imported.</para>
15313 <section id="kohamarcmapping">
15314 <title>Koha to MARC Mapping</title>
15316 <para>While Koha stores the entire MARC record, it also stores common
15317 fields for easy access in various tables in the database. Koha to MARC
15318 Mapping is used to tell Koha where to find these values in the MARC
15319 record. In many cases you will not have to change the default values
15320 set by in this tool on installation, but it is important to know that
15321 the tool is here and can be used at any time.</para>
15325 <para><emphasis>Get there:</emphasis> More > Administration
15326 > Catalog > Koha to MARC Mapping</para>
15330 <para>The Koha to MARC Mapping page offers you the option of choosing
15331 from one of three tables in the database to assign values to.</para>
15334 <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
15338 <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
15343 <para>After choosing the table you would like to view, click 'OK.' To
15344 edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
15347 <screeninfo>Map MARC Field to Koha Field</screeninfo>
15351 <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
15356 <para>Choose which MARC field you would like to map to this Koha Field
15357 and click the 'OK' button. If you would like to clear all mappings,
15358 click the 'Click to "Unmap"' button.</para>
15361 <para>At this time you can map only 1 MARC field to 1 Koha field.
15362 This means that you won't be able to map both the 100a and the 700a
15363 to the author field, you need to choose one or the other.</para>
15369 <section id="keywordmapping">
15370 <title>Keywords to MARC Mapping</title>
15372 <para>This tool will allow you to map MARC fields to a set of
15373 predefined keywords.</para>
15377 <para><emphasis>Get there:</emphasis> More > Administration
15378 > Catalog > Keywords to MARC Mapping</para>
15383 <para>This tool only effects sites that are not using the XSLT
15384 Stylesheets.</para>
15387 <para>At this time the only keyword in use is 'subtitle.'</para>
15389 <para>Using this tool you can define what MARC field prints to the
15390 detail screen of the bibliographic record using keywords. The
15391 following example will use the subtitle field.</para>
15393 <para>Using the Framework pull down menu, choose the <link
15394 linkend="marcbibframeworks">Framework</link> you would like to apply
15395 this rule to. For example, the subtitle for books can be found in the
15396 245$b field.</para>
15399 <screeninfo>Assigning Book Subtitle</screeninfo>
15403 <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
15408 <para>However the subtitle for DVDs appears in 245$p</para>
15411 <screeninfo>Assigning DVD Subtitle</screeninfo>
15415 <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
15420 <para>Using this tool you can tell Koha to print the right field as
15421 the subtitle when viewing the bibliographic record in the OPAC.</para>
15424 <screeninfo>Subtitle display in the OPAC</screeninfo>
15428 <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
15433 <para>This tool can be used to chain together pieces of the record as
15434 well. If you want the series number to show in the title on your
15435 search results you simply have to map 490 $v to 'subtitle' along with
15437 <para>Chain together the fields you want to show after the item
15438 title in the order in which you want them to appear.</para>
15441 <para>Future developments will include additional keyword assigned
15445 <section id="marcbibframeworkstest">
15446 <title>MARC Bibliographic Framework Test</title>
15448 <para>Checks the MARC structure.</para>
15452 <para><emphasis>Get there:</emphasis> More > Administration
15453 > Catalog > MARC Bibliographic Framework Test</para>
15457 <para>If you change your MARC Bibliographic framework it's recommended
15458 that you run this tool to test for errors in your definition.</para>
15461 <screeninfo>Framework Test</screeninfo>
15465 <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
15471 <section id="authoritiesadmin">
15472 <title>Authority Types</title>
15474 <para>Authority Types are basically MARC Frameworks for Authority
15475 records and because of that they follow the same editing rules found
15476 in the <link linkend="marcbibframeworks">MARC Bibliographic
15477 Frameworks</link> section of this manual. Koha comes with many of the
15478 necessary Authority frameworks already installed. To learn how to add
15479 and edit Authority Types, simply review the <link
15480 linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
15481 section of this manual.</para>
15485 <para><emphasis>Get there:</emphasis> More > Administration
15486 > Catalog > Authority Types</para>
15491 <section id="classificationsources">
15494 <firstname id="classsourceauthor">Savitra</firstname>
15496 <surname>Sirohi</surname>
15499 <orgname>Nucsoft OSS Labs</orgname>
15503 <pubdate id="classsourcepubdate">August 2010</pubdate>
15505 <othercredit id="classsourceeditor" role="copyeditor">
15506 <firstname>Nicole C.</firstname>
15508 <surname>Engard</surname>
15510 <contrib id="classsourcecredit">Fixed typos, changed content where
15511 necessary and added new screenshots.</contrib>
15515 <title>Classification Sources</title>
15517 <para>Source of classification or shelving scheme is an <link
15518 linkend="authorizedvalues">Authorized Values</link> category that is
15519 mapped to field 942$2 in Koha's MARC Bibliographic frameworks.</para>
15523 <para><emphasis>Get there:</emphasis> More > Administration
15524 > Catalog > Classification sources</para>
15529 <screeninfo>Classification Sources</screeninfo>
15533 <imagedata fileref="images/admin/cataloging/classsources.png"/>
15538 <para>Commonly used values of this field are:</para>
15542 <para>ddc - Dewey Decimal Classification</para>
15546 <para>lcc - Library of Congress Classification</para>
15550 <para>If you chose to install classification sources during Koha's
15551 installation, you would see other values too:</para>
15555 <para>ANSCR (sound recordings)</para>
15559 <para>SuDOC classification</para>
15563 <para>Universal Decimal Classification</para>
15567 <para>Other/Generic Classification</para>
15571 <section id="addingclasssource">
15572 <title>Adding/Editing Classification Sources</title>
15574 <para>You can add your own source of classification by using the New
15575 Classification Source button. To edit use the Edit link.</para>
15578 <screeninfo>Add classification source</screeninfo>
15582 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
15587 <para>When creating or editing:</para>
15591 <para>You will need to enter a code and a description.</para>
15595 <para>Check the 'Source in use?' checkbox if you want the value
15596 to appear in the drop down list for this category.</para>
15600 <para>Select the appropriate <link
15601 linkend="classfilingrules">filing rule</link> from the drop down
15609 <section id="classfilingrules">
15610 <title>Classification Filing Rules</title>
15612 <para>Filing rules determine the order in which items are placed on
15615 <para>Values that are pre-configured in Koha are:</para>
15627 <para>Generic</para>
15631 <para>Filing rules are mapped to <link
15632 linkend="addingclasssource">Classification sources</link>. You can
15633 setup new filing rules by using the New Filing Rule button. To edit
15634 use the Edit link.</para>
15636 <para>When creating or editing:</para>
15640 <para>Enter a code and a description</para>
15644 <para>Choose an appropriate filing routine - dewey, generic or
15651 <section id="recordmatchingrules">
15652 <title>Record Matching Rules</title>
15654 <para>Record matching rules are used when importing MARC records into
15659 <para><emphasis>Get there:</emphasis> More > Administration
15660 > Catalog > Record Matching Rules</para>
15664 <para>The rules that you set up here will be referenced with you <link
15665 linkend="stagemarc">Stage MARC Records for Import</link>.</para>
15667 <para>To create a new matching rule :</para>
15671 <para>Click 'New Record Matching Rule'</para>
15674 <screeninfo>Add record matching rule</screeninfo>
15678 <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
15685 <para>Choose a unique name and enter it in the 'Matching rule
15690 <para>'Description' can be anything you want to make it clear
15691 to you what rule you're picking</para>
15695 <para>'Match threshold' - The total number of 'points' a
15696 biblio must earn to be considered a 'match'</para>
15700 <para>Match points are set up to determine what fields to
15705 <para>'Search index' can be found by looking at the
15706 ccl.properties file on your system which tells the zebra
15707 indexing what data to search for in the MARC data".</para>
15711 <para>'Score' - The number of 'points' a match on this field
15712 is worth. If the sum of each score is greater than the match
15713 threshold, the incoming record is a match to the existing
15718 <para>Enter the MARC tag you want to match on in the 'Tag'
15723 <para>Enter the MARC tag subfield you want to match on in the
15724 'Subfields' field</para>
15728 <para>'Offset' - For use with control fields, 001-009</para>
15732 <para>'Length' - For use with control fields, 001-009</para>
15736 <para>Koha only has one 'Normalization rule' that removes
15737 extra characters such as commas and semicolons. The value you
15738 enter in this field is irrelevant to the normalization
15743 <para>'Required match checks' - ??</para>
15751 <section id="samplerecordmatch">
15752 <title>Sample Record Matching Rule: Control Number</title>
15755 <screeninfo>LOC Matching Rule</screeninfo>
15759 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
15766 <para>Match threshold: 100</para>
15770 <para>Matchpoints (just the one):</para>
15774 <para>Search index: Control-number</para>
15778 <para>Score: 101</para>
15782 <para>Tag: 001</para>
15787 <para>this field is for the control number assigned by the
15788 organization creating, using, or distributing the
15796 <para>Subfields: a</para>
15800 <para>Offset: 0</para>
15804 <para>Length: 0</para>
15808 <para>Normalization rule: Control-number</para>
15812 <para>Required Match checks: none (remove the blank one)</para>
15815 <screeninfo>Remove match check</screeninfo>
15819 <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
15828 <section id="oaisetsconfig">
15829 <title>OAI Sets Configuration</title>
15831 <para>On this page you can create, modify and delete OAI-PMH
15834 <section id="oaicreate">
15835 <title>Create a set</title>
15837 <para>To create a set:</para>
15841 <para>Click on the link 'Add a new set'</para>
15845 <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
15849 <para>Then you can add descriptions for this set. To do this
15850 click on 'Add description' and fill the newly created text box.
15851 You can add as many descriptions as you want.</para>
15855 <para>Click on 'Save' button'</para>
15860 <section id="oaimodify">
15861 <title>Modify/Delete a set</title>
15863 <para>To modify a set, just click on the link 'Modify' on the same
15864 line of the set you want to modify. A form similar to set creation
15865 form will appear and allow you to modify the setSpec, setName and
15866 descriptions.</para>
15868 <para>To delete a set, just click on the link 'Delete' on the same
15869 line of the set you want to delete.</para>
15872 <section id="oaimapping">
15873 <title>Define mappings</title>
15875 <para>Here you can define how a set will be build (what records will
15876 belong to this set) by defining mappings. Mappings are a list of
15877 conditions on record content. A record only need to match one
15878 condition to belong to the set.</para>
15882 <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
15883 example if you want to include in this set all records that have
15884 a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
15885 and 'Value' with XXX.</para>
15889 <para>If you want to add another condition, click on 'OR' button
15890 and repeat step 1.</para>
15894 <para>Click on 'Save'</para>
15898 <para>To delete a condition, just leave at least one of 'Field',
15899 'Subfield' or 'Value' empty and click on 'Save'.<note>
15900 <para>Actually, a condition is true if value in the
15901 corresponding subfield is strictly equal to what is defined if
15902 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
15903 set where condition is 999$9 = 'XXX'.</para>
15906 <para>And it is case sensitive : a record having 999$9 = 'xxx' will
15907 not belong to a set where condition is 999$9 = 'XXX'.</para>
15910 <section id="oaibuild">
15911 <title>Build sets</title>
15913 <para>Once you have configured all your sets, you have to build the
15914 sets. This is done by calling the script
15915 misc/migration_tools/build_oai_sets.pl.</para>
15920 <section id="acqadmin">
15921 <title>Acquisitions</title>
15925 <para><emphasis>Get there:</emphasis> More > Administration >
15926 Acquisitions</para>
15930 <section id="currexchangeadmin">
15931 <title>Currencies and Exchange Rates</title>
15933 <para>If you place orders from more than one country you will want to
15934 input currency exchange rates so that your acquisitions module will
15935 properly calculate totals.</para>
15939 <para><emphasis>Get there:</emphasis> More > Administration
15940 > Acquisitions > Currencies and Exchange Rates</para>
15945 <screeninfo>Currencies</screeninfo>
15949 <imagedata fileref="images/admin/acquisitions/currencies.png"/>
15955 <para>This data is not automatically updated, so be sure to keep it
15956 up to date so that your accounting is kept correct.</para>
15959 <para>The active currency is the main currency you use in your
15960 library. Your active currency will have a check mark in the 'Active'
15961 column. If you don't have an active currency you will see an error
15962 message telling you to choose an active currency.</para>
15965 <screeninfo>No active currency warning</screeninfo>
15969 <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
15975 <section id="budgetplanning">
15976 <title>Budgets</title>
15978 <para>Budgets are the top level used for tracking accounting values
15979 related to acquisitions.</para>
15983 <para><emphasis>Get there:</emphasis> More > Administration
15984 > Acquisitions > Budgets</para>
15988 <para>An example would be to create a budget for the current year and
15989 then breaking that into Funds for different areas of the
15992 <section id="addbudget">
15993 <title>Add a budget</title>
15995 <para>Budgets can either be created from scratch or by duplicating
15996 the previous year's budget.</para>
15998 <para>To duplicate a budget from a previous year, click on the link
15999 for the budget name from the list of budgets</para>
16002 <screeninfo>Budgets List</screeninfo>
16006 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
16011 <para>On the screen listing the budget breakdown click the Edit
16012 button at the top and choose to Duplicate budget</para>
16015 <screeninfo>Duplicate Budget</screeninfo>
16019 <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
16024 <para>You will be presented with a form where you simply need to
16025 enter the new start and end date and save the budget.</para>
16028 <screeninfo>New Duplicate Budget</screeninfo>
16032 <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
16037 <para>This will not only duplicate your budget, but all of the funds
16038 associated with that budget so that you can reuse budgets and funds
16039 from year to year.</para>
16041 <para>If you haven't used Koha before for acquisitions then you'll
16042 need to start fresh with a new budget. To add a new budget click the
16043 'New Budget' button.</para>
16046 <screeninfo>New Budget Form</screeninfo>
16050 <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
16057 <para>Choose the time period this budget is for, whether it's an
16058 academic year, a fiscal year, a quarter, etc.</para>
16062 <para>The Description should be something that will help you
16063 identify the budget when ordering</para>
16067 <para>In the amount box do not use any symbols, simply enter the
16068 amount of the budget with numbers and decimals.</para>
16072 <para>Marking a budget active makes it usable when placing
16073 orders in the acquisitions module, even if the order is placed
16074 after the budget end date. This will allow you to record orders
16075 that were places in a previous budget period.</para>
16079 <para>Locking a budget means that Funds will not be able to be
16080 modified by librarians</para>
16084 <para>Once you have made your edits, click the 'Save Changes'
16085 button. You will be brought to a list of your existing
16089 <screeninfo>List of Budgets</screeninfo>
16093 <imagedata fileref="images/admin/acquisitions/budgetlist.png"/>
16100 <section id="funds">
16101 <title>Funds</title>
16105 <para><emphasis>Get there:</emphasis> More > Administration
16106 > Acquisitions > Funds</para>
16110 <section id="addbudgetfund">
16111 <title>Add a Fund</title>
16113 <para>A fund is added to a budget.</para>
16116 <para>A <link linkend="addbudget">budget</link> must be defined
16117 before a fund can be created.</para>
16118 </important>To add a new fund click the New button and then choose
16119 which Budget you would like to add the fund to.</para>
16122 <screeninfo>Choose which budget to add a fund to</screeninfo>
16126 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
16131 <para>In the form that appears you wan to enter the basics about
16135 <screeninfo>New Fund Form</screeninfo>
16139 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
16144 <para>The three first fields are required, the rest are
16149 <para>Fund Code is a unique identifier for your fund</para>
16153 <para>The Fund Name should be something that librarians will
16158 <para>Amount should be entered with only numbers and decimals,
16159 no other characters</para>
16163 <para><emphasis>Encumbrance ??</emphasis></para>
16167 <para><emphasis>Expenditure ??</emphasis></para>
16171 <para>You can choose to assign this fund to a librarian. Doing
16172 so will make it so that only that librarian can make changes to
16177 <para>Choose which library will be using this fund</para>
16181 <para>You can restrict who can order from this fund by choosing
16182 either the owner or the library from the 'Restrict access to'
16186 <screeninfo>Restrict Fund Access</screeninfo>
16190 <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
16197 <para>Notes are simply for any descriptive notes you might want
16198 to add so that librarians know when to use this fund</para>
16202 <para>Planning categories are used for statistical purposes. To
16203 learn more about planning categories, check out the <link
16204 linkend="planningcatfaq">Planning Category FAQ</link>.</para>
16208 <para>When complete, click 'Submit' and you will be brought to a
16209 list of all of the funds for the budget.</para>
16212 <screeninfo>List of funds</screeninfo>
16216 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
16221 <para>To the right of each fund you will find the 'Edit,' 'Delete,'
16222 and 'Add Child Fund' options. A child fund simply a sub-fund of the
16223 fund listed. An example would be to have a fund for 'Fiction' and
16224 under that have a fund for 'New Releases' and a fund for 'Science
16225 Fiction.' It is an optional way to further organize your
16229 <section id="fundsplanning">
16230 <title>Budget Planning</title>
16232 <para>When viewing the list of funds click the 'Planning' button and
16233 choose how you would like to plan to spend your budget.</para>
16236 <screeninfo>Planning pull down menu</screeninfo>
16240 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
16245 <para>If you choose 'Plan by MONTHS' you will see the budgeted
16246 amount broken down by months:</para>
16249 <screeninfo>Budget Planning Formula</screeninfo>
16253 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
16258 <para>To hide some of the columns you can click the minus sign (-)
16259 to the right (or below as in the screenshot above) the dates. To add
16260 more columns you can click the 'Show a column' link found below the
16261 'Fund Remaining' heading.</para>
16264 <screeninfo>Choose columns to add</screeninfo>
16268 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
16273 <para>From here you can plan your budget spending by manually
16274 entering values or by clicking the 'Auto-fill row' button. If you
16275 choose to auto-fill the form the system will try to divide the
16276 amount accordingly, you may have to make some edits to split things
16277 more accurately.</para>
16280 <screeninfo>Auto-filled columns</screeninfo>
16284 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
16289 <para>Once your changes are made, click the 'Save' button. If you
16290 would like to export your data as a CSV file you can do so by
16291 entering a file name in the 'Output to a file named' field and
16292 clicking the 'Output' button.</para>
16295 <screeninfo>Export planning as CSV</screeninfo>
16299 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
16307 <section id="additionaladmin">
16308 <title>Additional Parameters</title>
16312 <para><emphasis>Get there:</emphasis> More > Administration >
16313 Additional Parameters</para>
16317 <section id="stopwordsadmin">
16318 <title>Stop Words</title>
16321 <para>If NoZebra is set to 'Use' this option will not appear on the
16322 administration menu</para>
16325 <para>Stop words are words that you want the search system to
16330 <para>>Get there: More > Administration > Additional
16331 Parameters > Stop Words</para>
16335 <para>Koha comes with a standard list of stop words that can be edited
16336 by visiting the Stop Word administration area.</para>
16339 <screeninfo>Stop word list</screeninfo>
16343 <imagedata fileref="images/admin/additional/stopwords.png"/>
16348 <para>To add a new stop word to the list, click the 'New Stop Word'
16349 button and add the word you'd like ignored</para>
16352 <screeninfo>New stop word</screeninfo>
16356 <imagedata fileref="images/admin/additional/newstop.png"/>
16362 <para>If you change something in this table, ask your administrator
16363 to run misc/batchRebuildBiblioTables.pl script.</para>
16367 <section id="z3950admin">
16368 <title>Z39.50 Servers</title>
16370 <para>Koha has a powerful copy cataloging tool. Using Koha you can
16371 connect to any Z39.50 target that is publicly available or that you
16372 have the log in information to.</para>
16376 <para><emphasis>Get there:</emphasis> More > Administration
16377 > Additional Parameters > Z39.50 Servers</para>
16381 <para>Koha comes with a default list of Z39.50 targets set up that you
16382 can add to, edit or delete</para>
16385 <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
16389 <imagedata fileref="images/admin/additional/z39list.png"/>
16394 <para>To find additional targets you use IndexData's IRSpy: <ulink
16395 url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink></para>
16397 <section id="addztarget">
16398 <title>Add a Z39.50 Target</title>
16402 <para>From the main Z39.50 page, click 'New Z39.50
16407 <para>Userid and Password are only required for servers that
16408 are password protected</para>
16413 <screeninfo>New Z39.50 Server Form</screeninfo>
16417 <imagedata fileref="images/admin/additional/newz39.png"/>
16425 <section id="suggestztarget">
16426 <title>Suggested Z39.50 Targets</title>
16428 <para>The following targets have been used successfully by other
16429 Koha libraries (in the Americas):</para>
16433 <para>BIBLIOS z3950.biblios.net:210 bibliographic</para>
16437 <para>BIG COUNTRY KOHA bcls.kohalibrary.com:210 bcls_koha</para>
16441 <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
16446 <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
16450 <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
16455 <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
16459 <para>LIBRARY OF CONGRESS z3950.loc.gov:7090 Voyager</para>
16463 <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
16468 <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
16472 <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
16476 <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210
16481 <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
16486 <para>TRI-UNI 129.97.129.194:7090 voyager</para>
16490 <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
16498 <chapter id="tools">
16499 <title>Tools</title>
16501 <para>Tools in Koha all perform some sort of action. Often many of the
16502 items listed under Tools in Koha are referred to as 'Reports' in other
16503 library management systems.</para>
16507 <para><emphasis>Get there:</emphasis> More > Tools</para>
16511 <section id="patrontools">
16512 <title>Patrons and Circulation</title>
16516 <section id="comments">
16517 <title>Comments</title>
16521 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16522 and Circulation > Comments</para>
16526 <para>All comments added by patrons via the OPAC to bibliographic
16527 records require moderation by the librarians. If there are comments
16528 awaiting moderation they will be listed on the main staff dashboard
16529 under the Tools label:</para>
16532 <screeninfo>Comments pending approval</screeninfo>
16536 <imagedata fileref="images/tools/comments/commentswaiting.png"/>
16541 <para>To moderate comments click on the notification on the main
16542 dashboard or go directly to the Comments Tool and click 'Approve' or
16543 'Delete' to the right of the comments awaiting moderation.</para>
16546 <screeninfo>Comment awaiting moderation</screeninfo>
16550 <imagedata fileref="images/tools/comments/commentmoderation.png"/>
16555 <para>If there are no comments to moderate you will see a message
16556 saying just that</para>
16559 <screeninfo>No comments to moderate</screeninfo>
16563 <imagedata fileref="images/tools/comments/nocomments.png"/>
16568 <para>You can also review and unapprove comments you have approved in
16569 the past by choosing the 'Approved comments' tab</para>
16572 <screeninfo>Approved comments</screeninfo>
16576 <imagedata fileref="images/tools/comments/commentapproved.png"/>
16582 <section id="patronimport">
16583 <title>Patron Import</title>
16587 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16588 and Circulation > Import Patrons</para>
16592 <para>The patron import tool can be used at any time to add patrons in
16593 bulk. It is commonly used in universities and schools when a new batch
16594 of students registers.</para>
16596 <section id="createpatronfile">
16597 <title>Creating Patron File</title>
16599 <para>Your Koha installation comes with a blank CSV file that you
16600 can use as a template for your patron records. If you would like to
16601 create the file yourself, make sure that your file has the following
16602 fields in this order as the header row:</para>
16604 <para>borrowernumber, cardnumber, surname, firstname, title,
16605 othernames, initials, streetnumber, streettype, address, address2,
16606 city, zipcode, country, email, phone, mobile, fax, emailpro,
16607 phonepro, B_streetnumber, B_streettype, B_address, B_address2,
16608 B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth,
16609 branchcode, categorycode, dateenrolled, dateexpiry, gonenoaddress,
16610 lost, debarred, contactname, contactfirstname, contacttitle,
16611 guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
16612 password, flags, userid, opacnote, contactnote, sort1, sort2,
16613 altcontactfirstname, altcontactsurname, altcontactaddress1,
16614 altcontactaddress2, altcontactaddress3, altcontactzipcode,
16615 altcontactcountry, altcontactphone, smsalertnumber,
16616 patron_attributes</para>
16619 <para>The 'password' value should be stored in plain text, and
16620 will be converted to a md5 hash (which is an encrypted version of
16621 the password).</para>
16625 <para>If your passwords are already encrypted, talk to your
16626 systems administrator about options</para>
16632 <para>Date formats should match your <link
16633 linkend="dateformat">system preference</link>, and must be
16634 zero-padded, e.g. '01/02/2008'.</para>
16638 <para>The fields 'branchcode' and 'categorycode' are required and
16639 must match valid entries in your database.</para>
16643 <para>If loading <link linkend="patronattributetypes">patron
16644 attributes</link>, the 'patron_attributes' field should contain a
16645 comma-separated list of attribute types and values.</para>
16649 <para>The attribute type code and a colon should precede each
16654 <para>For example: <emphasis
16655 role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis
16656 role="bold">STARTDATE:January 1
16657 2010,TRACK:Day</emphasis></para>
16661 <para>If an input record has more than one attribute, the
16662 fields should either be entered as an unquoted string
16663 (previous examples), or with each field wrapped in
16664 separate double quotes and delimited by a comma:</para>
16668 <para><emphasis role="bold">"STARTDATE:January 1,
16669 2010","TRACK:Day"</emphasis></para>
16673 <para>This syntax would be required if the data might
16674 have a comma in it, like a date string.</para>
16684 <section id="importpatrons">
16685 <title>Importing Patrons</title>
16687 <para>Once you have created your file, you can use the Patron Import
16688 Tool to bring the data into Koha.</para>
16691 <screeninfo>Import Patron Form</screeninfo>
16695 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
16702 <para>Choose your CSV file and choose to match on 'Cardnumber'
16703 to prevent adding of duplicate card numbers to the system</para>
16707 <para>Next you can choose default values to apply to all patrons
16708 you are importing</para>
16712 <para>ex. If you're importing patrons specific to one branch
16713 you can use the field on the Import form to apply the branch
16714 code to all those you are importing.</para>
16720 <para>Finally you need to decide on what data you want to
16721 replace if there are duplicates.</para>
16724 <screeninfo>Record matching options</screeninfo>
16728 <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
16735 <para>A matching record is found using the field you chose
16736 for matching criteria to prevent duplication</para>
16740 <para>If you included patron attributes in your file you can
16741 decide whether to add your values to existing values or
16742 erase existing values and enter only your new values.</para>
16750 <section id="notices">
16751 <title>Notices & Slips</title>
16755 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16756 and Circulation > Notices & Slips</para>
16760 <para>All notices and circulation receipts (or slips) generated by
16761 Koha can be customized using the Notices & Slips Tool. The system
16762 comes with several predefined templates that will appear when you
16763 first visit this tool.</para>
16766 <screeninfo>Notices & Slips Tool</screeninfo>
16770 <imagedata fileref="images/tools/notices/notices.png"/>
16775 <para>Each notice can be edited, but only a few can be deleted, this
16776 is to prevent system errors should a message try to send without a
16777 template. Each notice and slip can be edited on a per library basis,
16778 by default you will see the notices for all libraries.</para>
16780 <para>If you have a style you'd like applied to all slips you can
16781 point the <link linkend="SlipCSS">SlipCSS</link> preference to a
16782 stylesheet. The same is true for notices, using the <link
16783 linkend="NoticeCSS">NoticeCSS</link> preference to define a
16786 <section id="addnotices">
16787 <title>Adding Notices & Slips</title>
16789 <para>To add a new notice or slip</para>
16793 <para>Click 'New Notice'</para>
16796 <screeninfo>New Notice Form</screeninfo>
16800 <imagedata fileref="images/tools/notices/newnotice.png"/>
16807 <para>Choose which library this notice or slip is for</para>
16811 <para>Choose the module this notice is related to</para>
16815 <para>The Code is limited to 20 characters</para>
16820 <para>When working with the overdue notices you want each
16821 notice at each branch to have a unique code. Think about
16822 using the branch code in front of the notice code for each
16830 <para>Use the name field to expand on your Code</para>
16835 <para>With overdue notices, be sure to put your branch
16836 name in the description as well so that it will be visible
16837 when setting up your <link
16838 linkend="noticetriggers">triggers</link>.</para>
16845 <para>If you plan on writing the notice or slip in HTML check
16846 the 'HTML Message' box, otherwise the content will be generated
16847 as plain text</para>
16851 <para>Message Subject is what will appear in the subject line of
16856 <para>In the message body feel free to type whatever message you
16857 feel is best, use the fields on the left hand side to enter
16858 individualized data from the from database.</para>
16863 <para>Overdue notices can use
16864 <<items.content>> tags by themselves, or use
16865 <item></item> to span all of the tags. Learn
16866 more about the <link linkend="noticemarkup">Overdue Notice
16867 Markup</link></para>
16871 <para>On overdue notices make sure to use
16872 <<items.content>> tags to print out the
16873 data related to all items that are overdue.</para>
16879 <para>The other option, only for overdue notices, is
16880 to use the <item></item> tags to span the
16881 line so that it will print out multiple lines One
16882 example for the <item></item> tag option
16885 <para><item>"<<biblio.title>>" by
16886 <<biblio.author>>,
16887 <<items.itemcallnumber>>, Barcode:
16888 <<items.barcode>> , Checkout date:
16889 <<issues.issuedate>>, Due date:
16890 <<issues.date_due>> Fine:
16891 <fine>USD</fine> Due date:
16892 <<issues.date_due>> </item></para>
16900 <para>Only the overdue notices take advantage of the
16901 <item></item> tags, all other notices
16902 referencing items need to use
16903 <<items.content>></para>
16910 <section id="noticemarkup">
16911 <title>Overdue Notice Markup</title>
16913 <para>When creating your overdue notices there are two tags in
16914 addition to the various database fields that you can use in your
16915 notices.<important>
16916 <para>These new tags only work on the overdue notices, not
16917 other circulation related notices at this time.</para>
16918 </important></para>
16922 <para><item></item> which should enclose all
16923 fields from the biblio, biblioitems, and items tables.</para>
16927 <para><fine></fine> which should be enclosed by
16928 the item tag and should enclose a currency identifier per ISO
16929 4217. If this tag is present with a proper identifier, the
16930 fine for that item will be displayed in the proper currency
16935 <para>Note: ISO 4217 changes from time to time therefore
16936 all currencies may not be supported. If you find one that
16937 is not supported, please file a bug with the
16938 Locale::Currency::Format author Tan D Nguyen <tnguyen
16939 at cpan doe org>.</para>
16945 <para>An example of using these two tags in a notice template
16946 might be like:</para>
16948 <programlisting> The following item(s) is/are currently overdue:
16950 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item></programlisting>
16952 <para>Which, assuming two items were overdue, would result in a
16953 notice like:<programlisting> The following item(s) is/are currently overdue:
16955 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
16956 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</programlisting></para>
16960 <section id="existingnotices">
16961 <title>Existing Notices & Slips</title>
16963 <para>Among the default notices are notices for several common
16964 actions within Koha. All of these notices can be customized by
16965 altering their text via the Notices & Slips tool and their style
16966 using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
16967 define a stylesheet. Here are some of what those notices do</para>
16971 <para id="ACCTDETAILS">ACCTDETAILS</para>
16975 <para>Sent to patrons when their account is set up if the
16976 <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
16977 preference is set to 'Send'</para>
16983 <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
16987 <para>Used in the claim acquisition module</para>
16991 <para><emphasis>Get there:</emphasis> More > Acquisitions
16992 > Late issues</para>
16998 <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
17002 <para>This notice is used if two criteria are met:</para>
17007 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
17008 is set to 'Allow'</para>
17012 <para>The patron has requested to receive this
17017 <para><emphasis>Get there: </emphasis>OPAC >
17018 Login > my messaging</para>
17022 <para><emphasis>Get there: </emphasis>Staff Client
17023 > Patron Record > <link
17024 linkend="patnotices">Notices</link></para>
17032 <para>When this notice references the branches table it is
17033 referring to the pickup branch information.</para>
17039 <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
17040 that a hold has been placed)</para>
17044 <para>This notice requires the <link
17045 linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
17046 system preference to be set to 'Enable'</para>
17050 <para>When this notice references the branches table it is
17051 referring to the pickup branch information.</para>
17057 <para id="HOLD_PRINT">HOLD_PRINT (Printed notice when hold
17058 available for pickup)</para>
17062 <para>This notice is used for hold confirmation notices that
17063 are sent out in print format. This will not effect what the
17064 email notice looks like.</para>
17068 <para>When this notice references the branches table it is
17069 referring to the pickup branch information.</para>
17075 <para id="ODUE">ODUE (Overdue Notice)</para>
17079 <para>This notice is used to send Overdue Notices to
17084 <para>See a <link linkend="samplenotice">Sample Overdue
17085 Notice</link></para>
17089 <para>Requires that you set <link
17090 linkend="noticetriggers">Overdue Notice/Status
17091 Triggers</link></para>
17097 <para id="RLIST">RLIST (Routing List)</para>
17101 <para>Used in the serials module to notify patrons/staff of
17102 new issues of a serial</para>
17106 <para><emphasis>Get there:</emphasis> More > Serials
17107 > <link linkend="newsubscription">New
17108 Subscription</link></para>
17114 <para>You have the option to select the 'Routing List'
17115 notice when creating a new subscription (Choose from the
17116 'Patron notification' drop down).</para>
17121 <para>Notice also that if you'd like to notify patrons of
17122 new serial issues, you can click on 'define a notice'
17123 which will take you to the 'Notices' tool</para>
17130 <para>There are also a set of predefined slips (or receipts) listed
17131 on this page. All of these slips can be customized by altering their
17132 text via the Notices & Slips tool and their style using the
17133 <link linkend="SlipCSS">SlipCSS</link> preference to define a
17134 stylesheet. Here is what those slips are used for:</para>
17138 <para>ISSUEQSLIP</para>
17142 <para>Used to print the quick slip in circulation</para>
17146 <para>The quick slip only includes items that were checked
17153 <para>ISSUESLIP</para>
17157 <para>Used to print a full slip in circulation</para>
17161 <para>The slip or receipt will show items checked out today
17162 as well as items that are still checked out</para>
17168 <para>RESERVESLIP</para>
17172 <para>Used to print a holds slip</para>
17176 <para>The holds slip is generated when a hold is
17183 <para>TRANSFERSLIP</para>
17187 <para>Used to print a transfer slip</para>
17191 <para>The transfer slip is printed when you confirm a
17192 transfer from one branch to another in your system</para>
17200 <section id="noticetriggers">
17201 <title>Overdue Notice/Status Triggers</title>
17205 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17206 and Circulation > Overdue Notice/Status Triggers</para>
17210 <para>In order to send the overdue notices that you defined using the
17211 <link linkend="notices">Notices</link> tool, you need to first set the
17212 triggers to have these messages.</para>
17215 <para>In order to have overdue notices sent to your patrons, you
17216 need to <link linkend="addingpatroncat">set that patron
17217 category</link> to require overdue notices.</para>
17220 <para>The Overdue Notice/Status Triggers tool gives the librarian the
17221 power to send up to three notices to each patron type notifying them
17222 of overdue items</para>
17225 <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
17229 <imagedata fileref="images/tools/triggers.png"/>
17236 <para>Delay is the number of days after an issue is due before an
17237 action is triggered.</para>
17242 <para>If you want Koha to trigger an action (send a letter
17243 or restrict member), a delay value is required.</para>
17250 <para>To send additional notices, click on the tabs for 'Second'
17251 and 'Third' notice</para>
17255 <para>If you would like to prevent a patron from checking items
17256 out because of their overdue items, check the 'Restrict' box, this
17257 will put a notice on the patron's record at checkout informing the
17258 librarian that the patron cannot check out due to overdue
17263 <para>See a <link linkend="samplenotice">Sample Overdue
17264 Notice</link></para>
17269 <section id="patroncardcreator">
17270 <title>Patron Card Creator</title>
17274 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17275 and Circulation > Patron Card Creator</para>
17279 <para>The Patron Card Creator allow you to use layouts and templates
17280 which you design to print a nearly unlimited variety of patron cards
17281 including barcodes. Here are some of the features of the Patron Card
17282 Creator module:</para>
17286 <para>Customize patron card layouts</para>
17290 <para>Design custom card templates for printed patron cards</para>
17294 <para>Build and manage batches of patron cards</para>
17298 <para>Export single or multiple batches</para>
17302 <para>Export single or multiple patron cards from within a
17307 <para>Export card data as a PDF readable by any standard PDF
17308 reader, making patron cards printable directly on a printer</para>
17312 <para>At the top of each screen within the Patron Card Creator, you
17313 will see a toolbar allowing quick access to relevant functions. The
17314 menu to the left of each screen also allows easy access to the
17315 different sections of the Patron Card Creator. The bread crumb trail
17316 near the top of each screen will give specific indication as to where
17317 you are within the Patron Card Creator module and allow quick
17318 navigation to previously traversed sections. And finally, you can find
17319 more detailed information on each section of the Patron Card Creator
17320 by clicking the online help link at the upper left-hand corner of
17323 <section id="patrontemplate">
17324 <title>Templates</title>
17328 <para><emphasis>Get there:</emphasis> More > Tools >
17329 Patron Card Creator > Templates</para>
17333 <para>A template is the label/card stock you are using. This might
17334 be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
17335 Avery 28371 for your patron cards, just to give a couple of
17336 examples. These labels will include all of the information you will
17337 need for setting up a Koha, this information may be on the
17338 packaging, and if not it can usually be found on the vendor's
17341 <section id="addcardtemplate">
17342 <title>Add a Template</title>
17344 <para>To add a new template, you want to click on the 'Templates'
17345 button at the top of your page and choose 'New Template'</para>
17348 <screeninfo>New Template Button</screeninfo>
17352 <imagedata fileref="images/tools/patroncards/newtemplate.png"/>
17357 <para>Using the form that appears you can define the template for
17358 your sheet of labels or cards.</para>
17361 <screeninfo>Add Patron Card Template</screeninfo>
17365 <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
17372 <para>Template ID will be automatically generated after saving
17373 your template, this is simply a system generated unique
17378 <para>Template Code should be something you can use to
17379 identify your template on a list of templates</para>
17383 <para>You can use the Template Description to add additional
17384 information about the template</para>
17388 <para>The Units pull down is used to define what measurement
17389 scale you're going to be using for the template. This should
17390 probably match the unit of measurement used on the template
17391 description provided by the product vendor.</para>
17394 <screeninfo>Measurement Units</screeninfo>
17398 <imagedata fileref="images/tools/patroncards/units.png"/>
17405 <para>The measurements can be found on the vendor product
17406 packaging or website.</para>
17410 <para>A profile is a set of "adjustments" applied to a given
17411 template just prior to printing which compensates for
17412 anomalies unique and peculiar to a given printer (to which the
17413 profile is assigned).</para>
17417 <para>Before picking a profile try printing some sample
17418 cards so that you can easily define a profile that is
17419 right for your printer/template combination.</para>
17423 <para>After finding any anomalies in the printed document,
17424 <link linkend="addcardprofile">create a profile</link> and
17425 assign it to the template.</para>
17431 <para>After saving, your templates will appear on the 'Manage
17432 Templates' page.</para>
17435 <screeninfo>Manage Templates</screeninfo>
17439 <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
17446 <section id="patronprofile">
17447 <title>Profiles</title>
17451 <para><emphasis>Get there:</emphasis> More > Tools >
17452 Patron Card Creator > Profiles</para>
17456 <para>A profile is a set of "adjustments" applied to a given <link
17457 linkend="patrontemplate">template</link> just prior to printing
17458 which compensates for anomalies unique and peculiar to a given
17459 printer (to which the profile is assigned). This means if you set a
17460 template up and then print a sample set of data and find that the
17461 items are not all aligned the same on each card, you need to set up
17462 a profile for each printer to make up for the differences in
17463 printing styles, such as the shifting of text to the left, right,
17464 top or bottom.</para>
17466 <para>If your cards are printing just the way you want, you will not
17467 need a profile.</para>
17469 <section id="addcardprofile">
17470 <title>Add a Profile</title>
17472 <para>To add a new profile, you want to click on the 'Profiles'
17473 button at the top of your page and choose 'New Profile'</para>
17476 <screeninfo>New Profile Button</screeninfo>
17480 <imagedata fileref="images/tools/patroncards/newprofile.png"/>
17485 <para>Using the form that appears you can create a profile to fix
17486 any problems with your template.</para>
17489 <screeninfo>Add Printer Profile</screeninfo>
17493 <imagedata fileref="images/tools/patroncards/addprofile.png"/>
17500 <para>The Printer Name and Paper Bin do not have to match your
17501 printer exactly, they are for your reference so you can
17502 remember what printer you have set the profile for. So if you
17503 want to use the Printer model number in printer name or you
17504 can call it 'the printer on my desk'</para>
17508 <para>Template will be filled in once you have chosen which
17509 template to apply the profile to on the <link
17510 linkend="addcardtemplate">template edit form</link></para>
17514 <para>The Units pull down is used to define what measurement
17515 scale you're going to be using for your profile.</para>
17518 <screeninfo>Units of Measurement</screeninfo>
17522 <imagedata fileref="images/tools/patroncards/units.png"/>
17529 <para>Offset describes what happens when the entire image is
17530 off center either vertically or horizontally and creep
17531 describes a condition where the distance between the labels
17532 changes across the page or up and down the page</para>
17536 <para>For these values, negative numbers move the error up
17537 and to the left and positive numbers move the error down
17538 and to the right</para>
17542 <para>Example: the text is .25" from the left edge of the
17543 first label, .28" from the left edge of the second label
17544 and .31" from the left edge of the third label. This means
17545 the horizontal creep should be set to .03" to make up for
17546 this difference.</para>
17552 <para>After saving, your profiles will appear on the 'Manage
17553 Profiles' page.</para>
17556 <screeninfo>Manage Profiles</screeninfo>
17560 <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
17565 <para>Once you have saved your new profile, you can return to the
17566 list of templates and choose to edit the template that this
17567 profile is for.</para>
17571 <section id="cardlayouts">
17572 <title>Layouts</title>
17576 <para><emphasis>Get there:</emphasis> More > Tools >
17577 Patron Card Creator > Layouts</para>
17581 <para>A layout defines the text and images that will be printed on
17582 to the card and where it will appear.</para>
17584 <section id="addcardlayout">
17585 <title>Add a Layout</title>
17587 <para>To add a new layout, you want to click on the 'Layouts'
17588 button at the top of your page and choose 'New Layout'</para>
17591 <screeninfo>New Layout Button</screeninfo>
17595 <imagedata fileref="images/tools/patroncards/newlayout.png"/>
17600 <para>Using the form that appears you can create a profile to fix
17601 any problems with your template.</para>
17604 <screeninfo>Add New Layout</screeninfo>
17608 <imagedata fileref="images/tools/patroncards/addlayout.png"/>
17615 <para>The name you assign to the layout is for your benefit,
17616 name it something that will be easy to identify at a later
17621 <para>The Units pull down is used to define what measurement
17622 scale you're going to be using for your layout.</para>
17625 <screeninfo>Units of Measurement</screeninfo>
17629 <imagedata fileref="images/tools/patroncards/units.png"/>
17636 <para>Next note if this layout is for the front or the back of
17637 the patron card</para>
17641 <para>You will need a layout for both the front and back
17642 of your card if you have 2-sided library cards</para>
17648 <para>You have the option of adding up to 3 lines of text to
17649 your card. Your text can be static text of your choosing
17650 and/or fields from the patron record. If you want to print
17651 fields from the patron record you want to put the field names
17652 in brackets like so - <firstname></para>
17656 <para>For each line of text, you can choose your font, font
17657 size and the location of the text on the card using the lower
17658 X and Y coordinates</para>
17662 <para>In order to show the barcode and the patron card number
17663 you will need to check the 'Print Card Number as Barcode'
17664 option. This will turn the patron card number into a barcode.
17665 If you want the number to print in human readable format you
17666 will need to check the 'Print Card Number as Text Under
17667 Barcode' option.</para>
17671 <para>Finally you can choose up to two images to print on the
17676 <para>One can be the <link
17677 linkend="uploadpatronimages">patron image</link> which you
17678 can resize to meet your needs.</para>
17682 <para>The other image can be something like a library logo
17683 or symbol that you uploaded using the '<link
17684 linkend="managecardimages">Manage Images</link>' module of
17685 the Patron Card Creator Tool.</para>
17691 <para>After saving, your layouts will appear on the 'Manage
17692 Layouts' page.</para>
17695 <screeninfo>Manage Layouts</screeninfo>
17699 <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
17706 <section id="patroncardbatches">
17707 <title>Batches</title>
17711 <para><emphasis>Get there:</emphasis> More > Tools >
17712 Patron Card Creator > Batches</para>
17716 <para>A batch is a collection of patrons for whom you want to
17717 generate cards.</para>
17719 <section id="addcardbatch">
17720 <title>Add a Batch</title>
17722 <para>To add a new batch, you want to click on the 'Batches'
17723 button at the top of your page and choose 'New Batch'</para>
17726 <screeninfo>New Batch Button</screeninfo>
17730 <imagedata fileref="images/tools/patroncards/newbatch.png"/>
17739 <section id="managecardimages">
17740 <title>Manage Images</title>
17744 <para><emphasis>Get there:</emphasis> More > Tools >
17745 Patron Card Creator > Manage Images</para>
17749 <para>Images uploaded using this tool will appear on the menu when
17750 creating <link linkend="cardlayouts">patron card layouts</link>. You
17751 are limited in how many images you can upload (not counting patron
17752 images) by the <link linkend="ImageLimit">ImageLimit</link> system
17756 <para>Images must be under 500k in size.</para>
17760 <para>Pictures uploaded with this tool should be at least 300dpi
17761 which is the minimum quality for a printable image.</para>
17764 <para>In the center of the screen is a simple upload form, simply
17765 browse for the file on your computer and give it a name you'll
17766 recognize later.</para>
17769 <screeninfo>Upload Images</screeninfo>
17773 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
17778 <para>Once the file is uploaded you will be presented with a
17779 confirmation message.</para>
17782 <screeninfo>Image Uploaded</screeninfo>
17786 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
17791 <para>And the image will be listed with all of your others on the
17792 right hand side of the page.</para>
17795 <screeninfo>Images</screeninfo>
17799 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
17804 <para>To delete one or multiple of these images, click the checkbox
17805 to the right of each image you want to delete and click the 'Delete'
17810 <section id="anonpatrons">
17811 <title>Patrons (anonymize, bulk-delete)</title>
17815 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17816 and Circulation > Patrons (anonymize, bulk-delete)</para>
17820 <para>This tool allows you to bulk anonymize circulation histories
17821 (this means that you keep records of how many times items were checked
17822 out - but not the patrons who checked the items out) or bulk delete
17823 patrons (remove them from the system completely).<important>
17824 <para>Patrons with outstanding fines or items checked out are not
17825 saved. They are not completely removed from the system (moved to
17826 the delete_borrowers table), but this tool does not provide as
17827 many checks as one may desire.</para>
17828 </important></para>
17831 <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
17835 <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
17840 <para>To either delete or anonymize patrons</para>
17844 <para>Check the task you would like to perform (Delete or
17849 <para>Enter a date before which you want to alter the data</para>
17853 <para>Click 'Next'</para>
17857 <para>A confirmation will appear asking if you're sure this is
17858 what you want to happen</para>
17861 <screeninfo>Patron Anonymize/Bulk Delete
17862 Confirmation</screeninfo>
17866 <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
17873 <para>Clicking 'Finish' will delete or anonymize your data</para>
17876 <screeninfo>Completed Process</screeninfo>
17880 <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
17888 <section id="tagsmoderation">
17889 <title>Tag Moderation</title>
17893 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17894 and Circulation > Tags</para>
17898 <para>Depending on your <link linkend="taggingprefs">tagging system
17899 preferences</link>, librarians may need to approve tags before they
17900 are published on the OPAC. This is done via the Tag Moderation Tool.
17901 If there are tags awaiting moderation they will be listed on the main
17902 staff dashboard under the Tools label:</para>
17905 <screeninfo>Tags pending approval</screeninfo>
17909 <imagedata fileref="images/tools/tagging/pendingtags.png"/>
17914 <para>To moderate the tags visit the Tags tool. When first visiting
17915 the tool, you will be presented with a list of tags that are pending
17916 approval or rejection by a librarian</para>
17919 <screeninfo>Tags pending moderation</screeninfo>
17923 <imagedata fileref="images/tools/tagging/tagpending.png"/>
17930 <para>To approve a tag, you can either click the 'Approve' button
17931 in line with the term, or check all terms you want to approve and
17932 click 'Approve' below the table.</para>
17936 <para>To reject a tag, you can either click the 'Reject' button in
17937 line with the term, or check all terms you want to approve and
17938 click 'Reject' below the table.</para>
17942 <para>Once a tag has been approved or rejected it will be moved to the
17943 appropriate list of tags. A summary of all tags will appear on the
17944 right of the screen.</para>
17947 <screeninfo>Summary of tags</screeninfo>
17951 <imagedata fileref="images/tools/tagging/tagsummary.png"/>
17956 <para>Even though a tag is approved or rejected, it can still be moved
17957 to another list. When viewing approved tags each tag has the option to
17961 <screeninfo>Approved Tags</screeninfo>
17965 <imagedata fileref="images/tools/tagging/tagapproved.png"/>
17970 <para>To check terms against the approved and rejected lists (and
17971 possibly against <link linkend="TagsExternalDictionary">the
17972 dictionary</link> you have assigned for tag moderation) simply enter
17973 the term into the search box on the bottom right of the screen to see
17974 the status of the term</para>
17977 <screeninfo>Sample Blacklist/Whitelist test search</screeninfo>
17981 <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
17987 <section id="uploadpatronimages">
17988 <title>Upload Patron Images</title>
17992 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17993 and Circulation > Upload Patron Images</para>
17997 <para>Patron images can be uploaded in bulk if you are <link
17998 linkend="patronimages">allowing patron images</link> to be attached to
17999 patron records. These images can also be used when creating <link
18000 linkend="patroncardcreator">patron cards</link>.</para>
18004 <para>Create a txt file and title it "DATALINK.TXT" or
18005 "IDLINK.TXT"</para>
18009 <para>On each line in the text file enter the patron's card number
18010 followed by comma (or tab) and then the image file name</para>
18013 <screeninfo>Sample file and image</screeninfo>
18017 <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
18024 <para>Make sure that your TXT file is a plain text document,
18031 <para>Zip up the text file and the image files</para>
18035 <para>Go to the Upload Patron Images Tool</para>
18038 <screeninfo>Upload Image Tool for Single Image</screeninfo>
18042 <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
18049 <para>For a single image, simply point to the image file and enter
18050 the patron card number</para>
18054 <para>For multiple images, choose to upload a zip file</para>
18058 <para>After uploading you will be presented with a
18059 confirmation</para>
18062 <screeninfo>Image Upload Confirmation</screeninfo>
18066 <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
18074 <para>There is a limit of 520K on the size of the picture uploaded
18075 and it is recommended that the image be 200x300 pixels, but smaller
18076 images will work as well.</para>
18081 <section id="catalogtools">
18082 <title>Catalog</title>
18086 <section id="batchmodifyitems">
18087 <title>Batch item modification</title>
18091 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18092 > Batch item modification</para>
18096 <para>This tool will allow you to modify a batch of item records in
18100 <screeninfo>Batch Modification Tool</screeninfo>
18104 <imagedata fileref="images/tools/batchmod/batchmod.png"/>
18109 <para>From the tool you can choose to upload a file of barcodes or
18110 item ids, or you can scan items one by one into the box below the
18111 upload tool. Once you have your file uploaded or the barcodes listed
18112 you can click 'Continue.'</para>
18115 <screeninfo>Batch Modify Summary</screeninfo>
18119 <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
18124 <para>You will be presented with a summary of the items you want to
18125 modify. From here you can uncheck the items you don't want to modify
18126 before making changes in the form below. You can also hide columns you
18127 don't need to see to prevent having to scroll from left to right to
18128 see the entire item form.</para>
18130 <para>Using the edit form you can choose which fields to make edits
18131 to. By checking the checkbox to the right of each field you can clear
18132 the values in that field for the records you are modifying.</para>
18135 <screeninfo>Choose fields you want to change in bulk</screeninfo>
18139 <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
18144 <para>Once you have made you changes you will be presented with the
18145 resulting items.</para>
18148 <screeninfo>Item results summary</screeninfo>
18152 <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
18158 <section id="batchdeleteitems">
18159 <title>Batch item deletion</title>
18163 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18164 > Batch item deletion</para>
18168 <para>This tool will allow you to delete a batch of item records from
18171 <para>From the tool you can choose to upload a file of barcodes or
18172 item ids, or you can scan items one by one into the box below the
18173 upload tool.</para>
18176 <screeninfo>Batch Deletion Tool</screeninfo>
18180 <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
18185 <para>Once you have your file uploaded or the barcodes scanned you can
18186 click 'Continue.'</para>
18188 <para>You will be presented with a confirmation screen. From here you
18189 can uncheck the items you don't want to delete and decide if Koha
18190 should delete the bib record if the last item is being deleted before
18191 clicking 'Delete selected items.'</para>
18194 <screeninfo>Confirm Deletion</screeninfo>
18198 <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
18203 <para>If your file (or list of scanned barcodes) has more than 1000
18204 barcodes, Koha will be unable to present you with a list of the items.
18205 You will still be able to delete them, but not able to choose which
18206 items specifically to delete or delete the biblio records.</para>
18209 <screeninfo>More than 1000 records in the file</screeninfo>
18213 <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
18218 <para>If the items are checked out you will be presented with an error
18219 after clicking 'Delete selected items' and the items will not be
18223 <screeninfo>Items not Deleted</screeninfo>
18227 <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
18232 <para>If the items can be deleted they will be and you will be
18233 presented with a confirmation of your deletion.</para>
18236 <screeninfo>Batch Deletion Confirmation</screeninfo>
18240 <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
18246 <section id="exportbibs">
18247 <title>Export Bibliographic and Holdings Data (MARC Export)</title>
18251 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18252 > Export Bibliographic and Holdings Data</para>
18256 <para>Koha comes with a tool that will allow you to export your
18257 bibliographic and/or holdings data in bulk. This can be used to send
18258 your records to fellow libraries, organizations or services; or simply
18259 for backup purposes.</para>
18263 <para>Fill in the form in order to limit your export to a specific
18264 range (all fields are optional)</para>
18267 <screeninfo>Select Records to Export</screeninfo>
18271 <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
18278 <para>Choose to limit your export by any one or more of the
18279 following options</para>
18283 <para>Limit to a bib number range</para>
18287 <para>Limit to a specific item type</para>
18291 <para>Limit to a specific library</para>
18295 <para>Limit to a call number range</para>
18299 <para>Limit to an acquisition date range</para>
18305 <para>Next choose what to skip when exporting</para>
18308 <screeninfo>Export options</screeninfo>
18312 <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
18319 <para>By default items will be exported, if you would like
18320 to only export bibliographic data, check the 'Don't export
18325 <para>To limit your export only to items from the library
18326 you're logged in as (if you leave the 'Library' field set
18327 to 'All') or to the library you selected above check the
18328 'Remove non-local items' box</para>
18332 <para>You can also choose what fields you don't want to
18333 export. This can be handy if you're sharing your data, you
18334 can remove all local fields before sending your data to
18335 another library</para>
18341 <para>Finally choose the file type and file name</para>
18344 <screeninfo>File export format</screeninfo>
18348 <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
18355 <para>Choose to export your data in marc or marcxml
18360 <para>Choose the name you want your file to save as</para>
18366 <para>Click 'Export'</para>
18373 <section id="inventory">
18374 <title>Inventory/Stocktaking</title>
18378 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18379 > Inventory/Stocktaking</para>
18383 <para>Koha's Inventory Tool can be used in one of two ways, the first
18384 is by printing out a shelf list that you can then mark items off on,
18385 or by uploading a text files of barcodes gathered by a portable
18388 <para>If you do not have the ability to use your barcode scanner on
18389 the floor of the library, the first option available to you is to
18390 generate a shelf list based on criteria you enter.</para>
18393 <screeninfo>Inventory & Stocktaking Tool</screeninfo>
18397 <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
18402 <para>Choose which library, shelving location, call number range, item
18403 status and when the item was last seen to generate a shelf list that
18404 you can then print to use while walking around the library checking
18405 your collection</para>
18408 <screeninfo>Shelf List</screeninfo>
18412 <imagedata fileref="images/tools/inventory/shelflist.png"/>
18417 <para>Alternatively you can export the list to a CSV file for altering
18418 in an application on your desktop. Simply check the box next to
18419 'Export to csv file' to generate this file.</para>
18421 <para>Once you have found the items on your shelves you can return to
18422 this list and check off the items you found to have the system update
18423 the last seen date to today.</para>
18425 <para>If you have a portable scanner (or a laptop and USB scanner) you
18426 can walk through the library with the scanner in hand and scan
18427 barcodes as you come across them. Once finished you can then upload
18428 the text file generated by the scanner to Koha</para>
18431 <screeninfo>Barcode Import for Inventory Tool</screeninfo>
18435 <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
18440 <para>Choose the text file and the date you want to mark all items as
18441 seen and click 'Submit.'</para>
18444 <section id="labelcreator">
18445 <title>Label Creator</title>
18449 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18450 > Label Creator</para>
18454 <para>The Label Creator allow you to use layouts and templates which
18455 you design to print a nearly unlimited variety of labels including
18456 barcodes. Here are some of the features of the Label Creator
18461 <para>Customize label layouts</para>
18465 <para>Design custom label templates for printed labels</para>
18469 <para>Build and manage batches of labels</para>
18473 <para>Export single or multiple batches</para>
18477 <para>Export single or multiple labels from within a batch</para>
18481 <para>Export label data in one of three formats:</para>
18485 <para>PDF - Readable by any standard PDF reader, making labels
18486 printable directly on a printer</para>
18490 <para>CSV - Export label data after your chosen layout is
18491 applied allowing labels to be imported in to a variety of
18492 applications</para>
18496 <para>XML - Included as an alternate export format</para>
18502 <para>At the top of each screen within the Label Creator, you will see
18503 a toolbar allowing quick access to relevant functions. The menu to the
18504 left of each screen also allows easy access to the different sections
18505 of the Label Creator. The bread crumb trail near the top of each
18506 screen will give specific indication as to where you are within the
18507 Label Creator module and allow quick navigation to previously
18508 traversed sections. And finally, you can find more detailed
18509 information on each section of the Label Creator by clicking the
18510 online help link at the upper left-hand corner of every page.</para>
18512 <section id="labeltemplates">
18513 <title>Templates</title>
18517 <para><emphasis>Get there:</emphasis> More > Tools > Label
18518 Creator > Templates</para>
18522 <para>A template is based on the label/card stock you are using.
18523 This might be Avery 5160 for address labels, Gaylord 47-284 for
18524 spine labels or Avery 28371 for your patron cards, just to give a
18525 couple of examples. These labels will include all of the information
18526 you will need for setting up a Koha, this information may be on the
18527 packaging, and if not it can usually be found on the vendor's
18530 <section id="addlabeltemplate">
18531 <title>Add a Template</title>
18533 <para>To add a new template, you want to click on the 'Templates'
18534 button at the top of your page and choose 'New Template'</para>
18537 <screeninfo>New Label Template Option</screeninfo>
18541 <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
18546 <para>Using the form that appears you can define the template for
18547 your sheet of labels or cards.</para>
18550 <screeninfo>Label Template Form</screeninfo>
18554 <imagedata fileref="images/tools/labelcreator/labelform.png"/>
18561 <para>Template ID will be automatically generated after saving
18562 your template, this is simply a system generated unique
18567 <para>Template Code should be something you can use to
18568 identify your template on a list of templates</para>
18572 <para>You can use the Template Description to add additional
18573 information about the template</para>
18577 <para>The Units pull down is used to define what measurement
18578 scale you're going to be using for the template. This should
18579 probably match the unit of measurement used on the template
18580 description provided by the product vendor.</para>
18583 <screeninfo>Measurement Units</screeninfo>
18587 <imagedata fileref="images/tools/patroncards/units.png"/>
18594 <para>The measurements, number of columns and number of rows
18595 can be found on the vendor product packaging or
18601 <para>If you do not supply a left text margin in the
18602 template, a 3/16" (13.5 point) left text margin will
18603 apply by default.</para>
18610 <para>A profile is a set of "adjustments" applied to a given
18611 template just prior to printing which compensates for
18612 anomalies unique and peculiar to a given printer (to which the
18613 profile is assigned).</para>
18617 <para>Before picking a profile try printing some sample
18618 labels so that you can easily define a profile that is
18619 right for your printer/template combination.</para>
18623 <para>After finding any anomalies in the printed document,
18624 <link linkend="addlabelprofile">create a profile</link>
18625 and assign it to the template.</para>
18631 <para>After saving, your templates will appear on the 'Manage
18632 Templates' page.</para>
18635 <screeninfo>List of label templates</screeninfo>
18639 <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
18646 <section id="labelprofiles">
18647 <title>Profiles</title>
18651 <para><emphasis>Get there:</emphasis> More > Tools > Label
18652 Creator > Profiles</para>
18656 <para>A profile is a set of "adjustments" applied to a given <link
18657 linkend="addlabeltemplate">template</link> just prior to printing
18658 which compensates for anomalies unique and peculiar to a given
18659 printer (to which the profile is assigned). This means if you set a
18660 template up and then print a sample set of data and find that the
18661 items are not all aligned the same on each label, you need to set up
18662 a profile for each printer to make up for the differences in
18663 printing styles, such as the shifting of text to the left, right,
18664 top or bottom.</para>
18666 <para>If your labels are printing just the way you want, you will
18667 not need a profile.</para>
18669 <section id="addlabelprofile">
18670 <title>Add a Profile</title>
18672 <para>To add a new profile, you want to click on the 'Profiles'
18673 button at the top of your page and choose 'New Profile'</para>
18676 <screeninfo>New Profile Button</screeninfo>
18680 <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
18685 <para>Using the form that appears you can create a profile to fix
18686 any problems with your template.</para>
18689 <screeninfo>Create a Printer Profile</screeninfo>
18693 <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
18700 <para>The Printer Name and Paper Bin do not have to match your
18701 printer exactly, they are for your reference so you can
18702 remember what printer you have set the profile for. So if you
18703 want to use the Printer model number in printer name or you
18704 can call it 'the printer on my desk'</para>
18708 <para>Template will be filled in once you have chosen which
18709 template to apply the profile to on the <link
18710 linkend="addlabeltemplate">template edit form</link></para>
18714 <para>The Units pull down is used to define what measurement
18715 scale you're going to be using for your profile.</para>
18718 <screeninfo>Units of Measurement</screeninfo>
18722 <imagedata fileref="images/tools/patroncards/units.png"/>
18729 <para>Offset describes what happens when the entire image is
18730 off center either vertically or horizontally and creep
18731 describes a condition where the distance between the labels
18732 changes across the page or up and down the page</para>
18736 <para>For these values, negative numbers move the error up
18737 and to the left and positive numbers move the error down
18738 and to the right</para>
18742 <para>Example: the text is .25" from the left edge of the
18743 first label, .28" from the left edge of the second label
18744 and .31" from the left edge of the third label. This means
18745 the horizontal creep should be set to .03" to make up for
18746 this difference.</para>
18752 <para>After saving, your profiles will appear on the 'Manage
18753 Profiles' page.</para>
18756 <screeninfo>List of Profiles</screeninfo>
18760 <imagedata fileref="images/tools/labelcreator/profiles.png"/>
18765 <para>Once you have saved your new profile, you can return to the
18766 list of templates and choose to edit the template that this
18767 profile is for.</para>
18771 <section id="labellayouts">
18772 <title>Layouts</title>
18776 <para><emphasis>Get there:</emphasis> More > Tools > Label
18777 Creator > Layouts</para>
18781 <para>A layout is used to define the fields you want to appear on
18782 your labels.</para>
18784 <section id="addlabellayout">
18785 <title>Add a Layout</title>
18787 <para>To add a new layout, you want to click on the 'Layouts'
18788 button at the top of your page and choose 'New Layout'</para>
18791 <screeninfo>New Layout Button</screeninfo>
18795 <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
18800 <para>Using the form that appears you can create a profile to fix
18801 any problems with your template.</para>
18804 <screeninfo>Add New Layout</screeninfo>
18808 <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
18815 <para>The name of your layout can be anything you'd like to
18816 help you identify it later.</para>
18820 <para>If this is a barcode label you'll want to choose the
18821 encoding (Code 39 is the most common)</para>
18825 <para>The layout type can be any combination of bibliographic
18826 information and/or barcode. For example a spine label would
18827 just be Biblio whereas a label for your circulation staff to
18828 use to checkout the book would probably be
18829 Biblio/Barcode.</para>
18833 <para>The Bibliographic Data to Print includes any of the data
18834 fields that may be mapped to your MARC frameworks. You can
18835 choose from the preset list of fields or you can click on
18836 'List Fields' and enter your own data. In 'List Fields', you
18837 can specify MARC subfields as a 4-character tag-subfield
18838 string: (ie. 254a for the title field), You can also enclose a
18839 whitespace-separated list of fields to concatenate on one line
18840 in double quotes. (ie. "099a 099b" or "itemcallnumber
18841 barcode"). The fields available are from the database tables
18842 list below. Finally you could add in static text strings in
18843 single-quote (ie. 'Some static text here.')</para>
18847 <para>You can use the schema viewer (<ulink
18848 url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
18849 with the following tables to find field names to
18854 <para>Currently all fields in the following tables are
18855 used: items, biblioitems, biblio, branches</para>
18858 <screeninfo>List fields</screeninfo>
18862 <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
18873 <para>Choose if the label maker should print out the
18874 guidelines around each label</para>
18878 <para>Choose if you'd like Koha to try to split your call
18879 numbers (usually used on Spine Labels)</para>
18883 <para>Finally choose your text settings such as alignment,
18884 font type and size.</para>
18888 <para>After saving, your layouts will appear on the 'Manage
18889 Layouts' page.</para>
18893 <section id="labelbatches">
18894 <title>Batches</title>
18898 <para><emphasis>Get there:</emphasis> More > Tools > Label
18899 Creator > Batches</para>
18903 <para>Batches are made up of the barcodes you would like to print.
18904 Once in this tool you can search for the item records you would like
18905 to print out labels for.</para>
18907 <section id="addlabelbatch">
18908 <title>Add a Batch</title>
18910 <para>Batches can be created in one of two ways. The first is to
18911 click the 'Create Label Batch' link on the '<link
18912 linkend="managestaged">Staged MARC Management</link>' page:</para>
18915 <screeninfo>Create Label Batch Link on Staged Records
18920 <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
18925 <para>The other is to choose to create a new batch from the label
18926 creator tool</para>
18929 <screeninfo>Create New Batch</screeninfo>
18933 <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
18938 <para>You will be brought to an empty batch with an 'Add item(s)'
18939 button at the top of the page and a box to scan barcodes in
18943 <screeninfo>Add Items</screeninfo>
18947 <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
18952 <para>You can either scan barcodes in to the box provided and
18953 click the 'Add item(s)' button or you can click the 'Add item(s)'
18954 button with the barcodes box empty. Clicking 'Add item(s)' with
18955 nothing in the barcodes box will open a search window for you to
18956 find the items you want to add to the batch.</para>
18959 <screeninfo>Search for items for a Batch</screeninfo>
18963 <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
18968 <para>From the search results, click the check box next to the
18969 items you want to add to the batch and click the 'Add checked'
18970 button. You can also add items one by one by clicking the 'Add'
18971 link to the left of each item.</para>
18974 <screeninfo>Batch search results</screeninfo>
18978 <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
18983 <para>Once you have added all of the items click the 'Done'
18984 button. The resulting page will list the items you have
18988 <screeninfo>List of items in the batch</screeninfo>
18992 <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
18997 <para>To print your labels, click the 'Export Batch' button. To
18998 print only some of the labels, click the 'Export Item(s)' button.
18999 Either way you will be presented with a confirmation screen where
19000 you can choose your template and layout.</para>
19003 <screeninfo>Start batch export</screeninfo>
19007 <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
19012 <para>You will then be presented with three download options: PDF,
19013 Excel, and CSV.</para>
19016 <screeninfo>Batch save options</screeninfo>
19020 <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
19025 <para>After saving your file, simply print to the blank labels you
19026 have in your library.</para>
19031 <section id="quicklabelcreator">
19032 <title>Quick Spine Label Creator</title>
19036 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19037 > Quick Spine Label Creator</para>
19042 <para>This tool does not use the label layouts or templates, it
19043 simply prints a spine label in the first spot on the label
19048 <para>Define the fields you want to print on the spine label in
19049 the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
19050 system preference</para>
19054 <para>Format your label printing by editing spinelabel.css found
19055 in koha-tmpl/intranet-tmpl/prog/en/css/</para>
19060 <para>To use this tool you simply need the barcode for the book you'd
19061 like to print the spine label for.</para>
19064 <screeninfo>Quick Spine Label Creator</screeninfo>
19068 <imagedata fileref="images/tools/quickspinelable.png"/>
19074 <section id="stagemarc">
19075 <title>Stage MARC Records for Import</title>
19079 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19080 > Stage MARC records for import</para>
19084 <para>Importing records into Koha includes two steps. The first is to
19085 stage records for import.</para>
19089 <para>First find the MARC file on your computer</para>
19092 <screeninfo>Stage MARC Records for Import</screeninfo>
19096 <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
19103 <para>Next you will be presented with options for record matching
19104 and item imports</para>
19107 <screeninfo>Upload options</screeninfo>
19111 <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
19118 <para>Enter 'Comments about this file' to identify your upload
19119 when going to the '<link linkend="managestaged">Manage Staged
19120 MARC Records</link>' tool</para>
19124 <para>Choose the character encoding</para>
19128 <para>Choose whether or not you want to look for matching
19133 <para>You can set up <link
19134 linkend="recordmatchingrules">record matching rules</link>
19135 through the administration area</para>
19141 <para>Next choose what to do with matching records if they are
19146 <para>Finally choose what to do with records that are
19151 <para>Next you can choose whether or not to import the item
19152 data found in the MARC records</para>
19158 <para>Click 'Stage for import'</para>
19162 <para>You will be presented with a confirmation of your MARC
19166 <screeninfo>MARC Import Confirmation</screeninfo>
19170 <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
19177 <para>To complete the process continue to the <link
19178 linkend="managestaged">Managed Staged MARC Records
19184 <section id="managestaged">
19185 <title>Staged MARC Record Management</title>
19189 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19190 > Staged MARC Record Management</para>
19194 <para>Once you have <link linkend="stagemarc">staged</link> your
19195 records for import you can complete the import using this tool.</para>
19198 <screeninfo>List of Staged MARC Records</screeninfo>
19202 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
19209 <para>From the list of staged records, click on the file name that
19210 you want to finish importing</para>
19214 <para>You will note that records that have already been
19215 imported will say so under 'Status'</para>
19221 <para>A summary of your import will appear along with the option
19222 to change your matching rules</para>
19225 <screeninfo>Manage Staged Records Batch</screeninfo>
19229 <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
19236 <para>Below the summary is the option to import the batch of bib
19237 records using a specific framework</para>
19240 <screeninfo>Choose Framework to Import Into</screeninfo>
19244 <imagedata fileref="images/tools/marcimport/importframework.png"/>
19251 <para>Choosing a framework other than 'Default' isn't
19252 necessary, but it's helpful for running reports and having the
19253 right bib level item type selected on import.</para>
19259 <para>Below the framework selection there will be a list of the
19260 records that will be imported</para>
19263 <screeninfo>List of Staged Records</screeninfo>
19267 <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
19274 <para>Review your summary before completing your import to
19275 make sure that your matching rule worked and that the records
19276 appear as you expect them to</para>
19282 <para>Click 'Import into catalog' to complete the import</para>
19285 <screeninfo>Import summary</screeninfo>
19289 <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
19296 <para>Once your import is complete a link to the new bib records
19297 will appear to the right of each title that was imported</para>
19301 <para>You can also undo your import by clicking the 'Undo import
19302 into catalog' button</para>
19306 <para>Records imported using this tool remain in the 'reservoir' until
19307 they are cleaned. These items will appear when searching the catalog
19308 from the <link linkend="cataloging">Cataloging</link> tool:</para>
19311 <screeninfo>Reservoir Results</screeninfo>
19315 <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
19320 <para>To clean items out of the 'reservoir':</para>
19324 <para>Visit the main screen of the Manage Staged MARC Records
19328 <screeninfo>List of Staged MARC Records</screeninfo>
19332 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
19339 <para>To clean a batch, click the 'Clean' button to the
19344 <para>You will be presented with a confirmation message</para>
19347 <screeninfo>Clean MARC Records Confirmation</screeninfo>
19351 <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
19358 <para>Accept the deletion and the records will be removed from
19359 the reservoir and the status will be changed to
19367 <section id="uploadlocalimages">
19368 <title>Upload Local Cover Image</title>
19372 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19373 > Upload Local Cover Image</para>
19377 <para>This tool will allow you to upload cover images for the
19378 materials in your catalog. To access this tool, staff will need the
19379 <link linkend="toolspermissions">upload_local_cover_images
19380 permission</link>. In order for images to show in the staff client
19381 and/or OPAC you will need to set your <link
19382 linkend="LocalCoverImages">LocalCoverImages</link> and/or <link
19383 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> preferences
19384 to 'Display.' Images can be uploaded in batches or one by one.<tip>
19385 <para>Koha does not have a maximum file size limit for this tool,
19386 but Apache may limit the maximum size of uploads (talk to your sys
19390 <para>If uploading a single image:</para>
19394 <para>Visit the tool and click the 'Browse' button to browse to
19395 the image on your local machine.</para>
19398 <screeninfo>Upload single cover image</screeninfo>
19402 <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
19409 <para>Click 'Upload file'</para>
19413 <para>Choose 'Image file' under the 'File type' section</para>
19417 <para>Enter the biblionumber for the record you're attaching this
19418 image to. This is not the same as the barcode, this is the system
19419 generated number assigned by Koha.</para>
19423 <para>Find the biblionumber by looking at the end of the URL
19424 in the address bar when on the detail page</para>
19427 <screeninfo>Biblionumber in URL</screeninfo>
19431 <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
19438 <para>or by clicking on the MARC tab on the detail page in the
19439 staff client</para>
19442 <screeninfo>Biblionumber on MARC Record</screeninfo>
19446 <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
19455 <para>If you would like to replace any other cover images you may
19456 have uploaded in the past, check the 'Replace existing covers' box
19457 under the 'Options' section</para>
19461 <para>Click 'Process images'</para>
19465 <para>You will be presented with a summary of the upload and a
19466 link to the record you have just added the image to</para>
19470 <para>If uploading a batch of images at once you will need to prepare
19471 a ZIP file first.</para>
19475 <para>Enter in to the ZIP file all the images you are
19480 <para>Also include a text file (*.TXT) named either datalink.txt
19481 or idlink.txt listing the biblionumber followed by the image name
19482 for each image one per line</para>
19486 <para>ex. 4091,image4091.jpg</para>
19489 <screeninfo>ZIP File Contents</screeninfo>
19493 <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
19502 <para>Browse your local computer to the ZIP file</para>
19506 <para>Click 'Upload file'</para>
19510 <para>Choose 'Zip file' under the 'File type' section</para>
19514 <para>If you would like to replace any other cover images you may
19515 have uploaded in the past, check the 'Replace existing covers' box
19516 under the 'Options' section</para>
19520 <para>Click 'Process images'</para>
19524 <para>You will be presented with a summary of the upload</para>
19527 <screeninfo>Upload Summary</screeninfo>
19531 <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
19539 <para>Large cover images will be resized down to 800x600. Smaller
19540 images will not be made larger.</para>
19543 <para>You will be able to see your cover images in the staff client on
19544 the detail page under the 'Image' tab in the holdings table at the
19548 <screeninfo>Cover images in the staff client</screeninfo>
19552 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
19557 <para>In the OPAC the cover images will also appear in the images tab,
19558 as well as next to the title and on the search results.</para>
19562 <section id="additionaltools">
19563 <title>Additional Tools</title>
19567 <section id="calholidays">
19568 <title>Calendar</title>
19572 <para><emphasis>Get there:</emphasis> More > Tools >
19573 Additional Tools > Calendar</para>
19577 <para>Libraries can define library closings and holidays to be used
19578 when calculating due dates. You can make use of the Calendar by
19579 turning on the proper system preferences:</para>
19583 <para><emphasis>Get there: </emphasis>More > Administration
19584 > Global System Preferences > Circulation > <link
19585 linkend="useDaysMode">useDaysMode</link></para>
19589 <para>Choose the method for calculating due date - either
19590 include days the library is closed in the calculation or don't
19591 include them.</para>
19597 <para><emphasis>Get there:</emphasis> More > Administration
19598 > Global System Preferences > Circulation > <link
19599 linkend="finesCalendar">finescalendar</link></para>
19603 <para>This will check the holiday calendar before charging
19611 <screeninfo>Calendar & Holidays Tools</screeninfo>
19615 <imagedata fileref="images/tools/calendar/calendar.png"/>
19620 <section id="addevents">
19621 <title>Adding Events</title>
19623 <para>Before adding events, choose the library you would like to
19624 apply the closings to. When adding events you will be asked if you
19625 would like to apply the event to one branch or all branches. To add
19626 events, simply</para>
19630 <para>Click on the date on the calendar that you would like to
19631 apply the closing to</para>
19634 <screeninfo>Calendar Add Form</screeninfo>
19638 <imagedata fileref="images/tools/calendar/calendaradd.png"/>
19645 <para>In the form that appears above the calendar, enter the
19646 closing information (for more info on each option click the
19647 question mark [?] to the right of the option)</para>
19651 <para>Library will be filled in automatically based on the
19652 library you chose from the pull down at the top of the
19657 <para>The day information will also be filled in
19658 automatically based on the date you clicked on the
19663 <para>In the description enter the reason the library is
19668 <para>Next you can choose if this event is a one time event
19669 or if it is repeatable.</para>
19673 <para>If this is a one day holiday choose 'Holiday only
19674 on this day'</para>
19678 <para>If this is a weekly closing (like a weekend day)
19679 then you can choose 'Holiday repeated every same day of
19684 <para>If this is an annual holiday closing choose
19685 'Holiday repeated yearly on the same date'</para>
19689 <para>If the library is going to be closed for the week
19690 or a range of time choose 'Holiday on a range' and enter
19691 a 'To Date' at the top</para>
19695 <para>If the library is going to be closed for a range
19696 of time each year (such as summer holidays for schools)
19697 choose 'Holiday repeated yearly on a range' and enter a
19698 'To Date' at the top</para>
19704 <para>Finally decide if this event should be applied to all
19705 libraries or just the one you have originally
19710 <para>If you'd rather enter all the holidays and then
19711 copy them all to another branch all at once you can use
19712 the copy menu below the calendar</para>
19715 <screeninfo>Copy holidays</screeninfo>
19719 <imagedata fileref="images/tools/calendar/copyholidays.png"/>
19730 <para>After saving you will see the event listed in the summary
19731 to the right the calendar</para>
19734 <screeninfo>Calendar Summary</screeninfo>
19738 <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
19746 <section id="editevents">
19747 <title>Editing Events</title>
19749 <para>To edit events</para>
19753 <para>Click on the event on the calendar that you want to change
19754 (do this by clicking on the date on the calendar, not the event
19755 listed in the summary)</para>
19758 <screeninfo>Edit holiday form</screeninfo>
19762 <imagedata fileref="images/tools/calendar/calendaredit.png"/>
19769 <para>From this form you can make edits to the holiday or delete
19770 the holiday completely. Both actions require that you click
19771 'Save' before the change will be made.</para>
19775 <para>Clicking on repeatable events will offer slightly
19776 different options</para>
19779 <screeninfo>Edit repeatable event</screeninfo>
19783 <imagedata fileref="images/tools/calendar/calendarexception.png"/>
19790 <para>In the form above you will note that there is now an
19791 option to 'Generate an exception for this repeated holiday,'
19792 choosing this option will allow you to make it so that this
19793 date is not closed even though the library is usually closed
19794 on this date.</para>
19801 <section id="calendarhelp">
19802 <title>Additional Help</title>
19804 <para>When adding or editing events you can get additional help by
19805 clicking on the question mark next to various different options on
19809 <screeninfo>Additional Calendar Help Buttons</screeninfo>
19813 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
19820 <section id="csvprofiles">
19821 <title>CSV Profiles</title>
19825 <para><emphasis>Get there:</emphasis> More > Tools >
19826 Additional Tools > CSV Profiles</para>
19830 <para>CSV Profiles are created to define how you would like your cart
19831 or list to export.</para>
19833 <section id="addcsvprofile">
19834 <title>Add CSV Profiles</title>
19836 <para>To add a CSV Profile</para>
19840 <para>Click 'CSV Profiles' from the Tools menu</para>
19843 <screeninfo>Add CSV Profile</screeninfo>
19847 <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
19854 <para>The 'Profile name' will appear on the export pull down
19855 list when choosing 'Download' from your cart or list</para>
19859 <para>The 'Profile description' is for your own
19864 <para>The 'CSV separator' is the character used to separate
19865 values and value groups</para>
19869 <para>The 'Field separator' is the character used to
19870 separate duplicate fields</para>
19874 <para>Example: You may have multiple 650 fields</para>
19880 <para>The 'Subfield separator' is the character used to
19881 separate duplicate subfields</para>
19885 <para>Example: You may have multiple $a subfields in a
19892 <para>The 'Encoding' field lets you define the encoding used
19893 when saving the file</para>
19897 <para>Finally format your CSV file using the 'Profile
19898 marcfields' fields</para>
19902 <para>Define which fields or subfields you want to
19903 export, separated by pipes. Example :
19904 200|210$a|301</para>
19909 <para>You can also use your own headers (instead of
19910 the ones from Koha) by prefixing the field number with
19911 an header, followed by the equal sign. Example :
19912 Personal name=200|Entry element=210$a|300|009</para>
19922 <section id="editcsvprofile">
19923 <title>Modify CSV Profiles</title>
19925 <para>Once you have created at least one CSV Profile an 'Edit
19926 profile' tab will appear next to the 'New profile' button.</para>
19929 <screeninfo>Modify CSV Profiles</screeninfo>
19933 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
19940 <para>Choose the profile you would like to edit and alter the
19941 necessary fields.</para>
19945 <para>To delete a profile, check the 'Delete selected profile'
19946 option before clicking 'Submit Query'</para>
19949 <screeninfo>Delete an existing CSV Profile</screeninfo>
19953 <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
19961 <section id="usecsvprofiles">
19962 <title>Using CSV Profiles</title>
19964 <para>Your CSV Profiles will appear on the export list or cart menu
19965 under the 'Download' button</para>
19968 <screeninfo>CSV Profiles on Download Menu</screeninfo>
19972 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
19979 <section id="logviewer">
19980 <title>Log Viewer</title>
19984 <para><emphasis>Get there:</emphasis> More > Tools >
19985 Additional Tools > Log Viewer</para>
19989 <para>Actions within the Koha system are tracked in log files. Your
19990 <link linkend="logs">system preferences</link> can be changed to
19991 prevent the logging of different actions. These logs can be viewed
19992 using the Log Viewer Tool.</para>
19995 <screeninfo>Log Viewer</screeninfo>
19999 <imagedata fileref="images/tools/logs/logviewer.png"/>
20004 <para>Choosing different combinations of menu options will produce the
20005 log file for that query.</para>
20008 <screeninfo>A query for all logs related to the Circulation module
20009 produces a result like this</screeninfo>
20013 <imagedata fileref="images/tools/logs/logresults.png"/>
20018 <para>You will note that real names do not appear on the log, only
20019 identifying numbers. You need to use the identifying numbers when
20020 searching the logs as well.</para>
20023 <section id="newstool">
20024 <title>News</title>
20028 <para><emphasis>Get there:</emphasis> More > Tools >
20029 Additional Tools > News</para>
20033 <para>Koha's news module allows librarians to post news to the OPAC,
20034 staff interface and circulation receipts.</para>
20037 <screeninfo>Koha News Module</screeninfo>
20041 <imagedata fileref="images/tools/news/news.png"/>
20046 <para>To add news to either the OPAC, the Staff Client or a
20047 Circulation receipt:</para>
20051 <para>Click 'New Entry'</para>
20054 <screeninfo>Add Koha News Form</screeninfo>
20058 <imagedata fileref="images/tools/news/addnews.png"/>
20065 <para>Under 'Display Location' choose whether to put the news
20066 on the OPAC, Slip (circulation receipt) or the Librarian
20067 (Staff) Interface.</para>
20071 <para>Choose a title for your entry</para>
20075 <para>Using the publication and expiration date fields you can
20076 control how long your item appears</para>
20080 <para>'Appear in position' lets you decide what order your
20081 news items appear in</para>
20085 <para>The 'News' box allows for the use of HTML for formatting
20086 of your news item</para>
20092 <para>After filling in all of the fields, click 'Submit'</para>
20096 <para>News in the OPAC will appear above the <link
20097 linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
20100 <screeninfo>News in the OPAC</screeninfo>
20104 <imagedata fileref="images/tools/news/opacnews.png"/>
20111 <para>News in the Staff Client will appear on the far left of the
20115 <screeninfo>News in the Staff Client</screeninfo>
20119 <imagedata fileref="images/tools/news/librariannews.png"/>
20126 <para>News on the circulation receipts will appear below the items
20127 that are checked out</para>
20130 <screeninfo>News at the bottom of the circulation
20131 receipt</screeninfo>
20135 <imagedata fileref="images/tools/news/slipnews.png"/>
20143 <section id="taskscheduler">
20144 <title>Task Scheduler</title>
20148 <para><emphasis>Get there:</emphasis> More > Tools >
20149 Additional Tools > Task Scheduler</para>
20153 <para>The task scheduler is a way to schedule reports to run whenever
20156 <para>To schedule a task, visit the Task Scheduler and fill in the
20160 <screeninfo>Task Scheduler</screeninfo>
20164 <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
20171 <para>Current Server Time shows the time on your server (schedule
20172 all of your reports to run based on that time - not on your local
20177 <para>Time should be entered as hh:mm (2 digit hour, 2 digit
20182 <para>Date should be entered using the calendar pop up</para>
20186 <para>From Report choose the report you want to schedule</para>
20190 <para>Choose whether to receive the text of or a link to the
20195 <para>In the Email filed enter the email of the person you want to
20196 receive your report</para>
20200 <para>Below the task scheduler form, there is a list of scheduled
20204 <screeninfo>Scheduled Tasks</screeninfo>
20208 <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
20213 <para>You can also schedule reports directly from the list of saved
20214 reports by clicking the 'Schedule' link</para>
20217 <screeninfo>Saved Reports List</screeninfo>
20221 <imagedata fileref="images/tools/tasksched/savedreports.png"/>
20226 <section id="taskscedtroubleshoot">
20227 <title>Troubleshooting</title>
20229 <para>Task scheduler will not work if the user the web server runs
20230 as doesn't have the permission to use it. To find out if the right
20231 user has the permissions necessary, check /etc/at.allow to see what
20232 users are in it. If you don't have that file, check etc/at.deny. If
20233 at.deny exists but is blank, then every user can use it. Talk to
20234 your system admin about adding the user to the right place to make
20235 the task scheduler work.</para>
20241 <chapter id="patrons">
20242 <title>Patrons</title>
20244 <para>Before importing and/or adding patrons be sure to set up your <link
20245 linkend="patcats">patron categories</link>.</para>
20247 <section id="addnewpatron">
20248 <title>Add a new patron</title>
20250 <para>Patrons are added by going to the 'Patrons' module.</para>
20254 <para>Click 'New'</para>
20257 <screeninfo>Choose patron type</screeninfo>
20261 <imagedata fileref="images/patrons/newpatron.png"/>
20268 <para>The fields that appear on the patron add form can be
20269 controlled by editing the <link
20270 linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
20275 <para>First enter the identifying information regarding your
20279 <screeninfo>Add Patron Form</screeninfo>
20283 <imagedata fileref="images/patrons/addpatronform.png"/>
20290 <para>Required fields are defined in the <link
20291 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
20292 system preference</para>
20296 <para>Salutation is populated by the <link
20297 linkend="BorrowersTitles">BorrowersTitles</link> system
20304 <para>Next enter the contact information</para>
20307 <screeninfo>Patron Contact Information</screeninfo>
20311 <imagedata fileref="images/patrons/addcontact.png"/>
20318 <para>For contact information, note that the primary phone and
20319 email addresses are the ones that appear on notices and slips
20320 printed during circulation (receipts, transfer slips and hold
20321 slips). The primary email is also the one that overdue notices
20322 and other messages go to.</para>
20328 <para>If this patron is a child, you will be asked to attach the
20329 child patron to an adult patron</para>
20332 <screeninfo>Guarantor Linking</screeninfo>
20336 <imagedata fileref="images/patrons/addGuarantor.png"/>
20343 <para>Click 'Set to Patron' to search your system for an
20344 existing patron</para>
20348 <para>If the Guarantor is not in the system, you can enter the
20349 first and last name in the fields available</para>
20353 <para>The relationships are set using the <link
20354 linkend="borrowerRelationship">borrowerRelationship</link>
20355 system preference</para>
20361 <para>If this patron is a professional, you will be asked to attach
20362 the patron to an organizational patron</para>
20365 <screeninfo>Organization Linking</screeninfo>
20369 <imagedata fileref="images/patrons/addOrg.png"/>
20376 <para>Click 'Set to Patron to search your system for an existing
20383 <para>Each patron can have an alternate contact</para>
20386 <screeninfo>Alternate Contact</screeninfo>
20390 <imagedata fileref="images/patrons/addaltcontact.png"/>
20397 <para>An alternate contact could be a parent or guardian. It can
20398 also be used in academic settings to store the patron's home
20405 <para>The library management section includes values that are used
20406 within the library</para>
20409 <screeninfo>Library Management</screeninfo>
20413 <imagedata fileref="images/patrons/addlibmanagement.png"/>
20420 <para>The card number field is automatically calculated if you
20421 have the <link linkend="autoMemberNum">autoMemberNum</link>
20422 system preference set that way</para>
20427 <para>For a newly installed system this preference will
20428 start at 1 and increment by 1 each time after. To have it
20429 start with the starting number of your barcodes, enter the
20430 first barcode by hand in the patron record and save the
20431 patron. After that the field will increment that number by
20439 <para>If you accidentally chose the wrong patron category at the
20440 beginning you can fix that here</para>
20444 <para>Sort 1 and 2 are used for statistical purposes within your
20451 <para>Next, the Library Setup section includes additional library
20455 <screeninfo>Library set-up options</screeninfo>
20459 <imagedata fileref="images/patrons/addlibsetup.png"/>
20466 <para>The registration date will automatically be filled in with
20467 today's date</para>
20471 <para>If your patron cards expire (based on your <link
20472 linkend="patcats">patron category settings</link>) the Expiry
20473 date will automatically be calculated</para>
20477 <para>The OPAC Note is a note for the patron - it will appear in
20478 the OPAC on the patron's record</para>
20482 <para>The Circulation Note is meant solely for your library
20483 staff and will appear when the circulation staff goes to check
20484 an item out to the patron</para>
20487 <screeninfo>Sample Circulation Note</screeninfo>
20491 <imagedata fileref="images/patrons/circnote.png"/>
20498 <para>The Staff/OPAC asks for the username and password to be
20499 used by the patron (and/or staff member) to log into their
20500 account in the OPAC and for staff to log in to the staff
20505 <para>Staff will only be able to use this log in info to log
20506 in to the staff client if they have the <link
20507 linkend="patronpermissions">necessary
20508 permissions</link>.</para>
20516 <para>If you have set <link
20517 linkend="patronattributetypes">additional patron attributes</link>
20518 up, these will appear next</para>
20521 <screeninfo>Additional Patron Attributes</screeninfo>
20525 <imagedata fileref="images/patrons/addattributes.png"/>
20532 <para id="setpatronmessaging">Finally, if you have <link
20533 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
20534 set to 'allow,' you can choose the messaging preferences for this
20538 <screeninfo>Patron Messaging Settings</screeninfo>
20542 <imagedata fileref="images/patrons/addpatronmsg.png"/>
20550 <para>These preferences will override any you set via the
20551 <link linkend="addingpatroncat">patron
20552 categories</link></para>
20558 <para>These preference can be altered by the patron via the
20566 <para>Once finished, click 'Save'</para>
20570 <para>If the system suspects this patron is a duplicate of another it
20571 will warn you.</para>
20574 <screeninfo>Patron Duplicate Suspected</screeninfo>
20578 <imagedata fileref="images/patrons/duplicatewarn.png"/>
20583 <para>If you have set a minimum or upper age limit on the patron
20584 category and are requiring that the birth date be filled in, Koha will
20585 warn you if the patron you're adding is too old or young for the patron
20586 category you have selected:</para>
20589 <screeninfo>Patron age warning</screeninfo>
20593 <imagedata fileref="images/patrons/patronagelimit.png"/>
20599 <section id="addstaffpatron">
20600 <title>Add a Staff Patron</title>
20602 <para>All staff members must be entered into Koha as patrons of the
20603 'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
20604 Patron</link> to add a staff member. To give the staff member
20605 permissions to access the staff client, follow the steps in <link
20606 linkend="patronpermissions">Patron Permissions</link></para>
20609 <para>Remember to assign your staff secure usernames and passwords
20610 since these will be used to log into the staff client.</para>
20614 <section id="addstatspatron">
20615 <title>Add a Statistical Patron</title>
20617 <para>One way to track use of in house items is to "check out" the
20618 materials to a statistical patron. The "check out" process doesn's check
20619 the book out, but instead tracks an in house use of the item. To use
20620 this method for tracking in house use you first will need a <link
20621 linkend="patcats">patron category</link> set up for your Statistical
20625 <screeninfo>In House Patron Category</screeninfo>
20629 <imagedata fileref="images/patrons/statspatcat.png"/>
20634 <para>Next, you will need to create a new patron of the statistical
20638 <screeninfo>New In House Patron</screeninfo>
20642 <imagedata fileref="images/patrons/newinhouse.png"/>
20647 <para>Next, follow the steps put forth in the '<link
20648 linkend="addnewpatron">Add a new Patron</link>' section of this manual.
20649 Since this patron is not a real person, simply fill in the required
20650 fields, the correct library and nothing else.</para>
20652 <para>To learn about other methods of tracking in house use visit the
20653 <link linkend="trackinhouse">Tracking inhouse use</link> section of this
20657 <section id="duplicatepatron">
20658 <title>Duplicate a Patron</title>
20660 <para>Sometimes when you're adding a new family to your system you don't
20661 want to type the contact information over and over. Koha allows for you
20662 to duplicate a patron and change only the parts you want to (or need to)
20667 <para>Open the patron you want to use as your base (the patron you
20668 want to duplicate information from)</para>
20672 <para>Click the 'Duplicate' button at the top of their record</para>
20675 <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
20679 <imagedata fileref="images/patrons/duplicatepatron.png"/>
20686 <para>All of the fields with the exception of first name, card
20687 number, username and password have been duplicated. Fill in the
20688 missing pieces and click 'Save'</para>
20691 <screeninfo>Duplicating Patron Form</screeninfo>
20695 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
20703 <para>Clicking in a field that is already populated with data
20704 will clear that field of all information (making it easier for
20705 you to type in something different)</para>
20712 <para>You will be brought to your new patron</para>
20715 <screeninfo>Newly created patron</screeninfo>
20719 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
20727 <section id="editpatrons">
20728 <title>Editing Patrons</title>
20730 <para>Patrons in Koha can be edited using one of many edit
20735 <para>To edit the entire patron record simply click the 'Edit'
20736 button at the top of the patron record.</para>
20739 <screeninfo>Main Patron Edit Menu</screeninfo>
20743 <imagedata fileref="images/patrons/patronedit.png"/>
20750 <para>Patron passwords are not recoverable. The stars show on the
20751 patron detail next to the Password label are always there even if a
20752 password isn't set. If a patron forgets their password the only
20753 option is to reset their password. To change the patron's password,
20754 click the 'Change Password' button</para>
20757 <screeninfo>Patron Password Change Form</screeninfo>
20761 <imagedata fileref="images/patrons/patronpassword.png"/>
20768 <para>Koha cannot display existing passwords. Leave the field
20769 blank to leave password unchanged.</para>
20773 <para>This form can automatically generate a random password if
20774 you click the link labeled "Click to fill with a randomly
20775 generated suggestion. Passwords will be displayed as
20782 <para>To edit a specific section of the patron record (for example
20783 the Library Use section) click the 'Edit' link below the
20787 <screeninfo>Library Use Section of Patron Record</screeninfo>
20791 <imagedata fileref="images/patrons/patroneditsection.png"/>
20798 <para>A patron image can be added by browsing for the image on your
20799 machine from the 'Manage Patron Image' section</para>
20802 <screeninfo>Manage Patron Image Form</screeninfo>
20806 <imagedata fileref="images/patrons/patronaddimage.png"/>
20813 <para>This form will not appear if you have the <link
20814 linkend="patronimages">patronimages</link> system preference to
20815 not allow patron images</para>
20819 <para>To add patron images in bulk, use the <link
20820 linkend="uploadpatronimages">Upload Patron Images</link>
20827 <para id="patronflags">Patrons can also be blocked from checking
20828 items out by setting Patron Flags</para>
20831 <screeninfo>Patron Warning Flags</screeninfo>
20835 <imagedata fileref="images/patrons/patronflags.png"/>
20842 <para>If you would like your circulation staff to confirm a
20843 patron's address before checking items out to the patron, you
20844 can see the 'Gone no Address' flag</para>
20847 <screeninfo>Patron's address in doubt</screeninfo>
20851 <imagedata fileref="images/patrons/patronaddress.png"/>
20858 <para>If you would like to bar a patron from the library you can
20859 set the 'Restricted' flag</para>
20863 <para>This flag can automatically be set with the <link
20864 linkend="noticetriggers">Overdue/Notice Status
20865 Triggers</link></para>
20868 <screeninfo>Patron restricted</screeninfo>
20872 <imagedata fileref="images/patrons/patronrestricted.png"/>
20881 <para>If you enter in a date and/or note related to the
20882 restriction you will see that in the restricted message as
20886 <screeninfo>Restricted until message</screeninfo>
20890 <imagedata fileref="images/patrons/restricteduntil.png"/>
20897 <para>If the patron reports that they have lost their card you
20898 can set the 'Lost Card' flag to prevent someone else from using
20899 that card to check items out</para>
20902 <screeninfo>Patron lost card</screeninfo>
20906 <imagedata fileref="images/patrons/patroncardlost.png"/>
20915 <para>Children patrons do not become adults automatically in Koha.
20916 To upgrade a child patron to and adult patron category click on the
20917 'More' menu and choose 'Update Child to Adult Patron'</para>
20920 <screeninfo>Update Child to Adult Patron</screeninfo>
20924 <imagedata fileref="images/patrons/updatetoadult.png"/>
20931 <para>You will then be presented with a pop up window asking
20932 which one of your adult patron categories this Child should be
20936 <screeninfo>Choose Adult Category to Update To</screeninfo>
20940 <imagedata fileref="images/patrons/choosadulttype.png"/>
20950 <section id="patronpermissions">
20951 <title>Patron Permissions</title>
20953 <para>Patron Permissions are used to allow staff members access to the
20954 staff client.</para>
20957 <para>In order for a staff member to log into the staff interface they
20958 must have (at the very least) 'catalogue' permissions which allow them
20959 to view the staff interface.</para>
20962 <section id="setpatronperms">
20963 <title>Setting Patron Permissions</title>
20965 <para>To set patron permissions, you must first <link
20966 linkend="addstaffpatron">have a patron of the 'Staff' type</link>
20971 <para>On the patron record click More and choose Set Permissions
20972 to alter patron permissions</para>
20975 <screeninfo>Set Patron Permissions</screeninfo>
20979 <imagedata fileref="images/patrons/editpatronpermissions.png"/>
20986 <para>You will be presented with a list of preferences, some of
20987 which can be expanded by clicking the plus sign to the left of the
20988 section title.</para>
20991 <screeninfo>Patron Permissions</screeninfo>
20995 <imagedata fileref="images/patrons/GranularPermissions.png"/>
21003 <section id="patronpermsdefined">
21004 <title>Patron Permissions Defined</title>
21010 <para>superlibrarian</para>
21014 <para>Access to all functions within the staff client</para>
21019 <para>With this selected there is no need to choose any
21020 other permissions</para>
21029 <para>circulate</para>
21033 <para>Ability to check (issue) books out and in and access the
21034 'Circulation' page in the staff client</para>
21038 <para>This section can be expanded (<link
21039 linkend="circpermissions">Learn more</link>)</para>
21045 <para>catalogue</para>
21049 <para>Allows staff members to search the catalog via the staff
21054 <para>Must be given to all staff members to allow them to
21055 login to the staff client</para>
21061 <para>parameters</para>
21065 <para>Provides access to all areas of the Administration
21072 <para>borrowers</para>
21076 <para>Allows staff members to add or modify patrons (with the
21077 exception of setting permissions)</para>
21083 <para>permissions</para>
21087 <para>Ability to set patron permissions</para>
21093 <para>reserveforothers</para>
21097 <para>Ability to place holds on books for patrons via the
21098 staff interface</para>
21102 <para>This section can be expanded (<link
21103 linkend="reservepermissions">Learn more</link>)</para>
21109 <para>borrow</para>
21113 <para>Grants staff members the rights to borrow books from the
21120 <para>editcatalogue</para>
21124 <para>Ability to catalog items (add and edit bibliographic and
21125 holdings data)</para>
21129 <para>This section can be expanded (<link
21130 linkend="catpermissions">Learn more</link>)</para>
21136 <para>updatecharges</para>
21140 <para>Manage patron accounts (including paying fines, adding
21141 credits, and creating invoices)</para>
21147 <para>acquisition</para>
21151 <para>Provides access to the acquisitions and patron purchase
21152 suggestion modules</para>
21156 <para>This section can be expanded (<link
21157 linkend="acqpermissions">Learn more</link>)</para>
21163 <para>management</para>
21167 <para>No longer in use</para>
21177 <para>Access to all items in the Tools section of the staff
21182 <para>This section can be expanded (<link
21183 linkend="toolspermissions">Learn more</link>)</para>
21189 <para>editauthorities</para>
21193 <para>Provides access to edit the authority record</para>
21199 <para>serials</para>
21203 <para>Allows access to the serials module</para>
21207 <para>This section can be expanded (<link
21208 linkend="serpermissions">Learn more</link>)</para>
21214 <para>reports</para>
21218 <para>Allow access to the Reports module (ability to create,
21219 edit and run all reports)</para>
21223 <para>Reports found on the Circulation page are not controlled
21224 by this permission</para>
21228 <para>This section can be expanded (<link
21229 linkend="reportpermissions">Learn more</link>)</para>
21235 <para>staffaccess</para>
21239 <para>Provides the ability to modify login / permissions for
21245 <para>Requires the borrowers permission above</para>
21252 <section id="circpermissions">
21253 <title>Granular Circulate Permissions</title>
21255 <para>If the staff member has 'circulate' permissions they have the
21256 ability to perform all of these actions. If you would like to
21257 control circulation permissions on a more granular level choose from
21258 these options:</para>
21262 <para>circulate_remaining_permissions</para>
21266 <para>All circulation rights except the ability to override
21273 <para>override_renewals</para>
21277 <para>Override blocked renewals</para>
21281 <para>Requires that the staff member also has
21282 circulate_remaining_permissions</para>
21289 <section id="reservepermissions">
21290 <title>Granular Holds Permissions</title>
21292 <para>If the staff member has 'reserveforothers' permissions they
21293 have the ability to perform all of these actions. If you would like
21294 to control holds permissions on a more granular level choose from
21295 these options:</para>
21299 <para>modify_holds_priority</para>
21303 <para>Allow staff members to alter the holds priority
21304 (moving patrons up and down the queue)</para>
21310 <para>place_holds</para>
21314 <para>Allows staff members to place holds for patrons via
21315 the staff interface</para>
21322 <section id="catpermissions">
21323 <title>Granular Cataloging Permissions</title>
21325 <para>If the staff member has 'editcatalogue' permissions they have
21326 the ability to perform all of these actions. If you would like to
21327 control cataloging permissions on a more granular level choose from
21328 these options:</para>
21332 <para>edit_catalogue</para>
21336 <para>Ability to access all cataloging functions via the
21337 <link linkend="cataloging">Cataloging</link> page</para>
21343 <para>edit_items</para>
21347 <para>Ability to make <link linkend="editingitems">edits to
21348 item records</link>, but not bib records</para>
21354 <para id="fastaddpermissions">fast_cataloging</para>
21358 <para>The ability to catalog using only the <link
21359 linkend="fastaddcat">Fast Add Framework</link> found on the
21360 <link linkend="circulation">Circulation</link> page</para>
21367 <section id="acqpermissions">
21368 <title>Granular Acquisitions Permissions</title>
21370 <para>If the staff member has 'acquisition' permissions they have
21371 the ability to perform all of these actions. If you would like to
21372 control acquisitions permissions on a more granular level choose
21373 from these options:</para>
21377 <para>budget_add_del</para>
21381 <para>Ability to add and delete budgets (not modify)</para>
21387 <para>budget_manage</para>
21391 <para>Manage budgets</para>
21397 <para>budget_modify</para>
21401 <para>Ability to edit existing budgets (not to add or
21408 <para>contracts_manage</para>
21412 <para>Manage contracts</para>
21418 <para>group_manage</para>
21422 <para>Manage orders and basket groups</para>
21428 <para>order_manage</para>
21432 <para>Manage orders and baskets</para>
21438 <para>order_receive</para>
21442 <para>Manage orders and baskets</para>
21448 <para>period_manage</para>
21452 <para>Manage periods</para>
21458 <para>planning_manage</para>
21462 <para>Manage budget planning</para>
21468 <para>vendors_manage</para>
21472 <para>Manage vendors</para>
21479 <section id="serpermissions">
21480 <title>Granular Serials Permissions</title>
21482 <para>If the staff member has 'serials' permissions they have the
21483 ability to perform all of these actions. If you would like to
21484 control serials permissions on a more granular level choose from
21485 these options:</para>
21489 <para>check_expiration</para>
21493 <para>Check the expiration of a serial</para>
21499 <para>claim_serials</para>
21503 <para>Claim missing serials</para>
21509 <para>create_subscription</para>
21513 <para>Create a new subscription</para>
21519 <para>delete_subscription</para>
21523 <para>Delete an existing subscription</para>
21529 <para>edit_subscription</para>
21533 <para>Edit (but not delete or create) an existing
21534 subscription</para>
21540 <para>receive_serials</para>
21544 <para>Receive serials on existing subscriptions</para>
21550 <para>renew_subscription</para>
21554 <para>Renew an existing subscription</para>
21560 <para>routing</para>
21564 <para>Manage routing lists</para>
21571 <section id="toolspermissions">
21572 <title>Granular Tools Permissions</title>
21574 <para>If the staff member has 'tools' permissions they have the
21575 ability to access and use all items under the Tools menu. If you
21576 would like to control which tools staff members have access to on a
21577 more granular level choose from these options:</para>
21581 <para>batch_upload_patron_images</para>
21585 <para>Upload patron images in batch or one at a time (Access
21586 to the <link linkend="uploadpatronimages">Image Upload
21587 Tool</link>)</para>
21593 <para>delete_anonymize_patrons</para>
21597 <para>Delete old borrowers and anonymize circulation/reading
21598 history (Access to the <link linkend="anonpatrons">Anonymize
21599 Patron Tool</link>)</para>
21605 <para>edit_calendar</para>
21609 <para>Define days when the library is closed (Access to the
21610 <link linkend="calholidays">Calendar/Holidays
21611 Tool</link>)</para>
21617 <para>edit_news</para>
21621 <para>Write news for the OPAC and staff interfaces (Access
21622 to the <link linkend="newstool">News Tool</link>)</para>
21628 <para>edit_notice_status_triggers</para>
21632 <para>Set notice/status triggers for overdue items (Access
21633 to the <link linkend="noticetriggers">Overdue Notice
21634 Status/Triggers Tool</link>)</para>
21640 <para>edit_notices</para>
21644 <para>Define notices (Access to the <link
21645 linkend="notices">Notices Tool</link>)</para>
21651 <para>export_catalog</para>
21655 <para>Export bibliographic and holdings data (Access to the
21656 <link linkend="exportbibs">Export Bibliographic &
21657 Holdings Data Tool</link>)</para>
21663 <para>import_patrons</para>
21667 <para>Import patron data (Access to the <link
21668 linkend="patronimport">Import Patrons Tool</link>)</para>
21674 <para>inventory</para>
21678 <para>Perform inventory (stocktaking) of your catalog
21679 (Access to the <link linkend="inventory">Inventory
21680 Tool</link>)</para>
21686 <para>items_batchdel</para>
21690 <para>Perform batch deletion of items (Access to the <link
21691 linkend="batchdeleteitems">Delete a queryset of items
21692 Tool</link>)</para>
21698 <para>items_batchmod</para>
21702 <para>Perform batch modification of items (Access to the
21703 <link linkend="batchmodifyitems">Modify a queryset of items
21704 Tool</link>)</para>
21710 <para>label_creator</para>
21714 <para>Create printable labels and barcodes from catalog and
21715 patron data (Access to the <link
21716 linkend="labelcreator">Label Creator</link> and <link
21717 linkend="quicklabelcreator">Quick Label Creator</link>
21724 <para>manage_csv_profiles</para>
21728 <para>Create and edit CSV profiles (Access to the <link
21729 linkend="csvprofiles">CSV Profiles Tool</link>)</para>
21735 <para>manage_staged_marc</para>
21739 <para>Managed staged MARC records, including completing and
21740 reversing imports (Access to the <link
21741 linkend="managestaged">Manage Staged MARC Records
21742 Tool</link>)</para>
21748 <para>moderate_comments</para>
21752 <para>Moderate patron comments (Access to the <link
21753 linkend="comments">Comments</link> and <link
21754 linkend="tagsmoderation">Tags</link> Tools)</para>
21760 <para>schedule_tasks</para>
21764 <para>Schedule tasks to run (Access to the <link
21765 linkend="taskscheduler">Task Scheduler Tool</link>)</para>
21771 <para>stage_marc_import</para>
21775 <para>Stage MARC records into the reservoir (Access to the
21776 <link linkend="stagemarc">Stage MARC Records
21777 Tool</link>)</para>
21783 <para>upload_local_cover_images</para>
21787 <para>Upload local cover images (Access to the <link
21788 linkend="uploadlocalimages">Upload Local Cover Image
21789 Tool</link>)</para>
21795 <para>view_system_logs</para>
21799 <para>Browse the system logs (Access to the <link
21800 linkend="logviewer">Log Viewer Tool</link>)</para>
21807 <section id="reportpermissions">
21808 <title>Granular Reports Permissions</title>
21810 <para>If the staff member has 'reports' permissions they have the
21811 ability to perform all of these actions. If you would like to
21812 control reports permissions on a more granular level choose from
21813 these options:</para>
21817 <para>create_reports</para>
21821 <para>The ability to create and edit but not run SQL
21828 <para>execute_reports</para>
21832 <para>The ability to run but not create or edit SQL
21842 <section id="patroninformation">
21843 <title>Patron Information</title>
21845 <para>When viewing a patron record you have the option to view
21846 information from one of many tabs found on the left hand side of the
21849 <section id="patcheckout">
21850 <title>Check Out</title>
21852 <para>For instruction on checking items out, view the <link
21853 linkend="checkingout">Checking Out</link> section of this
21857 <section id="patrondetails">
21858 <title>Details</title>
21860 <para>All patron information will appear on the Details tab. This
21861 includes all the contact information, notes, custom patron attributes,
21862 messaging preferences, etc entered when adding the patron.</para>
21864 <para>In the case of patrons who are marked as 'Child' or
21865 'Professional' and their Guarantors additional information will appear
21866 on their record.</para>
21870 <para>A child patron will list their Guarantor</para>
21873 <screeninfo>Guarantor listed and linked from the child
21874 record</screeninfo>
21878 <imagedata fileref="images/patrons/child.png"/>
21885 <para>On the Guarantor's record, all children and/or professionals
21886 will be listed</para>
21889 <screeninfo>Guarantees listed on the Guarantor's
21890 profile</screeninfo>
21894 <imagedata fileref="images/patrons/parent.png"/>
21901 <section id="patcircsummary">
21902 <title>Circulation Summary</title>
21904 <para>Below the patron's information on the details screen is a
21905 tabbed display of the items they have checked out, overdue, and on
21909 <screeninfo>Checkout summary</screeninfo>
21913 <imagedata fileref="images/patrons/checkoutsummary.png"/>
21918 <para>If they have family at the library staff can see what the
21919 other family members have checked out.</para>
21922 <screeninfo>Relative checkouts</screeninfo>
21926 <imagedata fileref="images/patrons/relativecheckouts.png"/>
21933 <section id="patronfines">
21934 <title>Fines</title>
21936 <para>The patron's complete accounting history will appear on the
21937 Fines tab. Contrary to its name, the Fines tab does not just show fine
21938 data, it also shows membership fees, rental fees, reserve fees and any
21939 other charge you may have for patrons.</para>
21942 <screeninfo>Patron Accounting Summary</screeninfo>
21946 <imagedata fileref="images/patrons/patronaccount.png"/>
21951 <section id="chargefines">
21952 <title>Charging Fines/Fees</title>
21954 <para>Most fees and fines will be charged automatically if the <link
21955 linkend="finescronjob">fines cron job</link> is running:</para>
21959 <para>Fines will be charged based on your <link
21960 linkend="circfinerules">Circulation & Fines
21961 Rules</link></para>
21965 <para>Hold fees will be charged based on the rules you set in
21966 the <link linkend="patcats">Patron Types & Categories</link>
21967 administration area</para>
21971 <para>Rental fees will be charged based on the settings in your
21972 <link linkend="itemtypeadmin">Item Types</link> administration
21977 <para>Marking an item 'Lost' via the cataloging module will
21978 automatically charge the patron the replacement cost for that
21984 <section id="payfines">
21985 <title>Pay/Reverse Fines</title>
21987 <para>Each line item can be paid in full (or written off) using the
21988 'Pay Fines' tab.</para>
21991 <screeninfo>Paying Fines</screeninfo>
21995 <imagedata fileref="images/patrons/makepayment.png"/>
22002 <para>Each line item can be paid in full, partially paid, or
22003 written off.</para>
22007 <para>Pay a fine in full</para>
22011 <para>Click "Pay" next to the fine you want to pay in
22016 <para>The full amount of the fine will be populated for you
22017 in the "Collect From Patron" box</para>
22020 <screeninfo>Pay fine</screeninfo>
22024 <imagedata fileref="images/patrons/payfine.png"/>
22031 <para>Click "Confirm"</para>
22035 <para>The fine will be removed from outstanding fines, and
22036 displayed as fully paid.</para>
22042 <para>Pay a partial fine</para>
22046 <para>Click "Pay" next to the fine you want to partially
22051 <para>Enter the amount you are collecting from the patron in
22052 the "Collect From Patron" box</para>
22055 <screeninfo>Pay partial fine</screeninfo>
22059 <imagedata fileref="images/patrons/paypartial.png"/>
22066 <para>Click "Confirm"</para>
22070 <para>The fine will be updated to show the original Amount,
22071 and the current Amount Outstanding</para>
22077 <para>Pay an amount towards all fines</para>
22081 <para>Click the "Pay Amount" button</para>
22085 <para>Enter the amount you are collecting from the patron in
22086 "Collect from Patron." The sum of all fines is shown in
22087 "Total Amount Outstanding"</para>
22090 <screeninfo>Pay Amount</screeninfo>
22094 <imagedata fileref="images/patrons/payamount.png"/>
22101 <para>Click "Confirm"</para>
22105 <para>The fine totals will be updated with the payment
22106 applied to oldest fines first.</para>
22112 <para>Pay Selected fines</para>
22116 <para>Check the selection boxes next to the fines you wish
22117 to pay, click "Pay Selected"</para>
22120 <screeninfo>Select lines to pay</screeninfo>
22124 <imagedata fileref="images/patrons/payselected-select.png"/>
22131 <para>Enter an amount to pay towards the fines.</para>
22134 <screeninfo>Pay Selected</screeninfo>
22138 <imagedata fileref="images/patrons/payselected.png"/>
22145 <para>Click "Confirm"</para>
22149 <para>The fine totals will be updated with the payment
22150 applied to the oldest selected fines first.</para>
22156 <para>Writeoff a single fine</para>
22160 <para>Click "Writeoff" next to the fine you wish to
22165 <para>The fine will be removed from outstanding fines, and
22166 displayed as written off.</para>
22172 <para>Writeoff All fines</para>
22176 <para>Click the "Writeoff All" button</para>
22180 <para>All fines will be removed from outstanding fines, and
22181 displayed as written off.</para>
22187 <para>If you accidentally mark and item as paid, you can reverse
22188 that line item by clicking 'Reverse' to the right of the
22192 <screeninfo>Reverse Link</screeninfo>
22196 <imagedata fileref="images/patrons/reverselink.png"/>
22203 <para>Once clicked a new line item will be added to the
22204 account, showing the payment as reversed</para>
22207 <screeninfo>Reversed Payment</screeninfo>
22211 <imagedata fileref="images/patrons/reversed.png"/>
22221 <section id="manualinvoice">
22222 <title>Creating Manual Invoices</title>
22224 <para>For fees that are not automatically charged, librarians can
22225 create a manual invoice</para>
22228 <screeninfo>Create Manual Invoice</screeninfo>
22232 <imagedata fileref="images/patrons/manualinvoice.png"/>
22239 <para>First choose the type of invoice you would like to
22244 <para>To add additional values to the manual invoice type
22245 pull down menu, add them to the <link
22246 linkend="manualinvvals">MANUAL_INV</link> Authorized
22253 <para>If the fee is associated with an item you can enter its
22254 barcode so that the line item shows a link to that item</para>
22258 <para>The description field is where you will enter the
22259 description of the charge</para>
22263 <para>In the amount field, do not enter currency symbols, only
22264 numbers and decimals</para>
22269 <section id="manualcredit">
22270 <title>Creating Manual Credits</title>
22272 <para>Manual credits can be used to pay off parts of fines, or to
22273 forgive a fine amount.</para>
22276 <screeninfo>Create Manual Credit</screeninfo>
22280 <imagedata fileref="images/patrons/manualcredit.png"/>
22287 <para>First choose the type of credit you'd like to apply</para>
22291 <para>If this credit is associated with an item you can enter
22292 that item's barcode so that the line item links to the right
22297 <para>The description field is where you will enter the
22298 description of the credit</para>
22302 <para>In the amount field, do not enter currency symbols, only
22303 numbers and decimals</para>
22308 <section id="printinglineitems">
22309 <title>Printing Invoices</title>
22311 <para>To the right of each account line there is a print link.
22312 Clicking that link will print an invoice for the line item that
22313 includes the date and description of the line item along with the
22314 total outstanding on the account.</para>
22317 <screeninfo>Sample Invoice</screeninfo>
22321 <imagedata fileref="images/patrons/patroninvoice.png"/>
22328 <section id="circhistory">
22329 <title>Circulation History</title>
22331 <para>The circulation history tab will appear if you have set the
22332 <link linkend="intranetreadinghistory">intranetreadinghistory</link>
22333 preference to allow it to appear. If you have the <link
22334 linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
22335 'Allow' and the patron has decided that the library cannot keep this
22336 information this tab will only show currently checked out
22340 <screeninfo>Patron Circulation History</screeninfo>
22344 <imagedata fileref="images/patrons/readinghistory.png"/>
22349 <para>If you would like to export a list of barcodes for the items
22350 checked in today you can find that option under the More menu on the
22351 top right of the page.</para>
22354 <screeninfo>Export today's checkins</screeninfo>
22358 <imagedata fileref="images/patrons/readinghistory-export.png"/>
22363 <para>This will generate a text file with one barcode per line.</para>
22366 <section id="patmodlog">
22367 <title>Modification Log</title>
22369 <para>If you have set your <link
22370 linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
22371 records, then this tab will appear. The Modification Log will show
22372 when changes were made to the patron record. If you also have turned
22373 on the <link linkend="IssueLog">IssueLog</link> and <link
22374 linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
22375 this screen as well.</para>
22378 <screeninfo>Changes to Patron</screeninfo>
22382 <imagedata fileref="images/patrons/borrowerlog.png"/>
22389 <para>The Librarian field shows the patron number for the
22390 librarian who made the changes</para>
22394 <para>The module lists 'MEMBERS' for the patron module</para>
22398 <para>The action will tell you what action was being logged</para>
22402 <para>The Object field lists the borrowernumber that is being
22403 modified (in the example above, it was my changing my own
22409 <section id="patnotices">
22410 <title>Notices</title>
22412 <para>The <link linkend="setpatronmessaging">patron's messaging
22413 preferences</link> are set when <link
22414 linkend="addnewpatron">adding</link> or <link
22415 linkend="editpatrons">editing</link> the patron. This tab will show
22416 the messages that have been sent and those that are queued to be
22420 <screeninfo>Patron Notices Tab</screeninfo>
22424 <imagedata fileref="images/patrons/patnoticestab.png"/>
22429 <para>Clicking on the message title will expand the view to show you
22430 the full text of the message that was sent.</para>
22433 <screeninfo>Full message text</screeninfo>
22437 <imagedata fileref="images/patrons/patnoticestab-full.png"/>
22444 <section id="patronsearch">
22445 <title>Patron Search</title>
22447 <para>Clicking on the link to the Patron module will bring you to a
22448 search/browse screen for patrons. From here you can search for a
22452 <screeninfo>Patron Search</screeninfo>
22456 <imagedata fileref="images/patrons/patronsearch.png"/>
22461 <para>Depending on what you have chosen for the 'Search fields' you can
22462 search for patrons in various different ways.</para>
22465 <screeninfo>Patron Search Fields</screeninfo>
22469 <imagedata fileref="images/patrons/patronfieldsearch.png"/>
22476 <para>Standard:</para>
22480 <para>Enter any part of their name, username, email address or
22487 <para>Email:</para>
22491 <para>Enter any part of their email address.</para>
22497 <para>Borrower number:</para>
22501 <para>Enter the Koha borrower number</para>
22507 <para>Phone number:</para>
22511 <para>Enter the phone number exactly as it is in the system or
22512 by using spaces between each batch of numbers.</para>
22516 <para>Example: To find (212) 555-1212 you can search for it
22517 exactly as it was entered or by searching for 212 555
22524 <para>If you want to filter your results to a specific branch or
22525 category, you can click the plus sign [+] to the right of the search
22529 <screeninfo>Advanced Patron Search</screeninfo>
22533 <imagedata fileref="images/patrons/patronfilter.png"/>
22538 <para>You can also browse through the patron records by clicking on the
22539 linked letters across the top.</para>
22542 <screeninfo>Patron Browse</screeninfo>
22546 <imagedata fileref="images/patrons/patronbrowse.png"/>
22553 <chapter id="circulation">
22554 <title>Circulation</title>
22556 <para>Circulation functions can be accessed in several different ways. On
22557 the main page of the staff client there are some quick links in the center
22558 of the page to check items out, in or transfer them. For a complete
22559 listing of Circulation functions you can visit the Circulation page which
22560 is linked from the top left of every page or from the center of the main
22563 <para>Before circulating your collection you will want to set your <link
22564 linkend="globalsysprefs">Global System Preferences</link>, <link
22565 linkend="basicparams">Basic Parameters</link> and <link
22566 linkend="patscirc">Patrons & Circulation Rules</link>.</para>
22568 <para>While in Circulation you can jump between the tabs on the quick
22569 search box at the top of the screen by using the following hot
22574 <para>jump to the catalog search with Alt+Q</para>
22578 <para>jump to the checkout with Alt+U</para>
22582 <para>this will not work for Mac users</para>
22588 <para>jump to the checkin with Alt+R</para>
22593 <para>Mac users use the OPTION button in place of ALT</para>
22596 <section id="checkingout">
22597 <title>Check Out (Issuing)</title>
22599 <para>To begin the checkout process you must enter the patron barcode or
22600 part of their name. The checkout option appears in three main
22605 <para>Check out option on the top of the main staff client</para>
22608 <screeninfo>Check out box on main Koha Staff Client
22613 <imagedata fileref="images/circ/checkoutmain.png"/>
22620 <para>Check out option on the patron record</para>
22623 <screeninfo>Check out tab on a patron record</screeninfo>
22627 <imagedata fileref="images/circ/checkoutpatron.png"/>
22634 <para>Check out option on the quick search bar on the circulation
22638 <screeninfo>Check out tab on quick search bar</screeninfo>
22642 <imagedata fileref="images/circ/circquickbox.png"/>
22649 <section id="checkitemout">
22650 <title>Checking Items Out</title>
22652 <para>To check an item out to a patron, first search for that patron
22653 using one of the many options listed above.</para>
22656 <screeninfo>Check Out Screen</screeninfo>
22660 <imagedata fileref="images/circ/checkingout.png"/>
22665 <para>At the top of the Check Out screen is a box for you to type or
22666 scan the item's barcode into.</para>
22671 <para>Many modern barcode scanners will send a 'return' to the
22672 browser, making it so that the 'Check Out' button is
22673 automatically clicked</para>
22678 <para>If the barcode is not found you will be prompted to use fast
22679 cataloging to add the item. Learn more about <link
22680 linkend="fastaddcat">fast cataloging</link> later in this
22685 <para>Below the box for the barcode there may be options for you to
22686 override the default due date for the item.</para>
22690 <para>This option will only appear if you have set the <link
22691 linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
22692 to allow staff to override the due date</para>
22696 <para>At the bottom of the page there is a summary of the patron's
22697 current checked out items along with the due date (and time if the
22698 item is an hourly loan), items checked out today will appear at the
22702 <para>If the checked out time is listed as 00:00 then the item is a
22703 daily loan item. The due time for daily checkouts will show 23:59
22704 which is the last minute of the day.</para>
22708 <screeninfo>Patron's checkout summary</screeninfo>
22712 <imagedata fileref="images/circ/checkoutsummary.png"/>
22717 <para>Also at the bottom of the page is the list of items the patron
22721 <screeninfo>Holds summary on check out screen</screeninfo>
22725 <imagedata fileref="images/circ/holdssummary.png"/>
22730 <para>From the holds list you can suspend or resume patrons holds
22731 using the options at the bottom of the list if you have the <link
22732 linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
22733 set to 'allow.'</para>
22736 <para>If you have your <link
22737 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
22738 preference set to "Don't allow" then you will not have the option to
22739 put an end date on the hold suspension</para>
22742 <para>If there are notes on the patron record these will appear to the
22743 right of the checkout box</para>
22746 <screeninfo>Patron notes on check out screen</screeninfo>
22750 <imagedata fileref="images/circ/patronnotes.png"/>
22755 <para>If the patron has a hold waiting at the library that too will
22756 appear to the right of the check out box making it easy for the
22757 circulation librarian to see that there is another item to give the
22761 <screeninfo>Hold waiting message on check out screen</screeninfo>
22765 <imagedata fileref="images/circ/holdwaiting.png"/>
22770 <section id="printcircreceipt">
22771 <title>Printing Receipts</title>
22773 <para>Once you have checked out all of the items for the patron you
22774 can print them a receipt by choosing one of two methods.</para>
22776 <para>If you have the <link
22777 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
22778 preference set to 'open a print quick slip window' you can simply
22779 hit enter on your keyboard or scan a blank piece of paper with your
22780 barcode scanner. The idea being that you're "checking out" a blank
22781 barcode which triggers Koha to print the 'Quick slip.'</para>
22783 <para>You can also click the Print button at the top of the screen
22784 and choose 'Print slip' or 'Print quick slip'.</para>
22787 <screeninfo>Print receipt to slip printer</screeninfo>
22791 <imagedata fileref="images/circ/printslip.png"/>
22796 <para>If you choose 'Print slip' it will print all of the items the
22797 patron has checked out, including those they checked out at an
22798 earlier date. Choosing 'Print quick slip' will print only the items
22799 that were checked out today.</para>
22801 <para>What prints on the slips can be customized by altering the
22802 slip templates under the <link linkend="notices">Notices &
22803 Slips</link> tool.</para>
22806 <section id="clearpatroninfo">
22807 <title>Clear Patron Information</title>
22809 <para>When you're done checking an item out if you have the <link
22810 linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
22811 preference set to 'Show' you can clear the current patron by
22812 clicking the X in the top right of the patron's info to remove the
22813 current patron from the screen and start over.</para>
22816 <screeninfo>Clear Screen Button</screeninfo>
22820 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
22825 <para>If you have the <link
22826 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
22827 preference set to 'clear the screen' then you simply need to hit
22828 enter or scan a blank barcode and the screen will be cleared of the
22829 current patron.</para>
22833 <section id="checkoutmsg">
22834 <title>Check Out Messages</title>
22836 <para>If you check out an item that has multiple pieces and you have
22837 cataloged that information in subfield 3 of the item record (in
22838 MARC21) a message will pop up when you check out that item telling you
22839 how many pieces should be there.</para>
22842 <screeninfo>Materials in the checked out item</screeninfo>
22846 <imagedata fileref="images/circ/materialspecified.png"/>
22851 <para>There are times when Koha will prevent the librarian from being
22852 able to check out items to a patron. When this happens a warning will
22853 appear notifying the librarian of why the patron cannot check items
22858 <para>Patron owes too much in fines</para>
22861 <screeninfo>Patron owes too much in fines</screeninfo>
22865 <imagedata fileref="images/circ/fineswarning.png"/>
22872 <para>You can set the amount at which patron checkouts are
22873 blocked with the <link
22874 linkend="noissuescharge">noissuescharge</link> system
22881 <para>Patron has been barred from the library</para>
22884 <screeninfo>Patron account barred</screeninfo>
22888 <imagedata fileref="images/circ/debarwarning.png"/>
22895 <para>This can be set by the librarian editing a patron record
22896 and adding a <link linkend="patronflags">flag</link> or by the
22897 <link linkend="noticetriggers">Overdue/Notice Status
22898 Triggers</link></para>
22904 <para>Patron needs to confirm their address</para>
22907 <screeninfo>Patron's address warning</screeninfo>
22911 <imagedata fileref="images/circ/addresswarning.png"/>
22918 <para>This can be set by the librarian editing a patron record
22919 and adding a <link linkend="patronflags">flag</link></para>
22925 <para>Patrons has lost their library card</para>
22928 <screeninfo>Lost patron card warning</screeninfo>
22932 <imagedata fileref="images/circ/lostcardwarning.png"/>
22939 <para>This can be set by the librarian editing a patron record
22940 and adding a <link linkend="patronflags">flag</link></para>
22947 <section id="checkoutwarn">
22948 <title>Check Out Warnings</title>
22950 <para>Sometimes checkouts will trigger warning messages that will
22951 appear in a yellow box above the check out field. These warnings need
22952 to be acknowledged before you will be able to continue checking items
22957 <para>Patron has outstanding fines</para>
22960 <screeninfo>Patron has a debt</screeninfo>
22964 <imagedata fileref="images/circ/warnings/patrondebt.png"/>
22971 <para>Item on hold for someone else</para>
22974 <screeninfo>Item is on hold for someone else</screeninfo>
22978 <imagedata fileref="images/circ/warnings/onhold.png"/>
22985 <para>Item should be on the hold shelf waiting for someone
22989 <screeninfo>Item is on hold shelf waiting for someone
22994 <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
23001 <para>Item already checked out to this patron</para>
23004 <screeninfo>Item is currently checked out to this
23005 patron</screeninfo>
23009 <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
23016 <para>Item checked out to another patron</para>
23019 <screeninfo>Item checked out to another patron</screeninfo>
23023 <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
23030 <para>Item not for loan</para>
23033 <screeninfo>Item is not normally for loan</screeninfo>
23037 <imagedata fileref="images/circ/warnings/notforloan.png"/>
23044 <para>Patron has too many things checked out</para>
23047 <screeninfo>Too many checkouts</screeninfo>
23051 <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
23058 <para>Item cannot be renewed</para>
23061 <screeninfo>No more renewals</screeninfo>
23065 <imagedata fileref="images/circ/warnings/norenewals.png"/>
23072 <para>This can be overridden with the <link
23073 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
23074 system preference</para>
23080 <para>Barcode not found</para>
23083 <screeninfo>Barcode not found</screeninfo>
23087 <imagedata fileref="images/circ/barcodefastadd.png"/>
23094 <para>Learn more about <link linkend="fastaddcat">fast
23095 cataloging</link> later in this manual.</para>
23103 <section id="circrenew">
23104 <title>Renewing</title>
23106 <para>Checked out items can be renewed (checked out for another period
23107 of time) based on your <link linkend="circfinerules">circulation
23108 rules</link> and <link linkend="RenewalPeriodBase">renewal
23109 preferences</link>. If you allow it, patrons can renew their own items
23110 via the OPAC, but sometimes you'll need to help them by renewing their
23111 items via the staff client. To renew items checked out to a patron,
23112 visit their details page or checkout page and review their checkout
23113 summary at the bottom.</para>
23116 <screeninfo>Circulation Summary</screeninfo>
23120 <imagedata fileref="images/circ/circsummary.png"/>
23125 <para>In the Renew column you will see how many times each item has been
23126 renewed and a checkbox to renew the item for the patron. Check the boxed
23127 of the items you would like to renew and click the 'Renew or Return
23128 checked items' button, or to renew all items checked out to the patron
23129 simply click the 'Renew all' button.</para>
23132 <screeninfo>Renew buttons</screeninfo>
23136 <imagedata fileref="images/circ/renewbutton.png"/>
23141 <para>Sometimes renewals will be blocked based on your circulation
23142 rules, to override this block you must have your <link
23143 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
23144 preference set to 'Allow'. If you allow renewal limit overrides, you
23145 will see a checkbox at the bottom left of the circulation summary. Check
23146 that box and then choose the items you would like to renew.</para>
23149 <screeninfo>Override renewal limit</screeninfo>
23153 <imagedata fileref="images/circ/overriderenew.png"/>
23158 <para>Checking that box will add checkboxes in the renew column above
23159 where before the item was not renewable.</para>
23162 <section id="checkingin">
23163 <title>Check In (Returning)</title>
23165 <para>Checking in items can be performed from various different
23170 <para>The check in box on the top of the main staff client</para>
23173 <screeninfo>Check out box on main Koha Staff Client
23178 <imagedata fileref="images/circ/checkinmain.png"/>
23185 <para>The check in option on the quick search bar on the Circulation
23187 <screeninfo>Check in tab on quick search bar</screeninfo>
23191 <imagedata fileref="images/circ/checkinquickbox.png"/>
23194 </screenshot></para>
23198 <para>The check in link on the patron's checkout summary (and on the
23199 checkout summary page)</para>
23202 <screeninfo>Patron checkout summary includes 'Check In'
23207 <imagedata fileref="images/circ/checkinlink.png"/>
23214 <para>The Check in page under the Circulation menu</para>
23217 <screeninfo>Check in link on Circulation Module</screeninfo>
23221 <imagedata fileref="images/circ/checkincirc.png"/>
23228 <section id="checkitemin">
23229 <title>Checking Items In</title>
23231 <para>To check an item in scan the barcode for the item into the box
23232 provided. A summary of all items checked in will appear below the
23236 <screeninfo>Check In Summary</screeninfo>
23240 <imagedata fileref="images/circ/checkin.png"/>
23245 <para>If you are checking items in that were put in the dropbox while
23246 the library was closed you can check the 'Dropbox mode' box before
23247 scanning items. This will effectively roll back the returned date to
23248 the last date the library was open.</para>
23252 <para>This requires that you have your closings added to the <link
23253 linkend="calholidays">Holidays & Calendar Tool </link></para>
23257 <para>You can also choose to forgive all overdue charges for items you
23258 are checking in by checking the 'Forgive overdue charges' box before
23259 scanning items.</para>
23262 <section id="checkinmsg">
23263 <title>Check In Messages</title>
23265 <para>There are several messages that can appear when checking items
23270 <para>If you are checking an item in at a library other than the
23271 home branch, a message will appear asking you to transfer the book
23272 to the home library</para>
23275 <screeninfo>Check in Transfer Message</screeninfo>
23279 <imagedata fileref="images/circ/checkintransfer.png"/>
23286 <para>After this item is checked in the status of the item
23287 will be changed in the catalog to 'in transit'</para>
23290 <screeninfo>In Transit Status</screeninfo>
23294 <imagedata fileref="images/circ/transferstatus.png"/>
23301 <para>To mark an item as back at the home branch, check the
23302 item in at the home branch</para>
23305 <screeninfo>Check In Transferred Item</screeninfo>
23309 <imagedata fileref="images/circ/transfercheckin.png"/>
23316 <para>A message will appear tell you that the item is not
23317 checked out, but the status will now say available in the
23318 catalog. This step is necessary to mark items as received
23319 by the home branch.</para>
23327 <para>If you are checking in an item that should have multiple
23328 parts or pieces a message will appear warning you about the number
23329 of pieces you should have in your hand</para>
23332 <screeninfo>Materials Specified</screeninfo>
23336 <imagedata fileref="images/circ/materialspecified.png"/>
23343 <para>If you're checking an item in that has a hold on it, you
23344 will be prompted to confirm the hold</para>
23347 <screeninfo>Hold Found Check In Message</screeninfo>
23351 <imagedata fileref="images/circ/holdfound.png"/>
23358 <para>Clicking the Confirm hold button will mark the item as
23359 waiting for pickup from the library</para>
23362 <screeninfo>Hold waiting at the library</screeninfo>
23366 <imagedata fileref="images/circ/waitingstatus.png"/>
23373 <para>Clicking the Print Slip and Confirm button will mark the
23374 item as waiting for pickup at the library and present the
23375 library with a receipt to print and place on the book with the
23376 patron's information</para>
23380 <para>Ignoring the hold will leave the item on hold, but leave
23381 its status as Available (it will not cancel the hold)</para>
23387 <para>If you're checking in an item that has a hold on it at
23388 another branch you will be prompted to confirm and transfer the
23392 <screeninfo>Hold found for another branch</screeninfo>
23396 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
23403 <para>Clicking the Confirm hold and Transfer button will mark
23404 the item as in transit to the library where the hold was
23408 <screeninfo>In transit hold status</screeninfo>
23412 <imagedata fileref="images/circ/intransithold.png"/>
23419 <para>Clicking the Print Slip, Transfer and Confirm button
23420 will mark the item as in transit to the library where the hold
23421 was placed and present the library with a receipt to print and
23422 place on the book with the patron's information</para>
23426 <para>Ignoring the hold will leave the item on hold, but leave
23427 its status as Available (it will not cancel the hold)</para>
23433 <para>If you have the system showing you fines at the time of
23435 linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
23436 see a message telling you about the fine and providing you a link
23437 to the payment page for that patron</para>
23440 <screeninfo>FineNotifyAtCheckin</screeninfo>
23444 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
23453 <section id="circmessages">
23454 <title>Circulation Messages</title>
23456 <para>Circulation messages are short messages that librarians can leave
23457 for their patrons or their colleagues that will appear at the time of
23458 circulation.</para>
23460 <section id="setcircmsg">
23461 <title>Setting up Messages</title>
23463 <para>Circulation messages are set up as <link
23464 linkend="authorizedvalues">Authorized Values</link>. To add or edit
23465 Circulation Messages you want to work with the <link
23466 linkend="bornotes">BOR_NOTES</link> value.</para>
23469 <screeninfo>BOR_NOTES Authorized Values</screeninfo>
23473 <imagedata fileref="images/circ/bor_notes.png"/>
23478 <para>The 'Description' field can hold a canned message that you would
23479 like to appear on the patron's record. <important>
23480 <para>The 'Description' field is limited to 80 characters, but the
23481 patron message field can hold more than that. Enter 80 characters
23482 in the 'Description' field and then type the rest on the patron
23484 </important></para>
23487 <section id="addcircmsg">
23488 <title>Adding a Message</title>
23490 <para>When on the patron's check out tab you will see a link to 'Add a
23491 new message' to the right of the check out box.</para>
23494 <screeninfo>Circulation Message in Staff Client</screeninfo>
23498 <imagedata fileref="images/circ/staffmessages.png"/>
23503 <para>When you click 'Add a new message' you will be asked to choose
23504 if the message is for the librarians or the patron and the message you
23505 would like to leave.</para>
23508 <screeninfo>Leave a Circulation Message</screeninfo>
23512 <imagedata fileref="images/circ/leavecircmsg.png"/>
23518 <para>A message for the patron will also show to the library
23523 <section id="viewcircmsg">
23524 <title>Viewing Messages</title>
23526 <para>Circulation messages meant for the staff and/or the patron will
23527 appear on the patron's checkout screen to the right of the checkout
23528 box. Messages in bold and red are meant for the library staff only,
23529 whereas messages in regular italics font are meant for the patron and
23530 the librarian.</para>
23533 <screeninfo>Circulation Message in Staff Client</screeninfo>
23537 <imagedata fileref="images/circ/staffmessages.png"/>
23542 <para>Circulation messages meant for the patron will also appear when
23543 they log into the OPAC.</para>
23546 <screeninfo>Circulation Message in OPAC</screeninfo>
23550 <imagedata fileref="images/circ/opacmsg.png"/>
23557 <section id="holds">
23558 <title>Holds</title>
23562 <section id="holdsinstaff">
23563 <title>Placing Holds in Staff Client</title>
23565 <para>There are several ways to place holds from the staff client. The
23566 most obvious is using the 'Place Hold' button at the top of any
23567 bibliographic record.</para>
23570 <screeninfo>Place Hold Button on Bib Record</screeninfo>
23574 <imagedata fileref="images/circ/placeholdbib.png"/>
23579 <para>You can also click the smaller 'Place Hold' link found at the
23580 top of your catalog search results, or the 'Holds' link found below
23581 each result.</para>
23584 <screeninfo>Hold options on search results</screeninfo>
23588 <imagedata fileref="images/circ/placeholdsearch.png"/>
23593 <para>You will be asked to search for a patron by barcode or any part
23594 of their name to start the hold process.</para>
23597 <screeninfo>Find Patron For Hold</screeninfo>
23601 <imagedata fileref="images/circ/placeholdfindpatron.png"/>
23606 <para>If you'd like to search for the patron first and then the bib
23607 record for the hold, you can open the patron record and click on the
23608 'Search to Hold' button at the top of the patron record.</para>
23611 <screeninfo>Search to Hold on Patron Record</screeninfo>
23615 <imagedata fileref="images/circ/searchtohold.png"/>
23620 <para>After clicking the button you will be brought to the catalog
23621 search page where you can find the book(s) you want to place a hold
23622 on. Under each title on the results you'll see an option to 'Hold for
23623 Patron Name.'</para>
23626 <screeninfo>Hold for Patron links on Search Results</screeninfo>
23630 <imagedata fileref="images/circ/holdresults.png"/>
23635 <para>If you want to place a hold on multiple items, simply check the
23636 boxes to the left of them and click the arrow to the right of the
23637 'Place Hold' button.</para>
23640 <screeninfo>Hold Multiple Items for Patron</screeninfo>
23644 <imagedata fileref="images/circ/holdmultiresults.png"/>
23649 <para>Depending on how many items you choose to place a hold on at
23650 once you will see a different place hold form. If you are placing a
23651 hold on one bibliographic record you will see a list of all of the
23652 items you can place a hold on.</para>
23655 <screeninfo>Place Hold Form</screeninfo>
23659 <imagedata fileref="images/circ/placeholdsingle.png"/>
23666 <para>Enter any notes that might apply to this hold</para>
23670 <para>Choose the library where the patron will pick up the
23675 <para>If the patron wants the hold to start on a date other than
23676 today, enter that in the 'Hold starts on date' field</para>
23680 <para>This option will only appear if the <link
23681 linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
23682 system preference is set to 'Allow'</para>
23688 <para>If the patron has specified that they don't want the item
23689 after a certain date, or if you have limits on hold lengths, you
23690 can enter an expiration date for the hold in the 'Hold expires on
23695 <para>To have expired holds canceled automatically you will
23696 need to have the <link linkend="expiredholdscron">Expired
23697 Holds</link> cron job set to run on a regular basis.</para>
23703 <para>Next choose if you want to place a hold on the next
23704 available item or a specific item by clicking the radio button
23705 next to an individual item.</para>
23709 <para>If you're placing a hold on multiple items you will be presented
23710 with the next available option for all titles. If no items are
23711 available for hold it will say so on the confirmation screen.</para>
23714 <screeninfo>Place multiple items on hold</screeninfo>
23718 <imagedata fileref="images/circ/placeholdmultiple.png"/>
23723 <para>Once your hold is placed, if you'd like to have Koha forget that
23724 you used the 'Search to Hold' function, you can choose to have Koha
23725 'forget' the patron's name by clicking the arrow to the right of the
23726 'Place Hold' button on the search results and choosing the 'Forget'
23730 <screeninfo>Forget Search to Hold Option</screeninfo>
23734 <imagedata fileref="images/circ/forgethold.png"/>
23740 <section id="manageholds">
23741 <title>Managing Holds</title>
23743 <para>Holds can be altered and canceled from the Holds tab found on
23744 the left of the bibliographic record.</para>
23747 <screeninfo>Bibliographic Record Tabs</screeninfo>
23751 <imagedata fileref="images/circ/holdtab.png"/>
23756 <para>From the list of holds you can change the order of the holds,
23757 the pickup location, suspend and/or cancel the hold.</para>
23760 <screeninfo>Lists of Holds</screeninfo>
23764 <imagedata fileref="images/circ/holdslist.png"/>
23770 <para>If you have your <link
23771 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
23772 preference set to "Don't allow" then you will not have the option to
23773 put an end date on the hold suspension</para>
23777 <para>Depending on how you have your <link
23778 linkend="HidePatronName">HidePatronName</link> system preference set
23779 the list may show card numbers instead of names in the Patron column
23780 like in the image above.</para>
23783 <para>To rearrange or delete holds, simply make a selection from the
23784 'Priority' pull down or click the arrows to the right of the priority
23788 <screeninfo>Hold Priority Menu</screeninfo>
23792 <imagedata fileref="images/circ/holdpriority.png"/>
23797 <para>If you use the priority pull down to rearrange or delete holds
23798 you will need to click the 'Update hold(s)' button to save your
23801 <para>Clicking the down arrow to the right of the hold will stick the
23802 hold at the bottom of the list even if more requests are made.</para>
23804 <para>For example, your library has home-bound patrons that are
23805 allowed to keep books out for months at a time. It would not be fair
23806 to other patrons if a home-bound patron were able to check out a brand
23807 new book and keep it for months. For this reason, the home-bound
23808 patron's hold request would stay at the bottom of the queue until
23809 everyone else who wanted to read that book has already done so.</para>
23812 <screeninfo>Lowest Priority & Delete Options for
23817 <imagedata fileref="images/circ/lowestpriority.png"/>
23822 <para>If a patron asks to have their hold suspended and you have the
23823 <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
23824 system preference set to 'allow' you can do so by clicking the Suspend
23825 button to far right. If the patron gives you a date for the items to
23826 become unsuspended you can enter that in the date box and click the
23827 'Update hold(s)' button to save your changes.</para>
23830 <screeninfo>Hold suspension column</screeninfo>
23834 <imagedata fileref="images/circ/suspendholds.png"/>
23839 <para>To delete or cancel a hold click the red 'X' to the right of the
23840 hold line. To delete/cancel a bunch of holds you can choose 'del' from
23841 pull down to the left of each line and then click 'Update hold(s)' at
23842 the bottom of the list.</para>
23845 <screeninfo>Cancel Holds</screeninfo>
23849 <imagedata fileref="images/circ/cancelholds.png"/>
23855 <section id="receiveholds">
23856 <title>Receiving Holds</title>
23858 <para>When items that are on hold are checked in or out the system
23859 will remind the circulation librarian that the item is on hold and
23860 offer them options for managing the hold.</para>
23862 <para>When you check in an item that has a hold on it the system will
23863 ask you to either confirm and transfer the item</para>
23866 <screeninfo>Confirm Hold & Transfer</screeninfo>
23870 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
23875 <para>or just confirm the hold</para>
23878 <screeninfo>Confirm Hold</screeninfo>
23882 <imagedata fileref="images/circ/holdconfirm.png"/>
23887 <para>Clicking the Confirm button will mark the item as on hold for
23888 the patron. If the item needs to be transferred the item will also be
23889 marked as in transit to the proper branch. Clicking 'Ignore' will
23890 retain the hold, but allow you to check the item out to another
23891 patron. Choosing to confirm and print will present you with a
23892 printable page that you can slip inside the book with the necessary
23893 hold and/or transfer information.</para>
23895 <para>Once confirmed the hold will show on the patron record and on
23896 the checkout screen under the 'Hold' tab.</para>
23899 <screeninfo>Hold on Patron Record</screeninfo>
23903 <imagedata fileref="images/circ/holdpatronrec.png"/>
23908 <para>The item record will also show that the item is on hold.</para>
23911 <screeninfo>Hold on Item Record</screeninfo>
23915 <imagedata fileref="images/circ/holditem.png"/>
23920 <para>In some cases a patron may come in to pick up a hold for their
23921 partner (or someone else in their household). In this case you want to
23922 make sure that the hold is cancelled when you check the item out to
23923 someone else. When trying to check out an item that is already waiting
23924 for someone else you will be presented with a warning message.</para>
23927 <screeninfo>Hold waiting for someone else</screeninfo>
23931 <imagedata fileref="images/circ/holdwaitingwarn.png"/>
23936 <para>From here you can check the item out to the patron at the desk
23937 and cancel the hold for the patron.</para>
23941 <section id="transfers">
23942 <title>Transfers</title>
23944 <para>If you work in a multi-branch system you can transfer items from
23945 one library to another by using the Transfer tool. To transfer an
23950 <para>Click 'Transfer' on the Circulation page</para>
23953 <screeninfo>Transfer Tool</screeninfo>
23957 <imagedata fileref="images/circ/transfer.png"/>
23964 <para>Enter the library you would like to transfer the item
23969 <para>Scan or type the barcode on the item you would like to
23976 <para>Click 'Submit'</para>
23979 <screeninfo>Transfer Summary</screeninfo>
23983 <imagedata fileref="images/circ/itemtransferred.png"/>
23990 <para>The item will now say that it is in transit</para>
23993 <screeninfo>Item in Transit</screeninfo>
23997 <imagedata fileref="images/circ/itemintransit.png"/>
24004 <para>When the item arrives at the other branch the librarian must
24005 check the item in to acknowledge that it is no longer in
24010 <para>The item will not be permanently moved to the new
24014 <screeninfo>Item record</screeninfo>
24018 <imagedata fileref="images/circ/itemlocations.png"/>
24025 <para>The item shows the same 'Home Library' but has updated the
24026 'Current Location' to note where it resides at this time</para>
24033 <section id="setlibrary">
24034 <title>Set Library</title>
24036 <para>By default you will enter the staff client as if you are at your
24037 home library. This library will appear in the top right of the Staff
24041 <screeninfo>My Library</screeninfo>
24045 <imagedata fileref="images/circ/mylibrary.png"/>
24050 <para>This is the library that all circulation transactions will take
24051 place at. If you are at another library (or on a bookmobile) you will
24052 want to set your library before you start circulating items. To do this
24053 you can click 'Set' at the top right or on the Circulation page.</para>
24056 <screeninfo>Set Library Form</screeninfo>
24060 <imagedata fileref="images/circ/setlibrary.png"/>
24065 <para>Once you have saved your changes you new library will appear in
24066 the top right.</para>
24069 <section id="fastaddcat">
24070 <title>Fast Add Cataloging</title>
24072 <para>Sometimes circulation librarians need to quickly add a record to
24073 the system for an item they are about to check out. This is called 'Fast
24074 Add.' To allow circulation librarians access to the Fast Add Cataloging
24075 tool, simply make sure they have the <link
24076 linkend="fastaddpermissions">fast_cataloging</link> permissions. There
24077 are two ways to add titles via fast add. If you know that you're about
24078 to check out an item that isn't in you catalog you can go to the
24079 Circulation module and click 'Fast cataloging.'</para>
24082 <screeninfo>Circulation Menu</screeninfo>
24086 <imagedata fileref="images/circ/circmenu.png"/>
24091 <para>The cataloging interface will open up with the short cataloging
24095 <screeninfo>Fast Add Framework</screeninfo>
24099 <imagedata fileref="images/circ/fastadd.png"/>
24104 <para>After adding your cataloging data you will be asked to enter item
24105 data. Enter the items barcode, collection code, etc and save the item
24106 before checking it out.</para>
24108 <para>The other way to fast catalog is from the checkout screen. When
24109 you enter a barcode at checkout that Koha can't find, it will prompt you
24110 to use fast cataloging to add the item to Koha and check it out.</para>
24113 <screeninfo>Barcode not found</screeninfo>
24117 <imagedata fileref="images/circ/barcodefastadd.png"/>
24122 <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
24123 form where you can enter the title information</para>
24126 <screeninfo>Fast cataloging</screeninfo>
24130 <imagedata fileref="images/circ/fastaddbarcode.png"/>
24135 <para>After clicking 'Save' you will be brought to the item record where
24136 the barcode will already be filled in with the barcode you're trying to
24140 <screeninfo>Fast cataloging item record</screeninfo>
24144 <imagedata fileref="images/circ/fastadditem.png"/>
24149 <para>After clicking the 'Add item' button the item will automatically
24150 be checked out the patron you were trying to check the book out to
24154 <screeninfo>Checked out item</screeninfo>
24158 <imagedata fileref="images/circ/fastaddcheckedout.png"/>
24164 <section id="circreports">
24165 <title>Circulation Reports</title>
24169 <section id="holdsqueue">
24170 <title>Holds Queue</title>
24172 <para>This report will show you all of the holds at your
24176 <screeninfo>Sample Holds Queue</screeninfo>
24180 <imagedata fileref="images/circ/holdsqueue.png"/>
24185 <para>To generate this report, you must have the <link
24186 linkend="buildholdscron">Build Holds Queue cron job</link> running.
24187 This cron job is a script that should be run periodically if your
24188 library system allows borrowers to place on-shelf holds. This script
24189 decides which library should be responsible for fulfilling a given
24190 hold request.</para>
24192 <para>It's behavior is controlled by the system preferences <link
24193 linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link
24194 linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
24196 <para>If you do not want all of your libraries to participate in the
24197 on-shelf holds fulfillment process, you should list the the libraries
24198 that *do* participate in the process here by inputting all the
24199 participating library's branchcodes, separated by commas ( e.g.
24200 "MPL,CPL,SPL,BML" etc. ).</para>
24202 <para>By default, the holds queue will be generated such that the
24203 system will first attempt to hold fulfillment using items already at
24204 the pickup library if possible. If there are no items available at the
24205 pickup library to fill a hold, build_holds_queue.pl will then use the
24206 list of libraries defined in StaticHoldsQueueWeight. If
24207 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
24208 script will assign fulfillment requests in the order the branches are
24209 placed in the StaticHoldsQueueWeight system preference.</para>
24211 <para>For example, if your system has three libraries, of varying
24212 sizes ( small, medium and large ) and you want the burden of holds
24213 fulfillment to be on larger libraries before smaller libraries, you
24214 would want StaticHoldsQueueWeight to look something like
24215 "LRG,MED,SML".</para>
24217 <para>If you want the burden of holds fulfillment to be spread out
24218 equally throughout your library system, simply enable
24219 RandomizeHoldsQueueWeight. When this system preference is enabled, the
24220 order in which libraries will be requested to fulfill an on-shelf hold
24221 will be randomized each time the list is regenerated.</para>
24223 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
24224 time. Doing so will cause the build_holds_queue script to ignore
24225 RandomizeHoldsQueueWeight, causing the script to request hold
24226 fulfillment not randomly, but by alphabetical order.</para>
24229 <section id="holdspull">
24230 <title>Holds to pull</title>
24232 <para>This report will show you all of the items that have holds on
24233 them that are available at the library for pulling. If the items are
24234 available at multiple branches then all branches with that item
24235 available will see the hold to pull until one library triggers the
24239 <screeninfo>Holds to Pull</screeninfo>
24243 <imagedata fileref="images/circ/holdstopull.png"/>
24248 <para>You can limit the results you see by using the Refine box on the
24249 left side of the page:</para>
24252 <screeninfo>Refine Holds to Pull Report</screeninfo>
24256 <imagedata fileref="images/circ/refineholdstopull.png"/>
24262 <section id="holdspickup">
24263 <title>Holds awaiting pickup</title>
24265 <para>This report will show all of the holds that are waiting for
24266 patrons to pick them up.</para>
24269 <screeninfo>Holds Awaiting Pickup</screeninfo>
24273 <imagedata fileref="images/circ/holdspickup.png"/>
24278 <para>Items that have been on the hold shelf longer than you normally
24279 allow (based on the <link
24280 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
24281 preference value) will appear on the 'Holds Over' tab, they will not
24282 automatically be cancelled unless you have set the <link
24283 linkend="expiredholdscron">cron job</link> to do that for you, but you
24284 can cancel all holds using the button at the top of the list.</para>
24287 <screeninfo>Items waiting on the hold shelf too long</screeninfo>
24291 <imagedata fileref="images/circ/holdspickupover.png"/>
24297 <section id="holdratios">
24298 <title>Hold ratios</title>
24300 <para>Hold ratios help with collection development. Using this report
24301 you will be able to see how many of your patrons have holds on items
24302 and whether you should buy more. By default it will be set to the
24303 library needing 3 items per hold that has been placed. The report will
24304 tell you how many additional items need to be purchased to meet this
24308 <screeninfo>Hold Ratios</screeninfo>
24312 <imagedata fileref="images/circ/holdratio.png"/>
24318 <section id="transferstoreceive">
24319 <title>Transfers to receive</title>
24321 <para>This report will list all of the items that Koha thinks are in
24322 transit to your library.</para>
24325 <screeninfo>Transfers to Receive</screeninfo>
24329 <imagedata fileref="images/circ/transitreceive.png"/>
24334 <para>If your transfers are late in arriving at your library you will
24335 see a message stating how late your items are.</para>
24338 <screeninfo>Late transfers include warning messages</screeninfo>
24342 <imagedata fileref="images/circ/transferlate.png"/>
24348 <para>An item is considered late based on the number of days you
24349 have entered in the <link
24350 linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
24351 system preference.</para>
24355 <section id="overduesreport">
24356 <title>Overdues</title>
24359 <para>For libraries with a large patron base, this report may take a
24360 significant amount of time to run.</para>
24364 <para>Large libraries can choose to filter the report before it runs
24365 by setting the <link
24366 linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
24367 system preference to 'Require'.</para>
24370 <para>This report will list all items that are overdue at your
24374 <screeninfo>Overdues List</screeninfo>
24378 <imagedata fileref="images/circ/overdues.png"/>
24383 <para>The report can be filtered using the menu options found on the
24384 left of the report.</para>
24387 <section id="overduesfines">
24388 <title>Overdues with fines</title>
24390 <para>This report will show you any overdues at your library that have
24391 accrued fines on them.</para>
24394 <screeninfo>Overdues with fines</screeninfo>
24398 <imagedata fileref="images/circ/overduewfines.png"/>
24403 <para>If you would like to limit the report you can use the pull down
24404 menu at the top to limit to a specific shelving location at your
24405 branch. To see overdues with fines at other branches you will have to
24406 <link linkend="setlibrary">change your branch</link> or log in at that
24408 <para>If you do not charge fines and/or don't have the <link
24409 linkend="finescronjob">fines cron job</link> running you will see
24410 no data on this report.</para>
24411 </important></para>
24415 <section id="trackinhouse">
24416 <title>Tracking In house Use</title>
24418 <para>Many libraries track the use of items within the library. This can
24419 be done in Koha one of two ways. The first is to create one or more
24420 <link linkend="addstatspatron">Statistical Patrons</link>. When
24421 collecting items that have been used within the library, you will want
24422 to check them out to your statistical patron:</para>
24425 <screeninfo>Check Out Items to Stats Patron</screeninfo>
24429 <imagedata fileref="images/circ/checkoutinhouse.png"/>
24434 <para>Instead of marking the item as 'checked out' the system will
24435 record that the item was used in house:</para>
24438 <screeninfo>Local Use Recorded</screeninfo>
24442 <imagedata fileref="images/circ/localuserecorded.png"/>
24447 <para>Repeat these steps for all items that have been used within the
24448 library to keep accurate statistics for item use.</para>
24450 <para>The other way to record local use of items is to set your <link
24451 linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
24452 preference to 'Record.' Then whenever you check an item in that is not
24453 checked out and not on hold a local use will be recorded.</para>
24456 <screeninfo>Local Use Recorded</screeninfo>
24460 <imagedata fileref="images/circ/localusecheckin.png"/>
24466 <para>If you have <link
24467 linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
24468 'Record' you can still use your statistical patrons to record local
24469 use as well.</para>
24473 <section id="processinglocations">
24474 <title>In Processing / Book Cart Locations</title>
24476 <para>Koha allows for handling temporary locations like the processing
24477 center and/or book carts throughout the library. For this feature to
24478 work you must first make sure you have <link
24479 linkend="authorizedvalues">authorized values</link> set in the <link
24480 linkend="shelvelocvals">LOC</link> category for PROC (Processing Center)
24481 and CART (Book Cart).</para>
24484 <screeninfo>CART & PROC values in LOC</screeninfo>
24488 <imagedata fileref="images/circ/LOCvalues.png"/>
24493 <para>Next you need to set the <link
24494 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
24495 preference to PROC. This will set the new items to the Processing Center
24496 as their default location.</para>
24498 <para>Create items with their desired final shelving location.</para>
24502 <para>These newly cataloged items will be temporarily set to the
24503 PROC location and will display with whatever description PROC has.
24504 The original location code entered at item creation is stored in the
24505 new items column 'permanent_location', for future use. Items will
24506 stay in the PROC location until they are checked in. To have those
24507 items then move to the shelving cart:</para>
24511 <para>Turn on the <link
24512 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
24513 system preference</para>
24517 <para>Check in those newly-created items and they will be moved
24518 to the location code of CART and display with whatever
24519 description CART has.</para>
24523 <para>A <link linkend="proccartcron">cron job</link> runs at
24524 specified intervals to age items from CART to the permanent
24525 shelving location. (For example, an hourly cron entry of
24526 cart_to_shelf.pl --hours 3 where --hours is the amount of time
24527 an item should spend on the cart before aging to its permanent
24534 linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
24535 system preference is turned on, any newly checked-in item
24536 is also automatically put into the shelving cart, to be
24537 covered by the same script run.</para>
24543 <para>Checkins with confirmed holds will not go into the
24544 shelving cart. If items on the shelving cart are checked
24545 out, the cart location will be cleared.</para>
24555 <section id="selfcheckout">
24556 <title>Self Checkout</title>
24558 <para>Koha comes with a very basic self checkout module. To enable this
24559 module you need to set the <link
24560 linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
24561 'Enable.' To use this module you have to log in as a <link
24562 linkend="addstaffpatron">staff member</link> with <link
24563 linkend="patronpermissions">circulation permissions</link>.</para>
24566 <para>Create a <link linkend="addstaffpatron">staff patron</link>
24567 specifically for this action so that you don't leave a real staff
24568 client logged into a computer all day</para>
24571 <para>There is no link to the Self Checkout module, but a simple
24572 addition to the <link linkend="intranetuserjs">intranetuserjs</link>
24573 system preference can add one.</para>
24575 <programlisting>$(document).ready(function(){ $("#login
24576 #submit").parent().after("<p><a
24577 href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
24578 target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
24581 <para>The code above has line breaks added to make it more readable,
24582 please be sure to enter the above as one line in when putting it in
24583 the system preference.</para>
24586 <para>The link will then appear at the bottom of the log in page:</para>
24589 <screeninfo>Self Checkout Link on Staff Login</screeninfo>
24593 <imagedata fileref="images/circ/selfcheckoutlink.png"/>
24598 <para>You can also access this module by going to :
24599 http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
24601 <para>When on the self checkout page depending on your value in the
24602 <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
24603 preference you will be asked to enter you cardnumber</para>
24606 <screeninfo>Self Checkout Patron Card Number</screeninfo>
24610 <imagedata fileref="images/circ/selfcheckout.png"/>
24615 <para>or your username and password:</para>
24618 <screeninfo>Shelf checkout by login</screeninfo>
24622 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
24627 <para>Once you're logged in to the self check module you will be asked
24628 to scan the items you are checking out</para>
24631 <screeninfo>Self Checkout</screeninfo>
24635 <imagedata fileref="images/circ/selfcheckoutuser.png"/>
24640 <para>As you scan items they will appear below the barcode box</para>
24643 <screeninfo>Self Checkout Summary</screeninfo>
24647 <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
24652 <para>When you are finished scanning items it is important to click the
24653 'Click here if done' button to log the patron out and prepare for the
24654 next patron.</para>
24656 <para>When attempting to check items out there are some instances where
24657 error messages will appear and the patron will be directed to the
24658 librarian. This will happen even if you are allowing overrides on
24659 circulation functions. Only a librarian can override a circulation block
24660 and so patrons must go to the librarian for help in these
24664 <screeninfo>Self Checkout Error Message</screeninfo>
24668 <imagedata fileref="images/circ/selfcheckoutfines.png"/>
24674 <section id="offlinecirc">
24675 <title>Offline Circulation Utility</title>
24677 <section id="firefoxofflinecirc">
24680 <firstname>Franois</firstname>
24682 <surname>Charbonnier</surname>
24686 <orgname>BibLibre</orgname>
24689 <othercredit role="copyeditor">
24690 <firstname>Nicole C.</firstname>
24692 <surname>Engard</surname>
24694 <contrib>Changed content where necessary.</contrib>
24697 <pubdate>2012</pubdate>
24700 <title>Firefox Plugin</title>
24702 <para>There is an offline circulation tool that you can add to your
24703 Firefox browser as a plugin/addon. To do so, just go to <ulink
24704 url="https://addons.mozilla.org/en/firefox/addon/koct/">https://addons.mozilla.org/en/firefox/addon/koct/</ulink>
24705 page and click on the "install now" button. You may have to confirm
24706 the installation, just click on "install now" and then restart Firefox
24707 to complete the installation.</para>
24709 <para>Once you have installed the plugin and restarted Firefox, you
24710 will see the Koha logo in the add-on bar at the bottom right of
24714 <screeninfo>Koha Icon on Add-on Bar</screeninfo>
24718 <imagedata fileref="images/circ/koctstatusbar.png"/>
24723 <para>A click on the logo will open the tool in its own window.</para>
24726 <screeninfo>Koha Offline Circ Tool</screeninfo>
24730 <imagedata fileref="images/circ/koct.png"/>
24735 <para>The plugin consists of four tabs:</para>
24739 <para>The Check Out tab is where you check out items</para>
24743 <para>The Check In tab is where you check in items</para>
24747 <para>The Log tab keeps track of every transaction done while in
24748 offline mode</para>
24752 <para>The log will keep information until you empty it. Each
24753 time you open the plugin and it contains data in the log it
24754 will warn you</para>
24757 <screeninfo>Koha Offline Circ Warning</screeninfo>
24761 <imagedata fileref="images/circ/koctwarn.png"/>
24766 <para>If you'd like to clear the log, check the 'I want to
24767 delete rows' box before hitting the 'OK' button. Otherwise
24768 clicking 'OK' will keep the items in the log and let you
24769 continue working with the tool.</para>
24775 <para>The Param tab is to set up the plugin</para>
24779 <para>The first thing you want to do then is to set up the plugin. Go
24780 to the Param tab to set up the plugin</para>
24783 <screeninfo>Koha Offline CIrc Params</screeninfo>
24787 <imagedata fileref="images/circ/koctparam.png"/>
24792 <para>Answer the 4 questions presented:</para>
24796 <para>Server = the URL of the librarian interface</para>
24800 <para>Branch Code = the code for the branch where you are
24805 <para>Username = your staff account login</para>
24809 <para>Password = your staff account password</para>
24814 <para>To save the settings, you will have to close the plugin
24815 window and re-open it by clicking again on the Koha logo in the
24818 <para>You can create a staff account dedicated to the offline
24819 circulation. So that, no matter who is at the circulation desk,
24820 they can all use the same login. Along those lines, you can use a
24821 group login that you already have in place for circulation as
24823 </tip>Once you have everything set up you can start checking items
24826 <para>Checking out:</para>
24829 <screeninfo>Koha Offline Circulation Check Out</screeninfo>
24833 <imagedata fileref="images/circ/koct.png"/>
24840 <para>Go to the Check Out tab</para>
24844 <para>Scan the patron barcode</para>
24848 <para>Scan the item barcode</para>
24852 <para>Click 'Save'</para>
24856 <para>Checking in:</para>
24859 <screeninfo>Koha Offline Circulation Check In</screeninfo>
24863 <imagedata fileref="images/circ/koctcheckin.png"/>
24870 <para>Go to the Check In tab</para>
24874 <para>Scan the item barcode</para>
24878 <para>Click Save</para>
24882 <para>Each time, you check out or check in an item, a new transaction
24883 is recorded in the local plugin database and you will see, at the
24884 bottom of the plugin how many transactions has been made during the
24885 offline circulation. For example, "10 Row(s) Added" means you did 10
24886 transactions.</para>
24889 <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
24893 <imagedata fileref="images/circ/koctcount.png"/>
24898 <para>Then, if you want an overview of every transaction, go to the
24899 Log tab. This tab will show you the transactions in the plugin
24903 <screeninfo>Koha Offline Circulation Log</screeninfo>
24907 <imagedata fileref="images/circ/koctlog.png"/>
24913 <para>The status will be "Local." as long as you are offline and
24914 don't process the transactions into Koha.</para>
24915 </tip>When your Internet connection comes back up you will want to
24916 get these transactions in to Koha. Before processing these
24917 transactions you should be aware of a few issues.</para>
24919 <para>Because you are not connected to your Koha database when using
24920 this plugin holds will need additional processing. If an item you
24921 check in while offline has a hold, the hold is kept on the item.
24922 Since, you can't confirm holds found during the processing of every
24923 check in, the holds stay on the item and will need to be managed
24924 later. If you only checked in a few items you can just keep a record
24925 of them all. If you checked in a lot of items you can use the Holds
24926 Queue once it rebuilds to see what holds made it to the shelf
24927 erroneously.</para>
24929 <para>Similarly, if an patron card was expired, the offline
24930 circulation tool won't know about it, so the checkout will be recorded
24931 regardless of the patron's account being blocked normally.</para>
24933 <para>You have two options for adding this data to Koha</para>
24937 <para>Commit to Koha</para>
24941 <para>If you checked in/out on more than one computer at the
24942 same time, what you want is to process every transaction
24943 consistently. Let's say for instance that one patron checked a
24944 book out on one computer and then checked the same book in on
24945 another computer. To be consistent, you need to record the
24946 check out first and then the check in. Not the opposite! To do
24947 so, you need to group every transaction in one place, sort
24948 them all and then, process everything. So, you need to use the
24949 "Commit to Koha" option from every plugin/computer you worked
24950 with. This way, the log will go to Koha and be accessible from
24951 the Offline Circulation page.</para>
24954 <screeninfo>Circulation Menu</screeninfo>
24958 <imagedata fileref="images/circ/offlinecirclink.png"/>
24965 <para><emphasis>Get there:</emphasis> Circulation > Offline
24966 Circulation (Firefox add-on)</para>
24969 <screeninfo>Offline Circulation</screeninfo>
24973 <imagedata fileref="images/circ/offlinecirclog.png"/>
24980 <para>Once all of the logs from all of the circulation
24981 computers are loaded you will be able to check them all or
24982 select just those you want to process into Koha.</para>
24986 <para>Click on the Process button and Koha will record every
24987 sorted transaction one by one. For each transaction, the
24988 status will change to:</para>
24992 <para>"Success." if the transaction was processed
24997 <para>"Borrower not found." if the borrower card number is
25002 <para>"Item not found." if the item barcode is
25007 <para>"Item not issued." if you checked in an available
25014 <para>Once finished you will have a summary of all of your
25015 transactions</para>
25018 <screeninfo>Offline Circulation Summary</screeninfo>
25022 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
25031 <para>Apply directly</para>
25035 <para>If you performed all of the circulation actions on one
25036 computer then everything is sorted already so you can choose
25037 to "Apply directly"</para>
25041 <para>The status column will be updated to let you know if the
25042 transactions were applied</para>
25046 <para>"Success." if the transaction was processed
25051 <para>"Borrower not found." if the borrower card number is
25056 <para>"Item not found." if the item barcode is
25061 <para>"Item not issued." if you checked in an available
25068 <para>Once you're finished you can review all of the items
25069 right in the Log tab</para>
25072 <screeninfo>Koha Offline Circulation Apply
25073 Directly</screeninfo>
25077 <imagedata fileref="images/circ/koctdirectly.png"/>
25086 <para>Once you are done you can clear the log by clicking Clear. If
25087 you don't you will be warned the next time you open the Offline
25088 Circulation tool.</para>
25091 <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
25095 <imagedata fileref="images/circ/koctwarn.png"/>
25101 <section id="windowsofflinecirc">
25102 <title>Offline Circ Tool for Windows</title>
25104 <para>The Offline Circulation Utility can be downloaded at: <ulink
25105 url="http://millruntech.com/koha/koha-offline-circulation">http://millruntech.com/koha/koha-offline-circulation</ulink></para>
25108 <section id="uploadofflinecirc">
25109 <title>Upload Offline Circ File</title>
25111 <para>The <link linkend="windowsofflinecirc">offline circulation tool
25112 for Windows</link> will generate a KOC file that you can upload into
25113 Koha once your system comes back up.</para>
25115 <para>On the Circulation menu click 'Offline Circulation File (.koc)
25119 <screeninfo>Circulation menu</screeninfo>
25123 <imagedata fileref="images/circ/offlinecirclink.png"/>
25128 <para>Browse your computer for the *.koc file</para>
25131 <screeninfo>Upload KOC File</screeninfo>
25135 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
25140 <para>Once the file is uploaded, click the process the file</para>
25143 <screeninfo>Process offline circulation file</screeninfo>
25147 <imagedata fileref="images/circ/processoffline.png"/>
25152 <para>When this is complete you'll see the summary of actions from
25153 when you were offline (including any errors).</para>
25156 <screeninfo>Summary of offline actions</screeninfo>
25160 <imagedata fileref="images/circ/offlinesummary.png"/>
25168 <chapter id="cataloging">
25169 <title>Cataloging</title>
25171 <para>Before you start cataloging in Koha you're going to want to do some
25172 basic setup. Refer to the <link linkend="implementation">Implementation
25173 Checklist</link> for a full list of these things. Most importantly you're
25174 going to want to make sure that your <link
25175 linkend="marcbibframeworks">Frameworks</link> are all defined the way you
25176 want. Once in the cataloging module you will not be able to add or remove
25177 fields and subfields so your frameworks must be ready before you start
25182 <para><emphasis>Get there:</emphasis> More > Cataloging</para>
25186 <section id="catbibs">
25187 <title>Bibliographic Records</title>
25189 <para>In Koha the bibliographic record contains the main information
25190 related to the material. This includes things like the title, author,
25191 ISBN, etc. This information is stored in Koha in Marc (different flavors
25192 of Marc are supported in Koha). Once this information is saved, <link
25193 linkend="catitems">items or holdings</link> can be attached.</para>
25195 <section id="addbibrec">
25196 <title>Adding Records</title>
25198 <para>Records can be added to Koha via original or copy cataloging. If
25199 you would like to catalog a record using a blank template</para>
25203 <para>Click 'New Record'</para>
25206 <screeninfo>New Record Menu</screeninfo>
25210 <imagedata fileref="images/cataloging/newfromframework.png"/>
25217 <para>Choose the framework you would like to base your record
25224 <para>If you want to catalog a record based on an existing record at
25225 another library</para>
25229 <para>Click 'z39.50 Search'</para>
25232 <screeninfo>Z39.50 Search</screeninfo>
25236 <imagedata fileref="images/cataloging/zsearch.png"/>
25243 <para>Search for the item you would like to catalog</para>
25248 <para>If no results are found, try searching for fewer
25249 fields, not all Z39.50 targets can search all of the
25250 fields above.</para>
25257 <para>Search targets can be altered by using the <link
25258 linkend="z3950admin">Z39.50 Admin</link> area.</para>
25262 <para>From the results you can view the MARC or Card view for
25263 the records or choose to Import them into Koha</para>
25266 <screeninfo>Z39.50 Search Results</screeninfo>
25270 <imagedata fileref="images/cataloging/zsearchresults.png"/>
25277 <para>In addition to the Import link to the right of each
25278 title, you can click on the title you're interested in and
25279 a menu will pop up with links to preview the record and
25283 <screeninfo>Import Link Popup on Z39.50 Search
25284 Results</screeninfo>
25288 <imagedata fileref="images/cataloging/importz39.png"/>
25295 <para>If you don't find the title you need in your Z39.50
25296 search results you can click the 'Try Another Search'
25297 button at the bottom left of your results</para>
25300 <screeninfo>Try another search</screeninfo>
25304 <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
25315 <para>Once you've opened a blank framework or imported a record via
25316 Z39.50 you will be presented with the form to continue
25320 <screeninfo>Add MARC Record</screeninfo>
25324 <imagedata fileref="images/cataloging/addmarc.png"/>
25331 <para>To expand a collapsed tag click on the tag
25336 <para>To get help from the Library of Congress on a Marc tag click
25337 the question mark (?) to the right of each field number</para>
25341 <para>If you feel that this clutters the screen you can hide
25342 the question marks by unchecking the box next to the 'Show
25343 MARC tag documentation links' note at the top right of the
25347 <screeninfo>Show MARC tag documentation links
25348 checkbox</screeninfo>
25352 <imagedata fileref="images/cataloging/marcdoclinks.png"/>
25361 <para>Sometimes fields may not be editable due to the value in
25363 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
25364 system preference. If you have this preference set to not allow
25365 catalogers to type in fields controlled by authorities you may see
25366 a lock symbol to the left of the field.</para>
25369 <screeninfo>Authority fields locked against editing</screeninfo>
25373 <imagedata fileref="images/cataloging/lockedauthority.png"/>
25380 <para>If this icon appears you must click the icon to the
25381 right of the field to search for an existing authority.</para>
25384 <screeninfo>Search for authority</screeninfo>
25388 <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
25395 <para>From the results list click 'Choose authority' to bring
25396 that into your catalog record</para>
25399 <screeninfo>Authority search results</screeninfo>
25403 <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
25412 <para>To duplicate a field click on the 'repeat this tag' icon to
25413 the right of the tag</para>
25416 <screeninfo>Duplicate a Field</screeninfo>
25420 <imagedata fileref="images/cataloging/dupfield.png"/>
25427 <para>To move subfields in to the right order, click the up
25428 arrow to the left of the field</para>
25432 <para>To duplicate a subfield click on the clone icon (to
25433 remove a copied field, click the delete clone icon) to the
25434 right of the field</para>
25437 <screeninfo>Clone Subfield</screeninfo>
25441 <imagedata fileref="images/cataloging/clonesubfield.png"/>
25448 <para>To remove a subfield (if there is more than one of the
25449 same type), click the - (minus sign) to the right of the
25456 <para>To use a plugin click on the icon to the right of the
25460 <screeninfo>Leader Builder Plugin</screeninfo>
25464 <imagedata fileref="images/cataloging/leaderbuilder.png"/>
25471 <para>Some fixed fields have editors that will change based on
25472 the material type you're cataloging (for example the 006 and
25473 the 008 fields)</para>
25476 <screeninfo>008 Plugin</screeninfo>
25480 <imagedata fileref="images/cataloging/008plugin.png"/>
25489 <para>Once you've finished, click the 'Save' button at the top and
25490 choose whether you want to save and view the bib record you have
25491 created or continue on to add/edit items attached to the
25495 <screeninfo>Record save options</screeninfo>
25499 <imagedata fileref="images/cataloging/savecataloging.png"/>
25506 <para>If you are about to add a duplicate record to the system
25507 you will be warned before saving</para>
25510 <screeninfo>Duplicate Record Warning</screeninfo>
25514 <imagedata fileref="images/cataloging/duprecordwarn.png"/>
25524 <section id="cataloganalytics">
25525 <title>Adding Analytic Records</title>
25527 <para>Libraries sometimes make journal articles and articles within
25528 monographs and serials accessible to library patrons through analytics
25529 cataloging. Analytics cataloging creates separate bibliographic
25530 records for these articles, chapters, sections, etc. found within a
25531 larger resource such as a book, an article within a journal, newspaper
25532 or serial. In analytics cataloging, although a separate bib record is
25533 created for the title, it is not physically separated from the host
25534 item. Learn more about Analytics in Chapter 13 of AACR2.</para>
25536 <para>If you would like to catalog analytic records in Koha you first
25537 need to update the <link
25538 linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
25539 preference to 'Display.'</para>
25541 <para>After cataloging your analytic record (see <link
25542 linkend="addbibrec">Adding Records</link> for more on creating
25543 records) click 'Edit' from the normal view and choose to 'Link to Host
25547 <screeninfo>Link to Host Item</screeninfo>
25551 <imagedata fileref="images/cataloging/analyticslink.png"/>
25556 <para>This will prompt you to enter the barcode for the item this
25557 record should be linked to.</para>
25560 <screeninfo>Barcode for Analytic Linking</screeninfo>
25564 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
25569 <para>After entering the item's barcode and clicking 'Select' you will
25570 receive a confirmation message.</para>
25573 <screeninfo>Analytic Link Success</screeninfo>
25577 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
25582 <para>The record will now have the 773 field filled in properly to
25583 complete the link.</para>
25586 <screeninfo>773</screeninfo>
25590 <imagedata fileref="images/cataloging/analytics773.png"/>
25595 <para>If you have linked an analytic record incorrectly you can remove
25596 that link by editing the item on the analytic record (not the host
25597 record). To do this, go to the analytic record and click the 'Edit'
25598 button and choose to 'Edit items'. To the left of each item you will
25599 see two options.</para>
25602 <screeninfo>Edit Analytic Item Record</screeninfo>
25606 <imagedata fileref="images/cataloging/analyticdelink.png"/>
25613 <para>Clicking 'Edit in Host' will allow you to edit the item on
25614 the host record.</para>
25618 <para>Clicking 'Delink' will remove the 773 field and the link
25619 between the analytic and the host.</para>
25623 <para>To view all of the items tied to the host record, do a search
25624 for the record, click the Analytics tab on the left and the analytics
25625 tied to each barcode will be shown under the "Used in" column.</para>
25628 <screeninfo>Analytics Tab</screeninfo>
25632 <imagedata fileref="images/cataloging/analyticstab.png"/>
25638 <para>It is also possible to create analytic records from this
25639 screen by clicking on "Create Analytics"</para>
25642 <para>You can also see the analytics attached to this record by
25643 clicking the 'Show Analytic' link towards the top of the record in the
25644 normal view.</para>
25647 <screeninfo>Show Analytics on Bib Record</screeninfo>
25651 <imagedata fileref="images/cataloging/anayticbib.png"/>
25657 <section id="editbibrec">
25658 <title>Editing Records</title>
25660 <para>To edit a record you can click 'Edit Biblio' from the search
25661 results on the cataloging page</para>
25664 <screeninfo>Edit Biblio Option on Search Results</screeninfo>
25668 <imagedata fileref="images/cataloging/catalogsearch.png"/>
25673 <para>or by clicking the Edit button on the Bibliographic Record and
25674 choosing 'Edit Record'</para>
25677 <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
25681 <imagedata fileref="images/cataloging/editrecord.png"/>
25686 <para>The record will open in the MARC editor</para>
25689 <screeninfo>Editing MARC Record</screeninfo>
25693 <imagedata fileref="images/cataloging/editingrecord.png"/>
25698 <para>The alternative is to search via Z39.50 to overlay your record
25699 with a fuller record found at another library. You can do this by
25700 choosing 'Replace Record via Z39.50' from the Edit menu.</para>
25703 <screeninfo>Replace via Z39.50</screeninfo>
25707 <imagedata fileref="images/cataloging/replaceviaz39.png"/>
25712 <para>Once you choose that you will be brought to a Z39.50 search
25713 window to search other libraries for the record in question.</para>
25715 <para>Once you have made your edits (via either method) you can click
25716 'Save' at the top left of the editor.</para>
25718 <para>You can also use the edit menu to add your own custom cover
25719 image if you have either <link
25720 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
25721 <link linkend="LocalCoverImages">LocalCoverImages</link> set to
25722 'Display' by choosing 'Upload Image' from the menu.</para>
25725 <screeninfo>Upload Image</screeninfo>
25729 <imagedata fileref="images/cataloging/uploadimage.png"/>
25734 <para>Choosing to 'Upload Image' will take you to the <link
25735 linkend="uploadlocalimages">Upload Local Cover Image
25736 Tool</link>.</para>
25739 <section id="dupbibrec">
25740 <title>Duplicating Records</title>
25742 <para>Sometimes a copy of the record you need to catalog can't be
25743 found via Z39.50. In these cases you can create a duplicate of similar
25744 record and edit the necessary pieces to create a new record. To
25745 duplicate an existing record click 'Edit as New (Duplicate)' from the
25746 Edit menu on the Bibliographic Record</para>
25749 <screeninfo>Edit as New (Duplicate) Bibliographic
25750 Record</screeninfo>
25754 <imagedata fileref="images/cataloging/createduplicate.png"/>
25759 <para>This will open a new MARC record with the fields filled in with
25760 the values from the original Bibliographic Record.</para>
25763 <screeninfo>New Duplicate Record</screeninfo>
25767 <imagedata fileref="images/cataloging/newduprecord.png"/>
25773 <section id="mergebibs">
25774 <title>Merging Records</title>
25776 <para>If you would like to merge together multiple records you can do
25777 that via the <link linkend="lists">Lists</link> tool. <link
25778 linkend="mergebibrecs">Learn more here</link>.</para>
25782 <section id="catitems">
25783 <title>Item Records</title>
25785 <para>In Koha each bibliographic record can have one or more items
25786 attached. These items are sometimes referred to as holdings. Each item
25787 includes information to the physical copy the library has.</para>
25789 <section id="addingitems">
25790 <title>Adding Items</title>
25792 <para>After saving a new bibliographic record, you will be redirected
25793 to a blank item record so that you can attach an item to the
25794 bibliographic record. You can also click 'Add/Edit Items' from the
25795 cataloging search results</para>
25798 <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
25802 <imagedata fileref="images/cataloging/catalogsearch.png"/>
25807 <para>or you can add new item at any time by clicking 'New' on the
25808 bibliographic record and choosing 'New Item'</para>
25811 <screeninfo>New Item Button</screeninfo>
25815 <imagedata fileref="images/cataloging/newitem.png"/>
25820 <para>The item edit form will appear:</para>
25823 <screeninfo>Add item form</screeninfo>
25827 <imagedata fileref="images/cataloging/additem.png"/>
25832 <para>At the very least, if you plan on circulating the item, the
25833 following fields should be entered for new items:</para>
25837 <para>2 - Source of classification</para>
25841 <para>a - Permanent location</para>
25845 <para>b - Current location</para>
25849 <para>o - Full call number</para>
25853 <para>p - Barcode</para>
25857 <para>v - Cost, replacement price</para>
25861 <para>This value will be charged to patrons when you mark an
25862 item they have checked out as 'Lost'</para>
25868 <para>y - Koha item type</para>
25872 <para>To make sure that these values are filled in you can mark them
25873 as mandatory in the <link linkend="marcbibframeworks">framework</link>
25874 you're using and then they will appear in red with a 'required' label.
25875 The item will not save until the required fields are filled in.</para>
25878 <screeninfo>Required Item Subfield</screeninfo>
25882 <imagedata fileref="images/cataloging/requireditemfields.png"/>
25890 <para>To make item subfields required in a framework you'll want
25891 to edit the 952 field in the <link
25892 linkend="marcbibframeworks">framework editor</link>.</para>
25897 <para>Below the add form there are 3 buttons for adding the
25901 <screeninfo>Add Item Buttons</screeninfo>
25905 <imagedata fileref="images/cataloging/additembuttons.png"/>
25912 <para>Add Item will add just the one item</para>
25916 <para>Add & Duplicate will add the item and fill in a new form
25917 with the same values for your to alter</para>
25921 <para>Add Multiple Copies will ask how many copies and will then
25922 add that number of copies adding +1 to the barcode so each barcode
25927 <para>Your added items will appear above the add form once
25931 <screeninfo>Items</screeninfo>
25935 <imagedata fileref="images/cataloging/items.png"/>
25940 <para>Your items will also appear below the bibliographic details on
25941 the bib record display.</para>
25944 <screeninfo>List of Items on the Bib Record</screeninfo>
25948 <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
25953 <para>If you have <link
25954 linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
25955 set to 'Display' then there will also be a link to print a quick spine
25956 label next to each item.</para>
25959 <screeninfo>List of Items on the Bib Record with a Print Label
25964 <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
25970 <section id="editingitems">
25971 <title>Editing Items</title>
25973 <para>Items can be edited in several ways.</para>
25977 <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
25981 <screeninfo>Edit Items Menu Option</screeninfo>
25985 <imagedata fileref="images/cataloging/edititem.png"/>
25992 <para>Clicking 'Edit Items' beside the item on the 'Items'
25996 <screeninfo>Items Tab</screeninfo>
26000 <imagedata fileref="images/cataloging/itemstab.png"/>
26007 <para>The edit menu is also where items can be deleted from:</para>
26010 <screeninfo>Edit and Delete links for Items</screeninfo>
26014 <imagedata fileref="images/cataloging/edititemlink.png"/>
26019 <section id="itemquickedit">
26020 <title>Quick Item Status Updates</title>
26022 <para>Often circulation staff need to change the status of an item
26023 to Lost or Damaged. This doesn't require you to edit the entire item
26024 record. Instead clicking on the item barcode on the checkout summary
26025 or checkin history will bring you to an item summary. You can also
26026 get to the item summary by clicking on the Items tab to the left of
26027 the bib detail page.</para>
26030 <screeninfo>Item Edit</screeninfo>
26034 <imagedata fileref="images/cataloging/quickitemedit.png"/>
26039 <para>From this view you can mark an item lost by choosing a lost
26040 status from the pull down and clicking the 'Set Status'
26044 <screeninfo>Edit Lost Status</screeninfo>
26048 <imagedata fileref="images/cataloging/editloststatus.png"/>
26053 <para>You can also mark an item as damaged by choosing a damaged
26054 status from the pull down and clicking the 'Set Status'
26058 <screeninfo>Edit Damaged Status</screeninfo>
26062 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
26069 <section id="iteminfo">
26070 <title>Item Information</title>
26072 <para>To the left of every bibliographic record there is a tab to view
26076 <screeninfo>Items Tab</screeninfo>
26080 <imagedata fileref="images/cataloging/itemstab-long.png"/>
26085 <para>Clicking that tab will give you basic information about the
26086 items. If you ordered the item via the acquisitions module then the
26087 History section will include information about the order.</para>
26090 <screeninfo>History with order info</screeninfo>
26094 <imagedata fileref="images/cataloging/itemorderinfo.png"/>
26099 <para>If the Order or Accession date is linked, clicking it will bring
26100 you to the acquisitions information for that item.</para>
26103 <section id="moveitemrec">
26104 <title>Moving Items</title>
26106 <para>Items can be moved from one bibliographic record to another
26107 using the Attach Item option</para>
26110 <screeninfo>Attach Item Option</screeninfo>
26114 <imagedata fileref="images/cataloging/attachitem.png"/>
26119 <para>Visit the bibliographic record you want to attach the item to
26120 and choose 'Attach Item' from the 'Edit' menu.</para>
26123 <screeninfo>Attach Item Form</screeninfo>
26127 <imagedata fileref="images/cataloging/attachitemform.png"/>
26132 <para>Simply enter the barcode for the item you want to move and click
26135 <para>If you want to move all items to a new record creating only one
26136 bibliographic record you can use the <link
26137 linkend="mergebibrecs">Merge Records tool</link> instead.</para>
26140 <section id="deleteitems">
26141 <title>Deleting Items</title>
26143 <para>There are many ways to delete item records. If you only need to
26144 delete one item you can do this by opening up the detail page for the
26145 bib record and clicking the 'Edit' button at the top. From there you
26146 can choose to 'Edit items'.</para>
26149 <screeninfo>'Edit Items' menu option</screeninfo>
26153 <imagedata fileref="images/cataloging/edititemstodelete.png"/>
26158 <para>You will be presented with a list of items and next to each one
26159 will be a link labeled 'Delete'. Click that link and if the item is
26160 not checked out it will delete that item.</para>
26163 <screeninfo>Delete link on the left</screeninfo>
26167 <imagedata fileref="images/cataloging/deleteitemlink.png"/>
26172 <para>If you know that all of the items attached to your record are
26173 not currently checked out you can use the 'Delete all items' option
26174 under the 'Edit menu' and it will remove all items from the
26177 <para>Finally you can use the <link linkend="batchdeleteitems">batch
26178 delete tool</link> to delete a batch of items.</para>
26181 <section id="itemcirchistory">
26182 <title>Item Specific Circulation History</title>
26184 <para>Each bibliographic record keeps a circulation history (with or
26185 without the patron information depending on your settings), but each
26186 item also has its own circulation history page. To see this, click on
26187 the 'Items' tab to the left of the record you are viewing.</para>
26190 <screeninfo>Items tab</screeninfo>
26194 <imagedata fileref="images/cataloging/itemstab-long.png"/>
26199 <para>Below the 'History' heading is a link to 'View item's checkout
26200 history,' clicking that will open up the item's history which will
26201 look slightly different from the bibliographic record's history
26205 <screeninfo>Item Specific Circulation History</screeninfo>
26209 <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
26216 <section id="catauthorities">
26217 <title>Authorities</title>
26219 <para>Authority records are a way of controlling fields in your MARC
26220 records. Using authority records will provide you with control over
26221 subject headings, personal names and places.</para>
26223 <section id="addauthorities">
26224 <title>Adding Authorities</title>
26226 <para>To add a new authority record, choose the authority type from
26227 the 'New Authority' button.</para>
26230 <screeninfo>New Authority Record Options</screeninfo>
26234 <imagedata fileref="images/cataloging/newauthtypes.png"/>
26239 <para>The form that appears will allow you to enter all of the
26240 necessary details regarding your authority record.</para>
26243 <screeninfo>New Authority Record</screeninfo>
26247 <imagedata fileref="images/cataloging/newauthrec.png"/>
26252 <para>To expand collapsed values simply click on the title and the
26253 subfields will appear.</para>
26256 <section id="searchauthorities">
26257 <title>Searching Authorities</title>
26259 <para>From the authorities page you can search for existing terms and
26260 the bibliographic records they are attached to.</para>
26263 <screeninfo>Authority Search</screeninfo>
26267 <imagedata fileref="images/cataloging/authoritysearch.png"/>
26272 <para>From the results you will see the authority record, how many
26273 bibliographic records it is attached to, and a delete link (if there
26274 are not bibliographic records attached).</para>
26277 <screeninfo>Authority Search Results</screeninfo>
26281 <imagedata fileref="images/cataloging/authorityresults.png"/>
26286 <para>Clicking on the authority record summary will open the full
26287 record and the option to edit the record.</para>
26290 <screeninfo>Authority Record</screeninfo>
26294 <imagedata fileref="images/cataloging/authrecord.png"/>
26300 <section id="editauthorities">
26301 <title>Editing Authorities</title>
26303 <para>Authorities can be edited by clicking on the authority summary
26304 from the search results and then clicking the 'Edit' button above the
26308 <screeninfo>Edit Authority Record</screeninfo>
26312 <imagedata fileref="images/cataloging/editauthority.png"/>
26317 <para>Once you've made the necessary edits, simply click 'Save' and if
26318 you have the <link linkend="dontmerge">dontmerge</link> system
26319 preference set to 'Do' the next time the <link
26320 linkend="mergeauthcron">merge_authorities.pl cronjob</link> runs it
26321 will update all of the bib records that use that authority.</para>
26323 <para>To delete an authority record you first must make sure it's not
26324 linked to any bibliographic records. If it is not used by any
26325 bibliographic records a 'Delete' link will appear to the right of the
26326 record on the search results and as a button that appears after
26327 clicking on the summary of the authority record.</para>
26331 <section id="catguides">
26332 <title>Cataloging Guides</title>
26336 <section id="bibcatcheatsheet">
26339 <firstname>Jared</firstname>
26341 <surname>Camins-Esakov</surname>
26345 <orgname>American Numismatic Society</orgname>
26348 <othercredit role="copyeditor">
26349 <firstname>Nicole C.</firstname>
26351 <surname>Engard</surname>
26353 <contrib>Changed content where necessary.</contrib>
26356 <pubdate>2010</pubdate>
26359 <title>Bibliographic Record Cataloging Cheat Sheet</title>
26361 <table cellpadding="4" cellspacing="4" frame="all">
26362 <title>Cataloging Guide</title>
26364 <tgroup align="left" cols="4" colsep="1" rowsep="1">
26367 <entry><para>Tag</para></entry>
26369 <entry><para>Label</para></entry>
26371 <entry><para>Description</para></entry>
26373 <entry><para>Instructions</para></entry>
26379 <entry><para>000</para></entry>
26381 <entry><para>LEADER</para></entry>
26383 <entry><para>Describes the record(i.e. surrogate) -- is it a
26384 record for a monograph? A serial?</para></entry>
26386 <entry><para>Click in this field to fill it in. Then set
26387 "Bibliographic level" to 'a' for articles or 's' for serials.
26388 Otherwise, leave everything as is.</para></entry>
26392 <entry><para>001</para></entry>
26394 <entry><para>CONTROL NUMBER</para></entry>
26396 <entry><para>Accession number.</para></entry>
26398 <entry><para>Enter the accession number written inside the
26399 item here. For articles and items which do not have accession
26400 numbers, leave blank.</para></entry>
26404 <entry><para>003</para></entry>
26406 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
26408 <entry><para>Your MARC Organizational Code</para></entry>
26410 <entry><para>Click in this field to fill it in (will auto fill
26411 if you have your <link
26412 linkend="MARCOrgCode">MARCOrgCode</link> preference
26413 set).</para></entry>
26417 <entry><para>005</para></entry>
26419 <entry><para>D & T LATEST TRANSACTION</para></entry>
26421 <entry><para>Current date and time.</para></entry>
26423 <entry><para>Click in this field to fill it in.</para></entry>
26427 <entry><para>008</para></entry>
26429 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
26431 <entry><para>Field containing computer-readable
26432 representations of a number of things.</para></entry>
26434 <entry><para>Generally you will only use 's' (single) or 'm'
26435 (multiple) options for position 06- use the former when the
26436 item was published in a single year, the latter when it was
26437 published over the course of several. If there is a single
26438 date, only enter a date in the first date field (positions
26439 07-10). Enter the three-digit country code in positions 15-17,
26440 being sure to add spaces if the country code is fewer than
26441 three characters long. If there is an index, note that fact in
26442 position 31. Enter the three-letter language code in positions
26443 35-37.</para></entry>
26447 <entry><para>010</para></entry>
26449 <entry><para>LCCN</para></entry>
26451 <entry><para>A number assigned by the Library of Congress to
26452 uniquely identify the work.</para></entry>
26454 <entry><para>Check on the copyright page of the book (if it
26455 was published in the US) or the LC catalog for this number. If
26456 you can't find it, don't worry about it.</para></entry>
26460 <entry><para>020</para></entry>
26462 <entry><para>ISBN</para></entry>
26464 <entry><para>Unique number used by publishers to identify
26465 books.</para></entry>
26467 <entry><para>If this number isn't listed on the book, there
26468 probably isn't one.</para></entry>
26472 <entry><para>022</para></entry>
26474 <entry><para>ISSN</para></entry>
26476 <entry><para>Unique number used by publishers to identify
26477 serials.</para></entry>
26479 <entry><para>If this number isn't listed on the book, there
26480 probably isn't one.</para></entry>
26484 <entry><para>033</para></entry>
26486 <entry><para>DATE/TIME OF EVENT</para></entry>
26488 <entry><para>Used for auction dates. Required for auction
26489 catalogs.</para></entry>
26491 <entry><para>For auctions that took place on only one day,
26492 enter the date of the auction in the format YYYYMMDD in the
26493 subfield 'a' and a '0' in the first indicator. For auctions
26494 that took place over two consecutive days or any number of
26495 non-consecutive days, create a subfield 'a' for each day with
26496 the date in the format YYYYMMDD, and put a '1' in the first
26497 indicator. For auctions that took place over more than two
26498 consecutive days, create a subfield 'a' (in format YYYYMMDD)
26499 for the first day and a subfield 'a' (also in format YYYYMMDD)
26500 for the last day, and put a '2' in the first
26501 indicator.</para></entry>
26505 <entry><para>040</para></entry>
26507 <entry><para>CATALOGING SOURCE</para></entry>
26509 <entry><para>Identifies which libraries created and modified
26510 the record.</para></entry>
26512 <entry><para>For imported records, add a subfield 'd' with
26513 your OCLC code as the value. For new records, make sure that
26514 the subfield 'c' with your OCLC code as the
26515 value.</para></entry>
26519 <entry><para>041</para></entry>
26521 <entry><para>LANGUAGE CODE</para></entry>
26523 <entry><para>Identifies all the languages used in an item,
26524 when two or more languages are present.</para></entry>
26526 <entry><para>For significant portions of a text in a given
26527 language, there should be a subfield 'a' with that language
26528 code. If there are only summaries or abstracts in a specific
26529 language, create a subfield 'b' with that language
26530 code.</para></entry>
26534 <entry><para>100</para></entry>
26536 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
26538 <entry><para>Authorized form of the main author's
26539 name</para></entry>
26541 <entry><para>See Authorized headings sheet and AACR2. The
26542 first indicator should generally be a '1', to indicate that
26543 the entry is surname first. If the name consists only of a
26544 forename, however, the first indicator should be
26545 '0'.</para></entry>
26549 <entry><para>110</para></entry>
26551 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
26553 <entry><para>Authorized form of the name of the main corporate
26554 author. Required for auction catalogs.</para></entry>
26556 <entry><para>Auction catalogs should use a 110 field rather
26557 than a 100 field. See Authorized headings sheet and AACR2. Set
26558 the first indicator to '2'.</para></entry>
26562 <entry><para>111</para></entry>
26564 <entry><para>MAIN ENTRY--MEETING</para></entry>
26566 <entry><para>Authorized form of the name of a meeting which
26567 acted as a main offer (e.g. conference
26568 proceedings)</para></entry>
26570 <entry><para>See Authorized headings sheet and AACR2. Set the
26571 first indicator to '2'.</para></entry>
26575 <entry><para>245</para></entry>
26577 <entry><para>TITLE STATEMENT</para></entry>
26579 <entry><para>Transcription of the title statement from the
26580 title page (or chief source of information)</para></entry>
26582 <entry><para>Enter the title in subfield 'a', the subtitle in
26583 subfield 'b', and the statement of responsibility in subfield
26584 'c'. If you are creating a record for a single volume or part
26585 of a multi-part item, you should put the part number in
26586 subfield 'n' and the part title in subfield 'p.' For auction
26587 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
26588 in square brackets in subfield 'f'. See ISBD punctuation
26589 sheet. Set the first indicator to '0' if there is no author,
26590 otherwise set it to '1'. Set the second indicator to the
26591 number of non-filing characters (i.e. characters in an initial
26592 articles plus the space... for "The " set the second indicator
26593 to '4').</para></entry>
26597 <entry><para>246</para></entry>
26599 <entry><para>VARYING FORM OF TITLE</para></entry>
26601 <entry><para>Alternate form of title for searching and filing
26602 purposes</para></entry>
26604 <entry><para>If the patron might look for the work under a
26605 different title, enter it here. Do not include initial
26606 articles. The first indicator should be '3', unless the title
26607 is merely a variant spelling, in which case the first
26608 indicator should be '1'.</para></entry>
26612 <entry><para>250</para></entry>
26614 <entry><para>EDITION STATEMENT</para></entry>
26616 <entry><para>Transcription of the edition statement from the
26617 title page (or chief source of information)</para></entry>
26619 <entry><para>Transcribe the edition statement exactly as it
26620 appears on the title-page. You may abbreviate if the edition
26621 statement is very long.</para></entry>
26625 <entry><para>260</para></entry>
26627 <entry><para>PUBLICATION (IMPRINT)</para></entry>
26629 <entry><para>Publication information.</para></entry>
26631 <entry><para>Put the location of publication in subfield 'a',
26632 the publisher in subfield 'b', and the year (or probable year)
26633 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
26637 <entry><para>300</para></entry>
26639 <entry><para>PHYSICAL DESCRIPTION</para></entry>
26641 <entry><para>Physical description</para></entry>
26643 <entry><para>Enter the pagination statement in subfield 'a', a
26644 brief description of "special" contents such as illustrations
26645 or maps in subfield 'b' (see AACR2), and the size of the item
26646 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
26650 <entry><para>490</para></entry>
26652 <entry><para>SERIES STATEMENT</para></entry>
26654 <entry><para>Shows the series statement exactly as it appears
26655 on the item.</para></entry>
26657 <entry><para>Transcribe the series statement into subfield 'a'
26658 with the volume number in subfield 'v'. See ISBD punctuation
26659 sheet. Set the first indicator to '1' if you are using an 830.
26660 As a general rule, you should do so.</para></entry>
26664 <entry><para>500</para></entry>
26666 <entry><para>GENERAL NOTE</para></entry>
26668 <entry><para>Notes that don't fit anywhere
26669 else.</para></entry>
26671 <entry><para>Enter notes as full sentences, with a separate
26672 500 field for each distinct topic.</para></entry>
26676 <entry><para>501</para></entry>
26678 <entry><para>WITH NOTE</para></entry>
26680 <entry><para>Notes whether the work is bound with the works
26681 described by other records.</para></entry>
26683 <entry><para>Put description of relationship in subfield
26684 'a'.</para></entry>
26688 <entry><para>504</para></entry>
26690 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
26692 <entry><para>Indicates whether the work includes a
26693 bibliography.</para></entry>
26695 <entry><para>If the work includes a bibliography and index,
26696 put the text "Includes bibliographical references (p. XXX-XXX)
26697 and index." in subfield 'a'. If the work does not include an
26698 index, remove that part of the sentence. If the references are
26699 scattered throughout the work and not gathered into a distinct
26700 sentence, remove the parenthetical statement.</para></entry>
26704 <entry><para>505</para></entry>
26706 <entry><para>FORMATTED CONTENTS</para></entry>
26708 <entry><para>List of contents in a standard format.
26709 Unformatted contents can be listed in a 500 (General Note)
26710 field.</para></entry>
26712 <entry><para>See ISBD punctuation sheet. Set the first
26713 indicator to '0'. If you are separately coding authors and
26714 titles, set the second indicator to '0'. Otherwise, leave the
26715 second indicator blank.</para></entry>
26719 <entry><para>518</para></entry>
26721 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
26723 <entry><para>Used for auction dates.</para></entry>
26725 <entry><para>For auction catalogs, enter the date of the
26726 auction in the format 'January 2, 1984' in the subfield
26731 <entry><para>520</para></entry>
26733 <entry><para>SUMMARY, ETC.</para></entry>
26735 <entry><para>A brief summary or abstract of the book or
26736 article.</para></entry>
26738 <entry><para>In general you do not need to write a summary. A
26739 summary might be called for, however, with items that cannot
26740 be easily reviewed by a patron, such as books with highly
26741 acidic paper or CD-ROMs.</para></entry>
26745 <entry><para>546</para></entry>
26747 <entry><para>LANGUAGE NOTE</para></entry>
26749 <entry><para>Note describing the languages used in the
26750 work</para></entry>
26752 <entry><para>Only needed for works in multiple languages. See
26753 ISBD punctuation sheet.</para></entry>
26757 <entry><para>561</para></entry>
26759 <entry><para>PROVENANCE INFORMATION</para></entry>
26761 <entry><para>Describes the previous ownership of the
26762 item.</para></entry>
26764 <entry><para>Used only for rare books.</para></entry>
26768 <entry><para>563</para></entry>
26770 <entry><para>BINDING INFORMATION</para></entry>
26772 <entry><para>Describes the binding of the item.</para></entry>
26774 <entry><para>Used only for rare books.</para></entry>
26778 <entry><para>590</para></entry>
26780 <entry><para>LOCAL NOTE</para></entry>
26782 <entry><para>Local notes. Required for auction
26783 catalogs.</para></entry>
26785 <entry><para>Used for auction catalogs to indicate what types
26786 of coins are sold in the auction- Roman, Greek,
26787 etc.</para></entry>
26791 <entry><para>600</para></entry>
26793 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
26795 <entry><para>Authorized form of personal names for people
26796 discussed in the work</para></entry>
26798 <entry><para>See Authorized headings sheet and AACR2. The
26799 first indicator should generally be a '1', to indicate that
26800 the entry is surname first. If the name consists only of a
26801 forename, however, the first indicator should be '0'. If you
26802 found the name in the LC authority file, set the second
26803 indicator to '0'. Otherwise set the second indicator to
26804 '4'.</para></entry>
26808 <entry><para>610</para></entry>
26810 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
26812 <entry><para>Authorized form of corporate names for
26813 organizations discussed in the work</para></entry>
26815 <entry><para>See Authorized headings sheet and AACR2. Set the
26816 first indicator to '2'. If you found the name in the LC
26817 authority file, set the second indicator to '0'. Otherwise set
26818 the second indicator to '4'.</para></entry>
26822 <entry><para>611</para></entry>
26824 <entry><para>SUBJECT ADDED--MEETING</para></entry>
26826 <entry><para>Authorized form of meeting names for meetings
26827 discussed in the work</para></entry>
26829 <entry><para>See Authorized headings sheet and AACR2. Set the
26830 first indicator to '2'. If you found the name in the LC
26831 authority file, set the second indicator to '0'. Otherwise set
26832 the second indicator to '4'.</para></entry>
26836 <entry><para>630</para></entry>
26838 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
26840 <entry><para>Authorized form of titles for other works
26841 discussed in the work</para></entry>
26843 <entry><para>See Authorized headings sheet and AACR2. Set the
26844 first indicator to the number of non-filing characters (i.e.
26845 characters in an initial articles plus the space... for "The "
26846 set the first indicator to '4'). If you found the name in the
26847 LC authority file, set the second indicator to '0'. Otherwise
26848 set the second indicator to '4'.</para></entry>
26852 <entry><para>650</para></entry>
26854 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
26856 <entry><para>Library of Congress Subject Heading terms
26857 describing the subject of the work</para></entry>
26859 <entry><para>See Authorized headings sheet and AACR2. If you
26860 found the name in the LC authority file, set the second
26861 indicator to '0'. Otherwise set the second indicator to
26862 '4'.</para></entry>
26866 <entry><para>651</para></entry>
26868 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
26870 <entry><para>Library of Congress Subject Heading geographical
26871 terms describing the subject of the work</para></entry>
26873 <entry><para>See Authorized headings sheet and AACR2. If you
26874 found the name in the LC authority file, set the second
26875 indicator to '0'. Otherwise set the second indicator to
26876 '4'.</para></entry>
26880 <entry><para>655</para></entry>
26882 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
26884 <entry><para>Describes what an item is as opposed to what the
26885 item is about.</para></entry>
26887 <entry><para>Generally used only for auction catalogs, which
26888 should have the genre heading "Auction catalogs." (make sure
26889 to find the authorized heading!) If you found the name in the
26890 LC authority file, set the second indicator to '0'. If you are
26891 using a term from a specific thesaurus, set the second
26892 indicator to '7' and put the code for the thesaurus in
26893 subfield '2'. Otherwise set the second indicator to
26894 '4'.</para></entry>
26898 <entry><para>690</para></entry>
26900 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
26902 <entry><para>Used for headings from any custom subject
26903 authority file.</para></entry>
26905 <entry><para>If there is no appropriate LCSH term, you can use
26906 a 690 with subject headings you find on other items in the
26907 catalog.</para></entry>
26911 <entry><para>691</para></entry>
26913 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
26915 <entry><para>Used for headings from any custom subject
26916 authority file.</para></entry>
26918 <entry><para>If there is no appropriate LCSH term, you can use
26919 a 691 with subject headings you find on other items in the
26920 catalog.</para></entry>
26924 <entry><para>700</para></entry>
26926 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
26928 <entry><para>Used for second authors and other persons related
26929 to the production of the work.</para></entry>
26931 <entry><para>See Authorized headings sheet and AACR2. The
26932 first indicator should generally be a '1', to indicate that
26933 the entry is surname first. If the name consists only of a
26934 forename, however, the first indicator should be
26935 '0'.</para></entry>
26939 <entry><para>710</para></entry>
26941 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
26943 <entry><para>Used for corporate bodies related to the
26944 production of the work (e.g. publishers).</para></entry>
26946 <entry><para>See Authorized headings sheet and AACR2. Set the
26947 first indicator to '2'.</para></entry>
26951 <entry><para>711</para></entry>
26953 <entry><para>ADDED ENTRY--MEETING</para></entry>
26955 <entry><para>Used for meetings related to the production of
26956 the work (e.g. symposia that contributed to the
26957 work).</para></entry>
26959 <entry><para>See Authorized headings sheet and AACR2. Set the
26960 first indicator to '2'.</para></entry>
26964 <entry><para>730</para></entry>
26966 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
26968 <entry><para>Used for uniform titles related to the production
26969 of the work (e.g. a work that inspired the present
26970 work)</para></entry>
26972 <entry><para>See Authorized headings sheet and AACR2. Set the
26973 first indicator to the number of non-filing characters (i.e.
26974 characters in an initial articles plus the space... for "The "
26975 set the first indicator to '4').</para></entry>
26979 <entry><para>773</para></entry>
26981 <entry><para>HOST ITEM ENTRY</para></entry>
26983 <entry><para>Describes the larger bibliographic unit that
26984 contains the work (e.g. book or journal containing the article
26985 being described in the current record)</para></entry>
26987 <entry><para>If the host publication is author main entry,
26988 enter the authorized form of the author's name in subfield
26989 'a'. Put the title in subfield 't'. If the host publication is
26990 an independent work, put publication information in subfield
26991 'd'. When available, ISSN and ISBN should always be used in,
26992 in subfields 'x' and 'z' respectively. Relationship
26993 information (e.g. volume number, page number, etc.) goes in
26994 subfield 'g'. Subfield 'q' contains an encoded representation
26995 of the location of the item: volume, issue, and section
26996 numbers are separated by colons, and the first page is entered
26997 following a '<' at the end of the subfield. See ISBD
26998 punctuation sheet. Set the first indicator to '0'. If you want
26999 the label "In:" to be generated, leave the second indicator
27000 blank. If you want something else displayed before the 773
27001 text, set the second indicator to '8' and add a subfield 'i'
27002 with the label you want at the beginning of the field (e.g.
27003 "$iOffprint from:").</para></entry>
27007 <entry><para>830</para></entry>
27009 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
27011 <entry><para>Authorized form of the series name transcribed in
27012 the 490 field. Often this will just be the same as the
27013 490.</para></entry>
27015 <entry><para>See Authorized headings sheet and AACR2. Set the
27016 second indicator to the number of non-filing characters (i.e.
27017 characters in an initial articles plus the space... for "The "
27018 set the second indicator to '4').</para></entry>
27022 <entry><para>852</para></entry>
27024 <entry><para>LOCATION/CALL NUMBER</para></entry>
27026 <entry><para>Provides the section name for pre-barcode books,
27027 pamphlets, and some articles and serials.</para></entry>
27029 <entry><para>Do not put anything in this field if you are
27030 cataloging a volume which gets only one record and a barcode.
27031 If the item does not get a barcode, or you are currently
27032 creating a record for an article in a volume, put the section
27033 in subfield 'a' (see ANS cataloging documentation), and the
27034 call number in subfield 'i'. Set the first indicator to
27035 '8'.</para></entry>
27039 <entry><para>856</para></entry>
27041 <entry><para>ELECTRONIC ACCESS</para></entry>
27043 <entry><para>Links to material available
27044 online.</para></entry>
27046 <entry><para>Put the URL of any electronic copies or
27047 summaries, etc. in subfield 'u' and a link title in subfield
27048 'y'. Set the first indicator to '4'.</para></entry>
27052 <entry><para>942</para></entry>
27054 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
27056 <entry><para>Used for Koha-specific data.</para></entry>
27058 <entry><para>Set the subfield 'c' to the appropriate item
27059 type.</para></entry>
27066 <section id="itemcatguide">
27067 <title>Item/Holdings Record Cataloging Guide</title>
27069 <para>This table represents the default embedded holdings data in Koha
27070 3.4. This information can be used for migration or importing data
27073 <table cellpadding="4" cellspacing="4" frame="all">
27074 <title>Koha Embedded Holdings Data</title>
27076 <tgroup align="left" cols="4" colsep="1" rowsep="1">
27077 <colspec colname="tag" colnum="1"/>
27079 <colspec colname="data" colnum="2"/>
27081 <colspec colname="desc" colnum="3"/>
27083 <colspec colname="note" colnum="4"/>
27087 <entry><para>MARC21 Tag/subfield</para></entry>
27089 <entry><para>Data Element</para></entry>
27091 <entry><para>Description</para></entry>
27093 <entry><para>Notes</para></entry>
27099 <entry><para>952$0</para></entry>
27101 <entry><para>Withdrawn status</para></entry>
27103 <entry><para>Default values: </para><itemizedlist>
27105 <para>0 = Not withdrawn</para>
27109 <para>1 = Withdrawn</para>
27111 </itemizedlist></entry>
27113 <entry><para>Coded value, matching <link
27114 linkend="authorizedvalues">Authorized Value</link> category
27115 ('WITHDRAWN' in default installation)</para></entry>
27119 <entry><para>952$1</para></entry>
27121 <entry><para>Lost status</para></entry>
27123 <entry><para>Default values:</para><itemizedlist>
27125 <para>0 = Available</para>
27129 <para>1 = Lost</para>
27133 <para>2 = Long Overdue (Lost)</para>
27137 <para>3 = Lost and Paid For</para>
27141 <para>4 = Missing in Inventory</para>
27145 <para>5 = Missing in Hold Queue</para>
27147 </itemizedlist></entry>
27149 <entry><para>It's possible to configure OPAC so that lost
27150 items don't display with the <link
27151 linkend="hidelostitems">hidelostitems</link> system
27152 preference. </para><para>Coded value, matching <link
27153 linkend="authorizedvalues">Authorized Value</link> category
27154 ('LOST' in default installation)</para></entry>
27158 <entry><para>952$2</para></entry>
27160 <entry><para>Classification</para></entry>
27162 <entry><para>Classification scheme that defines filing rules
27163 used for sorting call numbers.</para></entry>
27165 <entry><para>A choice of <link
27166 linkend="classificationsources">classification sources</link>
27167 as they are defined in administration. If no classification
27168 scheme is entered, the system will use the value entered in
27170 linkend="DefaultClassificationSource">DefaultClassificationSource</link>
27171 preference.</para></entry>
27175 <entry><para>952$3</para></entry>
27177 <entry><para>Materials specified</para></entry>
27179 <entry><para>Specific issues of serials or multi-part
27180 items.</para></entry>
27182 <entry><para>Displayed when items are checked out and in to
27183 tell the staff how many pieces the item has. Copy/volume data
27184 is stored in 952$h and $t for display in Normal
27185 views.</para></entry>
27189 <entry><para>952$4</para></entry>
27191 <entry><para>Damaged status</para></entry>
27193 <entry><para>Default values: </para><itemizedlist>
27195 <para>0 = Not damaged</para>
27199 <para>1 = Damaged</para>
27201 </itemizedlist></entry>
27203 <entry><para>Coded value, matching <link
27204 linkend="authorizedvalues">Authorized Value</link> category
27205 ('DAMAGE' in default installation)</para></entry>
27209 <entry><para>952$5</para></entry>
27211 <entry><para>Use restrictions</para></entry>
27213 <entry><para>Default values:</para><itemizedlist>
27215 <para>0 = No use restrictions</para>
27219 <para>1 = Restricted Access</para>
27221 </itemizedlist></entry>
27223 <entry><para>Coded value, matching <link
27224 linkend="authorizedvalues">Authorized Value</link> category
27225 ('RESTRICT' in default installation). This value has no effect
27226 on circulation.</para></entry>
27230 <entry><para>952$7</para></entry>
27232 <entry><para>Not for loan</para></entry>
27234 <entry><para>Default values:</para><itemizedlist>
27236 <para>-1 = Ordered</para>
27240 <para>0 = Available for loans</para>
27244 <para>1 = Not for Loan</para>
27248 <para>2 = Staff Collection</para>
27250 </itemizedlist></entry>
27252 <entry><para>Coded value, matching <link
27253 linkend="authorizedvalues">Authorized Value</link> category
27254 ('NOT_LOAN' in default installation). Negative number values
27255 can still be placed on hold.</para></entry>
27259 <entry><para>952$8</para></entry>
27261 <entry><para>Collection code</para></entry>
27263 <entry><para>Coded value</para></entry>
27265 <entry><para>Coded value, matching <link
27266 linkend="authorizedvalues">Authorized Value</link> category
27267 ('CCODE' in default installation)</para></entry>
27271 <entry><para>952$9</para></entry>
27273 <entry><para>Item number</para></entry>
27275 <entry><para>System-generated item number.</para></entry>
27277 <entry><para>Does not display in the item
27278 record.</para></entry>
27282 <entry><para>952$a</para></entry>
27284 <entry><para>Owning Library **</para></entry>
27286 <entry><para>Branch code</para></entry>
27288 <entry><para><emphasis role="bold">Required</emphasis>. Code
27289 must be defined in <link linkend="libsgroups">Libraries,
27290 Branches and Groups</link></para></entry>
27294 <entry><para>952$b</para></entry>
27296 <entry><para>Holding library ** (usually the same as 952$a
27299 <entry><para>Branch code</para></entry>
27301 <entry><para><emphasis role="bold">Required</emphasis>. Code
27302 must be defined in <link linkend="libsgroups">Libraries,
27303 Branches and Groups</link></para></entry>
27307 <entry><para>952$c</para></entry>
27309 <entry><para>Shelving location code</para></entry>
27311 <entry><para/></entry>
27313 <entry><para>Coded value, matching <link
27314 linkend="authorizedvalues">Authorized Value</link> category
27315 ('LOC' in default installation)</para></entry>
27319 <entry><para>952$d</para></entry>
27321 <entry><para>Date acquired</para></entry>
27323 <entry><para>YYYY-MM-DD</para></entry>
27325 <entry><para>Date formats in the 952 subfields are required to
27326 be in the system internal format for data loading and
27327 subsequent item editing: YYYY-MM-DD</para></entry>
27331 <entry><para>952$e</para></entry>
27333 <entry><para>Source of acquisition</para></entry>
27335 <entry><para>Coded value or vendor string</para></entry>
27337 <entry><para>Filled in automatically with the Koha assigned
27338 vendor id by Acquisitions when an item is
27339 received.</para></entry>
27343 <entry><para>952$g</para></entry>
27345 <entry><para>Purchase price</para></entry>
27347 <entry><para>Decimal number, no currency symbol (ex.
27348 10.00)</para></entry>
27350 <entry><para>Filled in automatically by Acquisitions when an
27351 item is received.</para></entry>
27355 <entry><para>952$h</para></entry>
27357 <entry><para>Serial enumeration</para></entry>
27359 <entry><para/></entry>
27361 <entry><para>Filled in automatically by Serials if the issue
27362 is received there.</para></entry>
27366 <entry><para>952$o</para></entry>
27368 <entry><para>Koha full call number</para></entry>
27370 <entry><para/></entry>
27372 <entry><para>Can be filled in automatically based on the <link
27373 linkend="itemcallnumber">itemcallnumber</link> system
27374 preference.</para></entry>
27378 <entry><para>952$p</para></entry>
27380 <entry><para>Barcode *</para></entry>
27382 <entry><para>Max 20 characters</para></entry>
27384 <entry><para/></entry>
27388 <entry><para>952$t</para></entry>
27390 <entry><para>Copy number</para></entry>
27392 <entry><para>Max 32 characters</para></entry>
27394 <entry><para/></entry>
27398 <entry><para>952$v</para></entry>
27400 <entry><para>Replacement price</para></entry>
27402 <entry><para>Decimal number, no currency symbol (ex.
27403 10.00)</para></entry>
27405 <entry><para>Filled in automatically by Acquisitions when an
27406 item is received.</para></entry>
27410 <entry><para>952$w</para></entry>
27412 <entry><para>Price effective from</para></entry>
27414 <entry><para>YYYY-MM-DD</para></entry>
27416 <entry>Date formats in the 952 subfields are required to be in
27417 the system internal format for data loading and subsequent
27418 item editing: YYYY-MM-DD. Filled in automatically by
27419 Acquisitions when an item is received.</entry>
27423 <entry><para>952$y</para></entry>
27425 <entry><para>Koha item type **</para></entry>
27427 <entry><para>Coded value, required field for
27428 circulation</para></entry>
27430 <entry><para><emphasis role="bold">Required</emphasis>. Coded
27431 value, must be defined in <link linkend="itemtypeadmin">Item
27432 types</link></para></entry>
27436 <entry><para>952$z</para></entry>
27438 <entry><para>Public note</para></entry>
27440 <entry><para/></entry>
27442 <entry><para/></entry>
27448 <para>* - required for circulation</para>
27450 <para>** - required by Koha</para>
27453 <section id="onorderitemholds">
27455 <corpauthor>VOKAL</corpauthor>
27458 <firstname>Nicole C.</firstname>
27460 <surname>Engard</surname>
27463 <pubdate>2010</pubdate>
27465 <bibliosource><ulink
27466 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>
27469 <title>Handling On Order Items and Holds</title>
27471 <para>If you tend to import your MARC records when you have ordered
27472 the book (as opposed to when you receive the books), and allow patrons
27473 to place holds on those books, you may need to add item records to the
27474 *.mrc file before importing.</para>
27476 <para>The easiest way to import your latest order is to first run your
27477 records through <ulink
27478 url="http://people.oregonstate.edu/~reeset/marcedit/html/index.php">MARCEdit</ulink>.
27479 Download your MARC records, saving them to your desktop or some other
27480 location you use/will remember. If you have MARCEdit already installed
27481 you should simply have to double click on your MARC records, and they
27482 will automatically open in MARCEdit.<important>
27483 <para>This tutorial was written with MARCEdit version
27484 5.2.3769.41641 on Windows XP, instructions may be different if
27485 your version or operating system is different.</para>
27486 </important></para>
27490 <para>Your original file will automatically be in the input;
27491 ensure MarcBreaker is chosen, and then click "Execute"</para>
27494 <screeninfo>MarcBreaker</screeninfo>
27498 <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
27505 <para>You will be presented with a summary of the records
27506 processed at the bottom of the screen</para>
27509 <screeninfo>MarcBreaker Summary</screeninfo>
27513 <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
27520 <para>Click 'Edit Records' to continue on to adding item
27525 <para>Your screen will be replaced with a larger screen containing
27526 the MARC records</para>
27529 <screeninfo>MARC file for editing</screeninfo>
27533 <imagedata fileref="images/appendix-onorder/editrecords.png"/>
27540 <para>Click on Tools > Add/Edit Field</para>
27543 <screeninfo>Add/Delete Field</screeninfo>
27547 <imagedata fileref="images/appendix-onorder/addfield.png"/>
27554 <para>Enter in the Koha specific item info</para>
27557 <screeninfo>Add 942 Field</screeninfo>
27561 <imagedata fileref="images/appendix-onorder/add942.png"/>
27568 <para>In the Field box, type 942</para>
27572 <para>In the Field Data box, type \\$c and the item type code
27573 (\\$cBOOK in this example)</para>
27577 <para>Check the 'Insert last' option</para>
27581 <para>Click 'Add Field'</para>
27587 <para>Enter in the item record data</para>
27590 <screeninfo>Add 952 Field</screeninfo>
27594 <imagedata fileref="images/appendix-onorder/add952.png"/>
27601 <para>In the Field box, type 952</para>
27605 <para>In the Field Data box, type
27606 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
27610 <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
27614 <para>In a default install of Koha -1 is the value for
27615 the Ordered status</para>
27621 <para>You may want to look at other subfields you would
27622 like data in -- for example, changing the collection code
27623 to put all the items in the same collection (8),
27624 automatically fill in the acquisition date (d), or put in
27625 a public note (z).</para>
27629 <para>Be sure you use the $ to separate subfields; adding
27630 each subfield on a separate line will cause that many
27631 items to be imported with your MARC record (in the example
27632 above, four items, each with one of those subfields
27637 <para>Make sure you look at the Administration >
27638 Authorized Values in Koha to put the correct code into the
27645 <para>Check the 'Insert last' option</para>
27649 <para>Click 'Add Field'</para>
27655 <para>Close the field editor window</para>
27659 <para>Click on File > Compile into MARC</para>
27662 <screeninfo>Compile into MARC</screeninfo>
27666 <imagedata fileref="images/appendix-onorder/compile.png"/>
27673 <para>Choose where to save your file</para>
27677 <para>Now you want to go into your Koha system and follow the
27678 instructions for <link linkend="stagemarc">importing MARC
27679 records</link>.</para>
27681 <para>Once the item has come in, you will need to go to the item
27682 record and individually change the item to have the correct barcode,
27683 and manually change the status from Ordered to the blank line in the
27684 Not for Loan field.</para>
27687 <para>If you purchase your cataloged item records, you may want to
27688 request your vendor put in the information you need into the MARC
27689 records for you; that way, you could import the edited-by-the-vendor
27690 file, overwriting the current record, automatically replacing the
27691 data with what you need.</para>
27697 <chapter id="serials">
27698 <title>Serials</title>
27700 <para>Serials actions can be accessed by going to the More menu at the top
27701 of your screen and choosing Serials or by clicking Serials on the main
27702 Koha staff client page. The Serials module in Koha is used for keeping
27703 track of journals, newspapers and other items that come on a regular
27704 schedule. As with all modules, make sure you go through the related <link
27705 linkend="impserials">Implementation Checklist</link> before using the
27706 Serials module.</para>
27710 <para><emphasis>Get there:</emphasis> More > Serials</para>
27714 <section id="newsubscription">
27715 <title>Add a subscription</title>
27717 <para>Subscriptions can be added by clicking the 'New' button on any
27718 bibliographic record</para>
27721 <screeninfo>New Subscription Button</screeninfo>
27725 <imagedata fileref="images/serials/newsubfrombib.png"/>
27730 <para>Or by visiting the Serials module and clicking 'New
27731 Subscription'</para>
27734 <screeninfo>New Subscription Button</screeninfo>
27738 <imagedata fileref="images/serials/newsubbutton.png"/>
27743 <para>If you are entering a new subscription from the Serials module you
27744 will be presented with a blank form (if creating new from a
27745 bibliographic record the form will include the bib info).</para>
27748 <screeninfo>Add a new Subscription Form</screeninfo>
27752 <imagedata fileref="images/serials/addsub.png"/>
27759 <para>'Librarian' field will show the logged in librarian's
27764 <para>'Vendor' can be found by either searching vendors entered via
27765 the <link linkend="acqmodule">Acquisitions module</link> or entering
27766 the vendor ID number</para>
27770 <para>Vendor information is not required</para>
27774 <para>In order to claim missing and late issues you need to
27775 enter vendor information</para>
27778 <screeninfo>Vendor Missing Warning</screeninfo>
27782 <imagedata fileref="images/serials/vendorwarning.png"/>
27791 <para>'Biblio' is the MARC record you'd like to link this
27792 subscription to</para>
27796 <para>This can be done by searching for an existing record by
27797 clicking on the 'Search for Biblio' link below the boxes or by
27798 entering the bib number for a record in the first box. Only if
27799 you search with the field between the parenthesis.</para>
27805 <para>Next you can choose whether a new item is created when
27806 receiving an issue</para>
27810 <para>'Location' is for the shelving location</para>
27814 <para>'Call Number' is for your item's call number prefix</para>
27818 <para>'Library' is the branch that owns this subscription.</para>
27822 <para>If more than one library subscribes to this serial you
27823 will need to create a subscription for each library</para>
27827 <para>This can be done easily by using the 'Edit as New
27828 (Duplicate)' option found on the subscription information page
27829 and changing only the 'Library' field</para>
27832 <screeninfo>New Duplicate Subscription</screeninfo>
27836 <imagedata fileref="images/serials/newasdup.png"/>
27845 <para>The 'Grace Period' is the number of days before an issue is
27846 automatically moved from 'expected' status to 'waiting' and how many
27847 days before an issue is automatically moved from 'waiting' status to
27852 <para>Use the 'Public Note' for any notes you would like to appear
27853 in the OPAC for the patrons</para>
27857 <para>'Nonpublic Note' should be used for notes that are only
27858 visible to the librarians via the staff client</para>
27862 <para>To set up a routing list for serials, choose 'Routing List'
27863 from the 'Patron notification' field.</para>
27867 <para>For this option to appear you need to make sure that you
27868 have a Routing List notice set up in the <link
27869 linkend="notices">Notices Tool</link></para>
27873 <para>Learn more about <link linkend="routinglist">Routing
27874 Lists</link> later in this manual</para>
27880 <para>The Staff and OPAC Display options allow you to control how
27881 many issues appear by default on bibliographic records in the Staff
27882 Client and the OPAC</para>
27886 <para>If no values are entered in these fields, they will use
27888 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
27890 linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
27891 system preference values</para>
27897 <para>In 'First issue publication date' you want to enter the date
27898 of the issue you have in your hand, the date from which the
27899 prediction pattern will start</para>
27903 <para>There are several pre-defined options for the 'Frequency' of
27908 <para>Without periodicy: some very specific (usually high level
27909 science journals) don't have a true periodicity. When you
27910 subscribe to the title, you subscribe for 6 issues, which can
27911 arrive in 1 year... or 2... There is no regularity or known
27916 <para>Unknown select this if none of the other choices are
27921 <para>Irregular: The journal is not "regular" but has a
27922 periodicity. You know that it comes out on January, then in
27923 October and December, it is irregular, but you know when it's
27924 going to arrive.</para>
27928 <para>2/day: Twice daily</para>
27932 <para>1/day: Daily</para>
27936 <para>3/week: Three times a week</para>
27940 <para>1/week: Weekly</para>
27944 <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
27948 <para>1/ 3 weeks: Tri-weekly</para>
27952 <para>1/month: Monthly</para>
27956 <para>1/ 2 months (6/year): Bi-monthly</para>
27960 <para>1/ 3 months (1/quarter): Quarterly</para>
27964 <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
27965 Summer, Autumn, Winter, Spring)</para>
27969 <para>2/year: Half yearly</para>
27973 <para>1/year: Annual</para>
27977 <para>1/ 2 years: Bi-annual</para>
27983 <para>Checking the 'Manual history' box will allow you to enter
27984 serials outside the prediction pattern.</para>
27988 <para>'Numbering pattern' will help you determine how the numbers
27989 are printed for each issue</para>
27993 <para>Start with the numbering on the issue you have in hand,
27994 the numbering that matches the date you entered in the 'First
27995 issue publication' field</para>
27999 <para>If you have chosen any 'Numbering Format' other than
28000 'Number' in the 'Rollover at' field, enter the last issue number
28001 before the volume number changes</para>
28005 <para>If you chose the 'Number' Numbering Format you will
28006 see 'issues expected' in which you will enter the total
28007 number of issues you expect to receive.</para>
28010 <screeninfo>Number as Numbering Pattern</screeninfo>
28014 <imagedata fileref="images/serials/numberonly.png"/>
28023 <para>You can choose to create your own numbering pattern by
28024 choosing 'None of the above' and clicking the 'Show/Hide
28025 Advanced Pattern' button at the bottom of the form</para>
28031 <para>'Subscription start date' is the date at which the
28032 subscription begins. This is used for setting up renewal
28037 <para>'Subscription length' is the number of issues or months in the
28038 subscription. This is also used for setting up renewal alerts</para>
28042 <para>'Subscription end date' should only be entered for
28043 subscriptions that have ended (if you're entering in a backlog of
28048 <para>The 'Numbering formula' is editable to match the way you'd
28049 like your numbering to print on the item record and subscription
28050 information pages</para>
28054 <para>Click 'Save Subscription' to save the information you have
28055 entered. <link linkend="sampleserialsapp">Find sample serial examples in
28056 the appendix</link>.</para>
28059 <section id="receiveissues">
28060 <title>Receive Issues</title>
28062 <para>Issues can be marked as received from several locations. To find a
28063 subscription, use the search box at the top of the Serials page to
28064 search for the serial you'd like to receive issues for:</para>
28067 <screeninfo>Subscription Search</screeninfo>
28071 <imagedata fileref="images/serials/subsearch.png"/>
28076 <para>From the search results you can click the 'Serial Receive' link or
28077 you can click on the subscription title and then click the 'Receive'
28081 <screeninfo>Subscription Buttons</screeninfo>
28085 <imagedata fileref="images/serials/subbuttons.png"/>
28090 <para>The final way to receive serials is from the 'Serial Collection'
28091 page. To the left of the Subscription summary page there is a menu with
28092 a link to 'Serial Collection'</para>
28095 <screeninfo>Serial Subscription Menu</screeninfo>
28099 <imagedata fileref="images/serials/serialcolllink.png"/>
28104 <para>From the page that opens up you can click 'Edit Serial' with the
28105 issue you want to receive checked.</para>
28108 <screeninfo>Edit Issues</screeninfo>
28112 <imagedata fileref="images/serials/editissue.png"/>
28117 <para>All three of these options will open up the issue receive
28121 <screeninfo>Receive Serials</screeninfo>
28125 <imagedata fileref="images/serials/receiveissue.png"/>
28132 <para>Choose 'Arrived' from the status pull down to mark a serial as
28137 <para>If you have decided to have an item record created for each
28138 issue an <link linkend="addingitems">item add form</link> will
28143 <para>If your issue has a supplemental issue with it, fill in the
28144 Supplemental Issue information.</para>
28148 <para>If you have decided to have an item record created for each
28149 issue an <link linkend="addingitems">item add form</link> will
28150 appear for your supplement and for the issue itself</para>
28154 <para>Once you have entered your info you can click 'Save'</para>
28158 <para>If you are receiving multiple issues at once, or have marked an
28159 issue as 'Late' or 'Missing' there you can click the 'Generate Next'
28160 button below the list of issues.</para>
28163 <screeninfo>Generate Next Button</screeninfo>
28167 <imagedata fileref="images/serials/editissue.png"/>
28172 <para>Clicking this button will generate the next issue for you and mark
28173 the previously expected issue as 'Late' automatically. You can then
28174 check the 'Edit' box to the right of each issue and edit the status on
28175 multiple issues at once.</para>
28178 <section id="routinglist">
28179 <title>Create a Routing List</title>
28181 <para>A routing list is a list of people who receive the serial before
28182 it goes to the shelf. When setting up your serial subscription you want
28183 to be sure to pick 'Routing List' from the 'Patron Notification' pull
28187 <screeninfo>Patron Notification Option</screeninfo>
28191 <imagedata fileref="images/serials/serialnotification.png"/>
28196 <para>When on the subscription page you will see a link to the left that
28197 reads 'Create Routing List' or 'Edit Routing List'</para>
28200 <screeninfo>Subscription Routing List Link</screeninfo>
28204 <imagedata fileref="images/serials/createroutinglink.png"/>
28209 <para>Clicking that link will bring you to the menu to add a new routing
28213 <screeninfo>Routing List Creation</screeninfo>
28217 <imagedata fileref="images/serials/createroutinglist.png"/>
28222 <para>From here you want to click 'Add recipients' in order to add
28223 people to the routing list. In the menu that appears you can filter
28224 patrons by part of their name, their library and/or patron
28228 <screeninfo>Add Members to Routing List</screeninfo>
28232 <imagedata fileref="images/serials/addtorouting.png"/>
28237 <para>Clicking 'Add' to the right of each name will add them to the
28238 routing list. When you have chosen all of the people for the list, click
28239 the 'Close' link to be redirected to the routing list.</para>
28242 <screeninfo>Routing List</screeninfo>
28246 <imagedata fileref="images/serials/editroutinglist.png"/>
28251 <para>If the list looks the way you expect it to, then click 'Save'.
28252 Next you will be brought to a preview of the routing list. To print the
28253 list click 'Save and preview routing slip.' This will open a printable
28254 version of the list.</para>
28257 <screeninfo>Preview Routing List</screeninfo>
28261 <imagedata fileref="images/serials/previewroutinglist.png"/>
28267 linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
28268 on then patrons listed in the routing list will automatically be added
28269 to the holds list for the issue.</para>
28272 <section id="serialsubinstaff">
28273 <title>Subscriptions in Staff Client</title>
28275 <para>Subscription information will appear on bibliographic records
28276 under the 'Subscriptions' tab</para>
28279 <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
28283 <imagedata fileref="images/serials/subinfoonbib.png"/>
28288 <para>Clicking the 'Subscription Details' link will take you to the
28289 Subscription summary page in the staff client.</para>
28292 <screeninfo>Subscription Detail</screeninfo>
28296 <imagedata fileref="images/serials/subscriptiondetail.png"/>
28302 <section id="serialsubinopac">
28303 <title>Subscriptions in OPAC</title>
28305 <para>When viewing the subscription in the OPAC there will be several
28308 <para>Like in the staff client, there will be a Subscriptions tab on the
28309 bibliographic record.</para>
28312 <screeninfo>Subscriptions Tab in OPAC</screeninfo>
28316 <imagedata fileref="images/serials/subopac.png"/>
28321 <para>Under this tab will appear the number of issues you chose when
28322 setting up the subscription or in your <link
28323 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
28324 system preference. Clicking the 'More details' link will provide you
28325 with additional information about the serial history. You can set the
28326 default view of a serial in the OPAC with the <link
28327 linkend="SubscriptionHistory">SubscriptionHistory</link> system
28330 <para>There are two views, compact and full. The compact serial
28331 subscription will show basic information regarding the
28332 subscription</para>
28335 <screeninfo>Compact Serial View</screeninfo>
28339 <imagedata fileref="images/serials/compactopac.png"/>
28344 <para>From this compact display patrons can subscribe to routing lists
28345 by clicking the subscribe link that appears below subscriptions that
28346 offer a routing list.</para>
28349 <screeninfo>Subscribe link in the OPAC</screeninfo>
28353 <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
28358 <para>Whereas the full view shows extensive details, broken out by year,
28359 regarding the subscription</para>
28362 <screeninfo>Full Serial View</screeninfo>
28366 <imagedata fileref="images/serials/fullopac.png"/>
28372 <section id="serialclaims">
28373 <title>Claim Late Serials</title>
28375 <para>Koha can send email messages to your serial vendors if you have
28376 late issues. To the left of the main serials page there is a link to
28380 <screeninfo>Link to Claims on Serials Menu</screeninfo>
28384 <imagedata fileref="images/serials/serialclaimmenu.png"/>
28389 <para>The links to claims also appears to the left of the subscription
28393 <screeninfo>Link to Claims on the Serials Menu</screeninfo>
28397 <imagedata fileref="images/serials/serialclaimmenu1.png"/>
28402 <para>If you don't have a claim notice defined yet you will see a
28403 warning message that you need to first define a notice.</para>
28406 <screeninfo>Missing Claims Notice Warning</screeninfo>
28410 <imagedata fileref="images/serials/noserialclaim.png"/>
28415 <para>Clicking 'Claims' will open a report that will ask you to choose
28416 from your various serial vendors to generate claims for late
28420 <screeninfo>Serial Claims</screeninfo>
28424 <imagedata fileref="images/serials/serialclaims.png"/>
28429 <para>From the list of late issues you can choose which ones you want to
28430 send a claim email to by clicking the checkbox to the left of late
28431 issue, choosing the notice template to use and clicking the 'Send
28432 notification' button.</para>
28435 <section id="serialexpiration">
28436 <title>Check Serial Expiration</title>
28438 <para>When adding serials you enter a subscription length, using the
28439 check expiration tool you can see when your subscriptions are about to
28440 expire. To use the tool click the link to 'Check expiration' on the
28441 serials menu.</para>
28444 <screeninfo>Check Serial Expiration</screeninfo>
28448 <imagedata fileref="images/serials/serialexpiresearch.png"/>
28453 <para>In the form that appears you need to enter at least a date to
28456 <para>In your results you will see all subscriptions that will expire
28457 before the date you entered. From there you can choose to view the
28458 subscription further or renew it in one click.</para>
28461 <screeninfo>Serial Expiration Search Results</screeninfo>
28465 <imagedata fileref="images/serials/serialexpire.png"/>
28471 <section id="serialrenew">
28472 <title>Renewing Serials</title>
28474 <para>If your serial subscription has expired you won't be able to
28475 receive issues. To renew your subscription you can click the 'Renew'
28476 button at the top of your subscription detail page.</para>
28479 <screeninfo>Renew option on subscription detail</screeninfo>
28483 <imagedata fileref="images/serials/renewsubscription.png"/>
28488 <para>Another option is to click the 'Renew' link to the right of the
28489 subscription on the Serial Collection page.</para>
28492 <screeninfo>Renew option on serial collection</screeninfo>
28496 <imagedata fileref="images/serials/collectionrenew.png"/>
28501 <para>Once you click the 'Renew' link or button you will be presenting
28502 with renewal options.</para>
28505 <screeninfo>Subscription renewal form</screeninfo>
28509 <imagedata fileref="images/serials/serialrenew.png"/>
28516 <para>The start date should be the date your subscription period
28521 <para>For the subscription length you'll want to fill in one of the
28522 three fields presented: Number of num (issues), Number of months or
28523 Number of weeks.</para>
28527 <para>Finally enter any notes you might have about this
28534 <chapter id="acqmodule">
28535 <title>Acquisitions</title>
28537 <para>The Koha Acquisitions module provides a way for the library to
28538 record orders placed with vendors and manage purchase budgets.</para>
28542 <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
28546 <section id="acqsetup">
28547 <title>Setup</title>
28549 <para>Before using the Acquisitions Module you will want to make sure
28550 that you have completed all of the set up.</para>
28552 <para>First, set your <link linkend="acqprefs">Acquisitions System
28553 Preferences</link> and <link linkend="acqadmin">Acquisitions
28554 Administration</link> to match your library's workflow.</para>
28556 <para>On the main acquisitions page you will see your library's funds
28560 <screeninfo>Acquisitions Funds Summary</screeninfo>
28564 <imagedata fileref="images/acquisitions/acqfunds.png"/>
28570 <para>If the total line is confusing for the funds you have set up
28571 you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
28573 <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
28577 <para>To see all active funds you can click the checkbox next to 'Show
28578 all' below the funds table.</para>
28580 <para>To see a history of all orders in a fund you can click on the
28581 linked amount and it will run a search for you.</para>
28584 <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
28588 <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
28593 <para>Learn more in the <link linkend="fundtracking">Budget/Fund
28594 Tracking</link> section of this manual.</para>
28597 <section id="acqvendors">
28598 <title>Vendors</title>
28600 <para>Before any orders can be places you must first enter at least one
28603 <section id="addacqvendor">
28604 <title>Add a Vendor</title>
28606 <para>To add a vendor click the 'New Vendor' button on the
28607 Acquisitions page</para>
28610 <screeninfo>New Vendor Button on Acquisitions</screeninfo>
28614 <imagedata fileref="images/acquisitions/newvendbutton.png"/>
28619 <para>The vendor add form is broken into three pieces</para>
28623 <para>The first section is for basic information about the
28627 <screeninfo>Basic Vendor Information</screeninfo>
28631 <imagedata fileref="images/acquisitions/newvendor1.png"/>
28638 <para>Of these fields, only the Vendor name is required, the
28639 rest of the information should be added to help with
28640 generating claim letters and invoices</para>
28646 <para>The second section is for information regarding your contact
28647 at the Vendor's office</para>
28650 <screeninfo>Vendor Contact Details</screeninfo>
28654 <imagedata fileref="images/acquisitions/newvendor2.png"/>
28661 <para>None of these fields are required, they should only be
28662 entered if you want to keep track of your contact's
28663 information within Koha</para>
28669 <para>The final section is for billing information</para>
28672 <screeninfo>Vendor Ordering/Billing Information</screeninfo>
28676 <imagedata fileref="images/acquisitions/newvendor3.png"/>
28683 <para>To be able to order from a vendor you must make them
28688 <para>For List Prices and Invoice Prices choose the
28693 <para>Currencies are assigned in the <link
28694 linkend="currexchangeadmin">Currencies & Exchange
28695 Rates</link> admin area</para>
28701 <para>If your library is charged tax mark your Tax Number as
28706 <para>Note if you list prices and/or invoice prices include
28711 <para>If the vendor offers a consistent blank discount, enter
28712 that in the 'Discount' field</para>
28716 <para>You can enter item specific discounts when placing
28723 <para>Enter your tax rate if your library is charged taxes on
28728 <para>If you know about how long it usually takes orders to
28729 arrive from this vendor you can enter a delivery time. This
28730 will allow Koha to estimate when orders will arrive at your
28731 library on the late orders report.</para>
28735 <para>Notes are for internal use</para>
28742 <section id="editacqvendor">
28743 <title>View/Edit a Vendor</title>
28745 <para>To view a vendor's information page you must search for the
28746 vendor from the Acquisitions home page. Your search can be for any
28747 part of the Vendor's name:</para>
28750 <screeninfo>Vendor Search Results</screeninfo>
28754 <imagedata fileref="images/acquisitions/vendorsearch.png"/>
28759 <para>From the results, click on the name of the vendor you want to
28760 view or edit</para>
28763 <screeninfo>Vendor Information Page</screeninfo>
28767 <imagedata fileref="images/acquisitions/vendorpage.png"/>
28772 <para>To make changes to the vendor, simply click the 'Edit'
28775 <para>If the vendor has no baskets attached to it then a 'Delete'
28776 button will also be visible and the vendor can be deleted.</para>
28779 <screeninfo>Delete Vendor Button</screeninfo>
28783 <imagedata fileref="images/acquisitions/deletevendor.png"/>
28789 <section id="vendorcontracts">
28790 <title>Vendor Contracts</title>
28792 <para>You can define contracts (with a start and end date) and attach
28793 it to a vendor. This is used so that at the end of the year you can
28794 see how much you spent on a specific contract with a vendor. In some
28795 places, contracts are set up with a minimum and maximum yearly
28798 <section id="addvendorcontract">
28799 <title>Add a Contract</title>
28801 <para>At the top of a vendor search results page with only result or
28802 at the top of a vendor information page you will see a 'New
28803 Contract' button.</para>
28806 <screeninfo>New Contract Button</screeninfo>
28810 <imagedata fileref="images/acquisitions/newcontract.png"/>
28815 <para>The contract form will ask for some very basic information
28816 about the contract</para>
28819 <screeninfo>New Contract Form</screeninfo>
28823 <imagedata fileref="images/acquisitions/newcontractform.png"/>
28829 <para>You will not be able to enter a contract retrospectively,
28830 the end date must not be before today's date.</para>
28833 <para>Once the contract is saved it will appear below the vendor
28834 information.</para>
28837 <screeninfo>Vendor with contracts</screeninfo>
28841 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
28846 <para>It will also be an option when creating a basket</para>
28849 <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
28853 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
28861 <section id="managesuggest">
28862 <title>Managing Suggestions</title>
28864 <para>Depending on your settings in the <link
28865 linkend="suggestionspref">suggestion</link> system preference, patrons
28866 may be able to make purchase suggestions via the OPAC. When a suggestion
28867 is waiting for library review, it will appear on the Acquisitions home
28868 page under the vendor search.</para>
28871 <screeninfo>Pending suggestions on Acquisitions</screeninfo>
28875 <imagedata fileref="images/acquisitions/suggestonacq.png"/>
28880 <para>It will also appear on the main staff dashboard under the module
28884 <screeninfo>Pending suggestions on main page</screeninfo>
28888 <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
28893 <para>Clicking 'Manage suggestions' will take you to the suggestion
28894 management tool. If there are no pending suggestions you can access the
28895 suggestion management tool by clicking the 'Manage suggestions' link on
28896 the menu on the left of the Acquisitions page.</para>
28899 <screeninfo>Suggestion Management</screeninfo>
28903 <imagedata fileref="images/acquisitions/suggestmanage.png"/>
28908 <para>Your suggestions will be sorted into several tabs: Accepted,
28909 Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
28910 suggestion will show the name of the librarian who managed the
28911 suggestion and the reason they gave for accepting or rejecting it (found
28912 under 'Status').</para>
28914 <para>For libraries with lots of suggestions, there are filters on the
28915 left hand side of the Manage Suggestions page to assist in limiting the
28916 number of titles displayed on the screen.</para>
28919 <screeninfo>Suggestion Filtering</screeninfo>
28923 <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
28928 <para>Clicking on the blue headings will expand the filtering options
28929 and clicking '[clear]' will clear all filters and show all
28931 <para>The suggestions page will automatically be limited to
28932 suggestions for your library. To see information for all (or any
28933 other) libraries click on the 'Acquisition information' filter and
28934 change the library.</para>
28937 <screeninfo>Branch filter</screeninfo>
28941 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
28947 <para>When reviewing 'Pending' suggestions you can choose to check the
28948 box next to the item(s) you want to approve/reject and then choose the
28949 status and reason for your selection. You can also choose to completely
28950 delete the suggestion by checking the 'Delete selected' box.</para>
28953 <screeninfo>Pending Suggestions</screeninfo>
28957 <imagedata fileref="images/acquisitions/suggestpending.png"/>
28962 <para>Another option for libraries with long lists of suggestions is to
28963 approve or reject suggestions one by one by clicking on the title of the
28964 suggestion to open a summary of the suggestion, including information if
28965 the item was purchased.</para>
28968 <screeninfo>Suggestion Information</screeninfo>
28972 <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
28977 <para>Clicking 'edit' to the right of the suggested title will open a
28978 suggestion editing page.</para>
28981 <screeninfo>Edit Purchase Suggestion</screeninfo>
28985 <imagedata fileref="images/acquisitions/editsuggestion.png"/>
28990 <para>From this form you can make edits to the suggestion (adding more
28991 details or updating incorrect information provided by the patron). You
28992 can also choose to accept or reject the suggestion on an individual
28997 <para>Choosing to mark a request as 'Pending' will move the request
28998 back to the 'Pending' tab.</para>
29002 <para>Reasons for accepting and rejecting suggestions are defined by the
29003 <link linkend="suggestauthorized">SUGGEST</link> authorized
29007 <screeninfo>Reasons for approving or rejecting
29008 suggestions</screeninfo>
29012 <imagedata fileref="images/acquisitions/suggestreasons.png"/>
29017 <para>If you choose 'Others...' as your reason you will be prompted to
29018 enter your reason in a text box. Clicking 'Cancel' to the right of the
29019 box will bring back the pull down menu with authorized reasons.</para>
29022 <screeninfo>Enter reason for 'Others...'</screeninfo>
29026 <imagedata fileref="images/acquisitions/suggestothers.png"/>
29031 <para>Once you have clicked 'Submit' the suggestion will be moved to the
29032 matching tab. The status will also be updated on the patron's account in
29033 the OPAC and an <link linkend="notices">email notice</link> will be sent
29034 to the patron using the template that matches the status you have
29038 <screeninfo>Purchase suggestions in the OPAC</screeninfo>
29042 <imagedata fileref="images/acquisitions/mysuggestions.png"/>
29048 <section id="placingacqorder">
29049 <title>Placing Orders</title>
29051 <para>To place an order you must first search for the vendor or
29052 bookseller you want to send the order to.</para>
29054 <section id="createacqbasket">
29055 <title>Create a basket</title>
29057 <para>To create a basket you must first search for the vendor you're
29058 ordering from:</para>
29061 <screeninfo>New Basket / Add Basket Options</screeninfo>
29065 <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
29070 <para>Next to the vendor name you will see a 'New Basket'
29074 <screeninfo>Add Basket Form</screeninfo>
29078 <imagedata fileref="images/acquisitions/addbasket.png"/>
29083 <para>When adding a basket you want to give it a name that will help
29084 you identify it later. The notes fields are optional and can contain
29085 any type of information.</para>
29087 <para>If you have <link linkend="addvendorcontract">added
29088 contracts</link> to the vendor you're ordering from, you will also
29089 have an option to choose which contract you're ordering these items
29093 <screeninfo>Basket with contract options</screeninfo>
29097 <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
29102 <para>When finished, click 'Save'</para>
29105 <screeninfo>New Empty Basket</screeninfo>
29109 <imagedata fileref="images/acquisitions/basket.png"/>
29114 <para>Once your basket is created you are presented with several
29115 options for adding items to the order.</para>
29119 <para>If you are ordering another copy of an existing item, you
29120 can simply search for the record in your system</para>
29123 <screeninfo>Search for existing records</screeninfo>
29127 <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
29134 <para>From the results, simply click 'Order' to be brought to
29135 the order form</para>
29138 <screeninfo>Order form</screeninfo>
29142 <imagedata fileref="images/acquisitions/existingitemorder.png"/>
29149 <para>All of the details associated with the item will
29150 already be listed under 'Catalog details'</para>
29158 <para>If you allow patrons to make purchase suggestions (learn
29159 more in the <link linkend="managesuggest">Managing
29160 Suggestions</link> section of this manual) then you can place
29161 orders from those suggestions</para>
29164 <screeninfo>Approved Suggestions to Order From</screeninfo>
29168 <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
29175 <para>From the results, click 'Order' next to the item you
29176 want to order and you will be presented with the order form
29177 including a link to the suggestion</para>
29180 <screeninfo>Order from a Suggestion</screeninfo>
29184 <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
29191 <para>From this form you can make changes to the Catalog
29192 Details if necessary</para>
29196 <para>When the item appears in your basket it will include
29197 a link to the suggestion</para>
29200 <screeninfo>Suggestion Link in basket</screeninfo>
29204 <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
29215 <para>To order from a record that can't be found anywhere else,
29216 choose the 'From a new (empty) record'</para>
29219 <screeninfo>Order a new record</screeninfo>
29223 <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
29230 <para>You will be presented with an empty form to fill in all
29231 of the necessary details about the item you are
29238 <para>If you want to search other libraries for an item to
29239 purchase you can use the 'From an external source' option which
29240 will allow you to order from a MARC record found via a Z39.50
29244 <screeninfo>Search for record to add</screeninfo>
29248 <imagedata fileref="images/acquisitions/orderz39.png"/>
29255 <para>From the results click the Order link next to the item
29256 you want to purchase</para>
29259 <screeninfo>Search Results to Order From</screeninfo>
29263 <imagedata fileref="images/acquisitions/orderz39results.png"/>
29270 <para>If the item you're ordering from an external source
29271 looks like it might be a duplicate, Koha will warn you and
29272 give you options on how to proceed</para>
29275 <screeninfo>Duplicate order warning</screeninfo>
29279 <imagedata fileref="images/acquisitions/dupwarning.png"/>
29286 <para>From the warning you can choose to just order
29287 another copy on the existing bib record, create a new bib
29288 record, or cancel your order of this item.</para>
29294 <para>In the order form that pops up you will not be able to
29295 edit the catalog details</para>
29298 <screeninfo>New order from Z39.50 Search</screeninfo>
29302 <imagedata fileref="images/acquisitions/orderz39form.png"/>
29311 <para>The final option for ordering is to order from a staged
29312 record (<link linkend="stagemarc">learn more about staging
29313 records</link>)</para>
29316 <screeninfo>Staged Files to Order From</screeninfo>
29320 <imagedata fileref="images/acquisitions/stagedfiles.png"/>
29327 <para>From the list of files you are presented with, choose
29328 the 'Add orders' link</para>
29331 <screeninfo>Records in the staged file</screeninfo>
29335 <imagedata fileref="images/acquisitions/stagedrecords.png"/>
29342 <para>From the list of records, click 'Add order' next to
29343 the item you want to add to your order</para>
29346 <screeninfo>New order from Staged Record</screeninfo>
29350 <imagedata fileref="images/acquisitions/stagedorder.png"/>
29357 <para>From the order form you will not be able to edit
29358 the catalog details.</para>
29364 <para>The other option is to import all records from the
29365 staged file by scrolling below the list of records in the
29366 staged file and filling in the item information.</para>
29369 <screeninfo>Import All</screeninfo>
29373 <imagedata fileref="images/acquisitions/importallstaged.png"/>
29380 <para>If you choose this option the Koha will look in
29381 the 020$c and grab the pricing information from that
29382 field and put that on each order line.</para>
29392 <para>After bringing in the bib information, if your <link
29393 linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
29394 to add an item when ordering you will enter the item info next. You
29395 need to fill out at least one item record and then click the 'Add'
29396 button at the bottom left of the item form.</para>
29399 <screeninfo>Item order</screeninfo>
29403 <imagedata fileref="images/acquisitions/itemonorder.png"/>
29408 <para>After clicking add the item will appear above the form and then
29409 you can enter your next item the same way (if ordering more than one
29413 <screeninfo>Item ordered</screeninfo>
29417 <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
29422 <para>Once you have entered the info about the item you need to enter
29423 the Accounting information.</para>
29426 <screeninfo>Accounting Details</screeninfo>
29430 <imagedata fileref="images/acquisitions/accounting.png"/>
29437 <para>Quantity is populated by the number of items you've added to
29438 the order above</para>
29442 <para>The list of funds is populated by the <link
29443 linkend="funds">funds</link> you have assigned in the <link
29444 linkend="acqadmin">Acquisitions Administration</link> area</para>
29448 <para>The currency pull down will have the <link
29449 linkend="currexchangeadmin">currencies</link> you set up in the
29450 <link linkend="acqadmin">Acquisitions Administration</link>
29455 <para>The vendor price will be used to calculate the rest of the
29456 amount fields below</para>
29460 <para>If the price is uncertain, check the uncertain price
29465 <para>A basket with at least one uncertain price can't be
29472 <para>If you added Planning Values when <link
29473 linkend="addbudgetfund">creating the Fund</link> those values will
29474 appear in the two planning value fields</para>
29478 <para>Once an item is added to the basket you will be presented with a
29479 basket summary</para>
29482 <screeninfo>Basket with item info</screeninfo>
29486 <imagedata fileref="images/acquisitions/finalbasket.png"/>
29491 <para>From here you can edit or remove the items you have
29496 <para>Choosing to 'Delete the order' will just delete the order
29497 line, but leave the record in the catalog</para>
29501 <para>Choosing to 'Delete order and catalog record' remove both
29502 the order line and the record in the catalog</para>
29506 <para>The catalog record cannot always be deleted, you might
29507 see notes as to why</para>
29510 <screeninfo>Can't delete order line</screeninfo>
29514 <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
29523 <para>Also on the summary page you have the option to edit the
29524 information you entered about the basket by clicking the 'Edit basket
29525 header information' button, deleting the basket altogether by clicking
29526 the 'Delete this basket' button, or exporting your basket as a CSV
29527 file by clicking the 'Export this basket as CSV' button.</para>
29530 <screeninfo>Basket Buttons</screeninfo>
29534 <imagedata fileref="images/acquisitions/basketbuttons.png"/>
29539 <para>Once you're sure your basket is complete you can click 'Close
29540 this basket' button to indicate that this basket is complete and has
29541 been sent to the vendor. If you have your <link
29542 linkend="BasketConfirmations">BasketConfirmations</link> preference
29543 set to show a confirmation you will be asked if you're sure about
29544 closing the basket.</para>
29547 <screeninfo>Basket Closure Confirmation</screeninfo>
29551 <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
29556 <para>When closing the basket you can choose to add the basket to a
29557 group for easy printing and retrieval. If you check the box to 'Attach
29558 this basket to a new basket group' you will be brought to the group
29559 list where you can print a PDF of the order.</para>
29562 <screeninfo>Closed Baskets</screeninfo>
29566 <imagedata fileref="images/acquisitions/basketgroup.png"/>
29572 <para>A basket with at least one items marked as 'uncertain price'
29573 will not be able to be closed</para>
29576 <screeninfo>A basket with items where the price is
29577 uncertain</screeninfo>
29581 <imagedata fileref="images/acquisitions/basketuncertain.png"/>
29585 </important></para>
29587 <para>Clicking the 'Uncertain Prices' button will pull up a list of
29588 items that you have marked as uncertain for this vendor. From that
29589 list you can quickly edit the items by entering new prices and
29593 <screeninfo>Uncertain Prices</screeninfo>
29597 <imagedata fileref="images/acquisitions/uncertainprices.png"/>
29603 <para>The Uncertain Prices page is independent of the basket, it is
29604 linked to the vendor, so you will see all items on order for this
29605 vendor with uncertain prices.</para>
29611 <section id="acqbasketgroup">
29612 <title>Create a basket group</title>
29614 <para>A basket group is simply a group of baskets. In some libraries,
29615 you have several staff members that create baskets, and, at the end of
29616 a period of time, someone then groups them together to send to the
29617 vendor in bulk. That said, it is possible to have one basket in a
29618 basket group if that's the workflow used in your library.</para>
29621 <section id="printacqbasket">
29622 <title>Printing baskets</title>
29624 <para>When you are finished adding items to your basket you want to
29625 click 'Close this Basket'</para>
29628 <screeninfo>Close Basket</screeninfo>
29632 <imagedata fileref="images/acquisitions/closebasket.png"/>
29637 <para>You will be asked if you want to create a purchase order at this
29641 <screeninfo>Create Purchase Order</screeninfo>
29645 <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
29650 <para>Your completed order will be listed on the Basket Grouping page
29651 for the printing or further modification.</para>
29654 <screeninfo>Basket Grouping</screeninfo>
29658 <imagedata fileref="images/acquisitions/grouping.png"/>
29663 <para>Clicking 'Print' below your order will generate a PDF for
29664 printing. The PDF will have all of your library information followed
29665 by the items in your order.</para>
29668 <screeninfo>Order found on PDF</screeninfo>
29672 <imagedata fileref="images/acquisitions/pdforder.png"/>
29679 <section id="receiveacqorder">
29680 <title>Receiving Orders</title>
29682 <para>Orders can be received from the vendor information page</para>
29685 <screeninfo>Receive from Vendor Information</screeninfo>
29689 <imagedata fileref="images/acquisitions/receivefromvendor.png"/>
29694 <para>or the vendor search results page</para>
29697 <screeninfo>Vendor Search Results</screeninfo>
29701 <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
29706 <para>After clicking 'Receive shipment' you will be asked to enter a
29707 vendor invoice number and a shipment received date.</para>
29710 <screeninfo>Receive Shipment</screeninfo>
29714 <imagedata fileref="images/acquisitions/receive.png"/>
29719 <para>The receive page will list all items still on order with the
29720 vendor regardless of the basket the item is from.</para>
29723 <screeninfo>Receipt Summary</screeninfo>
29727 <imagedata fileref="images/acquisitions/receiptsummary.png"/>
29732 <para>To receive a specific item, click the 'Receive' link to the right
29733 of the item.</para>
29736 <screeninfo>Receive Item Form</screeninfo>
29740 <imagedata fileref="images/acquisitions/receiveitem.png"/>
29745 <para>From this form you can alter the cost information. You can also
29746 choose to mark only part of the order as received if the vendor didn't
29747 send your entire order by entering in the 'Quantity received'. The
29748 values you enter in the 'Replacement cost' and 'Actual cost' will
29749 automatically populate the item record by filling in subfield v (Cost,
29750 replacement price) and subfield g (Cost, normal purchase price) on the
29751 item record after saving.</para>
29754 <screeninfo>Item record after receipt</screeninfo>
29758 <imagedata fileref="images/acquisitions/receiveditem.png"/>
29763 <para>Once you have made any changes necessary, click 'Save' to mark the
29764 item as received.</para>
29767 <screeninfo>Already Received Items</screeninfo>
29771 <imagedata fileref="images/acquisitions/received.png"/>
29776 <para>When you're finished receiving items you can navigate away from
29777 this page or click the 'Finish receiving' button at the bottom of the
29780 <para>You will also see that the item is received and/or cancelled if
29781 you view the basket.</para>
29784 <screeninfo>One item marked (rcvd) in basket</screeninfo>
29788 <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
29794 <section id="acqclaims">
29795 <title>Claims & Late Orders</title>
29797 <para>If you have entered in an email address for the vendors in your
29798 system you can send them claim emails when an order is late. Before you
29799 can send claims you will need to set up an <link
29800 linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
29802 <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
29803 page you will be presented with a series of filter options on the left
29804 hand side. These filters will be applied only closed baskets.</para>
29807 <screeninfo>Acquisitions Late Order Filters</screeninfo>
29811 <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
29817 <para>The vendor pull down only shows vendors with closed baskets that
29821 <para>Once you filter your orders to show you the things you consider to
29822 be late you will be presented with a list of these items.</para>
29825 <screeninfo>Late Orders</screeninfo>
29829 <imagedata fileref="images/acquisitions/lateorders.png"/>
29834 <para>To the right of each late title you will be see a checkbox. Check
29835 off the ones you want a claim letter sent to and click 'Claim Order' at
29836 the bottom right of the list. This will automatically send an email to
29837 the vendor at the email address you have on file.<note>
29838 <para>The Estimated Delivery Date is based on the Delivery time
29839 value entered on the vendor record.</para>
29842 <para>If you would rather use a different acquisition claim letter
29843 (other than the default) you can <link linkend="addnotices">create that
29844 in the notices module</link> and choose it from the menu above the list
29845 of late items.</para>
29848 <screeninfo>Choose a Claim Letter</screeninfo>
29852 <imagedata fileref="images/acquisitions/claimletter.png"/>
29858 <section id="acqsearch">
29859 <title>Acquisition Searches</title>
29861 <para>At the top of the various Acquisition pages there is a quick
29862 search box where you can perform either a Vendor Search or an Order
29866 <screeninfo>Acquisition Searches</screeninfo>
29870 <imagedata fileref="images/acquisitions/acqsearches.png"/>
29875 <para>In the Vendor Search you can enter any part of the vendor name to
29876 get results.</para>
29879 <screeninfo>Vendor Search Results</screeninfo>
29883 <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
29888 <para>Using the Orders Search you can search for items that have been
29889 ordered with or without the vendor.</para>
29892 <screeninfo>Order Search Box</screeninfo>
29896 <imagedata fileref="images/acquisitions/ordersearch.png"/>
29901 <para>You can enter info in one or both fields and you can enter any
29902 part of the title and/or vendor name.</para>
29905 <screeninfo>Order Search Results</screeninfo>
29909 <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
29914 <para>Clicking the plus sign to the right of the Vendor search box will
29915 expand the search and allow you to search for additional fields.</para>
29918 <screeninfo>Expanded Orders Search</screeninfo>
29922 <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
29927 <para>Clicking Advanced Search to the right of the search button will
29928 give you all of the order search options available.</para>
29931 <screeninfo>Full Order Search</screeninfo>
29935 <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
29941 <section id="fundtracking">
29942 <title>Budget/Fund Tracking</title>
29944 <para>On the main acquisitions page there will be a table on the right
29945 showing you all of your active funds and a breakdown of what has been
29946 ordered or spent against them.</para>
29949 <screeninfo>Fund Table</screeninfo>
29953 <imagedata fileref="images/acquisitions/budgettable.png"/>
29958 <para>Clicking on the linked amounts under spent or ordered will show
29959 you a summary of the titles ordered on that budget.</para>
29962 <screeninfo>Titles Spent</screeninfo>
29966 <imagedata fileref="images/acquisitions/spent.png"/>
29973 <chapter id="stafflists">
29974 <title>Lists & Cart</title>
29976 <para>Lists are a way to save a collection of content on a specific topic
29977 or for a specific purpose. The Cart is a session specific storage
29982 <para><emphasis>Get there:</emphasis> More > Lists</para>
29986 <section id="lists">
29987 <title>Lists</title>
29991 <section id="createlist">
29992 <title>Create a List</title>
29994 <para>A list can be created by visiting the Lists page and clicking
29998 <screeninfo>New List Button</screeninfo>
30002 <imagedata fileref="images/lists/newlistbutton.png"/>
30007 <para>The new list form offers several options for creating your
30011 <screeninfo>New List Form</screeninfo>
30015 <imagedata fileref="images/lists/newlistform.png"/>
30022 <para>The name is what will appear on the list of Lists</para>
30026 <para>You can also choose how to sort the list</para>
30030 <para>Finally there are three types of lists you can choose
30035 <para>A Private List is managed by you and can be seen only by
30040 <para>A Public List can be seen by everybody, but managed only
30047 <para>A list can also be created from the catalog search
30051 <screeninfo>New list from catalog search</screeninfo>
30055 <imagedata fileref="images/lists/newlistsearch.png"/>
30062 <para>Check the box to the left of the titles you want to add to
30063 the new list</para>
30067 <para>Choose [New List] from the 'Add to:' pull down menu</para>
30070 <screeninfo>New List from Search Results</screeninfo>
30074 <imagedata fileref="images/lists/newlistfromsearch.png"/>
30081 <para>Name the list and choose what type of list this
30086 <para>A Private List is managed by you and can be seen
30091 <para>A Public List can be seen by everybody, but managed
30100 <para>Once the list is saved it will accessible from the Lists page
30101 and from the 'Add to' menu at the top of the search results.</para>
30104 <section id="addtolist">
30105 <title>Add to a List</title>
30107 <para>To add titles to an existing list click on the list name from
30108 the page of lists</para>
30111 <screeninfo>List of Lists</screeninfo>
30115 <imagedata fileref="images/lists/listslist.png"/>
30120 <para>From the List page you can add titles by scanning barcodes into
30121 the box at the bottom of the page</para>
30124 <screeninfo>Content of a List</screeninfo>
30128 <imagedata fileref="images/lists/listcontents.png"/>
30133 <para>A title can also be added to a list by selecting titles on the
30134 search results page and choosing the list from the 'Add to'
30138 <screeninfo>Add to List</screeninfo>
30142 <imagedata fileref="images/lists/addtolist.png"/>
30148 <section id="viewlist">
30149 <title>Viewing Lists</title>
30151 <para>To see the contents of a list, visit the Lists page on the staff
30155 <screeninfo>List of Lists</screeninfo>
30159 <imagedata fileref="images/lists/listslist.png"/>
30164 <para>Clicking on the 'List Name' will show the contents of the
30168 <screeninfo>Content of a List</screeninfo>
30172 <imagedata fileref="images/lists/listcontents.png"/>
30178 <section id="mergebibrecs">
30179 <title>Merging Bibliographic Records Via Lists</title>
30181 <para>The easiest way to merge together duplicate bibliographic
30182 records is to add them to a list and use the Merge Tool from
30186 <screeninfo>List of Duplicate Records</screeninfo>
30190 <imagedata fileref="images/lists/listofdups.png"/>
30195 <para>From the list, check the two items you want to merge. If you
30196 choose more than or fewer than 2, you will be presented with an
30200 <screeninfo>Merge Items Error</screeninfo>
30204 <imagedata fileref="images/lists/merge2rec.png"/>
30209 <para>Once you have selected the records you want to merge, click the
30210 'Merge selected items' button. You will be asked which of the two
30211 records you would like to keep as your primary record and which will
30212 be deleted after the merge. If the records were created using
30213 different frameworks, Koha will also ask you what Framework you would
30214 like the newly merged record to use.</para>
30217 <screeninfo>Choose Primary Record for Merge</screeninfo>
30221 <imagedata fileref="images/lists/mergeprimary.png"/>
30226 <para>You will be presented with the MARC for both of the records
30227 (each accessible by tabs labeled with the bib numbers for those
30228 records). By default the entire first record will be selected, uncheck
30229 the fields you don't want in the final (destination) record and then
30230 move on to the second tab to choose which fields should be in the
30231 final (destination) record.</para>
30234 <screeninfo>Merging Records</screeninfo>
30238 <imagedata fileref="images/lists/mergerecs.png"/>
30243 <para>Should you try to add a field that is not repeatable two times
30244 (like choosing the 245 field from both record #1 and #2) you will be
30245 presented with an error</para>
30248 <screeninfo>Non-repeatable Error</screeninfo>
30252 <imagedata fileref="images/lists/nondupfield.png"/>
30257 <para>Once you have completed your selections click the 'merge'
30258 button. The primary record will now CONTAIN the data you chose for it
30259 as well as all of the items/holdings from both bib records, and the
30260 second record will be deleted.<important>
30261 <para>It is important to rebuild your zebra index immediately
30262 after merging records. If a search is performed for a record which
30263 has been deleted Koha will present the patrons with an error in
30265 </important></para>
30269 <section id="cart">
30270 <title>Cart</title>
30272 <para>The cart is a temporary holding place for items in the OPAC and/or
30273 staff client. The cart will be emptied once the session is ended (by
30274 closing the browser or logging out). The cart is best used for
30275 performing batch operations (holds, printing, emailing) or for getting a
30276 list of items to be printed or emailed to yourself or a patron.</para>
30278 <para>If you would like to enable the cart in the staff client, you need
30279 to set the <link linkend="intranetbookbag">intranetbookbag</link> system
30280 preference to 'Show.' To add things to the cart, search the catalog and
30281 select the items you would like added to your cart and choose 'Cart'
30282 from the 'Add to' menu</para>
30285 <screeninfo>Add to Cart</screeninfo>
30289 <imagedata fileref="images/lists/addtocart.png"/>
30294 <para>A confirmation will appear below the cart button at the top of the
30295 staff client</para>
30298 <screeninfo>Items added to Cart</screeninfo>
30302 <imagedata fileref="images/lists/itemsaddedcart.png"/>
30307 <para>Clicking on the Cart icon will provide you with the contents of
30311 <screeninfo>Cart Contents</screeninfo>
30315 <imagedata fileref="images/lists/cart.png"/>
30322 <para>From this list of items you can perform several actions</para>
30326 <para>'Send' will send the list to the email address you
30331 <para>'Download' will allow you to download the cart using one of 3
30332 default formats or your <link linkend="csvprofiles">CSV
30333 Profiles</link></para>
30337 <para>'Print' will present you with a printable version of the
30342 <para>'Empty and Close' will empty the list and close the
30347 <para>'Hide Window' will close the window</para>
30353 <chapter id="reports">
30354 <title>Reports</title>
30356 <para>Reports in Koha are a way to gather data. Reports are used to
30357 generate statistics, member lists, shelving lists, or any list of data in
30358 your database.</para>
30362 <para><emphasis>Get there:</emphasis> More > Reports</para>
30366 <section id="customreports">
30367 <title>Custom Reports</title>
30369 <para>Koha's data is stored in a MySQL database which means that
30370 librarians can generate nearly any report they would like by either
30371 using the <link linkend="quidedreportwizard">Guided Reports
30372 Wizard</link> or writing their own <link linkend="reportfromsql">SQL
30373 query</link>.</para>
30375 <section id="customreport">
30376 <title>Add Custom Report</title>
30380 <section id="quidedreportwizard">
30381 <title>Guided Report Wizard</title>
30383 <para>The guided report wizard will walk you through a six step
30384 process to generate a report.</para>
30386 <para>Step 1: Choose the module you want to report on. This will
30387 determine what tables and fields are available for you to
30391 <screeninfo>Chose Module for Report</screeninfo>
30395 <imagedata fileref="images/reports/report1.png"/>
30400 <para>Step 2: Choose a report type. For now, Tabular is the only
30401 option available.</para>
30404 <screeninfo>Report Type</screeninfo>
30408 <imagedata fileref="images/reports/report2.png"/>
30413 <para>Step 3: Choose the fields you want in your report. You can
30414 select multiple fields and add them all at once by using CTRL+Click
30415 on each item you want to add before clicking the Add button.</para>
30418 <screeninfo>Select database fields to query</screeninfo>
30422 <imagedata fileref="images/reports/report3.png"/>
30427 <para>Step 4: Choose any limits you might want to apply to your
30428 report (such as item types or branches). If you don't want to apply
30429 any limits, simply click Next instead of making an option.</para>
30432 <screeninfo>Choose limits</screeninfo>
30436 <imagedata fileref="images/reports/report4.png"/>
30441 <para>Step 5: Perform math functions. If you don't want to do any
30442 calculations, simply click Next instead of making an option.</para>
30445 <screeninfo>Choose math functions</screeninfo>
30449 <imagedata fileref="images/reports/report5.png"/>
30454 <para>Step 6: Choose data order. If you want the data to print out
30455 in the order it's found in the database, simply click Finish.</para>
30458 <screeninfo>Choose ordering</screeninfo>
30462 <imagedata fileref="images/reports/report6.png"/>
30467 <para>When you are finished you will be presented with the SQL
30468 generated by the report wizard. From here you can choose to save the
30469 report by clicking 'Save' or copy the SQL and make edits to it by
30473 <screeninfo>Custom Report Confirmation</screeninfo>
30477 <imagedata fileref="images/reports/reportconfirm.png"/>
30482 <para>If you choose to save the report you will be asked to name
30483 your report and enter any notes regarding it.</para>
30486 <screeninfo>Save custom report</screeninfo>
30490 <imagedata fileref="images/reports/reportsave.png"/>
30495 <para>Once your report is saved it will appear on the 'Use Saved'
30496 page with all other saved reports.</para>
30499 <screeninfo>Saved Reports list</screeninfo>
30503 <imagedata fileref="images/reports/savedreports.png"/>
30508 <para>From here you can make edits, run the report, or schedule a
30509 time to have the report run. To find the report you created you can
30510 sort by any of the columns by clicking the on the column header
30511 (creation date is the best bet for finding the report you just
30512 added). You can also filter your results using the filter menu on
30516 <section id="reportfromsql">
30517 <title>Report from SQL</title>
30519 <para>In addition to the report wizard, you have the option to write
30520 your own queries using SQL. To find reports written by other Koha
30521 users, visit the Koha Wiki: <ulink
30522 url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink>.
30523 You can also find your database structure in
30524 /installer/data/mysql/kohastructure.sql or online at: <ulink
30525 url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
30527 <para>To add your query, click the link to 'Create from SQL' on the
30528 main reports module or the New button at the top of the Saved
30529 Reports page.</para>
30532 <screeninfo>New SQL Report</screeninfo>
30536 <imagedata fileref="images/reports/newsql.png"/>
30541 <para>Fill in the form presented</para>
30544 <screeninfo>Create Report from SQL</screeninfo>
30548 <imagedata fileref="images/reports/reportfromsql.png"/>
30555 <para>The name is what will appear on the Saved Reports page to
30556 help you identify the report later. It will also be searchable
30557 using the filters found the left of the Saved Reports
30562 <para>Notes will also appear on the Saved Reports page, this can
30563 be used to provide more details about the report or tips on how
30564 to enter values when it runs</para>
30568 <para>The type should always be 'Tabular' at this time since the
30569 other formats have not been implemented</para>
30573 <para>In the SQL box you will type or paste the SQL for the
30578 <para>If you feel that your report might be too resource
30579 intensive you might want to consider using runtime parameters to
30580 your query. Runtime parameters basically make a filter appear
30581 before the report is run to save your system resources.</para>
30583 <para>There is a specific syntax that Koha will understand as
30584 'ask for values when running the report'. The syntax is
30585 <<Question to ask|authorized_value>>.</para>
30589 <para>The << and >> are just delimiters. You
30590 must put << at the beginning and >> at the end
30591 of your parameter</para>
30595 <para>The 'Question to ask' will be displayed on the left of
30596 the string to enter.</para>
30600 <para>The authorized_value can be omitted if not applicable.
30601 If it contains an authorized value category, or branches or
30602 itemtype or categorycode, a list with the Koha authorized
30603 values will be displayed instead of a free field Note that
30604 you can have more than one parameter in a given SQL Note
30605 that entering nothing at run time won't probably work as you
30606 expect. It will be considered as "value empty" not as
30607 "ignore this parameter". For example entering nothing for :
30608 "title=<<Enter title>>" will display results
30609 with title='' (no title). If you want to have to have
30610 something not mandatory, use "title like <<Enter
30611 title>>" and enter a % at run time instead of
30616 <para>Examples:</para>
30620 <para>SELECT surname,firstname FROM borrowers WHERE
30621 branchcode=<<Enter patrons library|branches>>
30622 AND surname like <<Enter filter for patron surname (%
30623 if none)>></para>
30627 <para>SELECT * FROM items WHERE homebranch = <<Pick
30628 your branch|branches>> and barcode like
30629 <<Partial barcode value here>></para>
30634 <para>To generate a date picker calendar to the right of the
30635 field when running a report you can use the 'date' keyword
30636 like this: <<Enter Date|date>></para>
30639 <screeninfo>Date Picker</screeninfo>
30643 <imagedata fileref="images/reports/datepicker.png"/>
30650 <para>You have to put "%" in a text box to 'leave it blank'.
30651 Otherwise, it literally looks for "" (empty string) as the
30652 value for the field.</para>
30656 <para>In addition to using any authorized value code to
30657 generate a dropdown, you can use the following values as
30658 well: Branches (branches), Item Types (itemtypes) and Patron
30659 Categories (categorycode). For example a branch pull down
30660 would be generated like this
30661 <<Branch|branches>></para>
30664 <screeninfo>Branch pull down</screeninfo>
30668 <imagedata fileref="images/reports/branchpulldown.png"/>
30672 </important></para>
30677 <para>There is a limit of 10,000 records put on SQL statements
30678 entered in Koha. To get around this you want to add 'LIMIT 100000'
30679 to the end of your SQL statement (or any other number above
30683 <para>Once everything is entered click the 'Save Report' button and
30684 you'll be presented with options to run it. Once a report is saved
30685 you do not have to recreate it you can simply find it on the Saved
30686 Reports page and <link linkend="runcustomreport">run</link> or <link
30687 linkend="editcustomreports">edit</link> it.</para>
30691 <section id="editcustomreports">
30692 <title>Edit Custom Reports</title>
30694 <para>Every report can be edited from the reports lists. To see the
30695 list of reports already stored in Koha, click 'Use Saved.'</para>
30698 <screeninfo>Saved Reports</screeninfo>
30702 <imagedata fileref="images/reports/savedreports.png"/>
30707 <para>To find the report you'd like to edit you can sort by any of the
30708 columns by clicking the on the column header. You can also filter your
30709 results using the filter menu on the left.</para>
30711 <para>From this list you can edit any custom report by clicking 'Edit
30715 <screeninfo>Edit SQL Form</screeninfo>
30719 <imagedata fileref="images/reports/editreport.png"/>
30725 <section id="runcustomreport">
30726 <title>Running Custom Reports</title>
30728 <para>Once custom reports are saved to Koha, you can run them by going
30729 to the Saved Reports page and clicking the Run link to the right of
30733 <screeninfo>Run Report</screeninfo>
30737 <imagedata fileref="images/reports/runreport.png"/>
30742 <para>When you report runs you will either be asked for some
30746 <screeninfo>Enter report parameters</screeninfo>
30750 <imagedata fileref="images/reports/reportparameters.png"/>
30755 <para>or you will see the results right away</para>
30758 <screeninfo>Report results</screeninfo>
30762 <imagedata fileref="images/reports/reportresults.png"/>
30767 <para>From the results you can choose to rerun the report by clicking
30768 'Run report' at the top, edit the report by clicking the 'Edit' button
30769 or starting over and creating a new report by using the 'New' button.
30770 You can also download your results by choosing a file type at the
30771 bottom of the results next to the 'Download the report' label and
30772 clicking 'Download.'<tip>
30773 <para>A Comma Separated Text file is a CSV file and it can be
30774 opened by any spreadsheet application.</para>
30779 <section id="statsreports">
30780 <title>Statistics Reports</title>
30782 <para>Statistic reports will show you counts and sums. These reports are
30783 all about numbers and statistics, for reports that return more detailed
30784 data, use the <link linkend="quidedreportwizard">Guided Report
30785 Wizard</link>. These reports are limited in what data they can look at,
30786 so it's often recommended to use <link linkend="customreports">custom
30787 reports</link> for official end of the year statistics.</para>
30789 <section id="acqstats">
30790 <title>Acquisitions Statistics</title>
30793 <para>These reports are limited in what data they can look at, so
30794 it's often recommended to use <link linkend="customreports">custom
30795 reports</link> for official end of the year statistics.</para>
30798 <para>Using the form provided, choose which value you would like to
30799 appear in the Column and which will appear in the Row.</para>
30802 <screeninfo>Acquisitions Statistics</screeninfo>
30806 <imagedata fileref="images/reports/acqform.png"/>
30811 <para>If you choose to output to the browser your results will print
30812 to the screen.</para>
30815 <screeninfo>Acquisitions Statistics Results</screeninfo>
30819 <imagedata fileref="images/reports/acqnumbers.png"/>
30824 <para>You can also choose to export to a file that you can manipulate
30825 to your needs.</para>
30827 <para>When generating your report, note that you get to choose between
30828 counting or summing the values.</para>
30831 <screeninfo>Acquisitions Stats Options</screeninfo>
30835 <imagedata fileref="images/reports/acqtotal.png"/>
30840 <para>Choosing amount will change your results to appear as the sum of
30841 the amounts spent.</para>
30844 <screeninfo>Acquisitions statistics with totals</screeninfo>
30848 <imagedata fileref="images/reports/acqamounts.png"/>
30854 <section id="patstats">
30855 <title>Patron Statistics</title>
30858 <para>These reports are limited in what data they can look at, so
30859 it's often recommended to use <link linkend="customreports">custom
30860 reports</link> for official end of the year statistics.</para>
30863 <para>Using the form provided, choose which value you would like to
30864 appear in the Column and which will appear in the Row.</para>
30867 <screeninfo>Patron Statistics Options</screeninfo>
30871 <imagedata fileref="images/reports/patronform.png"/>
30876 <para>If you choose to output to the browser your results will print
30877 to the screen.</para>
30880 <screeninfo>Patron Statistics Results</screeninfo>
30884 <imagedata fileref="images/reports/patronresults.png"/>
30889 <para>Based on your selections, you may see some query information
30890 above your results table. You can also choose to export to a file that
30891 you can manipulate to your needs.</para>
30894 <section id="catstats">
30895 <title>Catalog Statistics</title>
30898 <para>These reports are limited in what data they can look at, so
30899 it's often recommended to use <link linkend="customreports">custom
30900 reports</link> for official end of the year statistics.</para>
30903 <para>Using the form provided, choose which value you would like to
30904 appear in the Column and which will appear in the Row.</para>
30907 <screeninfo>Catalog Statistics Form</screeninfo>
30911 <imagedata fileref="images/reports/catalogform.png"/>
30916 <para>If you choose to output to the browser your results will print
30917 to the screen.</para>
30920 <screeninfo>Catalog Statistic Results</screeninfo>
30924 <imagedata fileref="images/reports/catalogresults.png"/>
30929 <para>You can also choose to export to a file that you can manipulate
30930 to your needs.</para>
30933 <section id="circstats">
30934 <title>Circulation Statistics</title>
30937 <para>These reports are limited in what data they can look at, so
30938 it's often recommended to use <link linkend="customreports">custom
30939 reports</link> for official end of the year statistics.</para>
30942 <para>Using the form provided, choose which value you would like to
30943 appear in the Column and which will appear in the Row.</para>
30946 <screeninfo>Circulation Statistics</screeninfo>
30950 <imagedata fileref="images/reports/circform.png"/>
30955 <para>If you choose to output to the browser your results will print
30956 to the screen.</para>
30959 <screeninfo>Circulation Statistic Results</screeninfo>
30963 <imagedata fileref="images/reports/circresults.png"/>
30968 <para>You can also choose to export to a file that you can manipulate
30969 to your needs.<tip>
30970 <para>To get a complete picture of your monthly or daily
30971 circulation, you can run the report twice, once for 'Type' of
30972 'Checkout' and again for 'Renewal.'</para>
30974 <para>This report uses 'Period,' or date, filtering that allows
30975 you to limit to a month by simply selecting the first day of the
30976 first month through the first day of the next month. For example,
30977 10/1 to 11/1 to find statistics for the month of October.</para>
30981 <para>To find daily statistics, set your date
30982 range.</br> Example: "I want circulation data starting
30983 with date XXX up to, but not including, date XXX."</para>
30987 <para>For a whole month, an example range would be: 11/01/2009
30988 to 12/01/2009</para>
30992 <para>For a whole year, an example range would be: 01/01/2009
30993 to 01/01/2010</para>
30997 <para>For a single day, an example would be: 11/15/2009 to
30998 11/16/2009 to find what circulated on the 15th</para>
31003 <section id="inhouseuse">
31004 <title>Tracking in house use</title>
31006 <para>Using the Circulation statistics reporting wizard you can run
31007 reports on in house usage of items simply by choosing 'Local Use'
31008 from the 'Type' pull down:</para>
31011 <screeninfo>In House Use Stats</screeninfo>
31015 <imagedata fileref="images/reports/inhouse.png"/>
31022 <section id="serialstats">
31023 <title>Serials Statistics</title>
31026 <para>These reports are limited in what data they can look at, so
31027 it's often recommended to use <link linkend="customreports">custom
31028 reports</link> for official end of the year statistics.</para>
31031 <para>Using the form provided, choose how you would like to list the
31032 serials in your system.</para>
31035 <screeninfo>Serials Statistics</screeninfo>
31039 <imagedata fileref="images/reports/serialsform.png"/>
31044 <para>If you choose to output to the browser your results will print
31045 to the screen.</para>
31048 <screeninfo>Serials Results</screeninfo>
31052 <imagedata fileref="images/reports/serialsresults.png"/>
31057 <para>You can also choose to export to a file that you can manipulate
31058 to your needs.</para>
31061 <section id="holdstats">
31062 <title>Holds Statistics</title>
31065 <para>These reports are limited in what data they can look at, so
31066 it's often recommended to use <link linkend="customreports">custom
31067 reports</link> for official end of the year statistics.</para>
31070 <para>Using the form provided you can see statistics for holds placed,
31071 filled, cancelled and more at your library. From the form choose what
31072 value you want to display in the column and what value to show in the
31073 row. You can also choose from the filters on the far right of the
31077 <screeninfo>Hold Statistics Form</screeninfo>
31081 <imagedata fileref="images/reports/holdstatsform.png"/>
31086 <para>If you choose to output to the browser your results will print
31087 to the screen.</para>
31090 <screeninfo>Hold Stats Results</screeninfo>
31094 <imagedata fileref="images/reports/holdstatsresults.png"/>
31099 <para>You can also choose to export to a file that you can manipulate
31100 to your needs.</para>
31103 <section id="mostcheckouts">
31104 <title>Patrons with the most checkouts</title>
31106 <para>This report will simply list the patrons who have the most
31110 <screeninfo>Patrons with the most checkouts form</screeninfo>
31114 <imagedata fileref="images/reports/topcheckoutsform.png"/>
31119 <para>If you choose to output to the browser your results will print
31120 to the screen.</para>
31123 <screeninfo>Top checkouts results</screeninfo>
31127 <imagedata fileref="images/reports/topcheckoutsresult.png"/>
31132 <para>You can also choose to export to a file that you can manipulate
31133 to your needs.</para>
31136 <section id="mostcirculated">
31137 <title>Most Circulated Items</title>
31139 <para>This report will simply list the items that have the been
31140 checked out the most.</para>
31143 <screeninfo>Most Circulation Items Form</screeninfo>
31147 <imagedata fileref="images/reports/topcircform.png"/>
31152 <para>If you choose to output to the browser your results will print
31153 to the screen.</para>
31156 <screeninfo>Top Circulation Items Results</screeninfo>
31160 <imagedata fileref="images/reports/topcircresults.png"/>
31165 <para>You can also choose to export to a file that you can manipulate
31166 to your needs.</para>
31169 <section id="patnocheckouts">
31170 <title>Patrons with no checkouts</title>
31172 <para>This report will list for you the patrons in your system who
31173 haven't checked any items out.</para>
31176 <screeninfo>Patrons with no Checkouts</screeninfo>
31180 <imagedata fileref="images/reports/patnocheckout.png"/>
31185 <para>If you choose to output to the browser your results will print
31186 to the screen.</para>
31189 <screeninfo>Results for Patrons with no Checkouts</screeninfo>
31193 <imagedata fileref="images/reports/patnocheckout-results.png"/>
31198 <para>You can also choose to export to a file that you can manipulate
31199 to your needs.</para>
31202 <section id="itemnocheckouts">
31203 <title>Items with no checkouts</title>
31205 <para>This report will list items in your collection that have never
31206 been checked out.</para>
31209 <screeninfo>Items with No Checkouts</screeninfo>
31213 <imagedata fileref="images/reports/nocheckoutsform.png"/>
31218 <para>If you choose to output to the browser your results will print
31219 to the screen.</para>
31222 <screeninfo>Items with no checkouts results</screeninfo>
31226 <imagedata fileref="images/reports/nocheckoutsresults.png"/>
31231 <para>You can also choose to export to a file that you can manipulate
31232 to your needs.</para>
31235 <section id="catbyitem">
31236 <title>Catalog by Item Type</title>
31238 <para>This report will list the total number of items of each item
31239 type per branch.</para>
31242 <screeninfo>Catalog by Item Type</screeninfo>
31246 <imagedata fileref="images/reports/itemtotals.png"/>
31251 <para>If you choose to output to the browser your results will print
31252 to the screen.</para>
31255 <screeninfo>Total of Items by Type and Branch</screeninfo>
31259 <imagedata fileref="images/reports/itemtotalsresults.png"/>
31264 <para>You can also choose to export to a file that you can manipulate
31265 to your needs.</para>
31268 <section id="lostreport">
31269 <title>Lost Items</title>
31271 <para>This report will allow you to generate a list of items that have
31272 been marked as Lost within the system</para>
31275 <screeninfo>Lost Items Report</screeninfo>
31279 <imagedata fileref="images/reports/lostitems.png"/>
31285 <section id="avloantime">
31286 <title>Average Loan Time</title>
31288 <para>This report will list the average time items are out on loan
31289 based on the criteria you enter:</para>
31292 <screeninfo>Average Checkout Period Form</screeninfo>
31296 <imagedata fileref="images/reports/averloanform.png"/>
31301 <para>If you choose to output to the browser your results will print
31302 to the screen.</para>
31305 <screeninfo>Average Checkout Period Results</screeninfo>
31309 <imagedata fileref="images/reports/avercheckout.png"/>
31314 <para>You can also choose to export to a file that you can manipulate
31315 to your needs.</para>
31319 <section id="reportdic">
31320 <title>Report Dictionary</title>
31322 <para>The report dictionary is a way to pre-define common filters you'd
31323 like to apply to your reports. This is a good way to add in filters that
31324 the report wizard doesn't include by default. To add a new definition,
31325 or filter, click 'New Definition' on the Reports Dictionary page and
31326 follow the 4 step process.</para>
31328 <para>Step 1: Name the definition and provide a description if
31332 <screeninfo>Create a Definition</screeninfo>
31336 <imagedata fileref="images/reports/dict1.png"/>
31341 <para>Step 2: Choose the module that the will be queried.</para>
31344 <screeninfo>Select Koha Module</screeninfo>
31348 <imagedata fileref="images/reports/dict2.png"/>
31353 <para>Step 3: Choose columns to query from the tables presented.</para>
31356 <screeninfo>Choose columns</screeninfo>
31360 <imagedata fileref="images/reports/dict3.png"/>
31365 <para>Step 4: Choose the value(s) from the field(s). These will be
31366 automatically populated with options available in your database.</para>
31369 <screeninfo>Choose fields and values</screeninfo>
31373 <imagedata fileref="images/reports/dict4.png"/>
31378 <para>Confirm your selections to save the definition.</para>
31381 <screeninfo>Confirm Definition</screeninfo>
31385 <imagedata fileref="images/reports/dictconfirm.png"/>
31390 <para>Your definitions will all appear on the Reports Dictionary
31394 <screeninfo>Reports Dictionary Listing</screeninfo>
31398 <imagedata fileref="images/reports/dictlist.png"/>
31403 <para>Then when generating reports on the module you created the value
31404 for you will see an option to limit by the definition at the bottom of
31405 the usual filters.</para>
31408 <screeninfo>Dictionary Limit Option</screeninfo>
31412 <imagedata fileref="images/reports/dictionarylimit.png"/>
31419 <chapter id="opac">
31420 <title>OPAC</title>
31422 <para>This chapter assumes that you have the following preferences set as
31428 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
31434 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
31439 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
31444 <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
31448 <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
31453 <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
31458 <para><link linkend="reviewson">reviewson</link> = Allow</para>
31462 <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
31466 <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
31471 <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
31476 <para><link linkend="OPACAmazonEnabled">OPACAmazonEnabled</link> =
31482 linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
31487 <para><link linkend="XISBN">XISBN</link> = Use</para>
31491 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
31492 = Default set of links</para>
31496 <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
31497 = Don't show</para>
31501 <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
31507 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
31512 <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
31517 <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
31522 <para>If your system preferences are set differently your displays may
31525 <section id="opacsearchresults">
31526 <title>Search Results</title>
31528 <para>To search the OPAC you can either choose to enter your search
31529 words in the box at the top of the OPAC or click on the 'Advanced
31530 Search' link to perform a more detailed search.</para>
31533 <screeninfo>OPAC Search Box</screeninfo>
31537 <imagedata fileref="images/opac/searchbox.png"/>
31542 <para>For more on searching check the '<link
31543 linkend="searching">Searching</link>' chapter in this manual.</para>
31545 <section id="opacresultsoverview">
31546 <title>Results Overview</title>
31548 <para>After performing a search the number of results found for your
31549 search will appear above the results</para>
31552 <screeninfo>Total Results</screeninfo>
31556 <imagedata fileref="images/opac/totalresults-rss.png"/>
31561 <para>By default your search results will be sorted based on your
31562 <link linkend="opacdefaultsort">OPACdefaultSortField and
31563 OPACdefaultSortOrder</link> system preference values. To change this
31564 you can choose another sorting method from the pull down on the
31568 <screeninfo>Results Sorting Options</screeninfo>
31572 <imagedata fileref="images/opac/sortingresults.png"/>
31577 <para>Under each title on your results list a series of values from
31578 your leader will appear. It is important to note that this has nothing
31579 to do with the item types or collection codes you have applied to your
31580 records, this data is all pulled from your leader.</para>
31583 <screeninfo>Leader Visualization</screeninfo>
31587 <imagedata fileref="images/opac/leader.png"/>
31592 <para>Below each title you will see the availability for the items
31593 attached to the record. Note that even if you filtered on one library
31594 location all locations that hold the item will appear on the search
31598 <screeninfo>Holdings Information</screeninfo>
31602 <imagedata fileref="images/opac/holdings-results.png"/>
31607 <para>If you have turned on <link linkend="enhancedcontent">Enhanced
31608 Content</link> preferences you may have book jackets on your search
31612 <screeninfo>Book Jacket on Results</screeninfo>
31616 <imagedata fileref="images/opac/coverresults.png"/>
31622 <section id="opacfilter">
31623 <title>Filters</title>
31625 <para>To filter your results click on the links below the 'Refine Your
31626 Search' menu on the left of your screen</para>
31629 <screeninfo>Refine Your Results</screeninfo>
31633 <imagedata fileref="images/opac/refineresults.png"/>
31639 <section id="searchrss">
31640 <title>Search RSS Feeds</title>
31642 <para>You will be able to subscribe to your search results as an RSS
31643 feed by clicking the RSS icon in your address bar or next to the
31644 number of results. To learn more about what RSS feeds are check out
31645 <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
31646 video</ulink>.</para>
31649 <screeninfo>RSS Feed Icon</screeninfo>
31653 <imagedata fileref="images/opac/totalresults-rss.png"/>
31658 <para>Subscribing to search results as RSS feeds will allow you to see
31659 when a new item is added to the catalog in your area of
31664 <section id="opacbibrec">
31665 <title>Bibliographic Record</title>
31667 <para>When you click on a title from the search results, you're brought
31668 to the bibliographic detail of the record. This page is broken down in
31669 several different areas.</para>
31671 <para>At the top of your screen will be the title and the GMD:</para>
31674 <screeninfo>Title</screeninfo>
31678 <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
31683 <para>Below the title the authors will be listed. These come from your
31684 1xx and 7xx fields:</para>
31687 <screeninfo>Author Display</screeninfo>
31691 <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
31696 <para>If you have your <link
31697 linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
31698 set to 'show' you will see a material type that is determined by values
31699 in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
31700 Item Types</link> Appendix).</para>
31703 <screeninfo>XSLT Item Type</screeninfo>
31707 <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
31712 <para>Next you'll see the description of the record you're
31716 <screeninfo>Basic Details</screeninfo>
31720 <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
31725 <para>Following that information you'll find the subject headings which
31726 can be clicked to search for other titles on similar topics</para>
31729 <screeninfo>Bibliographic Subjects</screeninfo>
31733 <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
31738 <para>If your record has a table of contents or summary it will appear
31739 next to the 'Summary' or 'Table of Contents' label</para>
31742 <screeninfo>Summary</screeninfo>
31746 <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
31751 <para>If your record has data in the 856 fields you'll see the links to
31752 the right of the 'Online Resources' label</para>
31755 <screeninfo>Online Resources</screeninfo>
31759 <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
31764 <para>If the title you're viewing is in a public list then you'll see a
31765 list of those to the right of the 'List(s) this item appears in' label
31766 and if it has tags they will appear below the 'Tags from this library'
31770 <screeninfo>Tags</screeninfo>
31774 <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
31779 <para>In the tabs below the details you will find your holdings
31787 <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
31792 <para>Any notes (5xx fields) that have been cataloged will appear under
31793 'Title Notes'</para>
31796 <screeninfo>Title notes</screeninfo>
31800 <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
31805 <para>If you're allowing comments they will appear in the next
31809 <screeninfo>Comments</screeninfo>
31813 <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
31818 <para>And finally if you have enabled FRBR and you have other editions
31819 of the title in your collection you will see the 'Editions' tab.</para>
31822 <screeninfo>Editions</screeninfo>
31826 <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
31831 <para>To the right of the details you'll find a series of boxes. The
31832 first box is a list of buttons to help navigate the search results. From
31833 there you can see the next or previous result from your search or return
31834 to the results.</para>
31837 <screeninfo>Search Options</screeninfo>
31841 <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
31846 <para>Clicking Browse Results at the top of the right column will open
31847 up your search results on the detail page</para>
31850 <screeninfo>Search Results</screeninfo>
31854 <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
31859 <para>Below the search buttons you'll find the links to place a hold,
31860 print the record, save the record to your lists, or add it to your
31864 <screeninfo>More options</screeninfo>
31868 <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
31873 <para>Clicking 'More Searches' will show the list of libraries you
31874 entered in your <link
31875 linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
31879 <screeninfo>More Searches</screeninfo>
31883 <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
31888 <para>Under the 'Save Record' label you will find a series of file
31889 formats you can save the record as. This list can be customized by
31890 altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
31891 system preference.</para>
31894 <screeninfo>Save Record</screeninfo>
31898 <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
31903 <para>If at any time you want to change the view from the 'Normal' view
31904 to see the Marc or the ISBD you can click the tabs across the top of the
31908 <screeninfo>Record Views</screeninfo>
31912 <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
31918 <section id="opaclistscart">
31919 <title>Lists & Cart</title>
31921 <para>A cart is a temporary holding place for records you're interested
31922 in finding during this session. That means that once you log out of the
31923 OPAC or close the browser you lose the items in your cart. A list is a
31924 more permanent location for saving items. To learn more about lists,
31925 check the <link linkend="stafflists">Lists in the Staff Client</link>
31926 chapter of this manual.</para>
31928 <section id="opaclists">
31929 <title>Lists</title>
31931 <para>Patrons can manage their own private lists by visiting the 'my
31932 lists' section of their account.</para>
31935 <screeninfo>Lists Management</screeninfo>
31939 <imagedata fileref="images/opac/nolists.png"/>
31944 <section id="opacaddlists">
31945 <title>Creating Lists</title>
31947 <para>Lists can also be created by choosing the 'New List' option in
31948 the 'Add to' menu on the search results</para>
31951 <screeninfo>Add to New List</screeninfo>
31955 <imagedata fileref="images/opac/addtonewlist.png"/>
31960 <para>To create a list the patron simply needs to click the 'New
31961 List' link and populate the form that appears</para>
31964 <screeninfo>Create a new list</screeninfo>
31968 <imagedata fileref="images/opac/newlist.png"/>
31973 <para>The only field required is the 'List Name,' but the patron can
31974 also choose how they want the list sorted and if the list is public
31975 or private.<important>
31976 <para>If you aren't allowing patrons to create public lists with
31978 linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
31979 preference then patrons will only be able to create private
31981 </important></para>
31984 <section id="opacaddtolists">
31985 <title>Adding titles to Lists</title>
31987 <para>Titles can be added to lists from the search results and/or
31988 from the bibliographic record. On the search results options to add
31989 items to the list appear below each result and across the top of the
31990 results page</para>
31993 <screeninfo>Add to Lists from Results</screeninfo>
31997 <imagedata fileref="images/opac/addtolistcart.png"/>
32002 <para>To add a single title to a list, click the 'Save to Lists'
32003 option and then choose the list you'd like to add the title to. To
32004 add multiple titles to a list check the boxes on the left of the
32005 titles you want to add and then choose the list you want to add the
32006 titles to from the 'Add too' pull down at the top of the
32010 <section id="listscontent">
32011 <title>Viewing Lists Contents</title>
32013 <para>To view the contents of a list, click on the list name under
32014 the Lists button.</para>
32017 <screeninfo>Lists</screeninfo>
32021 <imagedata fileref="images/opac/chooselist.png"/>
32026 <para>The contents of the list will look similar to your search
32027 results pages except that there will be different menu options
32028 across the top of the list.</para>
32031 <screeninfo>List View</screeninfo>
32035 <imagedata fileref="images/opac/listview.png"/>
32040 <para>Using the menu options above the list you can place multiple
32041 items on hold, download the list contents, email the list or print
32042 the list out.</para>
32046 <para>To place a hold on one or more list items check the box to
32047 the left of the item and click the 'Place Hold' link at the
32052 <para>To download the list contents click the 'Download List'
32053 link and choose the format you'd like to download the list
32059 <para>iso2079 is MARC format</para>
32066 <para>To email the list contents to someone, click the 'Send
32067 List' link and enter in your email details in the form that pops
32071 <screeninfo>Email List Contents</screeninfo>
32075 <imagedata fileref="images/opac/emailist.png"/>
32082 <para>To print the contents of your list out click the 'Print
32088 <section id="opacmanagelists">
32089 <title>Managing Lists</title>
32091 <para>Once the list is saved patrons can begin adding items to it.
32092 From the 'my lists' tab on the patron record the patron can edit and
32093 delete the lists they have created by clicking the appropriate link
32094 to the right of the list name.</para>
32097 <screeninfo>My Lists</screeninfo>
32101 <imagedata fileref="images/opac/mylists.png"/>
32106 <para>To edit the list's title or sorting patrons click the 'Edit'
32107 link to the right of the list description.</para>
32110 <screeninfo>Editing List</screeninfo>
32114 <imagedata fileref="images/opac/editlist.png"/>
32119 <para>When clicking 'Delete' next to a list you will be asked to
32120 confirm that you want to delete the list.</para>
32123 <screeninfo>Delete list confirmation</screeninfo>
32127 <imagedata fileref="images/opac/deletelist.png"/>
32132 <para>The list will not be deleted until the 'Confirm' button is
32133 clicked to the right of the list you'd like to delete.</para>
32139 <section id="opaccart">
32140 <title>Cart</title>
32144 <section id="opacaddtocart">
32145 <title>Adding titles to the Cart</title>
32147 <para>Titles can be added to the cart from the search results and/or
32148 from the bibliographic record. On the search results options to add
32149 items to the cart appear below each result and across the top of the
32150 results page</para>
32153 <screeninfo>Add to Cart on Search Results</screeninfo>
32157 <imagedata fileref="images/opac/addtolistcart.png"/>
32162 <para>Clicking the 'Add to Cart' button will add the one title to
32163 your cart. To add multiple titles at once, check the box to the left
32164 of each result and then choose 'Cart' from the 'Add to' pull down at
32165 the top of the screen. Once titles are added to the cart you will be
32166 presented with a confirmation</para>
32169 <screeninfo>Items added to Cart</screeninfo>
32173 <imagedata fileref="images/opac/addedtocart.png"/>
32179 <section id="manageopaccart">
32180 <title>Managing the Cart</title>
32182 <para>Once you have titles in your cart you can manage the contents
32183 by clicking on the 'Cart' button usually found at the top of the
32184 screen to the right of the search box. Your cart will open in a new
32188 <screeninfo>Contents of your cart</screeninfo>
32192 <imagedata fileref="images/opac/cartcontents.png"/>
32197 <para>From this window you are presented with several options.
32198 Across the top of the cart are several buttons.</para>
32200 <para>First is the 'More details' button. Clicking this will show
32201 you additional information about the titles in your cart (ISBNs,
32202 Subjects, Publisher Info, Notes and more).</para>
32204 <para>Next is the option to send the contents of your cart to an
32205 email address. This is handy if you want to send the resources you
32206 found at the library to your home email account to refer to later or
32207 to send to a patron researching a specific topic. Clicking this link
32208 will open up a new window that asks for the email address and
32209 message to send.</para>
32212 <screeninfo>Email Cart</screeninfo>
32216 <imagedata fileref="images/opac/emailcart.png"/>
32221 <para>In addition to sending your cart you can download the contents
32222 of your cart in several pre-defined formats or using a <link
32223 linkend="csvprofiles">CSV Profile</link> that you defined in the
32224 Tools module.</para>
32227 <screeninfo>Download Cart</screeninfo>
32231 <imagedata fileref="images/opac/downloadcart.png"/>
32236 <para>Finally you can print out the contents of your cart by
32237 choosing the 'Print' link.</para>
32239 <para>In addition to the various different ways to save the contents
32240 of your cart, there are ways to add value to the data in your cart.
32241 By selecting one or more titles from the cart you can add them to a
32242 list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
32243 tag them (click 'Tag'). All of these operations follow the same
32244 procedure as they do when performing them in the OPAC.</para>
32249 <section id="opacplacehold">
32250 <title>Placing Holds</title>
32252 <para>Patrons can place holds on items via the OPAC if they're logged in
32253 and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
32254 preference set to 'Allow'. If the item can be placed on hold the option
32255 to place it on hold will appear in several different places.</para>
32259 <para>When viewing a list or search results page you'll see the
32260 option to place hold on multiple items by checking the boxes to the
32261 left of the results and clicking 'Place Hold' at the top</para>
32264 <screeninfo>Place Hold from Results</screeninfo>
32268 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
32275 <para>When viewing a list or search results page you'll see the
32276 option to place the item on hold below the basic information about
32280 <screeninfo>Place Hold</screeninfo>
32284 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
32291 <para>When viewing an individual title you'll see the option to
32292 place a hold in the box on the right side of the screen</para>
32295 <screeninfo>Place Hold</screeninfo>
32299 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
32306 <para>No matter which of the above links you click to place your hold
32307 you'll be brought to the same hold screen.</para>
32310 <screeninfo>Place Hold Form</screeninfo>
32314 <imagedata fileref="images/opac/opacplacehold.png"/>
32321 <para>Check the box to the left of the items you'd like to place on
32326 <para>The title includes a link back to the detail page for the
32331 <para>The priority shows where in the holds queue this hold will
32336 <para>If allowed by your <link
32337 linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link>
32338 preference, the 'Hold Starts on Date' column will show. This field
32339 allows the patron to have their hold start on a future date.</para>
32343 <para>By default holds placed in the system remain until canceled,
32344 but if the patron fills in a 'Hold Not Needed After' date then the
32345 hold has an expiration date.</para>
32350 <para>Expired holds are removed by the <link
32351 linkend="expiredholdscron">Expired Holds Cron Job</link>, this
32352 is not an automatic process and must be set up by your system
32353 administrator</para>
32360 <para>If allowed by your <link
32361 linkend="OPACItemHolds">OPACItemHolds</link> preference the patron
32362 will be allowed to choose whether to place the hold on the next
32363 available copy or a specific copy</para>
32366 <screeninfo>Specific Copy Hold</screeninfo>
32370 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
32377 <para>If allowed by your <link
32378 linkend="OPACAllowUserToChooseBranch">OPACAllowUserToChooseBranch</link>
32379 preference the patron can choose where they'd like to pick up their
32384 <para>After clicking the Place Hold button the patron will be brought to
32385 their account page where they'll see all of the items they have on
32389 <section id="opacenhancedcontent">
32390 <title>Enhanced Content</title>
32394 <section id="opactagging">
32395 <title>Tagging</title>
32397 <para>Depending on your settings for the <link
32398 linkend="TagsEnabled">TagsEnabled</link>, <link
32399 linkend="TagsInputOnList">TagsInputOnList</link> and <link
32400 linkend="TagsInputOnDetail">TagsInputOnDetail</link> preferences you
32401 may be able to add tags to bibliographic records from the search
32402 results and/or bibliographic records. If you are allowing patrons to
32403 add tags from the search results screen you will see an input box
32404 below each result and a 'Tag' option at the top of the screen.</para>
32407 <screeninfo>Tagging Options on Results</screeninfo>
32411 <imagedata fileref="images/opac/tags-results.png"/>
32416 <para>To add a tag to one item, type the tabs (separated by commas) in
32417 the 'New tag' box and click 'Add'. You will be presented with a
32418 confirmation of your tags being added.</para>
32421 <screeninfo>Tags Added on Results</screeninfo>
32425 <imagedata fileref="images/opac/tagsadded-results.png"/>
32430 <para>From the results you can also tag items in bulk by clicking the
32431 checkboxes on the left and then clicking the 'Tag' button at the top.
32432 After clicking the button it will change into an input box for you to
32433 add tags to all of the items you have selected.</para>
32436 <screeninfo>Add Tags to Multiple Items</screeninfo>
32440 <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
32446 <section id="opaccomments">
32447 <title>Comments</title>
32449 <para>Patrons can leave comments in the OPAC if you have the <link
32450 linkend="reviewson">reviewson</link> preference set to allow this.
32451 Each bibliographic record has a comments tab below the bibliographic
32452 information.</para>
32455 <screeninfo>Comments Tab</screeninfo>
32459 <imagedata fileref="images/opac/commentstab.png"/>
32464 <para>If the patron is logged in they will see a link to add a comment
32465 to the item. Clicking this link will open a pop up window with a box
32466 for their comments.</para>
32469 <screeninfo>Add a Comment</screeninfo>
32473 <imagedata fileref="images/opac/addcomment.png"/>
32478 <para>Once the comment has been typed and the 'Submit' button clicked,
32479 the patron will see their comment as pending and other patrons will
32480 simply see that there are no comments on the item.</para>
32483 <screeninfo>Pending Comment</screeninfo>
32487 <imagedata fileref="images/opac/commentpending.png"/>
32492 <para>Once the comment is approved the patron will see the number of
32493 comments on the 'Comments' tab and the comment highlighted in yellow
32494 as their comment.</para>
32497 <screeninfo>Your Comments</screeninfo>
32501 <imagedata fileref="images/opac/yourcomment.png"/>
32506 <para>Other patrons will see the comment with the name of the patron
32507 who left the comment (unless you have set the <link
32508 linkend="ShowReviewer">ShowReviewer</link> preference to not show
32509 patron names).</para>
32512 <screeninfo>Comment by other patron</screeninfo>
32516 <imagedata fileref="images/opac/commentby.png"/>
32521 <para>If you'd like to link to a page of recent comments added to your
32522 catalog you simply need to add a link to
32523 http://YOURCATALOG/cgi-bin/koha/opac-showreviews.pl to anywhere on
32527 <screeninfo>Recent Comments List</screeninfo>
32531 <imagedata fileref="images/opac/recentcomments.png"/>
32537 <section id="zotero">
32538 <title>Zotero</title>
32540 <para>Zotero is a Firefox add on that allows for the saving and
32541 generating of a bibliography. Learn more about and download Zotero at
32542 <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
32544 <para>When on the search results in the Koha OPAC, if you have Zotero
32545 installed, you will see a folder icon in the address bar to the right
32546 of the URL. Clicking that folder will open up a list of titles on the
32547 page for you to pick from to add to Zotero.</para>
32550 <screeninfo>Zotero pop up</screeninfo>
32554 <imagedata fileref="images/opac/zoteroaddressbar.png"/>
32559 <para>Select the titles you want to add to Zotero and then click the
32560 'OK' button. This will add the title to Zotero. You can see the title
32561 by opening your Zotero library.</para>
32564 <screeninfo>Title in the Zotero Library</screeninfo>
32568 <imagedata fileref="images/opac/zoterotitle.png"/>
32574 <section id="customrss">
32575 <title>Custom RSS Feeds</title>
32577 <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
32578 any SQL query (for example a new acquisitions RSS feed). rss.pl is run
32579 on the command line to produce an RSS XML document.</para>
32581 <para>The output should be placed in a directory accessible to the
32582 OPAC (or staff) web interface so that users can download the RSS
32585 <para>An example of usage can be found at: misc/cronjobs/rss.pl
32586 lastAcquired.conf</para>
32588 <para>Normally rss.pl should be run periodically (e.g., daily) to keep
32589 the feed up-to-date.</para>
32591 <para>The configuration file (e.g., lastAcquired.conf) lists</para>
32595 <para>name of the template file to use</para>
32599 <para>path of output file</para>
32603 <para>SQL query</para>
32607 <para>rss.pl runs the SQL query, then feeds the output of the query
32608 through the template to produce the output file.</para>
32611 <para>To use custom RSS feeds you need to turn on the cron
32613 </important></para>
32617 <section id="opacmyaccount">
32618 <title>My Account</title>
32620 <para>From the OPAC patrons can log in and access their account if you
32621 have set the <link linkend="opacuserlogin">opacuserlogin</link>
32622 preference to 'Allow'. Once logged in patrons are brought to their
32623 account summary. If you would like to get to your account in the OPAC,
32624 you can click on your name in the top right of any page in the
32627 <section id="opacmysummary">
32628 <title>My Summary</title>
32631 <screeninfo>My Summary</screeninfo>
32635 <imagedata fileref="images/opac/myaccount.png"/>
32640 <para>From the 'my summary' tab, patrons will see all of the items
32641 they have checked out with the overdue items highlighted in red. If
32642 you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
32643 set to 'Allow' then your patrons will be able to renew their books
32644 right from the OPAC. If you have HTML entered in the <link
32645 linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
32646 you will see that to the right of the 'Fines' column.</para>
32649 <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
32653 <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
32658 <para>If your patrons would like to see the items barcodes on their
32659 list of checked out items you can set up a <link
32660 linkend="patronattributetypes">patron attribute</link> with the value
32661 of SHOW_BCODE and <link linkend="authorizedvalues">authorized
32662 value</link> of YES_NO.</para>
32665 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
32669 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
32674 <para>Then on the <link linkend="editpatrons">patron's record set the
32675 value</link> for SHOW_BCODE to yes.</para>
32678 <screeninfo>Setting value for SHOW_BCODE on patron
32679 record</screeninfo>
32683 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
32688 <para>This will add a column to the check out summary in the OPAC that
32689 shows the patrons the barcodes of the items they have checked
32693 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
32697 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
32702 <para>Clicking on the 'Overdue' tab will show only the items that are
32706 <screeninfo>Overdue Items</screeninfo>
32710 <imagedata fileref="images/opac/myoverdues.png"/>
32715 <para>The 'Fines' tab will show just a total of what the patron owes.
32716 Clicking on the total will take them to the 'my fines' tab where they
32717 will see a complete breakdown of their fines and bills. If you don't
32718 charge fines at your library you can turn the display of these tabs
32719 off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
32720 preference to 'Don't Allow.'</para>
32723 <screeninfo>Patron Fines</screeninfo>
32727 <imagedata fileref="images/opac/myfines.png"/>
32732 <para>Finally, clicking on the 'Holds' tab will show the patron the
32733 status of all of the items they have on hold. Items that are ready for
32734 pickup will be highlighted in yellow.</para>
32737 <screeninfo>Patron holds status</screeninfo>
32741 <imagedata fileref="images/opac/myholds.png"/>
32746 <para>Patrons can cancel their own holds if they are not in transit or
32747 already waiting for them. They can also suspend all of their holds
32748 (depending on the value of your <link
32749 linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference)
32750 indefinitely or until a specific date if they choose by filling in the
32751 suspend options at the bottom of the page.</para>
32754 <para>If you have your <link
32755 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
32756 preference set to "Don't allow" then you will not have the option to
32757 put an end date on the hold suspension</para>
32761 <section id="opacmyaccount-flags">
32762 <title>Patron Flags</title>
32764 <para>If you have <link linkend="patronflags">flagged your patron's
32765 account</link> they may see one of the following error messages at the
32766 top of their account.</para>
32770 <para>Card marked as lost</para>
32773 <screeninfo>Library card lost</screeninfo>
32777 <imagedata fileref="images/opac/nocard.png"/>
32784 <para>Patron address in question</para>
32787 <screeninfo>Patron address in question</screeninfo>
32791 <imagedata fileref="images/opac/noaddress.png"/>
32799 <para>this error message will not include a link to the
32800 update form if you have <link
32801 linkend="OPACPatronDetails">OPACPatronDetails</link> set to
32802 'Don't allow'</para>
32809 <para>Patron marked restricted</para>
32812 <screeninfo>Patron restricted</screeninfo>
32816 <imagedata fileref="images/opac/debarred.png"/>
32824 <section id="opacmyfines">
32825 <title>My Fines</title>
32827 <para>If your library charges fines the next tab on the left is 'my
32828 fines.' Opening this tab will show the patron an entire history of
32829 their accounting at the library.</para>
32832 <screeninfo>Library Fines & Charges</screeninfo>
32836 <imagedata fileref="images/opac/mybilling.png"/>
32842 <section id="opacmydetails">
32843 <title>My Details</title>
32845 <para>If you have your <link
32846 linkend="OPACPatronDetails">OPACPatronDetails</link> preference set to
32847 'Allow', your patrons will see a form filled in with their contacting
32848 information by clicking on the 'my personal details' tab.</para>
32851 <screeninfo>Patron's personal details</screeninfo>
32855 <imagedata fileref="images/opac/myprofile.png"/>
32860 <para>Patrons can edit their details in this form and click 'Submit
32861 Changes' to have their edits sent to the library for review before
32862 their record is updated. The email with the changes is sent to the
32863 library administration email address and lines that the patron changed
32864 will start with the field name in all caps.</para>
32867 linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set
32868 to 'Don't allow' then patrons will simply see their details in plain
32872 <screeninfo>Patron's personal details with no edits</screeninfo>
32876 <imagedata fileref="images/opac/myprofile-noedit.png"/>
32882 <section id="opacmytags">
32883 <title>My Tags</title>
32885 <para>If your library has <link
32886 linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
32887 next tab on the left will be 'my tags.' This tab will show patrons all
32888 of the tags in the system as a cloud and then all of the tags they
32889 have applied in a list format. From here patrons have the ability to
32890 remove tags that they have added if they want.</para>
32893 <screeninfo>Patron's tags</screeninfo>
32897 <imagedata fileref="images/opac/mytags.png"/>
32903 <section id="opacmypassword">
32904 <title>Change My Password</title>
32906 <para>Next, if you have <link
32907 linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
32908 the next tab will be 'change my password,' where patrons can change
32909 their password for logging into the OPAC. Patrons will be presented
32910 with a standard form asking them to enter their old password and then
32911 their new password twice.</para>
32914 <screeninfo>Change my password</screeninfo>
32918 <imagedata fileref="images/opac/mypassword.png"/>
32924 <section id="opacmysearchistory">
32925 <title>My Search History</title>
32927 <para>If you have your <link
32928 linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
32929 preference set to 'Allow' then your patrons can access their search
32930 history via the 'my search history' tab.</para>
32933 <screeninfo>my search history tab</screeninfo>
32937 <imagedata fileref="images/opac/mysearchhistory.png"/>
32942 <para>The search history is a record of all searches run by the
32943 patron. Clicking on any of the search phrases will re-run the search
32944 for the patron. The search history can be deleted by the patron at any
32945 time by clicking the 'Delete your search history' link found at the
32946 top of this tab or by clicking the little red 'x' next to the 'Search
32947 history' link at the top right of the OPAC.</para>
32950 <screeninfo>Search history link at the top right of the
32955 <imagedata fileref="images/opac/searchistory.png"/>
32961 <section id="opacmyhistory">
32962 <title>My Reading History</title>
32964 <para>Depending on your library's setting for <link
32965 linkend="opacreadinghistory">opacreadinghistory</link> your patrons
32966 may see the 'my reading history' tab next. This will show the patron
32967 their entire reading history unless they have asked the library to not
32968 keep that information via the 'my privacy' tab which will appear if
32969 you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
32970 set to 'Allow.'</para>
32973 <screeninfo>Patron reading history</screeninfo>
32977 <imagedata fileref="images/opac/myhistory.png"/>
32983 <section id="opacmyprivacy">
32984 <title>My Privacy</title>
32986 <para>The 'my privacy' tab will appear if you have both the <link
32987 linkend="opacreadinghistory">opacreadinghistory</link> and the <link
32988 linkend="OPACPrivacy">OPACPrivacy</link> preferences set to 'Allow.'
32989 This tab will allow the patrons to decide how the library keeps their
32990 circulation history data.</para>
32993 <screeninfo>my privacy tab</screeninfo>
32997 <imagedata fileref="images/opac/myprivacy.png"/>
33002 <para>The patron can choose from three options:</para>
33006 <para>Forever: keep my reading history without limit. This is the
33007 option for users who want to keep track of what they are
33012 <para>Default: keep my reading history according to local laws.
33013 This is the default option : the library will keep your reading
33014 history for the duration permitted by local laws.</para>
33018 <para>Never: Delete my reading history immediately. This will
33019 delete all record of the item that was checked-out upon
33024 <para>Depending on the patron's suggestions the contents of the '<link
33025 linkend="opacmyhistory">my reading history</link>' tab and the '<link
33026 linkend="circhistory">Circulation History</link>' tab in the staff
33027 client may change.</para>
33029 <para>Regardless of the patron's choice they can delete their reading
33030 history in bulk at any time by clicking the 'Immediate deletion'
33034 <screeninfo>Delete Circulation History</screeninfo>
33038 <imagedata fileref="images/opac/deletecirchistory.png"/>
33043 <para>Clicking this button will not delete items that are currently
33044 checked out, but will clear the patron's past reading history.</para>
33047 <section id="opacmysuggestions">
33048 <title>My Purchase Suggestions</title>
33050 <para>If your library allows patrons to make purchase suggestions the
33051 next tab will show all suggestions that the patron made to the library
33052 and their statuses. To disable this tab and the suggestion
33053 functionality set the <link
33054 linkend="suggestionspref">suggestion</link> preference to 'Don't
33058 <screeninfo>Patron purchase suggestions</screeninfo>
33062 <imagedata fileref="images/opac/mysuggestions.png"/>
33068 <section id="opacmymsgs">
33069 <title>My Messaging</title>
33071 <para>If your library has the <link
33072 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
33073 preference set to 'Allow' then your patrons will be able to choose
33074 which messages they receive from the library (with the exception of
33075 overdue notices which the library controls).</para>
33078 <screeninfo>Patron messaging preferences</screeninfo>
33082 <imagedata fileref="images/opac/mymessages.png"/>
33087 <para>If you also allow SMS messages with the <link
33088 linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
33089 an additional column to receive these messages as SMS (or text
33090 messages) and a field for a cell (or SMS) number.</para>
33093 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
33097 <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
33103 <section id="opacmylists">
33104 <title>My Lists</title>
33106 <para>Finally, if your library has the <link
33107 linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
33108 last tab will by 'my lists.' From here your patrons can review public
33109 lists and create or edit their own private lists.</para>
33112 <screeninfo>Patron lists</screeninfo>
33116 <imagedata fileref="images/opac/mylists.png"/>
33123 <section id="purchasesuggest">
33124 <title>Purchase Suggestions</title>
33126 <para>If your library has the <link
33127 linkend="suggestionspref">suggestion</link> preference set to 'Allow'
33128 then patrons will have the option to make purchase suggestions in
33129 several areas in the OPAC.</para>
33131 <para>There will be a link at the top of your OPAC under the search
33135 <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
33139 <imagedata fileref="images/opac/suggestfromsearch.png"/>
33144 <para>There will be a link when the patron finds nothing for their
33148 <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
33152 <imagedata fileref="images/opac/suggestfromnoresults.png"/>
33157 <para>And there will be a link on the patron's <link
33158 linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
33161 <screeninfo>Purchase Suggestion from My Purchase Suggestions
33166 <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
33171 <para>Clicking any one of these links will open the purchase suggestion
33175 <screeninfo>New Purchase Suggestion</screeninfo>
33179 <imagedata fileref="images/opac/newsuggestion.png"/>
33186 <para>From the form on the 'Title' is required by the
33191 <para>If you would like the 'Reason for suggestion' menu shown in
33192 the screenshot above to appear on your suggestions list you need to
33193 add an <link linkend="authorizedvalues">authorized value</link>
33194 category titled 'OPAC_SUG' and include reasons as values in that
33199 <para>If you would like the patron to be able to choose which branch
33200 they are making a suggestion for you need to set the <link
33201 linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
33202 preference to 'Allow'</para>
33206 <para>Once the form is submitted the data will be saved to the <link
33207 linkend="managesuggest">Acquisitions</link> module for the librarians to
33212 <chapter id="searching">
33213 <title>Searching</title>
33217 <section id="searchprefixes">
33218 <title>Advanced Search Prefixes</title>
33220 <para>The following prefixes can be added to search terms in the keyword
33221 search box to limit items returned</para>
33225 <para>ti: title search</para>
33229 <para>ex. ti:hamlet</para>
33235 <para>su: subject search</para>
33239 <para>ex. su:cooking</para>
33245 <para>pb: publisher search</para>
33249 <para>ex. pb:penguin</para>
33255 <para>au: author search</para>
33259 <para>ex. au:rowling</para>
33265 <para>su-geo: geographic subjects</para>
33269 <para>ex. su-geo:wales and kw:description and kw:travel</para>
33275 <para>bc: barcode</para>
33279 <para>ex. bc:502326000912</para>
33285 <para>lex: lexile</para>
33289 <para>levels lex:510</para>
33298 <section id="searchguide">
33301 <firstname>Becky</firstname>
33303 <surname>Bell</surname>
33306 <orgname>WALDO</orgname>
33310 <pubdate>October 2008</pubdate>
33312 <othercredit role="copyeditor">
33313 <firstname>Nicole C.</firstname>
33315 <surname>Engard</surname>
33317 <contrib>Fixed typos, changed content where necessary and added new
33318 screenshots.</contrib>
33322 <title>Guide to Searching</title>
33324 <para>This brief guide will explain a chart that shows a sample of how a
33325 MARC21 database can be configured, as well as a brief introductory
33326 searching guide. The indexing fields described in this document relate
33327 to the bibliographic data and does not address authority database
33330 <section id="searchguide-indexing">
33331 <title>Indexing and Searching Description</title>
33333 <para>Koha's databases are indexed by the Zebra open-source software.
33334 The overview to the documentation describes Zebra as:</para>
33337 <para>"...Zebra is a high-performance, general-purpose structured
33338 text indexing and retrieval engine. It reads records in a variety of
33339 input formats (eg. email, XML, MARC) and provides access to them
33340 through a powerful combination of Boolean search expressions and
33341 relevance-ranked free-text queries.</para>
33343 <para>Zebra supports large databases (tens of millions of records,
33344 tens of gigabytes of data). It allows safe, incremental database
33345 updates on live systems. Because Zebra supports the
33346 industry-standard information retrieval protocol, Z39.50, you can
33347 search Zebra databases using an enormous variety of programs and
33348 toolkits, both commercial and free, which understands this
33349 protocol..." Zebra - User's Guide and Reference, p. 1, <ulink
33350 url="http://www.indexdata.dk/zebra/doc/zebra.pdf">http://www.indexdata.dk/zebra/doc/zebra.pdf</ulink></para>
33353 <para>This brief guide will explain a chart that shows a sample of how
33354 a MARC21 database can be configured, as well as a brief introductory
33355 searching guide. The indexing fields described in this document relate
33356 to the bibliographic data and does not address authority database
33360 <para>The indexing described in this document is the set used by
33361 SouthEastern University. Your local indexing may vary.</para>
33365 <section id="searchguide-indexconfig">
33366 <title>Indexing Configuration</title>
33368 <para>There are three configuration files that Koha uses while
33371 <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
33372 contains the Z39.50 bib-1 attribute list, plus the Koha local use
33373 attributes for Biblio Indexes, Items Index, and Fixed Fields and other
33374 special indexes. The Z39.50 Bib-1 profile is made up of several
33375 different types of attributes: Use, Relation, Position, Structure,
33376 Truncation, and Completeness. The bib-1 'Use' attribute is represented
33377 on the chart; the other attributes are used primarily when doing
33378 searches. While there are over 150+ use attributes that could be used
33379 to define your indexing set, it's unlikely that you will choose to use
33380 them all. The attributes you elect to use are those that become the
33381 indexing rules for your database. The other five attribute sets define
33382 the various ways that a search can be further defined, and will not
33383 specifically be addressed in this document. For a complete list of the
33384 standard Bib-1 attributes, go to <ulink
33385 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
33387 <para>The second file
33388 (etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs) contains
33389 the abstract syntax which maps the MARC21 tags to the set of Use
33390 Attributes you choose to use. The rules established in this file
33391 provides a passable Bath level 0 and 1 service, which includes author,
33392 title, subject, keyword and exact services such as standard
33393 identifiers (LCCN, ISBN, ISSN, etc.)</para>
33395 <para>The third file (etc/zebradb/ccl.properties) is the Common
33396 Command Language (CCL) field mappings. This file combines the bib-1
33397 attribute set file and the abstract file and adds the qualifiers,
33398 usually known as index names. The qualifiers, or indexes, for this
33399 database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
33400 su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
33401 mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
33403 <para>The Koha Indexing Chart summarizes the contents of all three of
33404 these files in a more readable format. The first two columns labeled
33405 Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes
33406 file. The third column labeled MARC tags indexed is where you find
33407 which MARC tags are mapped to an attribute. The fourth column labeled
33408 Qualifiers identifies the search abbreviations used in the internal
33409 CCL query. The following description provides a definition for the
33410 word 'qualifiers'.</para>
33412 <para><emphasis>Qualifiers are used to direct the search to a
33413 particular searchable index, such as title (ti) and author indexes
33414 (au). The CCL standard itself doesn't specify a particular set of
33415 qualifiers, but it does suggest a few shorthand notations. You can
33416 customize the CCL parser to support a particular set of qualifiers to
33417 reflect the current target profile. Traditionally, a qualifier would
33418 map to a particular use-attribute within the BIB-1attribute set. It is
33419 also possible to set other attributes, such as the structure
33420 attribute.</emphasis></para>
33422 <para>In the MARC tags indexed column, there are some conventions used
33423 that have specific meanings. They are:</para>
33427 <para>A three digit tag (100) means that all subfields in the tag
33428 can be used in a search query. So, if you enter a search for
33429 'Jackson' as an author, you will retrieve records where Jackson
33430 could be the last name or the first name.</para>
33434 <para>A three digit tag that has a '$' followed by a letter
33435 (600$a) means that a search query will only search the 'a'
33440 <para>A three digit tag that is followed by a ':' and a letter
33441 (240:w) means that a search query can be further qualified. The
33442 letter following the ':' identifies how to conduct the search. The
33443 most common values you'll see are 'w' (word), 'p' (phrase), 's'
33444 (sort), and 'n' (numeric).</para>
33448 <para>The contents of the MARC tags, subfields, and/or fixed field
33449 elements that are listed in this chart are all indexed. You'll see
33450 that every attribute line is not mapped to a specific qualifier
33451 (index)-LC card number, line 9 is one example. However, every indexed
33452 word (a string of characters preceded and succeeded by a space) can be
33453 searched using a keyword (kw) search. So, although an LC card number
33454 specific index doesn't exist, you can still search by the LCCN since
33455 tag 010 is assigned to the LC-card-number attribute. To verify this,
33456 enter 72180055 in the persistent search box. You should retrieve The
33457 gods themselves, by Isaac Asimov.</para>
33459 <para>Examples of fixed field elements indexing can be seen on the
33460 chart between Attribute 8822 and Attribute 8703. These attributes are
33461 most commonly used for limiting. The fixed field attributes currently
33462 represent the BK codes. Other format codes, if needed, could be
33466 <section id="searchguide-basics">
33467 <title>Basic Searching</title>
33469 <para>The search box that library staff and library patrons will see
33470 most often is the persistent search box at the top of the page. Koha
33471 interprets the searches as keyword searches.</para>
33474 <screeninfo>Koha search box</screeninfo>
33478 <imagedata fileref="images/searching/searchbox.png"/>
33483 <para>To start a search, you enter a word or multiple words in the
33484 search box. When a single word is entered, a keyword search is
33485 performed. You can check this out by typing one word into the form and
33486 note the number of results located. Then, repeat the search with a
33487 minor change. In front of the search word, type 'kw=' followed by the
33488 same search term. The results will be identical.</para>
33490 <para>When you have more than one word in the search box, Koha will
33491 still do a keyword search, but a bit differently. Each word will be
33492 searched on its own, then the Boolean connector 'and' will narrow your
33493 search to those items with all words contained in matching
33496 <para>Suppose you want to find material about how libraries are using
33497 mashups. You'll select the major words and enter them into the
33498 persistent search box.</para>
33501 <screeninfo>Keyword Search</screeninfo>
33505 <imagedata fileref="images/searching/searchterms.png"/>
33510 <para>The response to this search is:</para>
33513 <screeninfo>Results</screeninfo>
33517 <imagedata fileref="images/searching/resultssummary.png"/>
33522 <para>The order of the words does not affect the retrieval results, so
33523 you could also enter the search as "mashups library". The response to
33524 this search is results</para>
33527 <screeninfo>Results</screeninfo>
33531 <imagedata fileref="images/searching/resultssummary2.png"/>
33536 <para>Too many words in the search box will find very few matches, as
33537 the following example illustrates:</para>
33540 <screeninfo>No results found</screeninfo>
33544 <imagedata fileref="images/searching/noresults.png"/>
33550 <section id="searchguide-advanced">
33551 <title>Advanced Searching</title>
33553 <para>When you can't find the most appropriate material with a general
33554 search, you can move to the Advanced Search page by clicking on the
33555 Search option on the persistent toolbar.</para>
33558 <screeninfo>Koha Menu</screeninfo>
33562 <imagedata fileref="images/searching/menubar.png"/>
33567 <para>The Advanced Search page offers many ways to limit the results
33568 of your search. You can search using the Boolean operators AND, OR,
33569 and NOT; limit by item type; limit by year and language; limit by
33570 subtypes audience, content, format, or additional content types; by
33571 location and by availability.</para>
33573 <para>The first limiting section on the Advanced Search page provides
33574 a quick and simple way to use the Boolean operators in your search.
33575 Note that this display depends on a system preference setting. This
33576 option can be found on the Administration > System Preferences >
33577 Searching page. The option called <link
33578 linkend="expandedSearchOption">expandedSearchOption</link> must be set
33579 to 'show' to see the following display.</para>
33582 <screeninfo>Advanced Search Options</screeninfo>
33586 <imagedata fileref="images/searching/searchoptions.png"/>
33591 <para>In this section you can choose among the many indexes by
33592 clicking on the arrow in the first box. The blank box that follows is
33593 where you enter your first search term or terms. On the second line,
33594 you can choose the Boolean operator you want to use in your search.
33595 The options are 'and', 'or', and 'not'. Then, you would again choose
33596 the index to search, followed by the second term or terms. If you have
33597 more concepts you want to include in your search, you can click the
33598 [+] to add another line for your search.</para>
33600 <para>A sample search is shown next, followed by its results:</para>
33603 <screeninfo>Advanced Search</screeninfo>
33607 <imagedata fileref="images/searching/advsearch.png"/>
33613 <screeninfo>Results from Advanced Search</screeninfo>
33617 <imagedata fileref="images/searching/numresults.png"/>
33622 <para>When you use the Boolean operators to broaden or narrow a
33623 search, remember the action of each operator. The 'and' operator
33624 narrows the results you'll retrieve because the search will retrieve
33625 the records that include all your search terms. The 'or' operator
33626 expands the results because the search will look for occurrences of
33627 all of your search terms. The 'not' operator excludes records with the
33628 term that follows the operator.</para>
33630 <para>Note: If you leave this <link
33631 linkend="expandedSearchOption">expandedSearchOption</link> set to
33632 'don't show', this is the display you will see:</para>
33635 <screeninfo>Fewer Search Options</screeninfo>
33639 <imagedata fileref="images/searching/feweropts.png"/>
33644 <para>The Advanced Search page then shows the multiple kinds of limits
33645 that can be applied to your search results. Either check a box or
33646 select from the drop down menus to narrow your search. You will type
33647 the year, year range, or a 'greater than (>)' or 'less than (<)'
33651 <screeninfo>Other Advanced Search Options</screeninfo>
33655 <imagedata fileref="images/searching/advoptions.png"/>
33660 <para>Finally, you can choose how the results will be sorted. The
33661 pre-defined sort options are in the final area of the Advanced Search
33665 <screeninfo>Sort Results By</screeninfo>
33669 <imagedata fileref="images/searching/advsortby.png"/>
33674 <para>The default sort is by relevance, although you can choose to
33675 sort by author, by title, by call number, by dates, or by popularity.
33676 If you would prefer a different default sort, you can set <link
33677 linkend="defaultSortField">defaultSortField</link> to one of the other
33678 choices in Administration > System Preferences >
33682 <section id="searchguide-ccl">
33683 <title>Common Command Language Searching</title>
33685 <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
33686 internal search protocol. Searches initiated in the graphical
33687 interface use this protocol as well, although the searcher doesn't
33688 know which indexes, operators and limiters are available and being
33689 used to conduct their search. The searcher can use the Advanced Search
33690 when more precise results set are desired and where the search indexes
33691 are somewhat known. However, some library users and many library staff
33692 prefer using a command based structure. This part of the document will
33693 present and explain the use of the Koha command based structure. The
33694 indexes, operators, and limiters used are identical to those used in
33695 the graphical interface.</para>
33697 <section id="searchguide-indexes">
33698 <title>Indexes</title>
33700 <para>The CCL standard itself doesn't specify a particular set of
33701 qualifiers (indexes), but it does suggest a few short-hand notations
33702 such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
33703 it's possible to customize that set by adding needed indexes based
33704 on local requirements. A qualifier (index) maps to a particular
33705 use-attribute within the Z39.50 BIB-1 attribute set. The complete
33706 Z39.50 Bib-1 Attribute can be viewed at <ulink
33707 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
33709 <para>The standard Koha set of indexes is a fairly common example of
33710 MARC21 indexing rules. The indexes that are defined in Koha are
33711 indexes typically used by other integrated library systems. The
33712 defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
33714 <table cellpadding="4" cellspacing="4" frame="all">
33715 <title>Attributes</title>
33717 <tgroup align="left" cols="2" colsep="1" rowsep="1">
33720 <entry>Bib-1 Attribute</entry>
33722 <entry>Qualifier (index)</entry>
33728 <entry>Personal-name</entry>
33734 <entry>Corporate-name</entry>
33740 <entry>Conference-name</entry>
33746 <entry>Title</entry>
33752 <entry>Title-series</entry>
33758 <entry>Title-uniform</entry>
33764 <entry>ISBN</entry>
33770 <entry>ISSN</entry>
33776 <entry>Local number</entry>
33782 <entry>Local-classification</entry>
33784 <entry>lcn and callnum</entry>
33788 <entry>Subject</entry>
33790 <entry>su, su-to, su-geo, su-ut</entry>
33794 <entry>Pubdate</entry>
33796 <entry>yr,pubdate</entry>
33800 <entry>Date-of-Acquisition</entry>
33802 <entry>acqdate</entry>
33806 <entry>Language</entry>
33812 <entry>Place-of-publication</entry>
33818 <entry>Abstract</entry>
33824 <entry>Notes</entry>
33830 <entry>Record-type</entry>
33832 <entry>rtype, mc-rtype, mus</entry>
33836 <entry>Author</entry>
33838 <entry>au, aut</entry>
33842 <entry>Subject-person-name</entry>
33844 <entry>su-na</entry>
33848 <entry>Any (keyword)</entry>
33854 <entry>Publisher</entry>
33860 <entry>Content-type</entry>
33862 <entry>ctype</entry>
33866 <entry>Koha-Auth-Number</entry>
33872 <entry>Author-personal-bibliography</entry>
33878 <entry>Author-in-order</entry>
33886 <para>Refer to the Koha Indexing Chart for the MARC21 tags mapped to
33887 each Bib-1 Attribute and index combination.</para>
33889 <section id="search-audexamp">
33890 <title>Audience Examples</title>
33894 <para>aud:a Easy</para>
33898 <para>aud:cc Juvenile</para>
33902 <para>aud:d Young adult</para>
33906 <para>aud:e Adult</para>
33911 <section id="search-contentsexamp">
33912 <title>Contents Examples</title>
33916 <para>fic:1 Fiction</para>
33920 <para>fic:0 Non Fiction</para>
33924 <para>bio:b Biography</para>
33928 <para>mus:j Musical recording</para>
33932 <para>mus:I Non musical record</para>
33938 <section id="searchguide-syntax">
33939 <title>Search Syntax</title>
33941 <para>In the persistent search box, single words generally retrieve
33942 large sets. To narrow a search, you can use multiple words. Koha
33943 automatically uses the 'and' Boolean operator to create a set of
33944 records matching your input. When you want to narrow the search to
33945 an author or a title or a subject or some other specific field or
33946 use a Boolean operator, there isn't an obvious way to accomplish
33947 that specificity. The library user can, of course, go to the
33948 Advanced Search page; however, if you know how to construct a CCL
33949 search, you can achieve more specificity while using the persistent
33950 search box on any page.</para>
33952 <para>There is a specific order to the CCL search syntax. Although
33953 it can be used for simple searches, it is an especially effective
33954 way to perform complex searches, as it affords you a great deal of
33955 control over your search results. To construct a CCL search, first
33956 enter a desired index code, then an equal sign, followed by your
33957 search word(s). Following are examples of simple CCL
33962 <para>ti=principles of accounting</para>
33966 <para>au=brown joseph</para>
33970 <para>su=poetry</para>
33974 <para>su-na=Shakespeare</para>
33978 <para>kw=marlin</para>
33982 <para>You can refine your search by combining search terms with
33983 Boolean operators 'and', 'or', or 'not'. Following are examples of
33984 searches using Boolean operators.</para>
33988 <para>ti=principles of accounting and au=brown joseph</para>
33992 <para>su=poetry not su-na=Shakespeare</para>
33996 <para>kw=communication and su=debate</para>
34000 <para>You can also choose to search for things that start with a
34001 character or series of characters</para>
34005 <para>ti,first-in-subfield=C (will show you all titles that
34006 start with the letter 'C')</para>
34010 <para>Other string location searches can be performed with the
34011 following keywords:</para>
34015 <para>rtrn : right truncation</para>
34019 <para>ltrn : left truncation</para>
34023 <para>lrtrn : left and right truncation</para>
34027 <para>st-date : type date</para>
34031 <para>st-numeric : type number (integer)</para>
34035 <para>ext : exact search on whole subfield (does not work with
34040 <para>phr : search on expression anywhere in the subfield</para>
34044 <para>startswithnt : subfield starts with</para>
34048 <para>Using specific indexes and Boolean operators are not the only
34049 way a search can be refined. You can also refine your search as a
34050 phrase when looking for a title, author, or subject. The syntax for
34051 this search is <emphasis>index,phr=search words</emphasis>.</para>
34053 <para>To illustrate the results of various search types, a search
34054 was done for the words 'supreme court'. The results illustrate that
34055 the search index and the word order make a difference in search
34056 results. Only the results count and the search itself is in these
34057 examples. The search executed will always be between the single
34061 <screeninfo>Sample Search 1</screeninfo>
34065 <imagedata fileref="images/searching/ex1.png"/>
34071 <screeninfo>Sample Search 2</screeninfo>
34075 <imagedata fileref="images/searching/ex2.png"/>
34081 <screeninfo>Sample Search 3</screeninfo>
34085 <imagedata fileref="images/searching/ex3.png"/>
34091 <screeninfo>Sample Search 4</screeninfo>
34095 <imagedata fileref="images/searching/ex4.png"/>
34101 <screeninfo>Sample Search 5</screeninfo>
34105 <imagedata fileref="images/searching/ex5.png"/>
34111 <screeninfo>Sample Search 6</screeninfo>
34115 <imagedata fileref="images/searching/ex6.png"/>
34121 <screeninfo>Sample Search 7</screeninfo>
34125 <imagedata fileref="images/searching/ex7.png"/>
34131 <screeninfo>Sample Search 8</screeninfo>
34135 <imagedata fileref="images/searching/ex8.png"/>
34141 <screeninfo>Sample Search 9</screeninfo>
34145 <imagedata fileref="images/searching/ex9.png"/>
34150 <para>You can also choose to use limiters in your search query. Some
34151 common limiters include dates, languages, record types, and item
34152 types. In the Advance Search, you can either click a box or key in
34153 data to limit your search. You can also apply the same limits with
34154 CCL by using the syntax in the following examples. In all</para>
34156 <para><emphasis>By Date: su=supreme court and
34157 yr,st-numeric=>2000</emphasis></para>
34160 <screeninfo>Sample Search 10</screeninfo>
34164 <imagedata fileref="images/searching/ex10.png"/>
34169 <para>When you limit by date, you can use the '>' (greater than),
34170 '<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
34173 <para><emphasis>By Item Type: su=nursing and
34174 itype:BK</emphasis></para>
34177 <screeninfo>Sample Search 11</screeninfo>
34181 <imagedata fileref="images/searching/ex11.png"/>
34186 <para>Each library will have a different set of item types defined
34187 in their circulation configuration. When you set up item types, you
34188 define a code and a name for each one. The name will appear on the
34189 Advance Search page. The code you assigned is used as a CCL search
34190 limit, formatted as 'itype:x', where 'x' is the assigned code. The
34191 initial set of item types in Koha will usually be edited to reflect
34192 your collections, so your item type limiters may be different than
34193 the initial ones. The initial item type limiters follow.</para>
34197 <para>itype:BKS Books, Booklets, Workbooks</para>
34201 <para>itype:SR Audio Cassettes, CDs</para>
34205 <para>itype:IR Binders</para>
34209 <para>itype:CF CD-ROMs, DVD-ROMs, General Online
34214 <para>itype:VR DVDs, VHS</para>
34218 <para>itype:KT Kit</para>
34222 <para>itype:AR Models</para>
34226 <para>itype:SER Serials</para>
34230 <para><emphasis>By format: su=supreme court not
34231 l-format:sr</emphasis></para>
34234 <screeninfo>Sample Search 12</screeninfo>
34238 <imagedata fileref="images/searching/ex12.png"/>
34243 <para>The format limiters are derived from a combination of LDR, 006
34244 and 007 positions. The formats that are currently defined are the
34249 <para>l-format:ta Regular print</para>
34253 <para>l-format:tb Large print</para>
34257 <para>l-format:fk Braille</para>
34261 <para>l-format:sd CD audio</para>
34265 <para>l-format:ss Cassette recording</para>
34269 <para>l-format:vf VHS tape</para>
34273 <para>l-format:vd DVD video</para>
34277 <para>l-format:co CD software</para>
34281 <para>l-format:cr Website</para>
34285 <para><emphasis>By content type: su=supreme court not
34286 ctype:l</emphasis></para>
34289 <screeninfo>Sample Search 13</screeninfo>
34293 <imagedata fileref="images/searching/ex13.png"/>
34298 <para>The content types are taken from the 008 MARC tag, positions
34301 <para>There are two other limiter types that are not described in
34302 this document. They are: Audience and Content. The only difference
34303 in the syntax of the CCL is the actual limiter. They are reproduced
34304 here just in case you would like to use these limiters.</para>
34309 <section id="kohasearchindexes">
34310 <title>Koha Search Indexes</title>
34312 <para>By default, not all fields are indexed in the Zebra search engine,
34313 but many are. Below are the MARC21 fields that are indexed in
34316 <table cellpadding="4" cellspacing="4" frame="all">
34317 <title>Indexes</title>
34319 <tgroup align="left" cols="2" colsep="1" rowsep="1">
34322 <entry><para>Field</para></entry>
34324 <entry><para>Description</para></entry>
34330 <entry><para>001</para></entry>
34332 <entry><para>Control-number</para></entry>
34336 <entry><para>005</para></entry>
34338 <entry><para>Date/time-last-modified</para></entry>
34342 <entry><para>007</para></entry>
34344 <entry><para>Microform-generation:n:range(data,11,1),
34345 Material-type,ff7-00:w:range(data,0,1),
34346 ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
34347 ff7-01-02:w:range(data,0,2)</para></entry>
34351 <entry><para>008</para></entry>
34353 <entry><para>date-entered-on-file:n:range(data,0,5),
34354 date-entered-on-file:s:range(data,0,5),
34355 pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
34356 pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
34357 pl:w:range(data,15,3), ta:w:range(data,22,1),
34358 ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
34359 lf:w:range(data,33,1), bio:w:range(data,34,1),
34360 ln:n:range(data,35,3), ctype:w:range(data,24,4),
34361 Record-source:w:range(data,39,0)</para></entry>
34365 <entry><para>010</para></entry>
34367 <entry><para>LC-card-number, Identifier-standard</para></entry>
34371 <entry><para>011</para></entry>
34373 <entry><para>LC-card-number, Identifier-standard</para></entry>
34377 <entry><para>015</para></entry>
34379 <entry><para>BNB-card-number, BGF-number, Number-db,
34380 Number-natl-biblio, Identifier-standard</para></entry>
34384 <entry><para>017</para></entry>
34386 <entry><para>Number-legal-deposit,
34387 Identifier-standard</para></entry>
34391 <entry><para>018</para></entry>
34393 <entry><para>Identifier-standard</para></entry>
34397 <entry><para>020$a</para></entry>
34399 <entry><para>ISBN:w, Identifier-standard:w</para></entry>
34403 <entry><para>020</para></entry>
34405 <entry><para>Identifier-standard</para></entry>
34409 <entry><para>022$a</para></entry>
34411 <entry><para>ISSN:w, Identifier-standard:w</para></entry>
34415 <entry><para>022</para></entry>
34417 <entry><para>Identifier-standard</para></entry>
34421 <entry><para>023</para></entry>
34423 <entry><para>Identifier-standard</para></entry>
34427 <entry><para>024$a</para></entry>
34429 <entry><para>Identifier-other</para></entry>
34433 <entry><para>024</para></entry>
34435 <entry><para>Identifier-standard</para></entry>
34439 <entry><para>025</para></entry>
34441 <entry><para>Identifier-standard</para></entry>
34445 <entry><para>027</para></entry>
34447 <entry><para>Report-number, Identifier-standard</para></entry>
34451 <entry><para>028</para></entry>
34453 <entry><para>Number-music-publisher,
34454 Identifier-standard</para></entry>
34458 <entry><para>030</para></entry>
34460 <entry><para>CODEN, Identifier-standard</para></entry>
34464 <entry><para>034</para></entry>
34466 <entry><para>Map-scale</para></entry>
34470 <entry><para>037</para></entry>
34472 <entry><para>Identifier-standard, Stock-number</para></entry>
34476 <entry><para>040</para></entry>
34478 <entry><para>Code-institution, Record-source</para></entry>
34482 <entry><para>041</para></entry>
34484 <entry><para>ln</para></entry>
34488 <entry><para>043</para></entry>
34490 <entry><para>Code-geographic</para></entry>
34494 <entry><para>050$b</para></entry>
34496 <entry><para>LC-call-number:w, LC-call-number:p,
34497 LC-call-number:s</para></entry>
34501 <entry><para>050</para></entry>
34503 <entry><para>LC-call-number:w, LC-call-number:p,
34504 LC-call-number:s</para></entry>
34508 <entry><para>052</para></entry>
34510 <entry><para>Geographic-class</para></entry>
34514 <entry><para>060</para></entry>
34516 <entry><para>NLM-call-number</para></entry>
34520 <entry><para>070</para></entry>
34522 <entry><para>NAL-call-number</para></entry>
34526 <entry><para>080</para></entry>
34528 <entry><para>UDC-classification</para></entry>
34532 <entry><para>082</para></entry>
34534 <entry><para>Dewey-classification:w,
34535 Dewey-classification:s</para></entry>
34539 <entry><para>086</para></entry>
34541 <entry><para>Number-govt-pub</para></entry>
34545 <entry><para>100$9</para></entry>
34547 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
34551 <entry><para>100$a</para></entry>
34553 <entry><para>Author,Author:p, Author:s, Editor,
34554 Author-personal-bibliography, Author-personal-bibliography:p,
34555 Author-personal-bibliography:s</para></entry>
34559 <entry><para>100</para></entry>
34561 <entry><para>Author, Author-title, Author-name-personal, Name,
34562 Name-and-title, Personal-name</para></entry>
34566 <entry><para>110$9</para></entry>
34568 <entry><para>Koha-Auth-Number</para></entry>
34572 <entry><para>110</para></entry>
34574 <entry><para>Author, Author-title, Author-name-corporate, Name,
34575 Name-and-title, Corporate-name</para></entry>
34579 <entry><para>111$9</para></entry>
34581 <entry><para>Koha-Auth-Number</para></entry>
34585 <entry><para>111</para></entry>
34587 <entry><para>Author, Author-title, Author-name-corporate, Name,
34588 Name-and-title, Conference-name</para></entry>
34592 <entry><para>130$n</para></entry>
34594 <entry><para>Thematic-number</para></entry>
34598 <entry><para>130$r</para></entry>
34600 <entry><para>Music-key</para></entry>
34604 <entry><para>130$9</para></entry>
34606 <entry><para>Koha-Auth-Number</para></entry>
34610 <entry><para>130</para></entry>
34612 <entry><para>Title, Title-uniform</para></entry>
34616 <entry><para>210</para></entry>
34618 <entry><para>Title, Title-abbreviated</para></entry>
34622 <entry><para>211</para></entry>
34624 <entry><para>Title, Title-abbreviated</para></entry>
34628 <entry><para>212</para></entry>
34630 <entry><para>Title, Title-other-variant</para></entry>
34634 <entry><para>214</para></entry>
34636 <entry><para>Title, Title-expanded</para></entry>
34640 <entry><para>222</para></entry>
34642 <entry><para>Title, Title-key</para></entry>
34646 <entry><para>240$r</para></entry>
34648 <entry><para>Music-key</para></entry>
34652 <entry><para>240$n</para></entry>
34654 <entry><para>Thematic-number</para></entry>
34658 <entry><para>240</para></entry>
34660 <entry><para>Title:w, Title:p, Title-uniform</para></entry>
34664 <entry><para>243$n</para></entry>
34666 <entry><para>Thematic-number</para></entry>
34670 <entry><para>243$r</para></entry>
34672 <entry><para>Music-key</para></entry>
34676 <entry><para>243</para></entry>
34678 <entry><para>Title:w, Title:p, Title-collective</para></entry>
34682 <entry><para>245$a</para></entry>
34684 <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
34685 Title:w, Title:p, Title:s</para></entry>
34689 <entry><para>245$c</para></entry>
34691 <entry><para>Author, Author-in-order:w, Author-in-order:p,
34692 Author-in-order:s</para></entry>
34696 <entry><para>245$9</para></entry>
34698 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
34702 <entry><para>245</para></entry>
34704 <entry><para>Title:w, Title:p</para></entry>
34708 <entry><para>246</para></entry>
34710 <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
34711 Title-former</para></entry>
34715 <entry><para>247</para></entry>
34717 <entry><para>Title, Title:p, Title-former, Title-other-variant,
34718 Related-periodical</para></entry>
34722 <entry><para>260$a</para></entry>
34724 <entry><para>pl:w, pl:p</para></entry>
34728 <entry><para>260$b</para></entry>
34730 <entry><para>Publisher:w, Publisher:p</para></entry>
34734 <entry><para>260$c</para></entry>
34736 <entry><para>copydate, copydate:s</para></entry>
34740 <entry><para>260</para></entry>
34742 <entry><para>pl</para></entry>
34746 <entry><para>300</para></entry>
34748 <entry><para>Extent:w, Extent:p</para></entry>
34752 <entry><para>400$a</para></entry>
34754 <entry><para>Name-and-title</para></entry>
34758 <entry><para>400$t</para></entry>
34760 <entry><para>Author-title, Name-and-title, Title,
34761 Title-series</para></entry>
34765 <entry><para>400$9</para></entry>
34767 <entry><para>Koha-Auth-Number</para></entry>
34771 <entry><para>400</para></entry>
34773 <entry><para>Author, Author-name-personal, Name,
34774 Personal-name</para></entry>
34778 <entry><para>410</para></entry>
34780 <entry><para>Author, Corporate-name</para></entry>
34784 <entry><para>410$a</para></entry>
34786 <entry><para>Name-and-title</para></entry>
34790 <entry><para>410$t</para></entry>
34792 <entry><para>Author-title, Title, Title-series</para></entry>
34796 <entry><para>410$9</para></entry>
34798 <entry><para>Koha-Auth-Number</para></entry>
34802 <entry><para>410</para></entry>
34804 <entry><para>Author-name-corporate, Name</para></entry>
34808 <entry><para>411</para></entry>
34810 <entry><para>Author, Conference-name</para></entry>
34814 <entry><para>411$a</para></entry>
34816 <entry><para>Name-and-title</para></entry>
34820 <entry><para>411$t</para></entry>
34822 <entry><para>Author-title, Title-series</para></entry>
34826 <entry><para>411</para></entry>
34828 <entry><para>Author-name-corporate, Name</para></entry>
34832 <entry><para>440$a</para></entry>
34834 <entry><para>Title-series:w, Title-series:p</para></entry>
34838 <entry><para>440$9</para></entry>
34840 <entry><para>Koha-Auth-Number</para></entry>
34844 <entry><para>440</para></entry>
34846 <entry><para>Title-series:w, Title-series:p, Title,
34847 Title-series</para></entry>
34851 <entry><para>490$a</para></entry>
34853 <entry><para>Title-series:w, Title-series:p</para></entry>
34857 <entry><para>490</para></entry>
34859 <entry><para>Title, Title-series</para></entry>
34863 <entry><para>490$9</para></entry>
34865 <entry><para>Koha-Auth-Number</para></entry>
34869 <entry><para>500</para></entry>
34871 <entry><para>Note:w, Note:p</para></entry>
34875 <entry><para>502</para></entry>
34877 <entry><para>Material-type</para></entry>
34881 <entry><para>505$r</para></entry>
34883 <entry><para>Author</para></entry>
34887 <entry><para>505$t</para></entry>
34889 <entry><para>Title</para></entry>
34893 <entry><para>505</para></entry>
34895 <entry><para>Note:w, Note:p</para></entry>
34899 <entry><para>510</para></entry>
34901 <entry><para>Indexed-by</para></entry>
34905 <entry><para>520</para></entry>
34907 <entry><para>Abstract:w, Abstract:p</para></entry>
34911 <entry><para>521$a</para></entry>
34913 <entry><para>lex:n</para></entry>
34917 <entry><para>526$c</para></entry>
34919 <entry><para>arl, arl:n</para></entry>
34923 <entry><para>526$d</para></entry>
34925 <entry><para>arp, arp:n</para></entry>
34929 <entry><para>590</para></entry>
34931 <entry><para>Note:w, Note:p</para></entry>
34935 <entry><para>600$a</para></entry>
34937 <entry><para>Name-and-title, Name, Personal-name,
34938 Subject-name-personal, Subject</para></entry>
34942 <entry><para>600$t</para></entry>
34944 <entry><para>Name-and-title, Title, Subject</para></entry>
34948 <entry><para>600$9</para></entry>
34950 <entry><para>Koha-Auth-Number</para></entry>
34954 <entry><para>600</para></entry>
34956 <entry><para>Name, Personal-name, Subject-name-personal,
34957 Subject</para></entry>
34961 <entry><para>610$a</para></entry>
34963 <entry><para>Name-and-title</para></entry>
34967 <entry><para>610$t</para></entry>
34969 <entry><para>Name-and-title, Title</para></entry>
34973 <entry><para>610$9</para></entry>
34975 <entry><para>Koha-Auth-Number</para></entry>
34979 <entry><para>610</para></entry>
34981 <entry><para>Name, Subject, Corporate-name</para></entry>
34985 <entry><para>611</para></entry>
34987 <entry><para>Conference-name</para></entry>
34991 <entry><para>611$a</para></entry>
34993 <entry><para>Name-and-title</para></entry>
34997 <entry><para>611$t</para></entry>
34999 <entry><para>Name-and-title, Title</para></entry>
35003 <entry><para>611$9</para></entry>
35005 <entry><para>Koha-Auth-Number</para></entry>
35009 <entry><para>611</para></entry>
35011 <entry><para>Name, Subject</para></entry>
35015 <entry><para>630$n</para></entry>
35017 <entry><para>Thematic-number</para></entry>
35021 <entry><para>630$r</para></entry>
35023 <entry><para>Music-key</para></entry>
35027 <entry><para>630$9</para></entry>
35029 <entry><para>Koha-Auth-Number</para></entry>
35033 <entry><para>630</para></entry>
35035 <entry><para>Subject</para></entry>
35039 <entry><para>650$9</para></entry>
35041 <entry><para>Koha-Auth-Number</para></entry>
35045 <entry><para>650</para></entry>
35047 <entry><para>Subject, Subject:p</para></entry>
35051 <entry><para>651$9</para></entry>
35053 <entry><para>Koha-Auth-Number</para></entry>
35057 <entry><para>651</para></entry>
35059 <entry><para>Name-geographic, Subject,Subject:p</para></entry>
35063 <entry><para>652$9</para></entry>
35065 <entry><para>Koha-Auth-Number</para></entry>
35069 <entry><para>653$9</para></entry>
35071 <entry><para>Koha-Auth-Number</para></entry>
35075 <entry><para>653</para></entry>
35077 <entry><para>Subject, Subject:p</para></entry>
35081 <entry><para>654$9</para></entry>
35083 <entry><para>Koha-Auth-Number</para></entry>
35087 <entry><para>654</para></entry>
35089 <entry><para>Subject</para></entry>
35093 <entry><para>655$9</para></entry>
35095 <entry><para>Koha-Auth-Number</para></entry>
35099 <entry><para>655</para></entry>
35101 <entry><para>Subject</para></entry>
35105 <entry><para>656$9</para></entry>
35107 <entry><para>Koha-Auth-Number</para></entry>
35111 <entry><para>656</para></entry>
35113 <entry><para>Subject</para></entry>
35117 <entry><para>657$9</para></entry>
35119 <entry><para>Koha-Auth-Number</para></entry>
35123 <entry><para>657</para></entry>
35125 <entry><para>Subject</para></entry>
35129 <entry><para>690$9</para></entry>
35131 <entry><para>Koha-Auth-Number</para></entry>
35135 <entry><para>690</para></entry>
35137 <entry><para>Subject, Subject:p</para></entry>
35141 <entry><para>700$9</para></entry>
35143 <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
35147 <entry><para>700$a</para></entry>
35149 <entry><para>Author, Author:p</para></entry>
35153 <entry><para>700$n</para></entry>
35155 <entry><para>Thematic-number</para></entry>
35159 <entry><para>700$r</para></entry>
35161 <entry><para>Music-key</para></entry>
35165 <entry><para>700$t</para></entry>
35167 <entry><para>Author-title, Name-and-title, Title,
35168 Title-uniform</para></entry>
35172 <entry><para>700</para></entry>
35174 <entry><para>Author, Author-name-corporate,
35175 Author-name-personal, Name, Editor, Personal-name</para></entry>
35179 <entry><para>710</para></entry>
35181 <entry><para>Author, Corporate-name</para></entry>
35185 <entry><para>710$t</para></entry>
35187 <entry><para>Author-title, Name-and-title, Title,
35188 Title-uniform</para></entry>
35192 <entry><para>710$a</para></entry>
35194 <entry><para>Name-and-title</para></entry>
35198 <entry><para>710$9</para></entry>
35200 <entry><para>Koha-Auth-Number</para></entry>
35204 <entry><para>710</para></entry>
35206 <entry><para>Author, Name</para></entry>
35210 <entry><para>711$a</para></entry>
35212 <entry><para>Name-and-title</para></entry>
35216 <entry><para>711$t</para></entry>
35218 <entry><para>Author-title, Title, Title-uniform</para></entry>
35222 <entry><para>711$9</para></entry>
35224 <entry><para>Koha-Auth-Number</para></entry>
35228 <entry><para>711</para></entry>
35230 <entry><para>Author-name-corporate, Name,
35231 Conference-name</para></entry>
35235 <entry><para>730$n</para></entry>
35237 <entry><para>Thematic-number</para></entry>
35241 <entry><para>730$r</para></entry>
35243 <entry><para>Music-key</para></entry>
35247 <entry><para>730$9</para></entry>
35249 <entry><para>Koha-Auth-Number</para></entry>
35253 <entry><para>730</para></entry>
35255 <entry><para>Title, Title-uniform</para></entry>
35259 <entry><para>740</para></entry>
35261 <entry><para>Title, Title-other-variant</para></entry>
35265 <entry><para>773$t</para></entry>
35267 <entry><para>Host-item</para></entry>
35271 <entry><para>780$t</para></entry>
35273 <entry><para>Title</para></entry>
35277 <entry><para>780</para></entry>
35279 <entry><para>Title, Title-former,
35280 Related-periodical</para></entry>
35284 <entry><para>785</para></entry>
35286 <entry><para>Related-periodical</para></entry>
35290 <entry><para>800$a</para></entry>
35292 <entry><para>Name-and-title</para></entry>
35296 <entry><para>800$t</para></entry>
35298 <entry><para>Author-title, Name-and-title, Title,
35299 Title-series</para></entry>
35303 <entry><para>800$9</para></entry>
35305 <entry><para>Koha-Auth-Number</para></entry>
35309 <entry><para>800</para></entry>
35311 <entry><para>Author, Author-name-personal, Name,
35312 Personal-name</para></entry>
35316 <entry><para>810$a</para></entry>
35318 <entry><para>Name-and-title</para></entry>
35322 <entry><para>810$t</para></entry>
35324 <entry><para>Author-title, Name-and-title, Title,
35325 Title-series</para></entry>
35329 <entry><para>810$9</para></entry>
35331 <entry><para>Koha-Auth-Number</para></entry>
35335 <entry><para>810</para></entry>
35337 <entry><para>Author, Corporate-name, Author-name-corporate,
35338 Name</para></entry>
35342 <entry><para>811$a</para></entry>
35344 <entry><para>Name-and-title</para></entry>
35348 <entry><para>811$9</para></entry>
35350 <entry><para>Koha-Auth-Number</para></entry>
35354 <entry><para>811$t</para></entry>
35356 <entry><para>Author-title, Name-and-title, Title,
35357 Title-series</para></entry>
35361 <entry><para>811</para></entry>
35363 <entry><para>Author, Author-name-corporate, Name,
35364 Conference-name</para></entry>
35368 <entry><para>830$9</para></entry>
35370 <entry><para>Koha-Auth-Number</para></entry>
35374 <entry><para>830</para></entry>
35376 <entry><para>Title, Title-series</para></entry>
35380 <entry><para>840</para></entry>
35382 <entry><para>Title, Title-series</para></entry>
35386 <entry><para>999$c</para></entry>
35388 <entry><para>Local-Number:n, Local-Number:w,
35389 Local-Number:s</para></entry>
35393 <entry><para>999$d</para></entry>
35395 <entry><para>biblioitemnumber:n, biblioitemnumber:w,
35396 biblioitemnumber:s</para></entry>
35400 <entry><para>942$0</para></entry>
35402 <entry><para>totalissues:n, totalissues:s</para></entry>
35406 <entry><para>942$2</para></entry>
35408 <entry><para>cn-bib-source</para></entry>
35412 <entry><para>942$6</para></entry>
35414 <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
35418 <entry><para>942$c</para></entry>
35420 <entry><para>itemtype:w</para></entry>
35424 <entry><para>942$n</para></entry>
35426 <entry><para>Suppress:w, Suppress:n</para></entry>
35430 <entry><para>942$h</para></entry>
35432 <entry><para>cn-class</para></entry>
35436 <entry><para>942$i</para></entry>
35438 <entry><para>cn-item</para></entry>
35442 <entry><para>942$k</para></entry>
35444 <entry><para>cn-prefix</para></entry>
35448 <entry><para>942$m</para></entry>
35450 <entry><para>cn-suffix</para></entry>
35454 <entry><para>952$0</para></entry>
35456 <entry><para>withdrawn:n, withdrawn:w</para></entry>
35460 <entry><para>952$1</para></entry>
35462 <entry><para>lost, lost:n</para></entry>
35466 <entry><para>952$2</para></entry>
35468 <entry><para>classification-source</para></entry>
35472 <entry><para>952$3</para></entry>
35474 <entry><para>materials-specified</para></entry>
35478 <entry><para>952$4</para></entry>
35480 <entry><para>damaged:n, damaged:w</para></entry>
35484 <entry><para>952$5</para></entry>
35486 <entry><para>restricted:n, restricted:w</para></entry>
35490 <entry><para>952$6</para></entry>
35492 <entry><para>cn-sort:n, cn-sort:s</para></entry>
35496 <entry><para>952$7</para></entry>
35498 <entry><para>notforloan:n, notforloan:w</para></entry>
35502 <entry><para>952$8</para></entry>
35504 <entry><para>ccode</para></entry>
35508 <entry><para>952$9</para></entry>
35510 <entry><para>itemnumber:n, itemnumber:s</para></entry>
35514 <entry><para>952$a</para></entry>
35516 <entry><para>homebranch</para></entry>
35520 <entry><para>952$b</para></entry>
35522 <entry><para>holdingbranch</para></entry>
35526 <entry><para>952$c</para></entry>
35528 <entry><para>location</para></entry>
35532 <entry><para>952$d</para></entry>
35534 <entry><para>Date-of-acquisition, Date-of-acquisition:d,
35535 Date-of-acquisition:s</para></entry>
35539 <entry><para>952$e</para></entry>
35541 <entry><para>acqsource</para></entry>
35545 <entry><para>952$f</para></entry>
35547 <entry><para>coded-location-qualifier</para></entry>
35551 <entry><para>952$g</para></entry>
35553 <entry><para>price</para></entry>
35557 <entry><para>952$j</para></entry>
35559 <entry><para>stack:n, stack:w</para></entry>
35563 <entry><para>952$l</para></entry>
35565 <entry><para>issues:n, issues:w, issues:s</para></entry>
35569 <entry><para>952$m</para></entry>
35571 <entry><para>renewals:n, renewals:w</para></entry>
35575 <entry><para>952$n</para></entry>
35577 <entry><para>reserves:n, reserves:w</para></entry>
35581 <entry><para>952$o</para></entry>
35583 <entry><para>Local-classification:w, Local-classification:p,
35584 Local-classification:s</para></entry>
35588 <entry><para>952$p</para></entry>
35590 <entry><para>barcode, barcode:n</para></entry>
35594 <entry><para>952$q</para></entry>
35596 <entry><para>onloan:n, onloan:w</para></entry>
35600 <entry><para>952$r</para></entry>
35602 <entry><para>datelastseen</para></entry>
35606 <entry><para>952$s</para></entry>
35608 <entry><para>datelastborrowed</para></entry>
35612 <entry><para>952$t</para></entry>
35614 <entry><para>copynumber</para></entry>
35618 <entry><para>952$u</para></entry>
35620 <entry><para>uri:u</para></entry>
35624 <entry><para>952$v</para></entry>
35626 <entry><para>replacementprice</para></entry>
35630 <entry><para>952$w</para></entry>
35632 <entry><para>replacementpricedate</para></entry>
35636 <entry><para>952$y</para></entry>
35638 <entry><para>itype:w</para></entry>
35642 <entry><para>952$z</para></entry>
35644 <entry><para>Note:w, Note:p</para></entry>
35652 <chapter id="aboutkoha">
35653 <title>About Koha</title>
35655 <para>The 'About Koha' area will give you important server information as
35656 well as general information about Koha.</para>
35660 <para><emphasis>Get there:</emphasis> More > About Koha</para>
35664 <section id="aboutserver">
35665 <title>Server Information</title>
35667 <para>Under the 'Server Information' tab you will find information about
35668 the Koha version and the machine you have installed Koha on. This
35669 information is very important for debugging problems. When reporting
35670 issues to your support provider or to the various other support avenues
35671 (mailing lists, chat room, etc), it's always good to give the
35672 information from this screen.</para>
35675 <screeninfo>Server Information on Koha</screeninfo>
35679 <imagedata fileref="images/about/aboutserver.png"/>
35685 <section id="aboutserverperl">
35686 <title>Perl Modules</title>
35688 <para>In order to take advantage of all of the functionalities of Koha,
35689 you will need to keep your Perl modules up to date. The 'Perl Modules'
35690 tab will show you all of the modules required by Koha, the version you
35691 have installed and whether you need to upgrade certain modules.</para>
35694 <screeninfo>Perl Modules</screeninfo>
35698 <imagedata fileref="images/about/aboutperlmodules.png"/>
35703 <para>Items listed in bold are required by Koha, items highlighed in red
35704 are missing completely and items highlighted in yellow simply need to be
35709 <chapter id="implementation">
35710 <title>Implementation Checklist</title>
35712 <para>The following guide will walk you through the areas of Koha you need
35713 to look at in order to prepare to start using the system.</para>
35715 <section id="imp-migration">
35716 <title>Data Migration</title>
35718 <para>Before you can start using Koha you'll need to have some data.
35719 This can be done by entering it all by hand, but most people already
35720 have their data in electronic format of some sort and just need to
35721 reformat it a bit for importing into Koha.</para>
35725 <para>Create a list of libraries and enter their info and codes into
35726 <link linkend="libsgroups">Libraries & Groups</link></para>
35730 <para>Define your list of <link linkend="itemtypeadmin">Item
35731 Types</link></para>
35735 <para>Define you patron categories and enter the categories and
35736 their codes into <link linkend="patcats">Patron
35737 Categories</link></para>
35741 <para>Enter any additional patron information fields you use in your
35742 library in the <link linkend="patronattributetypes">Patron
35743 Attributes</link></para>
35747 <para>Requires that you first set the <link
35748 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
35749 system preference if you have custom fields</para>
35755 <para>Define all of your <link linkend="authorizedvalues">Authorized
35756 Values</link></para>
35760 <para><link linkend="ccode">Collection codes</link></para>
35764 <para><link linkend="shelvelocvals">Shelving
35765 locations</link></para>
35769 <para>Item statuses (<link linkend="lost">lost</link>, <link
35770 linkend="notforloan">not for loan</link>, <link
35771 linkend="restricted">use restrictions</link>)</para>
35775 <para>Plus any others that are needed in your library</para>
35781 <para>Optionally define <link linkend="citytowns">City/Postal
35782 Code</link> combos and <link linkend="roadtypes">Road Types</link>
35783 for patron entry</para>
35787 <para><link linkend="kohamarcmapping">Map your bibliographic
35788 data</link> from your legacy system to Koha fields and migrate
35789 (remembering to use the collection, shelving, item type and library
35790 codes you entered in the above setting areas)</para>
35794 <para><link linkend="patronimport">Map your patron data</link> from
35795 your legacy system to the Koha fields and migrate (remembering to
35796 use the patron and library codes you defined above)</para>
35800 <para>Test your migrated data to be sure that everything is as you
35801 expect it to be, some things to test include:</para>
35805 <para>Check some of your titles with diacritics and make sure
35806 that they migrated properly.</para>
35810 <para>Check titles in a series and make sure that series
35811 information migrated properly.</para>
35815 <para>Make sure that your patrons have their contact information
35816 in the right fields.</para>
35820 <para>If your serials data was migrated search for these records
35821 in the catalog and confirm that they look right.</para>
35825 <para>If your serials data was migrated search for these records
35826 in the serials module and confirm that they look right.</para>
35830 <para>Check marc records to verify a variety of items are
35831 cataloged correctly</para>
35835 <para>Check cataloging process to see if all necessary fields
35836 are available</para>
35840 <para>If fines are migrated, check to see that they are applied
35845 <para>If holds are migrated, check to see they are accurate in
35846 catalog and patron record</para>
35853 <section id="impadmin">
35854 <title>Admin Configuration</title>
35856 <para>Most of these preferences won't need to be changed to use your
35857 Koha system, but there are a few that you might want to
35862 <para>If your library uses CAS Authentication, you'll want to set
35863 the various <link linkend="casauthentication">CAS system
35864 preferences</link></para>
35868 <para>Administration System Preferences</para>
35873 linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
35874 This is the email address that will be used by the system in
35875 'from' lines and to send errors to if there is no email set for
35880 <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
35881 Decide if you want to show item type icons in the staff client
35886 <para><link linkend="delimiter">delimiter</link> : This value
35887 will be put in between fields when exporting data from
35892 <para><link linkend="virtualshelves">virtualshelves</link> :
35893 Decide if you want the staff and/or patrons to use lists in
35898 <para><link linkend="insecure">insecure</link> : If your system
35899 is behind a local firewall, you can set it to no require log in
35900 for the staff client</para>
35904 <para><link linkend="AutoLocation">AutoLocation</link> : Require
35905 staff to log in to the staff client from a specific IP
35911 linkend="IndependantBranches">IndependantBranches</link> :
35912 Prevent librarians from editing content that belongs to other
35919 <para>Go through the <link linkend="logs">Log System
35920 Preferences</link> and decide which actions you want to keep track
35921 of in the logs</para>
35926 <section id="implocal">
35927 <title>Localization Configuration</title>
35929 <para>Koha is used worldwide and so you need to make sure you set your
35930 localization preferences so that options throughout Koha appear properly
35931 for your location/language.</para>
35935 <para>Localization/Internationalization System Preferences</para>
35939 <para><link linkend="dateformat">dateformat</link> : Decide how
35940 dates are displayed throughout Koha</para>
35945 linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
35946 Decide if patrons can choose what language the OPAC appears
35951 <para><link linkend="opaclanguages">opaclanguages</link> :
35952 Decide which languages the patrons can choose from</para>
35958 <para><link linkend="languagepref">language</link> : Decide
35959 which languages appear in the staff client</para>
35964 linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
35965 Define your first day of the week</para>
35972 <section id="impcirc">
35973 <title>Circulation Configuration</title>
35975 <para>Before you start circulating your collection you'll need to set up
35976 your rules and preferences for circulation.</para>
35980 <para>Define you <link linkend="circfinerules">Circulation/Fine
35981 rules</link></para>
35985 <para>Enter the <link linkend="calholidays">days your library is
35986 closed</link> for fines and due date calculations</para>
35990 <para>Circulation System Preferences</para>
35994 <para><link linkend="CircControl">CircControl</link> : Define
35995 whether circ rules are based on item's location, patron's
35996 location or transaction location</para>
36000 <para><link linkend="useDaysMode">useDaysMode</link> : Define
36001 how due dates are calculated</para>
36005 <para><link linkend="finesCalendar">finesCalendar</link> :
36006 Define how fines are calculated (for every late date or only for
36007 days the library is open)</para>
36011 <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> :
36012 Decide if staff are allowed to override due dates on
36018 linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
36019 Decide if items are sent back to the owning branch when checked
36025 linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
36026 : Decide how items checked out today display on the patron
36032 linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
36033 : Decide how items checked out prior to today display on the
36034 patron record</para>
36038 <para><link linkend="noissuescharge">noissuescharge</link> :
36039 Define the maximum amount a patron can owe before checkouts are
36045 linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
36046 if patrons need to return items before their accounts
36051 <para><link linkend="AllowOnShelfHolds">AllowOnShelfHolds</link>
36052 : Decide if patrons can place holds on items that are marked as
36053 being available</para>
36058 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
36059 : Decide if you want the staff to be able to override the
36060 setting for the above at checkout</para>
36067 linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
36068 : Decide if patrons can place holds on items that are marked as
36074 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
36075 : Decide if you want the staff to be able to override the
36076 setting for the above at checkout</para>
36082 <para><link linkend="maxreserves">maxreserves</link> : Decide
36083 how many items a patron can have on hold at once</para>
36088 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
36089 : Decide if you want the staff to be able to override the
36090 setting for the above at checkout</para>
36096 <para><link linkend="maxoutstanding">maxoutstanding</link> :
36097 Define the maximum amount a patron can owe before holds are
36103 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
36104 : Decide if you want the staff to be able to override the
36105 setting for the above at checkout</para>
36112 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
36113 Define the number of days before a hold expires</para>
36117 <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
36118 : Decide if you want to use the built in web-based self-checkout
36124 linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
36125 Decide if the self-checkout system requires login</para>
36130 linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
36131 : Decide if you want patron images to show on the self
36132 checkout screen</para>
36139 linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
36140 : Decide if you want the staff to be able to checkout items
36141 marked as ‘not for loan'</para>
36146 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
36147 : Decide if you want staff to override the limit put on
36152 <para><link linkend="AllowFineOverride">AllowFineOverride</link>
36153 : Decide if you want staff to be able to override fine
36158 <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
36159 : Decide what date renewals are based on</para>
36163 <para><link linkend="finesMode">finesMode</link> : Switch to
36164 ‘Calculate and Charge' before go live if you charge
36169 <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
36170 If you want to receive a copy of every overdue notice sent out,
36171 enter your email address here</para>
36176 linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
36177 : Decide if you want an email every time a hold is placed</para>
36182 linkend="ReservesControlBranch">ReservesControlBranch</link> :
36183 Decide which branch's hold rules are considered first</para>
36187 <para><link linkend="soundon">soundon</link> : Decide if you
36188 want to have sounds on for circulation actions</para>
36193 linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
36194 : If you have a large amount of overdues, you might want to turn
36195 this preference on so as to allow you to filter before results
36201 linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
36202 : If you have a lot of staff members sharing one circ computer
36203 you might want to enable this so that staff can clear the screen
36204 in between checkouts to protect patron's privacy</para>
36209 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
36210 Decide how you want Koha to react if you scan in a blank barcode
36211 on the checkout screen</para>
36216 linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
36217 and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
36218 : Decide if you want patrons and/or staff to be able to suspend
36224 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
36225 : If you allow holds to be suspended decide if you want them
36226 to automatically resume on the date entered by the staff
36227 and/or patron</para>
36235 <para>Customize your <link linkend="notices">Notices &
36236 Slips</link></para>
36240 <para>Define your <link linkend="noticetriggers">Overdue Notice
36241 Triggers</link></para>
36245 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36249 <para>Populate <link linkend="buildholdscron">your holds
36250 queue</link> (every 1-4 hours)</para>
36254 <para>Decide <link linkend="expiredholdscron">when holds
36255 expire</link> (daily)</para>
36259 <para><link linkend="finescronjob">Calculate fines due</link>
36264 <para>Fines on hourly loans will calculate when you check
36265 the items in</para>
36271 <para><link linkend="longoverduecron">Mark long overdue items as
36272 lost</link> (daily)</para>
36276 <para>Decide when the system <link linkend="msgqueuecron">sends
36277 out messages</link> (1-4 hours)</para>
36281 <para>Decide when the system <link
36282 linkend="overduenoticecron">queues overdue notices</link>
36287 <para>Set up <link linkend="printholdcron">hold notices that
36288 didn't send for printing</link> (daily after overdues and
36289 message queue)</para>
36293 <para>Decide when the system <link
36294 linkend="advnoticecron">queues the advanced notice of items
36295 due</link> (daily)</para>
36299 <para>Find holds that need to be <link
36300 linkend="unsuspendholdcron">resumed and remove suspension</link>
36308 <section id="imppratrons">
36309 <title>Patron Configuration</title>
36311 <para>You have already imported patron data from your old system, but
36312 there are plenty of options available to you regarding patrons and their
36317 <para>Enter your <link linkend="addstaffpatron">staff members as
36318 patrons</link></para>
36322 <para>Define <link linkend="patronpermissions">staff members
36323 access permissions</link></para>
36329 <para>Patron System Preferences</para>
36333 <para><link linkend="AddPatronLists">AddPatronLists</link> :
36334 Decide how patron categories appear when creating a new
36339 <para><link linkend="autoMemberNum">autoMemberNum</link> :
36340 Decide if the patrons barcodes are auto-generated or if you
36341 enter them yourself</para>
36345 <para><link linkend="MaxFine">MaxFine</link> : Determine the
36346 maximum amount that people can owe in fines</para>
36351 linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
36352 : Decide when to warn staff that the patron account is about to
36358 linkend="intranetreadinghistory">intranetreadinghistory</link> :
36359 Decide if the staff can see the patron's reading/checkout
36365 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
36366 List fields that you want to appear as mandatory on the patron
36367 add/edit form</para>
36371 <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
36372 Add or change the titles for your patrons</para>
36377 linkend="borrowerRelationship">borrowerRelationship</link> : Add
36378 or change borrower relationships (child to adult and
36379 professional to organization)</para>
36384 linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
36385 : Determine if the patrons get an email confirming the creation
36386 of their account</para>
36391 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
36392 : Decide if patrons can choose from a series of notices (other
36393 than overdues)</para>
36397 <para><link linkend="patronimages">patronimages</link> : Decide
36398 if you want to save patron images in your system</para>
36403 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
36404 : Decide if you want to enable custom patron fields</para>
36408 <para><link linkend="minPasswordLength">minPasswordLength</link>
36409 : Enter the minimum number of characters you want passwords to
36415 linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
36416 Decide what fields your library doesn't need to see on the
36417 patron entry form</para>
36424 <section id="impcatalog">
36425 <title>Cataloging Configuration</title>
36427 <para>Before you start cataloging in Koha you'll want to set up your
36428 preferences and other rules.</para>
36432 <para>Define your cataloging templates aka <link
36433 linkend="marcbibframeworks">MARC Bibliographic
36434 Frameworks</link></para>
36438 <para>Run the <link linkend="marcbibframeworkstest">MARC
36439 Bibliographic Framework Test</link> to be sure your changes are
36446 <para>Define any <link linkend="authorizedvalues">authorized
36447 values</link> you might want to use in cataloging</para>
36451 <para>Set up <link linkend="classificationsources">custom
36452 classification sources</link> (if you use something other than the
36457 <para>Set up <link linkend="recordmatchingrules">MARC matching
36458 rules</link> for importing records from mrc files or z39.50</para>
36462 <para>Set up <link linkend="keywordmapping">Koha to Keyword
36463 mapping</link> for deciding how to display marc fields to the screen
36464 (still in beta - only one field)</para>
36468 <para>Set up the <link linkend="z3950admin">z39.50 targets</link>
36469 you want to search for cataloging (and acquisitions)</para>
36473 <para>Cataloging System Preferences</para>
36477 <para><link linkend="URLLinkText">URLLinkText</link> : Enter
36478 text to display when 856 fields do not have pre-defined
36483 <para><link linkend="hide_marc">hide_marc</link> : If you are
36484 unfamiliar with MARC you can have the MARC fields number
36489 <para><link linkend="LabelMARCView">LabelMARCView</link> :
36490 Choose how you want duplicate fields to appear on the
36496 linkend="DefaultClassificationSource">DefaultClassificationSource</link>
36497 : Choose which classification source is the default in your
36503 linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
36504 if you need labels to appear on your MARC editor</para>
36508 <para><link linkend="marcflavour">marcflavour</link> : Choose
36509 your MARC format</para>
36513 <para><link linkend="itemcallnumber">itemcallnumber</link> :
36514 Enter which field and subfields to look into for the call
36519 <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
36520 your MARC Organizational Code (not the same as your OCLC
36525 <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
36526 Koha generates item barcodes for you</para>
36530 <para><link linkend="OpacSuppression">OpacSuppression</link> :
36531 Decide if you want to hide items marked as suppressed from the
36532 OPAC search results</para>
36538 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36542 <para>Decide when the system <link linkend="checkurlcron">checks
36543 URLs in catalog records</link> to see if they are still
36551 <section id="impauthorities">
36552 <title>Authorities Configuration</title>
36554 <para>Koha has the ability to keep track of your authority records and
36555 how they're linked to your bibliographic records. Before using
36556 authorities you should configure several preferences.</para>
36560 <para>Set <link linkend="authoritiesadmin">Authority
36561 Frameworks</link> aka templates</para>
36565 <para>Authority System Preferences</para>
36570 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
36571 Decide if Koha creates authorities when cataloging</para>
36575 <para><link linkend="dontmerge">dontmerge</link> : Decide if
36576 updates to authorities trigger updates to the bibliographic
36577 records that link to them</para>
36582 linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
36583 Decide when authorities are created</para>
36587 <para><link linkend="LinkerModule">LinkerModule</link> : Decide
36588 which match the authority linker should use</para>
36592 <para><link linkend="LinkerOptions">LinkerOptions</link> :
36593 Decide if you want authority linking to be broader or more
36599 linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
36600 Decide if you want to enable authority linking while
36607 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36611 <para>Choose when the system looks for authorities updates to
36612 <link linkend="mergeauthcron">merge changes into bibliographic
36613 records</link></para>
36620 <section id="impsearching">
36621 <title>Searching Configuration</title>
36623 <para>There are several system preferences related to searching, it is
36624 not always recommended to make too many changes to these preferences
36625 since they are set to get you the most relevant results. If you would
36626 like to change the default way that Koha handles searching, view the
36627 <link linkend="searchingprefs">Searching system preferences</link>
36632 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36636 <para>Decide how often your <link
36637 linkend="rebuildsearchcron">system rebuilds the search
36638 index</link> (4-10 min)</para>
36644 <para>Searching System Preferences</para>
36649 linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> :
36650 Decide which authorized value fields you want patrons and staff
36651 to be able to limit their advanced searches by</para>
36656 linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
36657 : Decide how you want Koha to handle subject searches in the
36663 linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
36664 : Decide how you want Koha to handle subject searches in the
36670 linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
36671 : Decide how you want Koha to handle subject searches in the
36678 <para><link linkend="displayFacetCount">displayFacetCount</link>
36679 : Decide whether to show facet counts on search results</para>
36686 <section id="impopac">
36687 <title>OPAC Configuration</title>
36689 <para>There are a lot of ways you can customize your OPAC in
36694 <para>Decide how you want your OPAC to look & what content you
36695 want on the main page</para>
36699 <para>Create a library branded stylesheet using CSS</para>
36704 <para>Do not edit the default CSS files, instead create a new
36705 one, that way the system can always fall back on the original
36713 <para>Create a custom XSLT stylesheet to change the way search
36714 results and bib records appear in the OPAC</para>
36718 <para>OPAC System preferences</para>
36722 <para><link linkend="opacuserlogin">opacuserlogin</link> :
36723 Decide if you want to allow patrons to login to the OPAC to
36724 access customized functionality (searching will be allowed
36725 without logging in)</para>
36729 <para><link linkend="RequestOnOpac">RequestOnOpac</link> :
36730 Decide if patrons can place holds via the OPAC</para>
36734 <para><link linkend="OPACItemHolds">OPACItemHolds</link> :
36735 Decide if patrons can place holds on specific items (instead
36736 of just the next available item)</para>
36741 linkend="OpacPasswordChange">OpacPasswordChange</link> :
36742 Decide if patrons can change their password (don't allow
36743 this if you're using LDAP)</para>
36748 linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> :
36749 Decide if patrons can renew their checked out items via the
36755 linkend="opacreadinghistory">opacreadinghistory</link> :
36756 Decide if patrons can view their reading/checkout history
36757 via the OPAC</para>
36761 <para><link linkend="reviewson">reviewson</link> : Decide if
36762 you want to allow patrons to comment on bib records via the
36767 <para><link linkend="OpacStarRatings">OpacStarRatings</link>
36768 : Decide if patrons can leave star ratings</para>
36772 <para><link linkend="virtualshelves">virtualshelves</link> :
36773 Decide if you want patrons to be able to create Lists</para>
36778 linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
36779 : If patrons can create lists then decide if they are
36780 allowed to create public lists</para>
36784 <para><link linkend="suggestionspref">suggestion</link> :
36785 Decide if you want patrons to be able to submit purchase
36791 linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
36792 : Decide if you want patrons to be able to see purchase
36793 suggestions made by other patrons</para>
36799 <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
36800 patrons can save items into their cart</para>
36804 <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
36805 Decide if you want non logged in users to be able to make
36806 purchase suggestions</para>
36811 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> :
36812 Decide if you want to use the XSLT stylesheets on the OPAC
36813 search results</para>
36818 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> :
36819 Decide if you want to use the XSLT stylesheets on the bib
36820 records in the OPAC</para>
36824 <para><link linkend="LibraryName">LibraryName</link> : Enter
36825 your library name for display in the <title> tag and on
36826 the top of the OPAC</para>
36830 <para><link linkend="opacsmallimage">opacsmallimage</link> :
36831 Choose a logo to replace the Koha logo</para>
36835 <para><link linkend="opaccredits">opaccredits</link> : Enter
36836 HTML to appear at the bottom of every page in the OPAC</para>
36840 <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
36841 : Enter HTML that will appear in the center of the main OPAC
36846 <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
36847 will appear to the left on the main OPAC page</para>
36851 <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
36852 HTML that will appear below OpacNav</para>
36856 <para><link linkend="opacheader">opacheader</link> : Enter the
36857 HTML that will appear above the search box on the OPAC</para>
36862 linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
36863 the HTML that will appear when no results are found</para>
36868 linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
36869 the HTML that will appear below the facets on your search
36874 <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
36875 : Enter the HTML that will appear in the far right of the
36876 circulation summary in the OPAC</para>
36880 <para>Customize your stylesheets:</para>
36884 <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
36885 any additional fields you want to define styles for</para>
36890 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
36891 Point to a CSS file on your Koha server</para>
36895 <para><link linkend="opacstylesheet">opacstylesheet</link> :
36896 If you have a custom CSS enter the link to that file</para>
36901 linkend="opaccolorstylesheet">opaccolorstylesheet</link> :
36902 Point to a CSS file on your Koha server</para>
36909 linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
36910 Decide if you want search terms to be highlighted on the search
36915 <para><link linkend="hidelostitems">hidelostitems</link> :
36916 Decide if you want to show patrons items you have marked as
36921 <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
36922 : Decide what view is the default for bib records on the
36927 <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> :
36928 Decide if you want to enable the shelf browse
36929 functionality</para>
36934 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
36935 Decide if URLs clicked in the OPAC are opened in a new
36941 linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
36942 you have a multi-branch system decide if you want patrons to
36943 search their library first</para>
36947 <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
36948 Decide if you want patrons to be able to search your authority
36953 <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if
36954 you want patrons to browse your authority file</para>
36959 linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
36960 Choose which libraries you want patrons to be able to re-run
36961 their search in</para>
36966 linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
36967 : If you're a multi-branch system you can add a pull down to the
36968 search bar for patrons to search which library to search</para>
36973 linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
36974 : Decide if you want the system to keep a search history</para>
36980 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36984 <para>If you have the <link
36985 linkend="OpacBrowser">OpacBrowser</link> preference set decide
36986 <link linkend="authbrowsercron">when you want the contents to
36987 rebuild</link></para>
36991 <para>If you have <link linkend="customrss">custom RSS
36992 feeds</link>, decide when you want the <link
36993 linkend="customrssfeedcron">feed to be populated</link></para>
36999 <section id="editableopac">
37000 <title>Editable OPAC Regions</title>
37002 <para>Using the OPAC system preferences you can customize various
37003 regions, the following graphics will define what preferences update
37004 each regions.</para>
37007 <screeninfo>OPAC Editable Regions</screeninfo>
37011 <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
37016 <para>An example of a way to customize the page is included as
37020 <screeninfo>Customized Koha OPAC</screeninfo>
37024 <imagedata fileref="images/appendix-opac/opaccustomregions-customized.jpg"/>
37031 <section id="impenhanced">
37032 <title>Enhanced Content Configuration</title>
37034 <para>Koha allows you to pull in content from outside sources to enhance
37035 your bib records. All of this content can be toggled on and off using
37036 the enhanced content system preferences.</para>
37040 <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
37044 <para>If you would like to have your OPAC and/or staff client
37045 show an 'Editions' tab on the bib record, you want to enable one
37046 or the other FRBR preferences and then either one or both of the
37047 ISBN services (XISBN and ThingISBN).</para>
37053 <para><link linkend="amazonprefs">Amazon</link> : This service is
37054 free and just requires that you visit <ulink
37055 url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
37060 <para>Using the Amazon preferences you can choose to show
37061 different types of content from Amazon. Before choosing which
37062 types of content you would like to display you will need to
37063 enable Amazon content for the staff client and/or the
37071 linkend="Babelthequeprefs">Babelthèque</link></para>
37075 <para>This is a pay service. Contact Babelthèque to learn
37076 how to enable this content in the OPAC.</para>
37082 <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
37086 <para>This is a pay service from Baker & Taylor. Contact
37087 Baker & Taylor for the information to enter into these
37088 preferences.</para>
37094 <para><link linkend="googleprefs">Google</link></para>
37098 <para>This service is free and does not require registration,
37099 simply enable GoogleJackets and you're set to go.</para>
37105 <para><link linkend="librarythingprefs">LibraryThing</link></para>
37109 <para>With the exception of ThingISBN, you will need to contact
37110 LibraryThing for the information to enter into these
37115 <para>Enabling ThingISBN will help to populate the editions tab
37116 on the bib record display if you have enabled FRBR.</para>
37122 <para><link linkend="novelistselect">Novelist</link></para>
37126 <para>This is a pay service from Ebsco. Contact Ebsco for the
37127 information to enter into these preferences</para>
37133 <para><link linkend="oclcprefs">OCLC</link></para>
37137 <para>XISBN is used to populate the editions tab on the bib
37138 record display if you have enabled FRBR. This service is free
37139 for up to 999 queries a day.</para>
37145 <para><link linkend="Syndeticsprefs">Syndetics</link></para>
37149 <para>This is a pay service from Syndetics to add content for
37150 your bib records. Contact Syndetics for the information to enter
37151 into these preferences.</para>
37157 <para><link linkend="taggingprefs">Tagging</link></para>
37161 <para>Choose whether or not you want to allow patrons to add
37162 tags to records in Koha.</para>
37169 <section id="impacq">
37170 <title>Acquisitions Configuration</title>
37172 <para>When using acquisitions in Koha you first need to define some
37177 <para>Set up your <link linkend="budgetplanning">funds &
37178 budgets</link></para>
37182 <para>Choose your <link linkend="currexchangeadmin">default
37183 currency</link> and enter others if you order from multiple
37188 <para>Enter in your <link linkend="acqvendors">vendor
37189 information</link></para>
37193 <para>Create an <link linkend="marcbibframeworks">Framework with the
37194 code ACQ</link> (if you're going to enter item records at the time
37195 of ordering or receiving)</para>
37199 <para>Acquisitions System preferences</para>
37203 <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
37204 Decide if an item record is created during acquisition</para>
37208 <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
37209 Decide how you want monetary amounts to display</para>
37213 <para><link linkend="gist">gist</link> : Enter your sales tax
37214 (if you are billed for tax)</para>
37218 <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
37219 Decide what format you want your print orders to use</para>
37226 <section id="impserials">
37227 <title>Serials Configuration</title>
37229 <para>When you use serials there are a few options you can set before
37234 <para>Serials System Preferences</para>
37239 linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
37240 : Decide if you want renewing serials to add a suggestion for
37241 easy purchasing</para>
37245 <para><link linkend="RoutingSerials">RoutingSerials</link> :
37246 Decide if you want to route serials around your library</para>
37251 linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
37252 Decide if holds are placed on serials when there is a routing
37253 list in place</para>
37259 <para>Cataloging System Preferences</para>
37264 linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
37265 : Decide how many of the most recent issues to display in the
37266 staff client</para>
37271 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
37272 : Decide how many of the most recent issues to display in the
37278 linkend="SubscriptionHistory">SubscriptionHistory</link> :
37279 Decide how you want the subscription information to display in
37287 <section id="impgolive">
37288 <title>Planning for Go-Live</title>
37290 <para>Once you have all of your settings ready, you need to prepare for
37291 making your system live:</para>
37295 <para>Decide if you need training by an outside service or if your
37296 staff can do the training themselves.</para>
37300 <para>Make sure that there is time for your staff to play with your
37301 test system and get comfortable with it</para>
37305 <para>If this is a migration, work with your previous company to
37306 extract data right before you go live</para>
37310 <para>Come up with URLs for your new Koha OPAC & Staff
37315 <para>Make sure that if you're hosting your own system you have a
37322 <chapter id="sopac">
37323 <title>SOPAC2 Installation</title>
37325 <section id="sopac2">
37328 <firstname>Jean-André</firstname>
37330 <surname>Santoni</surname>
37333 <orgname>BibLibre</orgname>
37337 <pubdate>August 2009</pubdate>
37339 <othercredit role="translator">
37340 <firstname>Nicole C.</firstname>
37342 <surname>Engard</surname>
37344 <contrib>Translation</contrib>
37348 <title>SOPAC2 Introduction</title>
37351 <para>The following documentation was translated using Google
37352 Translate from French to English and may have some language
37357 <section id="sopacintro">
37358 <title>Introduction</title>
37360 <para>This is an installation guide and the connector SOPAC2 Koha. It
37361 has been tested on Debian Lenny and Ubuntu Jaunty, with 6.12 and Koha
37362 Drupal 3.0.x It does not cover the installation of Koha and Drupal, but
37363 SOPAC, its dependencies and the connector.</para>
37366 <section id="sopacinstall">
37367 <title>Installation of Locum and Insurge</title>
37369 <para>Locum and Insurge are the two libraries used primarily by SOPAC.
37370 They serve as a layer of abstraction to the data. Insurge manages the
37371 social aspect (tags, reviews, ratings), while Locum manages the
37372 connection to the ILS via the connector. Both libraries use a different
37373 database from that of Drupal.</para>
37375 <section id="sopacdepend">
37376 <title>Dependencies</title>
37378 <para>There are no packages for Debian MDB2 yet, you can install it
37381 <programlisting># apt-get install php-pear
37382 # pear install MDB2
37383 # pear install MDB2#mysql</programlisting>
37386 <section id="sopacdownload">
37387 <title>Download</title>
37389 <para>Download the Locum and Insurge libraries from SVN:</para>
37391 <programlisting># cd /usr/local/lib
37392 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
37393 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
37396 <section id="sopaccreatedb">
37397 <title>Creation of the Database</title>
37399 <programlisting>$ mysql -u root
37400 mysql> create database scas;
37401 mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
37402 mysql> flush privileges;
37403 mysql> exit</programlisting>
37406 <section id="sopacdsn">
37407 <title>Sync DSN</title>
37409 <para>This file will provide the connection information to a DB
37412 <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
37414 <para>It should contain:</para>
37416 <programlisting><?php
37417 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
37420 <section id="sopacinstallinsurge">
37421 <title>Installation of Insurge</title>
37423 <para>If you customize the name of the database, consider editing the
37426 <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
37428 <para>Import Insurge:</para>
37430 <programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
37432 <para>Configure Insurge:</para>
37434 <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
37436 <para>The variables in insurge.ini are empty. The default values are
37437 too long and cause MySQL errors.</para>
37439 <para>Here is a sample of insurge.ini</para>
37441 <programlisting>; This is the Locum configuration file
37442 ; General configuration options for your installation of Insurge.
37444 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
37445 ; This is where you configure your repository membership information.
37447 ; parent_server is the server name of the repository parent server you have been
37449 ; group_id = The group ID you have been given by your repository admin.
37450 ; These configuration points are OPTIONAL and are only necessary if you are
37451 ; participating in a repository relationship.
37455 group_key = ""</programlisting>
37458 <section id="sopacinstallocum">
37459 <title>Installation of Locum</title>
37461 <para>The same procedure applies to Locum</para>
37463 <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
37464 # mysql < /usr/local/lib/locum/sql/scas_locum.sql
37465 # nano /usr/local/lib/locum/sql/locum_init.sql
37466 # mysql < /usr/local/lib/locum/sql/locum_init.sql
37467 # nano /usr/local/lib/locum/config/locum.ini
37468 # mkdir /usr/local/var
37469 # mkdir /usr/local/var/log</programlisting>
37471 <para>Configure the DSN:</para>
37473 <programlisting>[locum_config]
37474 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
37476 <para>And the coordinates of your Koha installation:</para>
37478 <programlisting>[ils_config]
37480 ils_version = "30x"
37481 ils_server = "localhost"
37482 ils_harvest_port = "80"</programlisting>
37484 <para>The rest depends on your configuration of Koha.</para>
37488 <section id="sopackoha">
37489 <title>Installation of Koha Connector</title>
37491 <para>Enter the connector Koha from SVN:</para>
37493 <programlisting># cd /usr/local/lib/locum/connectors/
37494 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
37497 <section id="sopacharvest">
37498 <title>Harvest Records</title>
37500 <para>Now that the connector is in place, we will be able to launch
37501 harvest.php, a tool that will reap Locum DB Koha and fill the
37504 <para>Start by configuring harvest.php:</para>
37506 <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
37508 <para>Here are the variables you must change:</para>
37510 <programlisting>$first_record = 1;
37511 $last_record = 30;</programlisting>
37513 <para>These are the minimum and maximum biblionumbers from your Koha
37516 <para>Then start the harvest:</para>
37518 <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
37519 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
37522 <section id="sopacphinx">
37523 <title>Installation of Sphinx</title>
37525 <para>Sphinx is the indexer for the database used by Locum and
37528 <section id="sphinxdepend">
37529 <title>Dependencies</title>
37531 <para>There is no Debian package for Sphinx so you'll have to compile
37532 the source directly:</para>
37534 <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
37537 <section id="sphinxdownload">
37538 <title>Download and Compile</title>
37540 <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
37541 $ tar zxvf sphinx-0.9.8.tar.gz
37543 $ ./configure --prefix=/usr/local/sphinx
37546 # mkdir /usr/local/sphinx
37547 # mkdir /usr/local/sphinx/lib
37548 # cp api/sphinxapi.php /usr/local/sphinx/lib/
37549 $ rm -R sphinx-0.9.8*</programlisting>
37552 <section id="sphinxuser">
37553 <title>Creation of User and Group</title>
37555 <para>Creating a Sphinx user and change the owner:</para>
37557 <programlisting># adduser sphinx
37559 # usermod -G sphinx sphinx
37560 # mkdir /usr/local/sphinx/var/run
37561 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
37564 <section id="demonsphinx">
37565 <title>The demon Sphinx</title>
37567 <para>Download:</para>
37569 <programlisting># cd /etc/init.d
37570 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
37571 # chmod +x /etc/init.d/sphinx</programlisting>
37573 <para>Add Sphinx in the service at boot:</para>
37575 <programlisting># update-rc.d sphinx defaults</programlisting>
37578 <section id="sphinxconfig">
37579 <title>Configuration</title>
37581 <para>Copy the configuration file supplied with the source of Sphinx
37582 before the change:</para>
37584 <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
37585 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
37586 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
37587 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
37589 <para>And if you personalize the name of the BDD:</para>
37591 <programlisting># sed 's/scas/Ma_BDD/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
37594 <section id="sphinxindexing">
37595 <title>Indexing documents</title>
37597 <para>Indexing is necessary if you want to use the search features of
37600 <para>You must first complete the Insurge table index</para>
37602 <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
37603 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
37605 <para>Then start indexing Sphinx</para>
37607 <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
37609 <para>Finally, we must start the demon:</para>
37611 <programlisting># /etc/init.d/sphinx start</programlisting>
37613 <para>When the demon is already en route, you can update the index
37616 <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
37620 <section id="installsopac">
37621 <title>Installation of SOPAC2</title>
37623 <para>Now to the SOPAC software itself:</para>
37625 <section id="downloadsopac">
37626 <title>Download</title>
37628 <para>Download from SVN:</para>
37630 <programlisting>$ cd /chemin/vers/drupal/sites/all/
37633 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
37636 <section id="sopacinstallation">
37637 <title>Installation</title>
37639 <para>Going in the administration of Drupal to activate the module.
37640 Enable also the dependencies:</para>
37644 <para>Profile</para>
37648 <para>PHP Filter</para>
37656 <para>The Drupal menu should now list these entries.</para>
37659 <section id="configsopac">
37660 <title>Configuration</title>
37662 <para>Then go into the settings of SOPAC.</para>
37666 <para>Configure the paths to the Locum and Insurge
37671 <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
37672 with content like:</para>
37676 <programlisting><?php
37677 print sopac_search_form('both');
37678 print theme('pages_catalog');</programlisting>
37682 <para>Check the Input Format "PHP Code"</para>
37686 <para>Check Move to front page</para>
37690 <para>In URL path settings, set the SOPAC URL prefix you have
37695 <para>Go to the root of Drupal, a search form will appear.</para>
37697 <para>Thinking to empty the cache of Drupal when something does not
37700 <para>Drupal offers a few blocks, not configured by default. Must
37701 specify on which page they should appear.</para>
37706 <chapter id="cronjobsch">
37707 <title>Cron Jobs</title>
37711 <section id="cronjobs">
37712 <title>Cron Jobs</title>
37714 <para>The locations below assume a dev install which puts the crons in
37715 misc/, if you have a standard install you may want to look in bin/ for
37716 these files if you cannot find them in misc/</para>
37718 <section id="searchcron">
37719 <title>Search</title>
37723 <section id="rebuildsearchcron">
37724 <title>Rebuild Index</title>
37726 <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
37728 <para>Does: Updates Zebra indexes with recently changed data.</para>
37730 <para>Required by: Zebra</para>
37732 <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
37733 depending on performance needs</para>
37737 <section id="circcron">
37738 <title>Circulation</title>
37740 <section id="buildholdscron">
37741 <title>Holds Queue</title>
37743 <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
37745 <para>Does: Updates holds queue report</para>
37747 <para>Required by: <link linkend="holdsqueue">Holds Queue
37748 Report</link></para>
37750 <para>Frequency suggestion: every 1-4 hours</para>
37752 <para>Description:</para>
37756 <para>A script that should be run periodically if your library
37757 system allows borrowers to place on-shelf holds. This script
37758 decides which library should be responsible for fulfilling a
37759 given hold request.</para>
37761 <para>It's behavior is controlled by the system preferences
37762 <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
37764 linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
37766 <para>If you do not want all of your libraries to participate in
37767 the on-shelf holds fulfillment process, you should list the the
37768 libraries that *do* participate in the process here by inputting
37769 all the participating library's branchcodes, separated by commas
37770 ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
37772 <para>By default, the holds queue will be generated such that
37773 the system will first attempt to hold fulfillment using items
37774 already at the pickup library if possible. If there are no items
37775 available at the pickup library to fill a hold,
37776 build_holds_queue.pl will then use the list of libraries defined
37777 in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
37778 disabled ( which it is by default ), the script will assign
37779 fulfillment requests in the order the branches are placed in the
37780 StaticHoldsQueueWeight system preference.</para>
37782 <para>For example, if your system has three libraries, of
37783 varying sizes ( small, medium and large ) and you want the
37784 burden of holds fulfillment to be on larger libraries before
37785 smaller libraries, you would want StaticHoldsQueueWeight to look
37786 something like "LRG,MED,SML".</para>
37788 <para>If you want the burden of holds fulfillment to be spread
37789 out equally throughout your library system, simply enable
37790 RandomizeHoldsQueueWeight. When this system preference is
37791 enabled, the order in which libraries will be requested to
37792 fulfill an on-shelf hold will be randomized each time the list
37793 is regenerated.</para>
37795 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
37796 this time. Doing so will cause the build_holds_queue script to
37797 ignore RandomizeHoldsQueueWeight, causing the script to request
37798 hold fulfillment not randomly, but by alphabetical order.</para>
37802 <section id="buildholdscronperl">
37803 <title>Perl Documentation</title>
37806 role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
37808 <para>my $biblionumber_aref =
37809 GetBibsWithPendingHoldRequests();</para>
37811 <para>Return an arrayref of the biblionumbers of all bibs that
37812 have one or more unfilled hold requests.</para>
37815 role="bold">GetPendingHoldRequestsForBib</emphasis></para>
37817 <para>my $requests =
37818 GetPendingHoldRequestsForBib($biblionumber);</para>
37820 <para>Returns an arrayref of hashrefs to pending, unfilled hold
37823 <para>the bib identified by $biblionumber. The following keys are
37824 present in each hashref:</para>
37828 <para>biblionumber</para>
37832 <para>borrowernumber</para>
37836 <para>itemnumber</para>
37840 <para>priority</para>
37844 <para>branchcode</para>
37848 <para>reservedate</para>
37852 <para>reservenotes</para>
37856 <para>borrowerbranch</para>
37860 <para>The arrayref is sorted in order of increasing
37864 role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
37866 <para>my $available_items =</para>
37868 <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
37870 <para>Returns an arrayref of items available to fill hold requests
37871 for the bib identified by $biblionumber. An item is available to
37874 <para>request if and only if:</para>
37878 <para>it is not on loan</para>
37882 <para>it is not withdrawn</para>
37886 <para>it is not marked notforloan</para>
37890 <para>it is not currently in transit</para>
37894 <para>it is not lost</para>
37898 <para>it is not sitting on the hold shelf</para>
37903 role="bold">MapItemsToHoldRequests</emphasis></para>
37905 <para>MapItemsToHoldRequests($hold_requests,
37906 $available_items);</para>
37909 role="bold">CreatePickListFromItemMap</emphasis></para>
37911 <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
37914 role="bold">_get_branches_to_pull_from</emphasis></para>
37916 <para>Query system preferences to get ordered list of branches to
37917 use to fill hold requests.</para>
37921 <section id="expiredholdscron">
37922 <title>Expired Holds</title>
37925 misc/cronjobs/holds/cancel_expired_holds.pl</para>
37927 <para>Does: By default, this cron job will only automatically cancel
37928 holds where the user has set an expiration date. If the library is
37930 linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
37932 linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
37933 preferences then this script will also cancel holds that have been
37934 sitting on the hold shelf for too long and will (if the library
37935 does) charge the patron for not picking up the hold.</para>
37937 <para>Frequency suggestion: daily</para>
37940 <section id="unsuspendholdcron">
37941 <title>Unsuspend Holds</title>
37944 misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
37946 <para>Does: This script checks to find holds that should no longer
37947 be suspended and removes the suspension if the <link
37948 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
37949 preference is set to 'allow'. This puts the patron back in to the
37950 queue where they were when the hold was suspended.</para>
37952 <para>Frequency suggestion: daily</para>
37955 <section id="finescronjob">
37956 <title>Fines</title>
37958 <para>Script path: misc/cronjobs/fines.pl</para>
37960 <para>Required by: <link linkend="finesMode">finesMode</link> system
37963 <para>Frequency suggestion: nightly</para>
37966 <section id="longoverduecron">
37967 <title>Long Overdues</title>
37969 <para>Script path: misc/cronjobs/longoverdue.pl</para>
37971 <para>Does: allows one to specify delays for changing items to
37972 different lost statuses, and optionally charge for them.</para>
37974 <para>Frequency suggestion: nightly</para>
37976 <section id="longoverduecronperl">
37977 <title>Perl Documentation</title>
37979 <para><emphasis role="bold">NAME</emphasis></para>
37981 <para>longoverdue.pl cron script to set lost statuses on overdue
37982 materials. Execute without options for help.</para>
37987 <section id="noticescron">
37988 <title>Notices</title>
37992 <section id="msgqueuecron">
37993 <title>Message Queue</title>
37995 <para>Script path: misc/cronjobs/process_message_queue.pl</para>
37997 <para>Does: processes the message queue to send emails and SMS
37998 messages to users. sends outgoing emails to patrons.</para>
38000 <para>Frequency suggestion: 1-4 hours</para>
38003 <section id="advnoticecron">
38004 <title>Advanced Notice</title>
38006 <para>Script path: misc/cronjobs/advance_notices.pl</para>
38008 <para>Does: prepares "pre-due" notices and "item due" notices for
38009 patrons who request them prepares notices for patrons for items just
38010 due or coming due soon. requires <link
38011 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
38014 <para>Frequency suggestion: nightly</para>
38017 <para>This script does not actually send the notices. It queues
38018 them in the <link linkend="msgqueuecron">message queue</link> for
38022 <section id="advnoticecronperl">
38023 <title>Perl Documentation</title>
38025 <para><emphasis role="bold">NAME</emphasis></para>
38027 <para>advance_notices.pl - cron script to put item due reminders
38028 into message queue</para>
38030 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
38032 <para>./advance_notices.pl -c</para>
38034 <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
38036 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
38038 <para>This script prepares pre-due and item due reminders to be
38039 sent to patrons. It queues them in the message queue, which is
38040 processed by the process_message_queue.pl cronjob. The type and
38041 timing of the messages can be configured by the patrons in their
38042 "My Alerts" tab in the OPAC.</para>
38044 <para><emphasis role="bold">METHODS</emphasis></para>
38046 <para>parse_letter</para>
38050 <section id="overduenoticecron">
38051 <title>Overdue Notice</title>
38053 <para>Script path: misc/cronjobs/overdue_notices.pl</para>
38055 <para>Does: prepares messages to alert patrons of overdue messages
38056 (both via email and print)</para>
38058 <para>Frequency suggestion: nightly</para>
38061 <para>This script does not actually send the notices. It queues
38062 them in the <link linkend="msgqueuecron">message queue</link> for
38063 later or generates the HTML for later printing</para>
38066 <section id="overduenoticecronperl">
38067 <title>Perl Documentation</title>
38069 <para><emphasis role="bold">NAME</emphasis></para>
38071 <para>overdue_notices.pl - prepare messages to be sent to patrons
38072 for overdue items</para>
38074 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
38076 <para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
38077 -library <branchcode>...] [ -max <number of days> ] [
38078 -csv [ <filename> ] ] [-itemscontent <field list>
38081 <para>Options:</para>
38083 <para>-help brief help message</para>
38085 <para>-man full documentation</para>
38087 <para>-n No email will be sent</para>
38089 <para>-max <days> maximum days overdue to deal with</para>
38091 <para>-library <branchname> only deal with overdues from
38092 this library (repeatable : several libraries can be given)</para>
38094 <para>-csv <filename> populate CSV file</para>
38096 <para>-html <filename> Output html to file</para>
38098 <para>-itemscontent <list of fields> item information in
38101 <para>-borcat <categorycode> category code that must be
38104 <para>-borcatout <categorycode> category code that must be
38107 <para><emphasis role="bold">OPTIONS</emphasis></para>
38109 <para>-help Print a brief help message and exits.</para>
38111 <para>-man Prints the manual page and exits.</para>
38113 <para>-v Verbose. Without this flag set, only fatal errors are
38116 <para>-n Do not send any email. Overdue notices that would have
38117 been sent to the patrons or to the admin are printed to standard
38118 out. CSV data (if the -csv flag is set) is written to standard out
38119 or to any csv filename given.</para>
38121 <para>-max Items older than max days are assumed to be handled
38122 somewhere else, probably the longoverdues.pl script. They are
38123 therefore ignored by this program. No notices are sent for them,
38124 and they are not added to any CSV files. Defaults to 90 to match
38125 longoverdues.pl.</para>
38127 <para>-library</para>
38129 <para>select overdues for one specific library. Use the value in
38130 the branches.branchcode table. This option can be repeated in
38131 order to select overdues for a group of libraries.</para>
38133 <para>-csv Produces CSV data. if -n (no mail) flag is set, then
38134 this CSV data is sent to standard out or to a filename if
38135 provided. Otherwise, only overdues that could not be emailed are
38136 sent in CSV format to the admin.</para>
38138 <para>-itemscontent</para>
38140 <para>comma separated list of fields that get substituted into
38141 templates in places of the <<items.content>>
38142 placeholder. This defaults to
38143 issuedate,title,barcode,author</para>
38145 <para>Other possible values come from fields in the biblios,
38146 items, and issues tables.</para>
38148 <para>-borcat Repetable field, that permit to select only few of
38149 patrons categories.</para>
38151 <para>-borcatout</para>
38153 <para>Repetable field, permis to exclude some patrons
38156 <para>-t | --triggered</para>
38158 <para>This option causes a notice to be generated if and only if
38159 an item is overdue by the number of days defined in a notice
38162 <para>By default, a notice is sent each time the script runs,
38163 which is suitable for less frequent run cron script, but requires
38164 syncing notice triggers with the cron schedule to ensure proper
38165 behavior. Add the --triggered option for daily cron, at the risk
38166 of no notice being generated if the cron fails to run on
38169 <para>-list-all</para>
38171 <para>Default items.content lists only those items that fall in
38172 the range of the currently processing notice. Choose list-all to
38173 include all overdue items in the list (limited by -max
38176 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
38178 <para>This script is designed to alert patrons and administrators
38179 of overdue items.</para>
38181 <para>Configuration</para>
38183 <para>This script pays attention to the overdue notice
38184 configuration performed in the "Overdue notice/status triggers"
38185 section of the "Tools" area of the staff interface to Koha. There,
38186 you can choose which letter templates are sent out after a
38187 configurable number of days to patrons of each library. More
38188 information about the use of this section of Koha is available in
38189 the Koha manual.</para>
38191 <para>The templates used to craft the emails are defined in the
38192 "Tools: Notices" section of the staff interface to Koha.</para>
38194 <para>Outgoing emails</para>
38196 <para>Typically, messages are prepared for each patron with
38197 overdue items. Messages for whom there is no email address on file
38198 are collected and sent as attachments in a single email to each
38199 library administrator, or if that is not set, then to the email
38200 address in the "KohaAdminEmailAddress" system preference.</para>
38202 <para>These emails are staged in the outgoing message queue, as
38203 are messages produced by other features of Koha. This message
38204 queue must be processed regularly by the
38205 misc/cronjobs/process_message_queue.pl program.</para>
38207 <para>In the event that the "-n" flag is passed to this program,
38208 no emails are sent. Instead, messages are sent on standard output
38209 from this program. They may be redirected to a file if
38212 <para>Templates</para>
38214 <para>Templates can contain variables enclosed in double angle
38215 brackets like <<this>>. Those variables will be
38216 replaced with values specific to the overdue items or relevant
38217 patron. Available variables are:</para>
38219 <para><<bib>></para>
38221 <para>the name of the library</para>
38223 <para><<items.content>></para>
38225 <para>one line for each item, each line containing a tab separated
38226 list of title, author, barcode, issuedate</para>
38228 <para><<borrowers.*>></para>
38230 <para>any field from the borrowers table</para>
38232 <para><<branches.*>></para>
38234 <para>any field from the branches table</para>
38236 <para>CSV output</para>
38238 <para>The "-csv" command line option lets you specify a file to
38239 which overdues data should be output in CSV format.</para>
38241 <para>With the "-n" flag set, data about all overdues is written
38242 to the file. Without that flag, only information about overdues
38243 that were unable to be sent directly to the patrons will be
38244 written. In other words, this CSV file replaces the data that is
38245 typically sent to the administrator email address.</para>
38247 <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
38249 <para>"overdue_notices.pl" - In this most basic usage, with no
38250 command line arguments, all libraries are processed individually,
38251 and notices are prepared for all patrons with overdue items for
38252 whom we have email addresses. Messages for those patrons for whom
38253 we have no email address are sent in a single attachment to the
38254 library administrator's email address, or to the address in the
38255 KohaAdminEmailAddress system preference.</para>
38257 <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
38258 email and populates /tmp/overdues.csv with information about all
38259 overdue items.</para>
38261 <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
38262 of overdues in the last 2 weeks for the MAIN library.</para>
38264 <para><emphasis role="bold">SEE ALSO</emphasis></para>
38266 <para>The misc/cronjobs/advance_notices.pl program allows you to
38267 send messages to patrons in advance of their items becoming due,
38268 or to alert them of items that have just become due.</para>
38270 <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
38272 <para>These methods are internal to the operation of
38273 overdue_notices.pl.</para>
38275 <para>parse_letter</para>
38277 <para>parses the letter template, replacing the placeholders with
38278 data specific to this patron, biblio, or item</para>
38280 <para>named parameters:</para>
38282 <para>letter - required hashref</para>
38284 <para>borrowernumber - required integer</para>
38286 <para>substitute - optional hashref of other key/value pairs that
38287 should be substituted in the letter content</para>
38289 <para>returns the "letter" hashref, with the content updated to
38290 reflect the substituted keys and values.</para>
38292 <para>prepare_letter_for_printing</para>
38294 <para>returns a string of text appropriate for printing in the
38295 event that an overdue notice will not be sent to the patron's
38296 email address. Depending on the desired output format, this may be
38297 a CSV string, or a human-readable representation of the
38300 <para>required parameters:</para>
38302 <para>letter</para>
38304 <para>borrowernumber</para>
38306 <para>optional parameters:</para>
38308 <para>outputformat</para>
38312 <section id="printholdcron">
38313 <title>Print Hold Notices</title>
38315 <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
38317 <para>Does: looks through the message queue for hold notices that
38318 didn't go through because the patron didn't have an email address
38319 and generates a print notice</para>
38321 <para>Frequency suggestion: nightly</para>
38324 <section id="talkingtechcrons">
38325 <title>Talking Tech</title>
38327 <para>To learn more about setting up this third party product view
38328 the <link linkend="talkingtechappendix">Talking Tech
38329 Appendix</link>.</para>
38331 <section id="talkingtechsendcron">
38332 <title>Sending Notices File</title>
38335 misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
38337 <para>Does: Script to generate Spec C outbound notifications file
38338 for Talking Tech i-tiva phone notification system.</para>
38340 <para>Required by: <link
38341 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
38343 <para>Frequency suggestion: nightly</para>
38345 <section id="talkingsendcronperl">
38346 <title>Perl Documentation</title>
38348 <para><emphasis role="bold">USAGE</emphasis></para>
38350 <para>TalkingTech_itiva_outbound.pl</para>
38352 <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
38353 6 --output=/tmp/talkingtech/outbound.csv</para>
38355 <para>TalkingTech_itiva_outbound.pl --type=RESERVE
38356 --type=PREOVERDUE --lang=FR</para>
38358 <para>Script to generate Spec C outbound notifications file for
38359 Talking Tech i-tiva phone notification system.</para>
38361 <para>--help -h</para>
38363 <para>Prints this help</para>
38365 <para>-v Provide verbose log information.</para>
38367 <para>--output -o</para>
38369 <para>Destination for outbound notifications file (CSV format).
38370 If no value is specified, output is dumped to screen.</para>
38372 <para>--lang</para>
38374 <para>Sets the language for all outbound messages. Currently
38375 supported values are EN, FR and ES. If no value is specified, EN
38376 will be used by default.</para>
38378 <para>--type</para>
38380 <para>REQUIRED. Sets which messaging types are to be used. Can
38381 be given multiple times, to specify multiple types in a single
38382 output file. Currently supported values are RESERVE, PREOVERDUE
38383 and OVERDUE. If no value is given, this script will not produce
38384 any outbound notifications.</para>
38386 <para>--waiting-hold-day -w</para>
38388 <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
38389 has been set to waiting on which to call. Use switch as many
38390 times as desired. For example, passing "-w 0 -w 2 -w 6" will
38391 cause calls to be placed on the day the hold was set to waiting,
38392 2 days after the waiting date, and 6 days after. See example
38393 above. If this switch is not used with --type=RESERVE, calls
38394 will be placed every day until the waiting reserve is picked up
38395 or canceled.</para>
38397 <para>--library-code --code -c</para>
38399 <para>OPTIONAL The code of the source library of the message.
38400 The library code is used to group notices together for
38401 consortium purposes and apply library specific settings, such as
38402 prompts, to those notices. This field can be blank if all
38403 messages are from a single library.</para>
38407 <section id="talkingtechreceivecron">
38408 <title>Receiving Notices File</title>
38411 misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
38413 <para>Does: Script to process received Results files for Talking
38414 Tech i-tiva phone notification system.</para>
38416 <para>Required by: <link
38417 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
38419 <para>Frequency suggestion: nightly</para>
38421 <section id="talkingreceivecronperl">
38422 <title>Perl Documentation</title>
38424 <para><emphasis role="bold">USAGE</emphasis></para>
38426 <para>TalkingTech_itiva_inbound.pl</para>
38428 <para>TalkingTech_itiva_inbound.pl -v
38429 --input=/tmp/talkingtech/results.csv</para>
38431 <para>Script to process received Results files for Talking Tech
38432 i-tiva phone notification system.</para>
38434 <para>--help -h</para>
38436 <para>Prints this help</para>
38438 <para>-v Provide verbose log information.</para>
38440 <para>--input -i</para>
38442 <para>REQUIRED. Path to incoming results file.</para>
38448 <section id="proccartcron">
38449 <title>In Processing/Book Cart</title>
38451 <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
38453 <para>Does: Updates all items with a location of CART to the item's
38454 permanent location.</para>
38456 <para>Required by: <link
38457 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
38459 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
38460 & <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
38461 system preferences</para>
38463 <para>Frequency suggestion: hourly</para>
38465 <section id="proccartcronperl">
38466 <title>Perl Documentation</title>
38468 <para><emphasis role="bold">NAME</emphasis></para>
38470 <para>cart_to_shelf.pl cron script to set items with location of
38471 CART to original shelving location after X hours. Execute without
38472 options for help.</para>
38476 <section id="catalogcron">
38477 <title>Catalog</title>
38481 <section id="checkurlcron">
38482 <title>Check URLs</title>
38484 <para>Script path: misc/cronjobs/check-url.pl</para>
38486 <para>Does: checks URLs in 856$u field. Script output can now be
38487 formatted in CSV or HTML. The HTML version links directly to MARC
38488 biblio record editor.</para>
38490 <para>Frequency suggestion: monthly</para>
38492 <para>Learn more: <ulink
38493 url="http://wiki.koha-community.org/wiki/Check-url_enhancements">http://wiki.koha-community.org/wiki/Check-url_enhancements</ulink></para>
38495 <section id="checkurlcronperl">
38496 <title>Perl Documentation</title>
38498 <para><emphasis role="bold">NAME</emphasis></para>
38500 <para>C4::URL::Checker - base object for checking URL stored in
38503 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
38505 <programlisting>use C4::URL::Checker;
38507 my $checker = C4::URL::Checker->new( );
38508 $checker->{ host_default } = 'http://mylib.kohalibrary.com';
38509 my $checked_urls = $checker->check_biblio( 123 );
38510 foreach my $url ( @$checked_urls ) {
38511 print "url: ", $url->{ url A }, "\n",
38512 "is_success: ", $url->{ is_success }, "\n",
38513 "status: ", $url->{ status }, "\n";
38514 } </programlisting>
38516 <para><emphasis role="bold">FUNCTIONS</emphasis></para>
38520 <para>Create a URL Checker. The returned object can be used to set
38521 default host variable :</para>
38523 <programlisting>my $checker = C4::URL::Checker->new( );
38524 $checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
38526 <para>check_biblio</para>
38528 <para>Check all URL from a biblio record. Returns a pointer to an
38529 array containing all URLs with checking for each of them.</para>
38531 <programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
38533 <para>With 2 URLs, the returned array will look like that:</para>
38537 'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
38538 'is_success' => 1,
38539 'status' => 'ok'
38542 'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
38543 'is_success' => 0,
38544 'status' => '404 - Page not found'
38546 ], </programlisting>
38548 <para><emphasis role="bold">NAME</emphasis></para>
38550 <para>check-url.pl - Check URLs from 856$u field.</para>
38552 <para><emphasis role="bold">USAGE</emphasis></para>
38554 <para>check-url.pl [--verbose|--help]
38555 [--host=http://default.tld]</para>
38557 <para>Scan all URLs found in 856$u of bib records and display if
38558 resources are available or not.</para>
38560 <para><emphasis role="bold">PARAMETERS</emphasis></para>
38562 <para>--host=http://default.tld</para>
38564 <para>Server host used when URL doesn't have one, ie doesn't begin
38565 with 'http:'. For example, if --host=http://www.mylib.com, then
38566 when 856$u contains 'img/image.jpg', the url checked is:
38567 http://www.mylib.com/image.jpg'.</para>
38569 <para>--verbose|-v</para>
38571 <para>Outputs both successful and failed URLs.</para>
38573 <para>--html</para>
38575 <para>Formats output in HTML. The result can be redirected to a
38576 file accessible by http. This way, it's possible to link directly
38577 to biblio record in edit mode. With this parameter --host-pro is
38580 <para>--host-pro=http://koha-pro.tld</para>
38582 <para>Server host used to link to biblio record editing
38585 <para>--help|-h</para>
38587 <para>Print this help page.</para>
38591 <section id="mergeauthcron">
38592 <title>Merge Authorities</title>
38594 <para>Script path: misc/migration_tools/merge_authorities.pl</para>
38596 <para>Does: Updates biblio data with changes to authorities
38599 <para>Required by: <link linkend="dontmerge">dontmerge</link> system
38602 <para>Frequency suggestion: nightly</para>
38605 <section id="serialscron">
38606 <title>Serials Update</title>
38608 <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
38610 <para>Does: checks if there is a "late" issue on active
38611 subscriptions, and if there is, the script will set it as late, and
38612 add the next one as expected.</para>
38614 <para>Frequency suggestion: nightly</para>
38618 <section id="opaccrons">
38619 <title>OPAC</title>
38623 <section id="customrssfeedcron">
38624 <title>RSS Feeds</title>
38626 <para>Script path: misc/cronjobs/rss/rss.pl</para>
38628 <para>Does: Produces an RSS XML document for any SQL query (not used
38629 for search results RSS feed). <link linkend="customrss">Learn
38630 more</link>.</para>
38632 <para>Frequency suggestion: hourly</para>
38635 <section id="authbrowsercron">
38636 <title>Authorities Browser</title>
38638 <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
38640 <para>Does: Generate content for authorities browse in OPAC</para>
38642 <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link>
38643 system preference</para>
38646 <section id="keywordclouds">
38647 <title>Subject/Author Clouds</title>
38649 <para>Script path: misc/cronjobs/cloud-kw.pl</para>
38651 <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
38652 misc/cronjobs/cloud-sample.conf has a sample of how this script
38655 <para>Frequency: This is the type of script you can run once a month
38656 or so, the content generated isn't going to change very much over
38659 <section id="keywordcloudsperl">
38660 <title>Perl Documentation</title>
38662 <para><emphasis role="bold">NAME</emphasis></para>
38664 <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
38667 <para><emphasis role="bold">USAGE</emphasis></para>
38669 <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
38671 <para>Creates multiple HTML files containing keywords cloud with
38672 top terms sorted by their logarithmic weight. cloud.conf is a YAML
38673 configuration file driving cloud generation process.</para>
38675 <para><emphasis role="bold">PARAMETERS</emphasis></para>
38677 <para>--conf=configuration file</para>
38679 <para>Specify configuration file name</para>
38681 <para>--verbose|-v</para>
38683 <para>Enable script verbose mode.</para>
38685 <para>--help|-h</para>
38687 <para>Print this help page.</para>
38689 <para><emphasis role="bold">CONFIGURATION</emphasis></para>
38691 <para>Configuration file looks like that:</para>
38693 <para><programlisting> ---
38694 # Koha configuration file for a specific installation
38695 # If not present, defaults to KOHA_CONF
38696 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
38697 # Zebra index to scan
38699 # Koha index used to link found kewords with an opac search URL
38701 # Number of top keyword to use for the cloud
38703 # Include CSS style directives with the cloud
38704 # This could be used as a model and then CSS directives are
38705 # put in the appropriate CSS file directly.
38707 # HTML file where to output the cloud
38708 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
38710 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
38711 ZebraIndex: Subject
38715 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis
38716 role="bold">IMPROVEMENTS</emphasis></para>
38718 <para>Generated top terms have more informations than those
38719 outputted from the time being. Some parameters could be easily
38720 added to improve this script:</para>
38722 <para>WithCount</para>
38724 <para>In order to output terms with the number of occurrences they
38725 have been found in Koha Catalogue by Zebra.</para>
38727 <para>CloudLevels</para>
38729 <para>Number of levels in the cloud. Now 24 levels are
38732 <para>Weighting</para>
38734 <para>Weighting method used to distribute terms in the cloud. We
38735 could have two values: Logarithmic and Linear. Now it's
38736 Logarithmic by default.</para>
38740 <para>Now terms are outputted in the lexical order. They could be
38741 sorted by their weight.</para>
38746 <section id="systemcron">
38747 <title>System Administration</title>
38751 <section id="cleandbcron">
38752 <title>Clean up Database</title>
38754 <para>Script path: misc/cronjobs/cleanup_database.pl</para>
38756 <para>Does: Truncates the sessions table and cleans out old
38757 zebraqueue entries.</para>
38761 <section id="acqcrons">
38762 <title>Acquisitions</title>
38764 <section id="cleansuggcron">
38765 <title>Clean up old suggestions</title>
38767 <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
38769 <para>Does: Removes old (defined by you) suggestions from the
38770 suggestion management area.</para>
38774 <section id="deprecatedcrons">
38775 <title>Deprecated scripts</title>
38777 <para>These should not be run without modification:</para>
38779 <para>Script path: misc/cronjobs/update_items.pl</para>
38781 <para>Script path:misc/cronjobs/smsoverdues.pl</para>
38783 <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
38785 <para>Script path:misc/cronjobs/reservefix.pl</para>
38787 <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
38789 <para>Script path:misc/cronjobs/j2a.pl</para>
38794 <chapter id="webservices">
38795 <title>Web Services</title>
38799 <section id="OAI-PMHservice">
38800 <title>OAI-PMH</title>
38804 <section id="oaiconfsample">
38805 <title>Sample OAI Conf File</title>
38807 <para><programlisting> format:
38810 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
38811 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
38812 xsl_file: /usr/local/koha/xslt/vs.xsl
38814 metadataPrefix: marxml
38815 metadataNamespace: http://www.loc.gov/MARC21/slim
38816 http://www.loc.gov/standards/marcxml/schema/MARC21slim
38817 schema: http://www.loc.gov/MARC21/slim
38818 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
38820 metadataPrefix: oai_dc
38821 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
38822 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
38824 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
38830 <title>Using the SRU server</title>
38832 <section id="usingsru">
38835 <firstname>Nicolas</firstname>
38837 <surname>Morin</surname>
38840 <orgname>BibLibre</orgname>
38844 <pubdate>December 2009</pubdate>
38847 <title>Using the SRU server</title>
38849 <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
38850 information about the protocol itself can be found at <ulink
38851 url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
38852 The version implemented is version 1.1.</para>
38854 <section id="sru_explain">
38855 <title>Explain</title>
38857 <para>If you want to have information about the implementation of SRU
38858 on a given server, you should have access to the Explain file using a
38859 request to the server without any parameter. Like
38860 <http://myserver.com:9999/biblios/>. The response from the
38861 server is an XML file that should look like the following and will
38862 give you information about the default settings of the SRU
38866 <zs:explainResponse>
38867 <zs:version>1.1</zs:version>
38869 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
38870 <zs:recordPacking>xml</zs:recordPacking>
38871 <zs:recordData>
38872 <explain xml:base="zebradb/explain-biblios.xml">
38874 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
38876 <serverInfo protocol="SRW/SRU/Z39.50">
38877 <host>biblibre</host>
38878 <port>9999</port>
38879 <database>biblios</database>
38880 </serverInfo>
38881 <databaseInfo>
38882 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
38883 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
38885 <sru>http://biblibre:9999</sru>
38887 </databaseInfo>
38889 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
38890 <title>CQL Standard Set</title>
38892 <index search="true" scan="true" sort="false">
38893 <title lang="en">CQL Server Choice</title>
38895 <name set="cql">serverChoice</name>
38898 <attr type="1" set="bib1">text</attr>
38901 <index search="true" scan="true" sort="false">
38902 <title lang="en">CQL All</title>
38904 <name set="cql">all</name>
38907 <attr type="1" set="bib1">text</attr>
38910 <!-- Record ID index -->
38911 <index search="true" scan="true" sort="false">
38912 <title lang="en">Record ID</title>
38914 <name set="rec">id</name>
38917 <attr type="1" set="bib1">rec:id</attr>
38918 <attr type="4" set="bib1">3</attr>
38924 <section id="sru_search">
38925 <title>Search</title>
38928 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
38929 is composed of the following elements:</para>
38933 <para>base url of the SRU server :
38934 http://myserver.com:9999/biblios?</para>
38938 <para>search part with the 3 required parameters : version,
38939 operation and query. The parameters within the search part should
38940 be of the key=value form, and can be combined with the &
38945 <para>One can add optional parameters to the query, for instance
38946 maximumRecords indicating the maximum number of records to be returned
38948 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
38949 will only get the first 5 results results from the server.</para>
38952 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>
38953 gives more details about the search operations and in particular the
38954 list of optional parameters for searching.</para>
38956 <section id="sru_search_more_details">
38957 <title>More details about Search</title>
38959 <para>The "operation" key can take two values: scan or
38960 searchRetrieve.</para>
38962 <para>If operation=searchRetrieve, then the search key should be
38963 query. As in : operation=searchRetrieve&query=reefs</para>
38965 <para>If operation=scan, then the search key should be scanClause.
38966 As in : operation=scan&scanClause=reefs</para>
38968 <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
38969 that exist on your system. For instance you'll see that we have
38970 indexes for Subject and for Title: att 21 Subject and att 4 Title
38971 respectively.</para>
38973 <para>In the pqf.properties file located under
38974 etc/zebradb/pqf.properties I see that an access point already uses
38975 my Subject index (index.dc.subject = 1=21) while another uses my
38976 Title index (index.dc.title = 1=4) I know this is my Subject index
38977 because as I've seen just before in my bib1.att file, it's called
38978 with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
38979 my Subject index. And Title was called with 1=4 so index.dc.title =
38980 1=4 correctly points to my Title index. I can now construct my query
38981 just like I would in a search box, just preceding it with the
38982 "query" key: query=Subject=reefs and Title=coral searches "reefs" in
38983 the subject and "coral" in the title. The full url would be
38984 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
38985 and Title=coral If I want to limit the result set to just 5 records,
38987 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
38988 and Title=coral&maximumRecords=5</para>
38990 <para>I can also play with truncate, relations, etc. Those are also
38991 defined in my pqf.properties file. I can see for instance the
38992 position properties defined as:</para>
38995 position.first = 3=1 6=1
38997 position.any = 3=3 6=1
38998 # "any position in field"
39001 <para>So as an example if I want "coral" to be at the beginning of
39002 the title, I can do this query :
39003 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
39008 <section id="sru_retrieve">
39009 <title>Retrieve</title>
39011 <para>My search for
39012 http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
39013 reefs&maximumRecords=1 retrieves just on record. The response
39014 looks like this:</para>
39017 <zs:searchRetrieveResponse>
39018 <zs:version>1.1</zs:version>
39019 <zs:numberOfRecords>1</zs:numberOfRecords>
39022 <zs:recordPacking>xml</zs:recordPacking>
39023 <zs:recordData>
39024 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
39025 <leader> cam a22 4500</leader>
39026 <datafield tag="010" ind1=" " ind2=" ">
39027 <subfield code="a">2-603-01193-6</subfield>
39028 <subfield code="b">rel.</subfield>
39029 <subfield code="d">159 F</subfield>
39031 <datafield tag="020" ind1=" " ind2=" ">
39032 <subfield code="a">FR</subfield>
39033 <subfield code="b">00065351</subfield>
39035 <datafield tag="101" ind1="1" ind2=" ">
39036 <subfield code="c">ita</subfield>
39038 <datafield tag="105" ind1=" " ind2=" ">
39039 <subfield code="a">a z 00|y|</subfield>
39041 <datafield tag="106" ind1=" " ind2=" ">
39042 <subfield code="a">r</subfield>
39044 <datafield tag="100" ind1=" " ind2=" ">
39045 <subfield code="a">20091130 frey50 </subfield>
39047 <datafield tag="200" ind1="1" ind2=" ">
39048 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
39049 <subfield code="b">Texte imprimé</subfield>
39050 <subfield code="e">la faune sous-marine des coraux</subfield>
39051 <subfield code="f">A. et A. Ferrari</subfield>
39053 <datafield tag="210" ind1=" " ind2=" ">
39054 <subfield code="a">Lausanne</subfield>
39055 <subfield code="a">Paris</subfield>
39056 <subfield code="c">Delachaux et Niestlé</subfield>
39057 <subfield code="d">cop. 2000</subfield>
39058 <subfield code="e">impr. en Espagne</subfield>
39060 <datafield tag="215" ind1=" " ind2=" ">
39061 <subfield code="a">287 p.</subfield>
39062 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
39063 <subfield code="d">20 cm</subfield>
39067 <size>4725</size>
39068 <localnumber>2</localnumber>
39069 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
39072 </zs:recordData>
39073 <zs:recordPosition>1</zs:recordPosition>
39075 </zs:records>
39076 </zs:searchRetrieveResponse>
39083 <appendix id="sysprefdefaults">
39084 <title>System Preference Defaults</title>
39088 <section id="isbddefaults">
39089 <title>ISBD Defaults</title>
39093 <section id="isbddefault">
39094 <title>MARC Default</title>
39096 <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
39097 110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
39098 }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
39099 130t }|<br/><br/></para>
39101 <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
39102 245s }{ 245h }|</para>
39104 <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
39107 <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
39109 <para>#245||{ 245c }|</para>
39111 <para>#242||{ = 242c }|</para>
39113 <para>#250| - |{ 250a }{ 250b }|</para>
39115 <para>#254|, |{ 254a }|</para>
39117 <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
39120 <para>#256|, |{ 256a }|</para>
39122 <para>#257|, |{ 257a }|</para>
39124 <para>#258|, |{ 258a }{ 258b }|</para>
39126 <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
39128 <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
39131 <para>#306| - |{ 306a }|</para>
39133 <para>#307| - |{ 307a }{ 307b }|</para>
39135 <para>#310| - |{ 310a }{ 310b }|</para>
39137 <para>#321| - |{ 321a }{ 321b }|</para>
39139 <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
39140 }{ 340h }{ 340i }|</para>
39142 <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
39143 }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
39144 342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
39146 <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
39147 }{ 343h }{ 343i }|</para>
39149 <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
39151 <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
39152 }{ 352i }{ 352q }|</para>
39154 <para>#362| - |{ 362a }{ 351z }|</para>
39156 <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
39158 <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
39160 <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
39161 }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
39162 800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
39164 <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
39165 }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
39166 810s }{ 810t }{ 810u }{ 810v }|.</para>
39168 <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
39169 }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
39172 <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
39173 }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
39176 <para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
39178 <para>#501|<br/><br/>|{ 501a }|</para>
39180 <para>#502|<br/><br/>|{ 502a }|</para>
39182 <para>#504|<br/><br/>|{ 504a }|</para>
39184 <para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
39187 <para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
39188 506d }{ 506u }|</para>
39190 <para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
39192 <para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
39194 <para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
39197 <para>#511|<br/><br/>|{ 511a }|</para>
39199 <para>#513|<br/><br/>|{ 513a }{513b }|</para>
39201 <para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
39202 514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
39205 <para>#515|<br/><br/>|{ 515a }|</para>
39207 <para>#516|<br/><br/>|{ 516a }|</para>
39209 <para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
39211 <para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
39214 <para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
39216 <para>#522|<br/><br/>|{ 522a }|</para>
39218 <para>#524|<br/><br/>|{ 524a }|</para>
39220 <para>#525|<br/><br/>|{ 525a }|</para>
39222 <para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
39223 510d }{\n510x }|</para>
39225 <para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
39226 506d }{\n506u }|</para>
39228 <para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
39229 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
39231 <para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
39232 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
39235 <para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
39238 <para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
39241 <para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
39242 540d }{\n520u }|</para>
39244 <para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
39245 }{\n544d }{\n544e }{\n544n }|</para>
39247 <para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
39249 <para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
39251 <para>#547|<br/><br/>|{\n547a }|</para>
39253 <para>#550|<br/><br/>|{ 550a }|</para>
39255 <para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
39256 552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
39257 }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
39259 <para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
39260 555d }{ 555u }|</para>
39262 <para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
39264 <para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
39266 <para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
39267 565d }{ 565e }|</para>
39269 <para>#567|<br/><br/>|{ 567a }|</para>
39271 <para>#580|<br/><br/>|{ 580a }|</para>
39273 <para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
39275 <para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
39277 <para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
39279 <para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
39281 <para>#020|<br/><br/><label>ISBN: </label>|{
39282 020a }{ 020c }|</para>
39284 <para>#022|<br/><br/><label>ISSN: </label>|{
39287 <para>#222| = |{ 222a }{ 222b }|</para>
39289 <para>#210| = |{ 210a }{ 210b }|</para>
39291 <para>#024|<br/><br/><label>Standard No.:
39292 </label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
39294 <para>#027|<br/><br/><label>Standard Tech. Report.
39295 No.: </label>|{ 027a }|</para>
39297 <para>#028|<br/><br/><label>Publisher. No.:
39298 </label>|{ 028a }{ 028b }|</para>
39300 <para>#013|<br/><br/><label>Patent No.:
39301 </label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
39304 <para>#030|<br/><br/><label>CODEN: </label>|{
39307 <para>#037|<br/><br/><label>Source: </label>|{
39308 037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
39310 <para>#010|<br/><br/><label>LCCN: </label>|{
39313 <para>#015|<br/><br/><label>Nat. Bib. No.:
39314 </label>|{ 015a }{ 0152 }|</para>
39316 <para>#016|<br/><br/><label>Nat. Bib. Agency Control
39317 No.: </label>|{ 016a }{ 0162 }|</para>
39319 <para>#600|<br/><br/><label>Subjects--Personal
39320 Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
39321 }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
39322 }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
39323 }{--600x}{--600z}{--600y}{--600v}|</para>
39325 <para>#610|<br/><br/><label>Subjects--Corporate
39326 Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
39327 }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
39328 }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
39329 }{--610x}{--610z}{--610y}{--610v}|</para>
39331 <para>#611|<br/><br/><label>Subjects--Meeting Names:
39332 </label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
39333 }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
39334 611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
39336 <para>#630|<br/><br/><label>Subjects--Uniform
39337 Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
39338 }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
39339 630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
39341 <para>#648|<br/><br/><label>Subjects--Chronological
39342 Terms: </label>|{\n6483 }{\n648a
39343 }{--648x}{--648z}{--648y}{--648v}|</para>
39345 <para>#650|<br/><br/><label>Subjects--Topical Terms:
39346 </label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
39347 }{--650x}{--650z}{--650y}{--650v}|</para>
39349 <para>#651|<br/><br/><label>Subjects--Geographic
39350 Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
39351 }{--651x}{--651z}{--651y}{--651v}|</para>
39353 <para>#653|<br/><br/><label>Subjects--Index Terms:
39354 </label>|{ 653a }|</para>
39356 <para>#654|<br/><br/><label>Subjects--Facted Index
39357 Terms: </label>|{\n6543
39358 }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
39360 <para>#655|<br/><br/><label>Index Terms--Genre/Form:
39361 </label>|{\n6553 }{\n655a}{--655b}{--655x
39362 }{--655z}{--655y}{--655v}|</para>
39364 <para>#656|<br/><br/><label>Index Terms--Occupation:
39365 </label>|{\n6563
39366 }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
39368 <para>#657|<br/><br/><label>Index Terms--Function:
39369 </label>|{\n6573
39370 }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
39372 <para>#658|<br/><br/><label>Index Terms--Curriculum
39374 </label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
39376 <para>#050|<br/><br/><label>LC Class. No.:
39377 </label>|{ 050a }{ / 050b }|</para>
39379 <para>#082|<br/><br/><label>Dewey Class. No.:
39380 </label>|{ 082a }{ / 082b }|</para>
39382 <para>#080|<br/><br/><label>Universal Decimal Class.
39383 No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
39385 <para>#070|<br/><br/><label>National Agricultural
39386 Library Call No.: </label>|{ 070a }{ / 070b }|</para>
39388 <para>#060|<br/><br/><label>National Library of
39389 Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
39391 <para>#074|<br/><br/><label>GPO Item No.:
39392 </label>|{ 074a }|</para>
39394 <para>#086|<br/><br/><label>Gov. Doc. Class. No.:
39395 </label>|{ 086a }|</para>
39397 <para>#088|<br/><br/><label>Report. No.:
39398 </label>|{ 088a }|</para>
39401 <section id="unimarcdefault">
39402 <title>UNIMARC Default</title>
39404 <para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
39405 200i}|</h2></para>
39407 <para>#461|<label class="ipt">A part of : </label>|<a
39408 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
39409 461h} {v. 461v}{(461d)}<br/>|</para>
39411 <para>#200b|<label class="ipt">Material Designation :
39412 </label>| {200b }|<br/></para>
39414 <para>#101a|<label class="ipt">Language(s): </label>|<a
39415 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
39417 <para>#200f|<label class="ipt">Authors : </label>|<a
39418 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
39419 ; }</a>|<br/></para>
39421 <para>#200g|<label class="ipt">Co-authors : </label>|<a
39422 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
39423 ; }</a>|<br/></para>
39425 <para>#210a|<br/><label class="ipt">Place of pubblication
39426 : </label>|<a
39427 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
39429 <para>#210c|<label class="ipt">Publisher : </label>|<a
39430 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
39431 ; }</a>|<br/></para>
39433 <para>#210d|<label class="ipt">Date of pubblication :
39434 </label>|{ 210d}|<br/></para>
39436 <para>#215|<label class="ipt">Description :
39437 </label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
39439 <para>#225a|<label class="ipt">Series :</label>|<a
39440 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
39441 ;}</a> |</para>
39443 <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
39444 225v}|<br/></para>
39446 <para>#686|<label>Classification : </label>|{ 686a
39447 }|<br/></para>
39449 <para>#608|<label>Form, Genre : </label>|<a
39450 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
39451 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39452 title="Search on {608a}">{
39453 608a}</a>|<br/><br/></para>
39455 <para>#200||<label class="ipt">Subjects :
39456 </label><br/>|<ul></para>
39458 <para>#600|<label class="ipt">Person(s)
39459 </label><br/> |<li><a
39460 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
39461 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39462 title="Search on {600a}">{
39463 600a}</a></li>|<br/></para>
39465 <para>#601|<label class="ipt">Organisation(s)
39466 </label><br/>|<li><a
39467 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
39468 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39469 title="Search on {601a}">{
39470 601a}</a></li>|<br/></para>
39472 <para>#606|<label class="ipt">Term(s)
39473 </label><br/>|<li><a
39474 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
39475 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39476 title="Search on {606a}">{
39477 606a}</a></li>|<br/></para>
39479 <para>#607|<label class="ipt">Place(s)
39480 </label><br/>|<li><a
39481 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
39482 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39483 title="Search on {607a}">{
39484 607a}</a></li>|<br/></para>
39486 <para>#610|<label>Keywords</label><br/>|<li><a
39487 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
39488 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39489 title="Search on {610a}">{ 610a}</a></li>|</para>
39491 <para>#200||</ul>|</para>
39493 <para>#856|<label class="ipt">Electronic resource :
39494 </label>|<a href="{856u}">click here</a> to go to
39495 the external resource<br/></para>
39497 <para>#010|<label class="ipt">ISBN : </label>|{010a
39498 ;}|<br/></para>
39500 <para>#011|<label class="ipt">ISSN : </label>|{011a
39501 ;}|<br/></para>
39503 <para>#200||<label class="ipt">Notes :
39504 </label>|<br/><ul></para>
39506 <para>#300||<li>{300a}</li>|</para>
39508 <para>#307||<li>{307a}</li>|</para>
39510 <para>#310||<li>{310a}</li>|</para>
39512 <para>#326||<li>{326a}</li>|</para>
39514 <para>#327||<li>{327a}</li>|</para>
39516 <para>#333|<li>Public : |{333a}</li>|</para>
39518 <para>#200||</ul>|</para>
39520 <para>#330||<label class="ipt">Abstract :
39521 </label>|<br/></para>
39523 <para>#330||{330a}|<br/></para>
39525 <para>#200||<br/><h2>Items</h2>|</para>
39527 <para>#200|<table>|<th>Call
39528 number</th><th>Copy
39529 note</th><th>Fonds</th><th>Genre
39530 detail</th><th>Circulation
39531 type</th><th>Barcode</th>|</para>
39533 <para>#995||<tr><td> {995k}</td><td>
39534 {995u}</td><td>
39535 {995y}</td><td>{995e} </td><td>
39536 {995o}</td><td>{995f}</td></tr>|</table></para>
39540 <section id="nozebradefault">
39541 <title>NoZebraIndexes Default</title>
39543 <para>'title' =>
39544 '130a,210a,222a,240a,243a,245a,245b,246a,246b,247a,247b,250a,250b,440a,830a',</para>
39546 <para>'author' =>
39547 '100a,100b,100c,100d,110a,111a,111b,111c,111d,245c,700a,710a,711a,800a,810a,811a',</para>
39549 <para>'isbn' => '020a',</para>
39551 <para>'issn' => '022a',</para>
39553 <para>'lccn' => '010a',</para>
39555 <para>'biblionumber' => '999c',</para>
39557 <para>'itemtype' => '942c',</para>
39559 <para>'publisher' => '260b',</para>
39561 <para>'date' => '260c',</para>
39563 <para>'note' => '500a,
39564 501a,504a,505a,508a,511a,518a,520a,521a,522a,524a,526a,530a,533a,538a,541a,546a,555a,556a,562a,563a,583a,585a,582a',</para>
39566 <para>'subject' =>
39567 '600*,610*,611*,630*,650*,651*,653*,654*,655*,662*,690*',</para>
39569 <para>'dewey' => '082',</para>
39571 <para>'bc' => '952p',</para>
39573 <para>'callnum' => '952o',</para>
39575 <para>'an' => '6009,6109,6119',</para>
39577 <para>'homebranch' => '952a,952c'</para>
39581 <appendix id="receiptprint">
39582 <title>Configuring Receipt Printers</title>
39584 <para>The following instructions are for specific receipt printers, but
39585 can probably be used to help with setup of other brands as well.</para>
39587 <section id="epsonprinters">
39589 <corpauthor>NEKLS</corpauthor>
39591 <pubdate>2008</pubdate>
39593 <bibliosource><ulink
39594 url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
39597 <title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
39601 <section id="epsonprintdriver">
39602 <title>In the Print Driver</title>
39604 <para>For these instructions, we are using version 5,0,3,0 of the
39605 Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
39606 Register at the <ulink
39607 url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
39608 Center website</ulink> to gain access to the drivers; go to Technical
39609 Resources, then choose the printer model from the Printers drop-down
39612 <para>Click Start > Printers and Faxes > Right click the receipt
39613 printer > Properties:</para>
39617 <para>Advanced Tab, click Printing Defaults button</para>
39621 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
39625 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
39626 Printable Width</para>
39630 <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
39631 window that appears. Fit to Printable Width should be
39632 automatically selected.</para>
39636 <para>OK your way out of there.</para>
39641 <section id="epsonfirefox">
39642 <title>In Firefox</title>
39644 <para>Under File > Page Setup:</para>
39648 <para>Shrink to fit page on Format & Options tab</para>
39652 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
39653 makes the receipts use all available space on the paper
39658 <para>Set all Headers/Footers to -blank-. This removes all of the
39659 gunk you might normally find on a print from Firefox, such as the
39660 URL, number of pages, etc.</para>
39664 <para>Click OK</para>
39668 <para>Set the default printer settings in Firefox so you don't see a
39669 "Print" dialog:</para>
39673 <para>Go to File > Print</para>
39677 <para>Set the Printer to the receipt printer.</para>
39681 <para>Click the Advanced (or Properties) button</para>
39685 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
39689 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
39690 Printable Width</para>
39694 <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
39695 window that appears. Fit to Printable Width should be
39696 automatically selected.</para>
39700 <para>OK your way out, go ahead and print whatever page you are
39705 <para>Type about:config, in the address bar. Click "I'll be
39706 careful, I promise!" on the warning message.</para>
39710 <para>Type, print.always in Filter.</para>
39714 <para>Look for print.always_print_silent.</para>
39718 <para>If the preference is there then set the value to
39725 <para>If the preference is not there (and it shouldn't be in most
39726 browsers) you have to add the preference.</para>
39730 <para>Right click the preference area and select New >
39735 <para>Type print.always_print_silent in the dialog box and set
39736 the value to True. This sets the print settings in Firefox to
39737 always use the same settings and print without showing a
39745 <para>Setting the print.always_print_silent setting in about:config
39746 DISABLES the ability to choose a printer in Firefox.</para>
39751 <section id="epson2">
39753 <corpauthor>NEKLS</corpauthor>
39755 <pubdate>2008</pubdate>
39757 <bibliosource><ulink
39758 url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
39761 <title>For Epson TM-T88II (2) Printers</title>
39763 <para>Register at the <ulink
39764 url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
39765 Center website</ulink> to gain access to the drivers; go to Technical
39766 Resources, then choose the printer model from the Printers drop-down
39769 <section id="epson2firefox">
39770 <title>In Firefox</title>
39772 <para>Under File > Page Setup:</para>
39776 <para>Shrink to fit page on Format & Options tab</para>
39780 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
39781 makes the receipts use all available space on the paper
39786 <para>Set all Headers/Footers to -blank-. This removes all of the
39787 gunk you might normally find on a print from Firefox, such as the
39788 URL, number of pages, etc.</para>
39792 <para>Click OK</para>
39796 <para>Set the default printer settings in Firefox so you don't see a
39797 "Print" dialog:</para>
39801 <para>Go to File > Print</para>
39805 <para>Set the Printer to the receipt printer.</para>
39809 <para>Print whatever page you are on.</para>
39813 <para>Type about:config, in the address bar. Click "I'll be
39814 careful, I promise!" on the warning message.</para>
39818 <para>Type, print.always in Filter.</para>
39822 <para>Look for, print.always_print_silent.</para>
39826 <para>If the preference is there then set the value to
39833 <para>If the preference is not there (and it shouldn't be in most
39834 browsers) you have to add the preference.</para>
39838 <para>Right click the preference area and select New >
39843 <para>Type, print.always_print_silent in the dialog box and
39844 set the value to True. This sets the print settings in Firefox
39845 to always use the same settings and print without showing a
39853 <para>Setting the print.always_print_silent setting in about:config
39854 DISABLES the ability to choose a printer in Firefox.</para>
39859 <section id="starprinter">
39861 <corpauthor>RHCL</corpauthor>
39864 <firstname>Nicole C.</firstname>
39866 <surname>Engard</surname>
39869 <pubdate>2010</pubdate>
39872 <title>For Star SP542 Printers</title>
39874 <section id="installstarprinter">
39875 <title>Installing the Printer</title>
39877 <para>While the following comments are based on the Star SP542 receipt
39878 printer, they probably apply to all printers in the SP5xx
39881 <para>The Star SP542 receipt printer works well with Koha and Firefox
39882 on Windows XP SP3. This printer, with either the parallel or USB
39883 interface, is fairly easy to install and configure. You will need the
39884 following executable file which is available from numerous places on
39885 the Internet:</para>
39887 <para>linemode_2k-xp_20030205.exe</para>
39889 <para>This executable actually does all of the installation; you will
39890 not need to use the Microsoft Windows "Add Printer" program. We
39891 recommend that when installing, the option for the software monitor
39892 not be selected; we have experienced significant pauses and delays in
39893 printing with it. Instead, simply choose to install the receipt
39894 printer without the monitor.</para>
39896 <para>Additionally, the install program may not put the printer on the
39897 correct port, especially if using the USB interface. This is easily
39898 corrected by going to "Start -> Printers and Faxes -> Properties
39899 for the SP542 printer -> Ports", then check the appropriate
39902 <para>A reboot may be required, even if not indicated by the
39903 installation software or the operating system.</para>
39907 <section id="firefoxreceipt">
39909 <corpauthor>VOKAL</corpauthor>
39912 <firstname>Nicole C.</firstname>
39914 <surname>Engard</surname>
39917 <pubdate>2010</pubdate>
39919 <bibliosource><ulink
39920 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>
39923 <title>Configuring Firefox to Print to Receipt Printer</title>
39927 <para>Open File > Page Setup</para>
39931 <para>Make all the headers and footers blank</para>
39935 <para>Set the margins to 0 (zero)</para>
39939 <para>In the address bar of Firefox, type about:config</para>
39943 <para>Search for print.always_print_silent and double click
39948 <para>Change it from false to true</para>
39952 <para>This lets you skip the Print pop up box that comes up, as
39953 well as skipping the step where you have to click OK,
39954 automatically printing the right sized slip.</para>
39960 <para>If print.always_print_silent does not come up</para>
39964 <para>Right click on a blank area of the preference
39969 <para>Select new > Boolean</para>
39973 <para>Enter "print.always_print_silent" as the name (without
39978 <para>Click OK</para>
39982 <para>Select true for the value</para>
39988 <para>You may also want to check what is listed for
39989 print.print_printer</para>
39993 <para>You may have to choose Generic/Text Only (or whatever your
39994 receipt printer might be named)</para>
40002 <appendix id="samplenotice">
40003 <title>Example Notice</title>
40005 <para>Nicole Engard</para>
40007 <para>410 Library Rd.</para>
40009 <para>Philadelphia, PA 19107</para>
40011 <para>Dear Nicole Engard (23529000035726),</para>
40013 <para>According to our records, at the time of this notice, you have items
40014 that are overdue. Please return or renew them as soon as possible to avoid
40015 increasing late fines.</para>
40017 <para>If you have registered a password with the library, you may use it
40018 with your library card number to renew online.</para>
40020 <para>If you believe you have returned the items below please call at and
40021 library staff will be happy to help resolve the issue.</para>
40023 <para>The following item(s) are currently overdue:</para>
40025 <para>07/08/2008 Creating drug-free schools and communities : 502326000054
40026 Fox, C. Lynn.</para>
40028 <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
40030 <para>Sincerely, Library Staff</para>
40033 <appendix id="sampleserialsapp">
40034 <title>Sample Serials</title>
40038 <section id="readersdigestsample">
40039 <title>Reader's Digest (0034-0375)</title>
40043 <para>Published 12 times a year (monthly)</para>
40047 <para>The Volume number changes every 6 months and the numbers
40048 continues on (requires an advanced pattern).</para>
40051 <screeninfo>Sample Reader's Digest Subscription</screeninfo>
40055 <imagedata fileref="images/serialssamples/readersserial.png"/>
40065 <section id="peoplesample">
40066 <title>People Weekly (1076-0091)</title>
40070 <para>Published weekly</para>
40074 <para>The website says "on Saturday except the first week of
40075 August, Thanksgiving week, the first and last weeks of the year"
40076 but this does not match the pattern for 2007 or 2008</para>
40082 <para>In the Jul-Dec there are 26 issues</para>
40086 <para>In the Jan-Jun there are 25 issues (no issue for the first
40087 week of January)</para>
40091 <para>Since the irregularity on the first # 26 does not skip a week,
40092 this would be set up as to roll over on issue 25. The 26th issue in the
40093 second half of the year would have to be received as a
40094 supplemental.</para>
40096 <para>The irregularity check will complain that 52 issues were expected,
40097 but 25 entered. The current irregularity check can only check that the
40098 first position of the numbering pattern matches the expected issue count
40099 of the periodicity. But we do need to trigger the rollover on the
40100 volume, so we need to define the last two weeks of the year as
40101 irregularities. So we receive 50 issues the first 50 weeks, then one
40102 supplemental issue in week 51, which we have to define the enumeration
40103 for, then the next predicted issue will be the following year's first
40107 <section id="hebrewserialsample">
40108 <title>עת-מול
40109 עיתון
40110 לתולדות ארץ
40111 ישראל ועם
40112 ישראל</title>
40114 <para>This journal is published with the following rules:</para>
40118 <para>6 issues a year (every 2 months)</para>
40122 <para>year changes every 6 issues</para>
40126 <para>we start in 2011</para>
40130 <para>the issue number goes up indefinitely</para>
40134 <para>starting from issue 215</para>
40138 <para>The planning would look like this:</para>
40141 <screeninfo>Sample for this Hebrew Journal</screeninfo>
40145 <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
40152 <appendix id="kohacms">
40153 <title>Using Koha as a Content Management System (CMS)</title>
40157 <section id="kohacmssetup">
40158 <title>Setup</title>
40160 <para>These are instructions for taking a default install of Koha 3.0
40161 and allowing it to function as a little content management system. This
40162 will allow a library to publish an arbitrary number of pages based on a
40163 template. This example uses the template for the main opac page, but you
40164 could just as well use any template you wish with a bit more editing.
40165 This may be appropriate if you have a small library, want to allow
40166 librarians to easily add pages, and do not want to support a complete
40171 <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
40172 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same
40177 <para>Edit pages.pl in an editor</para>
40181 <para>At approximately line 32 add:</para>
40183 <programlisting>my $cgi = new CGI;</programlisting>
40187 <para>At approximately line 36 change this code:</para>
40189 <programlisting>template_name =>
40190 "opac-main.tmpl",</programlisting>
40192 <para>To this code:</para>
40194 <programlisting>template_name => "pages.tmpl",</programlisting>
40198 <para>At approximately line 54 change this code:</para>
40200 <programlisting>$template->param(
40201 koha_news => $all_koha_news,
40202 koha_news_count => $koha_news_count
40203 ); </programlisting>
40205 <para>To this:</para>
40207 <programlisting>my $page = "page_" . $cgi->param("p");
40208 $template->param(
40209 koha_news => $all_koha_news,
40210 koha_news_count => $koha_news_count,
40211 local_page => "" .
40212 C4::Context->preference($page)
40213 ); </programlisting>
40218 /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/opac-main.tmpl
40220 /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tmpl</para>
40224 <para>At approximately line 38, change this:</para>
40226 <programlisting><!-- TMPL_IF NAME="OpacMainUserBlock"
40227 --><div id="opacmainuserblock" class="container"><!--
40228 TMPL_VAR NAME="OpacMainUserBlock" --></div><!-- /TMPL_IF
40229 --> </programlisting>
40231 <para>To this:</para>
40233 <programlisting><!-- TMPL_IF NAME="local_page" --><div
40234 id="opacmainuserblock" class="container"><!-- TMPL_VAR
40235 NAME="local_page" --></div><!-- /TMPL_IF
40236 --></programlisting>
40240 <para>In system preferences in the staff client, click the button
40241 for "New Preference" under "Local Use"</para>
40245 <para>Fill it out as so</para>
40249 <para>Explanation: test page for pages tiny cms</para>
40253 <para>Variable: page_test</para>
40257 <para>Value: Lorem ipsum</para>
40261 <para>Click the TextArea link (or enter "TextArea" into the
40262 input field below it)</para>
40266 <para>variable options (last field): 80|50</para>
40272 <para>In a browser go to
40273 http://youraddress/cgi-bin/koha/pages.pl?p=test The page should come
40274 up with the words "Lorem ipsum" in the main content area of the
40275 page. (replace "youraddress" with localhost, 127.0.0.1, or your
40276 domain name depending on how you have Apache set up.)</para>
40280 <para>To add more pages simply create a system preference where the
40281 title begins with "page_" followed by any arbitrary letters. You can
40282 add any markup you want as the value of the field. Reference the new
40283 page by changing the value of the "p" parameter in the URL.</para>
40287 <section id="kohacmstrouble">
40288 <title>Troubleshooting</title>
40290 <para>If you have problems check file permissions on pages.pl and
40291 pages.tmpl. They should have the same user and group as other Koha
40292 files like opac-main.pl.</para>
40295 <section id="kohacmsbonus">
40296 <title>Bonus Points</title>
40298 <para>Instead of using the address
40299 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
40300 http://youraddress/pages.pl?p=test Just open up
40301 /etc/koha/koha-httpd.conf and add the follow at about line
40302 13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
40304 <para>Then restart Apache.</para>
40308 <section id="kohacmsusage">
40309 <title>Usage</title>
40311 <para>After setting up Koha as a CMS you can create new pages following
40312 these instructions:</para>
40314 <section id="kohacmspages">
40315 <title>Adding Pages</title>
40317 <para>To add a new page you need to add a system preference under
40322 <para>Get there: More > Administration > Global System
40323 Preferences > Local Use</para>
40327 <para>Click 'New Preference'</para>
40331 <para>Enter in a description in the Explanation field</para>
40335 <para>Enter a value that starts with 'page_' in the Variable
40340 <para>Enter starting HTML in the Value field</para>
40343 <screeninfo>Add a new preference</screeninfo>
40347 <imagedata fileref="images/appendix-cms/newpreference.png"/>
40354 <para>Set the Variable Type to Textarea</para>
40358 <para>Set the Variable options to something like 20|20 for 20 rows
40359 and 20 columns</para>
40362 <screeninfo>Settings for the new preference</screeninfo>
40366 <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
40374 <section id="kohacmsview">
40375 <title>Viewing your page</title>
40377 <para>You can view your new page at
40378 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
40379 the part you entered after 'page_' in the Variable field.</para>
40382 <section id="kohacmsexpage">
40383 <title>Example</title>
40385 <para>This process can be used to create recommended reading lists
40386 within Koha. So once the code changes have been made per the
40387 instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
40388 instructions above to great a page for 'Recommended Reading
40392 <screeninfo>Create page by modifying a system
40393 preference</screeninfo>
40397 <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
40402 <para>Next we need to create pages for our various classes (or
40403 categories). To do this, return to the 'Adding a New Page' section and
40404 create a preference for the first class.</para>
40407 <screeninfo>Add a new sys pref for another page</screeninfo>
40411 <imagedata fileref="images/appendix-cms/class101-pref.png"/>
40416 <para>Next you'll want to link your first page to your new second
40417 page, go to the page_recommend preference and click 'Edit.' Now you
40418 want to edit the HTML to include a link to your newest page:</para>
40421 <screeninfo>Edit original preference to add new page</screeninfo>
40425 <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
40431 <section id="examplecms">
40432 <title>Live Examples</title>
40436 <para>The Crawford Library at Dallas Christian College is using
40437 this method for their recommended reading lists: <ulink
40438 url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
40445 <appendix id="resetkohadb">
40446 <title>Resetting the Koha Database</title>
40448 <para>These notes on how to reset the database for Koha 3 were derived
40449 from the following email thread: <ulink
40450 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>
40452 <para>Resetting the database may be useful if you install Koha with the
40453 sample data, and then wish to use real data without reinstalling the
40456 <section id="truncate">
40457 <title>Truncate Tables</title>
40459 <para>Use your preferred MySQL client to <ulink
40460 url="http://dev.mysql.com/doc/refman/5.0/en/truncate.html">truncate</ulink>
40461 the following tables:</para>
40469 <para>biblioitems</para>
40477 <para>auth_header</para>
40481 <para>sessions</para>
40485 <para>zebraqueue</para>
40490 <section id="resetzebra">
40491 <title>Reset the Zebra Index</title>
40493 <para>Run the following commands to reset the authorities and biblios
40494 Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
40495 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
40499 <appendix id="importantlinks">
40500 <title>Important Links</title>
40504 <section id="koharelatedlinks">
40505 <title>Koha Related</title>
40509 <para>Report Koha Bugs - <ulink
40510 url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
40514 <para>Koha Versioning Control - <ulink
40515 url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
40519 <para>Database Structure - <ulink
40520 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>
40524 <para>Koha as a CMS - <ulink
40525 url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
40529 <para>Kyles's Koha Tools - <ulink
40530 url="http://millruntech.com/koha">http://millruntech.com/koha</ulink></para>
40534 <para>Koha Bibliography - <ulink
40535 url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
40539 <para>Koha Shared Links - <ulink
40540 url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
40544 <para>Koha Presentations - <ulink
40545 url="http://www.slideshare.net/group/koha-ils/slideshows">http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
40550 <section id="catalogrelatedlinks">
40551 <title>Cataloging Related</title>
40555 <para>Koha MARC Tutorials - <ulink
40556 url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
40560 <para>Z39.50 Server Search - <ulink
40561 url="http://targettest.indexdata.com/">http://targettest.indexdata.com/</ulink></para>
40565 <para>Z39.50 Server List - <ulink
40566 url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm">http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
40570 <para>Library of Congress Authorities - <ulink
40571 url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
40575 <para>MARC Country Codes - <ulink
40576 url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
40580 <para>Search the MARC Code List for Organizations - <ulink
40581 url="http://www.loc.gov/marc/organizations/org-search.php">http://www.loc.gov/marc/organizations/org-search.php</ulink></para>
40585 <para>Search for Canadian MARC Codes - <ulink
40586 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>
40590 <para>Z39.50 Bib-1 Attribute - <ulink
40591 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink></para>
40596 <section id="enhancedcontentlinks">
40597 <title>Enhanced Content Related</title>
40601 <para>Amazon Associates - <ulink
40602 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
40606 <para>Amazon Web Services - <ulink
40607 url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
40611 <para>WorldCat Affiliate Tools - <ulink
40612 url="http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister">http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister</ulink></para>
40616 <para>XISBN - <ulink
40617 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
40621 <para>LibraryThing for Libraries - <ulink
40622 url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
40627 <section id="opaclinks">
40628 <title>Design Related</title>
40632 <para>JQuery Library - <ulink
40633 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
40637 <para>Owen Leonard's Koha Blog - <ulink
40638 url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
40643 <section id="reportlinks">
40644 <title>Reports Related</title>
40648 <para>SQL Reports Library - <ulink
40649 url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink></para>
40653 <para>Database Schema - <ulink
40654 url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
40658 <para>Sample reports from NEKLS - <ulink
40659 url="http://www.nexpresslibrary.org/training/reports-training/">http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
40664 <section id="installlinks">
40665 <title>Installation Guides</title>
40669 <para>Installing Koha 3 on Ubuntu - <ulink
40670 url="http://www.blazingmoon.org/guides/k3-on-u810-1.html">http://www.blazingmoon.org/guides/k3-on-u810-1.html</ulink></para>
40674 <para>Koha on Debian installation documentation - <ulink
40675 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>
40679 <para>Koha 3.2 on Debian Squeeze - <ulink
40680 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>
40685 <section id="misclinks">
40686 <title>Misc</title>
40690 <para>Zotero - <ulink
40691 url="http://zotero.org">http://zotero.org</ulink></para>
40695 <para>SOPAC - <ulink
40696 url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
40702 <appendix id="XSLTiTypes">
40703 <title>Koha XSLT Item Types</title>
40705 <para>When you have any of the XSLT system preferences (<link
40706 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>, <link
40707 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>, <link
40708 linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>, and/or <link
40709 linkend="XSLTResultsDisplay">XSLTResultsDisplay</link>) along with the
40710 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
40711 preference turned on you will see item type icons on the related screen.
40713 <para>These images are coming from values found in your leader, if
40714 your leader is not cataloged properly it might be best to turn off the
40715 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
40716 preference (which can be done while leaving the other XSLT preferences
40718 </important></para>
40721 <screeninfo>Book image</screeninfo>
40725 <imagedata fileref="images/appendix-xslt/book.png"/>
40732 <para>Book [BK]</para>
40736 <para>leader6 = a (and one of the leader7 values below)</para>
40740 <para>leader7 = a</para>
40744 <para>leader7 = c</para>
40748 <para>leader7 = d</para>
40752 <para>leader7 = m</para>
40758 <para>leader6 = t</para>
40765 <screeninfo>Computer Image</screeninfo>
40769 <imagedata fileref="images/appendix-xslt/comp.png"/>
40776 <para>Computer File [CF]</para>
40780 <para>leader6 = m</para>
40787 <screeninfo>Continuing Resource Image</screeninfo>
40791 <imagedata fileref="images/appendix-xslt/cr.png"/>
40798 <para>Continuing Resource [CR]</para>
40802 <para>leader7 = b</para>
40806 <para>leader7 = i</para>
40810 <para>leader7 = s</para>
40817 <screeninfo>Map Image</screeninfo>
40821 <imagedata fileref="images/appendix-xslt/map.png"/>
40828 <para>Map [MP]</para>
40832 <para>leader6 = e</para>
40836 <para>leader6 = f</para>
40843 <screeninfo>Mixed Materials Image</screeninfo>
40847 <imagedata fileref="images/appendix-xslt/mixed.png"/>
40854 <para>Mixed [MX]</para>
40858 <para>leader6 = p</para>
40865 <screeninfo>Sound Image</screeninfo>
40869 <imagedata fileref="images/appendix-xslt/sound.png"/>
40876 <para>Sound [MU]</para>
40880 <para>leader6 = c</para>
40884 <para>leader6 = d</para>
40888 <para>leader6 = i</para>
40892 <para>leader6 = j</para>
40899 <screeninfo>Visual Material Image</screeninfo>
40903 <imagedata fileref="images/appendix-xslt/visual.png"/>
40910 <para>Visual Material [VM]</para>
40914 <para>leader6 = g</para>
40918 <para>leader6 = k</para>
40922 <para>leader6 = r</para>
40929 <screeninfo>Kit Image</screeninfo>
40933 <imagedata fileref="images/appendix-xslt/kit.png"/>
40944 <para>leader6 = o</para>
40951 <appendix id="marcedit">
40952 <title>MarcEdit</title>
40956 <section id="marceditprefix">
40957 <title>Adding a prefix to call numbers</title>
40959 <para>When bringing data into Koha, you may want to first clean it up.
40960 One common action among Koha users is to add a prefix to the call
40965 <para>Open MarcEdit</para>
40968 <screeninfo>MarcEdit</screeninfo>
40972 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
40979 <para>Click 'MarcEditor'</para>
40983 <para>Go to Tools > Edit Subfield Data</para>
40986 <screeninfo>Edit subfield data</screeninfo>
40990 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
40997 <para>To prepend data the special character is: ^b To simply
40998 prepend data to the beginning of a subfield, add ^b to the Field
40999 Data: textbox and the data to be appended in the Replace</para>
41002 <screeninfo>Prepend data to a field</screeninfo>
41006 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
41013 <para>To prepend data to the beginning of the subfield while
41014 replacing a text string, add ^b[string to replace] to the Field
41015 Data textbox and the data to be appended in the Replace With
41023 <section id="marceditexcel">
41026 <firstname>Kanika</firstname>
41028 <surname>Goyal</surname>
41031 <orgname>Delhi Technological University</orgname>
41036 <firstname>Nicole C.</firstname>
41038 <surname>Engard</surname>
41041 <pubdate>2010</pubdate>
41043 <bibliosource><ulink
41044 url="http://www.botskool.com/geeks/how-import-excel-data-koha">http://www.botskool.com/geeks/how-import-excel-data-koha</ulink></bibliosource>
41047 <title>Importing Excel data into Koha</title>
41049 <para>Suppose you have records of your library in excel data sheet
41050 format and want them to import into Koha. But how will you do this? Koha
41051 will not let you import excel records directly. Well here is a very
41052 simple solution for you which will let you import your excel records in
41053 Koha easily. First, we will convert excel file into Marc file and then
41054 will import it into Koha.</para>
41056 <para>Follow the given steps to import your excel records into
41059 <section id="convertexcel">
41060 <title>Converting from Excel format into .mrk format</title>
41062 <para>First, we will convert excel format into .mrk format. For this
41063 we will use MarcEdit. You can download it from <ulink
41064 url="http://people.oregonstate.edu/~reeset/marcedit/html/downloads.html">http://people.oregonstate.edu/~reeset/marcedit/html/downloads.html</ulink>.</para>
41066 <para>Now open it and select Add-ins-->Delimited Text
41070 <screeninfo>Delimited Text Translator</screeninfo>
41074 <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
41079 <para>Click Next when the following window appears.</para>
41082 <screeninfo>Delimited Text Translator</screeninfo>
41086 <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
41091 <para>Browse for your excel file.</para>
41094 <screeninfo>Delimited Text Translator</screeninfo>
41098 <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
41103 <para>Locate your excel file by choosing the format Excel
41104 File(*.xls).</para>
41107 <screeninfo>Delimited Text Translator</screeninfo>
41111 <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
41116 <para>Similarly, fill all the other entries such as Output File, Excel
41117 Sheet Name and check UTF-8 Encoded (if required) and Click
41121 <screeninfo>Delimited Text Translator</screeninfo>
41125 <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
41130 <para>Now you will be prompted for mapping the fields to recognise the
41131 fields by standard marc format.</para>
41133 <para>Suppose for Field 0 that is first column I entered Map to:
41134 022$a( Valid ISSN for the continuing resource) and then click on
41138 <screeninfo>Delimited Text Translator</screeninfo>
41142 <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
41148 <para>You can customize Indicators and all other things, for more
41149 information on marc21 format visit the <ulink
41150 url="http://www.loc.gov/marc/bibliographic/">official library of
41151 congress site</ulink>.</para>
41154 <para>Similarly map all other fields and then Click on Finish.</para>
41157 <screeninfo>Delimited Text Translator</screeninfo>
41161 <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
41166 <para>And then a window will appear indicating that your Marc Text
41167 File(*.mrk) has been created.</para>
41170 <screeninfo>Delimited Text Translator</screeninfo>
41174 <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
41179 <para>Click Close and we have created a .mrk file from .xls file in
41180 this step. You can view the file by double clicking on it.</para>
41183 <section id="convertmrk">
41184 <title>Convert .mrk file to .mrc</title>
41186 <para>We will convert .mrk file that we have created in the above step
41187 into raw Marc format that can be directly imported into Koha.</para>
41189 <para>For this again open MarcEdit and Select MARC Tools.</para>
41192 <screeninfo>MARC Tools</screeninfo>
41196 <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
41201 <para>Next Select MarcMaker to convert .mrk file into .mrc
41205 <screeninfo>MarcMaker</screeninfo>
41209 <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
41214 <para>Locate your input file and name your output file. Then Click
41218 <screeninfo>MarcMaker</screeninfo>
41222 <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
41227 <para>And it will show you the Result.</para>
41230 <screeninfo>MarcMaker</screeninfo>
41234 <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
41239 <para>Click Close and now we have raw Marc records with us (.mrc
41243 <section id="importmrc">
41244 <title>Import .mrc into Koha</title>
41246 <para>More information on importing records into Koha can be found in
41247 the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
41248 section of this manual.</para>
41250 <para>Finally we will import above created .mrc file into Koha.</para>
41252 <para>Click on Tools in your Koha staff client.</para>
41255 <screeninfo>Koha Staff Client</screeninfo>
41259 <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
41264 <para>Next Click on Stage MARC Records for Import.</para>
41267 <screeninfo>Stage MARC Records for Import</screeninfo>
41271 <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
41276 <para>After this, choose your previously created .mrc file and click
41280 <screeninfo>Stage File</screeninfo>
41284 <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
41289 <para>You can also add comment about file and finally click on Stage
41293 <screeninfo>Stage for Import</screeninfo>
41297 <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
41302 <para>When the import is done, you will get a result something like
41306 <screeninfo>Staged Records Summary</screeninfo>
41310 <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
41315 <para>Next, click on Manage staged records.</para>
41317 <para>Here you can even change matching rules.</para>
41320 <screeninfo>Manage Staged Records</screeninfo>
41324 <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
41329 <para>Click on Import this batch into catalog when you are
41332 <para>Thats it. After all the records get imported, check Status and
41333 it should read "imported"</para>
41336 <screeninfo>Finalize Import</screeninfo>
41340 <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
41345 <para>You can even undo the Import operation.</para>
41347 <para>And within few minutes, we have imported around 10,000 records
41353 <appendix id="talkingtechappendix">
41354 <title>Talking Tech</title>
41356 <para>Talking Tech I-tiva is a third party, proprietary, product that
41357 libraries can subscribe to. Learn more here: <ulink
41358 url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
41360 <section id="talkingtechinstall">
41361 <title>Installation and Setup Instructions</title>
41363 <para>Be sure you've run
41364 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
41365 to install the required data pack (new syspref, notice placeholders and
41366 messaging transport preferences)</para>
41368 <para>To use, <link
41369 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
41370 syspref must be turned on.</para>
41372 <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
41374 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
41375 system preference turned on, and patrons to have filled in a preference
41376 for receiving these notices by phone.</para>
41378 <para>For OVERDUE messages, overdue notice triggers must be configured
41379 under Koha -> Tools -> <link linkend="noticetriggers">Overdue
41380 Notice Triggers</link>. Either branch-specific triggers or the default
41381 level triggers may be used (script will select whichever is
41382 appropriate).</para>
41385 <section id="talkingtechsend">
41386 <title>Sending Notices File</title>
41390 <para>Add the <link
41391 linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
41392 script to your crontab</para>
41396 <para>Add an FTP/SFTP or other transport method to send the output
41397 file to the I-tiva server</para>
41401 <para>If you wish, archive the sent notices file in another
41402 directory after sending</para>
41406 <para>Run TalkingTech_itiva_outbound.pl --help for more
41410 <section id="talkingtechreceive">
41411 <title>Receiving Results File</title>
41415 <para>Add an FTP/SFTP or other transport method to send the Results
41416 file to a known directory on your Koha server</para>
41420 <para>Add the <link
41421 linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
41422 script to your crontab, aimed at that directory</para>
41426 <para>If you wish, archive the results file in another directory
41427 after processing</para>
41431 <para>Run TalkingTech_itiva_inbound.pl --help for more
41436 <appendix id="faqs">
41437 <title>FAQs</title>
41441 <section id="displayfaq">
41442 <title>Display</title>
41446 <section id="customicons">
41447 <title>Custom Item Type/Authorized Value Icons</title>
41449 <para><emphasis role="bold">Question:</emphasis> Can I have my own set
41450 of item type images (or authorized value icons)?</para>
41452 <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
41453 additional icons to your system you simply add a new directory to
41454 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
41455 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
41456 directory. Your icons will show up in a new tab as soon as they are in
41457 the folders.</para>
41462 <para>Remember to put the icons in both places (on the OPAC and
41463 the intranet).</para>
41469 <section id="customkohaimages">
41470 <title>Customizing Koha Images</title>
41472 <para><emphasis role="bold">Question</emphasis>: Can I customize the
41473 images in the OPAC?</para>
41475 <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
41476 with a series of original images that you can alter to meet your
41477 needs. The originals can be found in the misc/interface_customization/
41481 <section id="opacdisplayfaq">
41482 <title>OPAC Display Fields</title>
41484 <para><emphasis role="bold">Question</emphasis>: What MARC fields
41485 print to the different OPAC screens in Koha?</para>
41487 <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
41488 must be set as follows for the following fields to show</para>
41493 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
41494 using XSLT stylesheets</para>
41499 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
41500 using XSLT stylesheets</para>
41505 linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
41510 <para>The OPAC Results page shows:</para>
41518 <para>100, 110, 111</para>
41522 <para>700, 710, 711</para>
41542 <para>The OPAC Details page shows:</para>
41550 <para>100, 110, 111</para>
41554 <para>700, 710, 711</para>
41558 <para>440, 490</para>
41586 <para>130, 240</para>
41626 <para>plus all of the 5xx fields in the Notes tab at the
41632 <section id="displaysubtitle">
41633 <title>Subtitle Display on Bib Records</title>
41635 <para><emphasis role="bold">Question</emphasis>: How do I get the
41636 subtitle to display on the detail pages for my bib records?</para>
41638 <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
41639 depends on there being a <link linkend="keywordmapping">keyword
41640 mapping</link> for the MARC field in question. Adding a mapping for
41641 "subtitle" -> "245b" for an item's framework results in display of
41642 the subtitle in OPAC and staff client search and detail pages
41643 (although not in all instances where subtitles might be displayed,
41644 e.g. the Cart).</para>
41647 <section id="customlogo">
41650 <firstname>Owen</firstname>
41652 <surname>Leonard</surname>
41655 <orgname>Athens County Public Library</orgname>
41659 <pubdate>July 2010</pubdate>
41662 <title>Customize Logo on Staff Client</title>
41664 <para><emphasis role="bold">Question</emphasis>: How do I change the
41665 Koha logo on the Staff Client login page?</para>
41667 <para><emphasis role="bold">Answer</emphasis>: <link
41668 linkend="opacsmallimage">Opacsmallimage</link> controls the display of
41669 the Koha logo in the OPAC, but there is no system preference
41670 controlling the logo on the staff client login page. Luckily the logo
41671 is displayed via CSS so it can be easily customized through some
41674 <para>These are the relevant parts of the staff client default CSS:
41675 <programlisting>#login h1 {
41676 background:url("../../img/koha-logo.gif") no-repeat scroll center
41678 margin-bottom:0.5em;
41683 border-bottom:medium none;
41686 text-indent:-1000px;
41687 }</programlisting></para>
41689 <para>If you have access to the file system on your Koha server you
41690 can add a custom CSS file and specify that file using the <link
41691 linkend="intranetcolorstylesheet">intranetcolorstylesheet</link>
41692 system preference.</para>
41694 <para>There is no analogue to the <link
41695 linkend="OPACUserCSS">OPACUserCSS</link> preference in the staff
41696 client, but you can get around this by putting this in the <link
41697 linkend="intranetuserjs">intranetuserjs</link> preference:
41698 <programlisting>//]]>
41700 <style type="text/css">
41701 /* inline styles */
41703 <script type="text/javascript">
41704 //<![CDATA[</programlisting></para>
41706 <para>In the above snippet where it says /* inline styles */ we'll
41707 redeclare the relevant properties from the styles of the login
41708 image:<programlisting>//]]>
41710 <style type="text/css">
41711 /* inline styles */
41714 background:url("../../img/koha-logo.gif") no-repeat scroll center
41722 <script type="text/javascript">
41724 </programlisting></para>
41726 <para>I've only reproduced the properties necessary to make the change
41727 we want. You can see that the "background:" property sets the path to
41728 the default logo. You can change this to point to any image you want,
41729 on the Koha server or anywhere else. Then you just need to change the
41730 #login h1 a's "height" property to match the height of the image you
41733 <para>For example:</para>
41735 <para><programlisting>//]]>
41737 <style type="text/css">
41738 /* inline styles */
41741 background:url("http://www.myacpl.org/sites/all/themes/npl/logo.png")
41742 no-repeat scroll center top transparent;
41749 <script type="text/javascript">
41750 //<
projects / kohadocs.git / blob