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
1151 <para>Description:</para>
1155 <para>This is a pipe separated (|) list of options. At the
1156 moment, the only option available is "broader_headings." With
1157 this option set to "broader_headings", the linker will try to
1158 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1160 <para>First: Camins-Esakov, Jared--Coin
1161 collections--Catalogs--Early works to 1800</para>
1163 <para>Next: Camins-Esakov, Jared--Coin
1164 collections--Catalogs</para>
1166 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1168 <para>Next: Camins-Esakov, Jared (matches! if a previous
1169 attempt had matched, it would not have tried this)</para>
1174 <section id="LinkerRelink">
1175 <title>LinkerRelink</title>
1177 <para>Default: Do</para>
1179 <para>Asks: ___ relink headings that have previously been linked
1180 to authority records.</para>
1182 <para>Values:</para>
1194 <para>Description:</para>
1198 <para>When set to 'Do', the linker will confirm the links for
1199 headings that have previously been linked to an authority
1200 record when it runs, correcting any incorrect links it may
1201 find. When set to 'Do not', any heading with an existing link
1202 will be ignored, even if the existing link is invalid or
1210 <section id="catprefs">
1211 <title>Cataloging</title>
1213 <para><emphasis>Get there:</emphasis> More > Administration >
1214 Global System Preferences > Cataloging</para>
1216 <section id="catdisplayprefs">
1217 <title>Display</title>
1221 <section id="authoritysep">
1222 <title>authoritysep</title>
1224 <para>Default: --</para>
1226 <para>Asks: Separate multiple displayed authors, series or
1227 subjects with ___.</para>
1230 <section id="hide_marc">
1231 <title>hide_marc</title>
1233 <para>Default: Display</para>
1235 <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1238 <para>Values:</para>
1242 <para>Display -- shows the tag numbers on the cataloging
1246 <screeninfo>MARC editor with tags showing</screeninfo>
1250 <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1257 <para>Don't display -- shows just descriptive text when
1261 <screeninfo>MARC editor without tags showing</screeninfo>
1265 <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1273 <section id="IntranetBiblioDefaultView">
1274 <title>IntranetBiblioDefaultView</title>
1276 <para>Default: ISBD form</para>
1278 <para>Asks: By default, display biblio records in ___</para>
1280 <para>Values:</para>
1284 <para>ISBD form -- displays records in the staff client in the
1285 old card catalog format</para>
1289 <para>See <link linkend="isbdpref">ISBD</link> preference
1290 for more information</para>
1296 <para>Labelled MARC form -- displays records in the staff
1297 client in MARC with text labels to explain the different
1302 <para>MARC form -- displays records in the staff client in
1307 <para>normal form -- visual display in the staff client (for
1308 the average person)</para>
1312 <para>Description:</para>
1316 <para>This setting determines the bibliographic record display
1317 when searching the catalog on the staff client. This setting
1318 does not affect the display in the OPAC which is changed using
1319 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1320 preference under the OPAC preference tab. This setting changes
1321 the look of the record when first displayed. The MARC and ISBD
1322 views can still be seen by clicking in the sidebar.</para>
1327 <section id="isbdpref">
1330 <para>Default: <link linkend="isbddefault">MARC21 Default
1331 Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1332 Appendix</link></para>
1334 <para>Asks: Use the following as the ISBD template:</para>
1336 <para>Description:</para>
1340 <para>This determines how the ISBD information will display.
1341 Elements in the list can be reordered to produce a different
1342 ISBD view. ISBD, the International Standard Bibliographic
1343 Description, was first introduced by IFLA (International
1344 Federation of Library Associations) in 1969 in order to
1345 provide guidelines for descriptive cataloging. The purpose of
1346 ISBD is to aid the international exchange of bibliographic
1347 records for a variety of materials.</para>
1352 <section id="LabelMARCView">
1353 <title>LabelMARCView</title>
1355 <para>Default: Don't</para>
1357 <para>Asks: ___ collapse repeated tags of the same type into one
1360 <para>Values:</para>
1364 <para>Do -- will combine all identical tag numbers under one
1365 heading in the MARC view in the OPAC and Staff Client</para>
1368 <screeninfo>MARC View in the Staff Client with LabelMARCView
1369 set to Do</screeninfo>
1373 <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
1380 <para>Don't -- will list all of the tags individually in the
1381 MARC view in the OPAC and Staff Client</para>
1384 <screeninfo>MARC View in the Staff Client with LabelMARCView
1385 set to Don't</screeninfo>
1389 <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
1397 <section id="OpacSuppression">
1398 <title>OpacSuppression</title>
1400 <para>Default: Don't hide</para>
1402 <para>Asks: ___ items marked as suppressed from OPAC search
1405 <para>Values:</para>
1409 <para>Don't hide -- will show items in OPAC search results if
1410 they are marked suppressed</para>
1414 <para>Hide -- will not show items in OPAC search results if
1415 they're marked as suppressed</para>
1419 <para>Each bib record with items you want to hide from the
1420 OPAC simply need to have the 942n field set to 1. The
1421 index then hides it from display in OPAC but will still
1422 display it in the Staff Client</para>
1428 <para>Description:</para>
1432 <para>An <link linkend="authorizedvalues">authorized
1433 value</link> for 942$n field should be set to eliminate
1434 errors. One example would be to create an authorized value
1435 titled SUPPRESS with a value of 0 for don't suppress and 1 for
1441 <para>If this preference is set to 'hide' and you have the 942n
1442 field set to 1, it will hide the entire bib record - not just an
1443 individual item.</para>
1447 <para>You must have the Suppress index set up in Zebra and at
1448 least one suppressed item, or your searches will be
1453 <section id="URLLinkText">
1454 <title>URLLinkText</title>
1456 <para>Default: Online Resource</para>
1458 <para>Asks: Show ___ as the text of links embedded in MARC
1461 <para>Description:</para>
1465 <para>If the 856 field does not have a subfield 3 or y
1466 defined, the OPAC will say 'Click here to access online.' If
1467 you would like the field to say something else enter that in
1473 <section id="UseControlNumber">
1474 <title>UseControlNumber</title>
1476 <para>Default: Don't use</para>
1478 <para>Asks: ___ record control number ($w subfields) and control
1479 number (001) for linking of bibliographic records.</para>
1481 <para>Values:</para>
1485 <para>Don't use</para>
1489 <para>When clicking on links to titles that appear next to
1490 'Continues' and 'Continued by' in the detail display Koha
1491 will perform a title search</para>
1501 <para>When clicking on links to titles that appear next to
1502 'Continues' and 'Continued by' in the detail display Koha
1503 will perform a control number (MARC field 001)
1511 <para>Unless you are going in and manually changing 773$w to
1512 match your rigorously-defined bibliographic relationships, you
1513 should set this preference to "Don't use" and instead set <link
1514 linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
1518 <para>Description:</para>
1522 <para>If you have a serial called "Journal of Interesting
1523 Things" which has a separate record from when it was called
1524 "Transactions of the Interesting Stuff Society," you could add
1525 linking fields to indicate the relationship between the two
1526 records. UseControlNumber allows you to use your local
1527 accession numbers for those links. In MARC21, the relevant
1528 sections of the two records might look like
1529 this:<programlisting> =001 12345
1530 =110 2_$aInteresting Stuff Society.
1531 =245 10$aTransactions of the Interesting Stuff Society.
1532 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1535 =110 2_$aInteresting Stuff Society.
1536 =245 10$aJournal of Interesting Things.
1537 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
1539 <para>With UseControlNumber set to 'Use', the 78x links will
1540 use the Control Numbers is subfield $w, instead of doing a
1541 title search on "Journal of Interesting Things" and
1542 "Transactions of the Interesting Stuff Society"
1543 respectively.</para>
1549 <section id="catinterfaceprefs">
1550 <title>Interface</title>
1554 <section id="advancedMARCeditor">
1555 <title>advancedMARCeditor</title>
1557 <para>Default: Don't display</para>
1559 <para>Asks: ___ descriptions of fields and subfields in the MARC
1562 <para>Description:</para>
1566 <para>This preference determines whether or not MARC field
1567 names will be present when editing or creating MARC
1572 <para>Values:</para>
1576 <para>Display</para>
1579 <screeninfo>MARC editor with text labels</screeninfo>
1583 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
1590 <para>Don't display</para>
1593 <screeninfo>MARC editor without text labels</screeninfo>
1597 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
1605 <section id="DefaultClassificationSource">
1606 <title>DefaultClassificationSource</title>
1608 <para>Default: Dewey Decimal System</para>
1610 <para>Asks: Use ___ as the default classification source.</para>
1612 <para>Values:</para>
1616 <para>ANSCR (Sound Recordings)</para>
1620 <para>Dewey Decimal Classification</para>
1624 <para>Library of Congress Classification</para>
1628 <para>Other/Generic Classification Scheme</para>
1632 <para>SuDoc Classification (U.S. GPO)</para>
1636 <para>Universal Decimal Classification</para>
1641 <section id="EasyAnalyticalRecords">
1644 <firstname id="analyticsauthor">Linda</firstname>
1646 <surname>Culberson</surname>
1649 <orgname>Ms. Dept. of Archives and History</orgname>
1653 <pubdate id="analyticspubdate">October 2011</pubdate>
1655 <othercredit id="analyticseditor" role="copyeditor">
1656 <firstname>Nicole C.</firstname>
1658 <surname>Engard</surname>
1660 <contrib id="analyticscredit">Fixed typos, changed content
1661 where necessary and added new screenshots.</contrib>
1665 <title>EasyAnalyticalRecords</title>
1667 <para>Asks: ___ easy ways to create analytical record
1668 relationships</para>
1670 <para>Default: Don't Display</para>
1672 <para>Values:</para>
1676 <para>Display</para>
1680 <para>Don't Display</para>
1685 <para>If you decide to use this feature you'll want to make sure
1687 linkend="UseControlNumber">UseControlNumber</link> preference is
1688 set to "Don't use" or else the "Show analytics" links in the
1689 staff client and the OPAC will be broken.</para>
1692 <para>Description:</para>
1696 <para>An analytic entry in a catalog is one that describes a
1697 part of a larger work that is also described in the catalog.
1698 In bibliographic cataloging, analytic entries may be made for
1699 chapters in books or special issues of articles in
1700 periodicals. In archival cataloging, analytic entries may be
1701 made for series or items within a collection. This feature in
1702 Koha allows for an easy way of linking analytic entries to the
1703 host records, and this system preference adds several new menu
1704 options to the staff cataloging detail pages to allow that to
1711 <section id="catrecordprefs">
1712 <title>Record Structure</title>
1716 <section id="AlternateHoldingsField">
1717 <title>AlternateHoldingsField &
1718 AlternateHoldingsSeparator</title>
1720 <para>Asks: Display MARC subfield ___ as holdings information for
1721 records that do not have items, with the subfields separated by
1724 <para>Description:</para>
1728 <para>Sometimes libraries migrate to Koha with their holding
1729 info in the 852 field (OCLC holdings information field) and
1730 choose not to transfer that information into the 952 (Koha
1731 holdings information field) because they don't plan on
1732 circulating those items. For those libraries or other
1733 libraries that have data in the 852 fields of their records
1734 that they want to display, these preferences let you choose to
1735 display holdings info from a field other than the 952 field.
1736 The AlternateHoldingsField preference can contain multiple
1737 subfields to look in; for instance 852abhi would look in 852
1738 subfields a, b, h, and i.</para>
1742 <para>With AlternateHoldingsField set to 852abhi and
1743 AlternateHoldingsSeparator set to a space the holdings would
1744 look like the following:</para>
1747 <screeninfo>Alternate Holdings Display</screeninfo>
1751 <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
1759 <section id="autoBarcode">
1760 <title>autoBarcode</title>
1762 <para>Default: generated in the form
1763 <branchcode>yymm0001</para>
1765 <para>Asks: Barcodes are ___</para>
1767 <para>Values:</para>
1771 <para>generated in the form <branchcode>yymm0001</para>
1775 <para>generated in the form <year>-0001</para>
1779 <para><year>-0002. generated in the form 1, 2, 3</para>
1783 <para>not generated automatically</para>
1787 <para>Description:</para>
1791 <para>This setting is for libraries wishing to generate
1792 barcodes from within Koha (as opposed to scanning in
1793 pre-printed barcodes or manually assigning them).</para>
1798 <section id="item-level_itypes">
1799 <title>item-level_itypes</title>
1801 <para>Default: specific item</para>
1803 <para>Asks: Use the item type of the ___ as the authoritative item
1804 type (for determining circulation and fines rules, etc).</para>
1806 <para>Values:</para>
1810 <para>biblio record</para>
1814 <para>specific item</para>
1818 <para>Description:</para>
1822 <para>This preference determines whether the item type Koha
1823 uses for issuing rules will be an attribute of the
1824 bibliographic record or the item record. Most libraries refer
1825 to the item record for item types. It also determines if the
1826 item type icon appears on the OPAC search results. If you have
1827 the preference set to 'biblio record' then Koha displays the
1828 item type icon on the search results to the left of the result
1832 <screeninfo>Item Type Icons to the Left of Result
1833 Information</screeninfo>
1837 <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
1845 <section id="itemcallnumber">
1846 <title>itemcallnumber</title>
1848 <para>Default: 082ab</para>
1850 <para>Asks: Map the MARC subfield to an item's callnumber.</para>
1853 <para>This can contain multiple subfields to look in; for
1854 instance 082ab would look in 082 subfields a and b.</para>
1857 <para>Description:</para>
1861 <para>This setting determines which MARC field will be used to
1862 determine the call number that will be entered into item
1863 records automatically (952$o). The value is set by providing
1864 the MARC field code (050, 082, 090, 852 are all common) and
1865 the subfield codes without the delimiters ($a, $b would be
1870 <para>Examples:</para>
1874 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
1875 item record: 852hi</para>
1880 <section id="marcflavour">
1881 <title>marcflavour</title>
1883 <para>Default: MARC21</para>
1885 <para>Asks: Interpret and store MARC records in the ___
1888 <para>Description:</para>
1892 <para>This preference defines global MARC style (MARC21 or
1893 UNIMARC) used for encoding. MARC21 is the standard style for
1894 the US, Canada and Britain. UNIMARC is a variation of MARC21
1895 that is used in France, Italy, Russia, and many other
1900 <para>Values:</para>
1908 <para>UNIMARC</para>
1913 <section id="MARCOrgCode">
1914 <title>MARCOrgCode</title>
1916 <para>Default: OSt</para>
1918 <para>Asks: Fill in the MARC organization code ___ by default in
1919 new MARC records (leave blank to disable).</para>
1921 <para>Description:</para>
1925 <para>The MARC Organization Code is used to identify libraries
1926 with holdings of titles and more.</para>
1930 <para>Learn more and find your library's code on the <ulink
1931 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC
1932 Code list for Organizations</ulink> or in Canada on the <ulink
1933 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
1934 Symbols Directory</ulink>.</para>
1937 <section id="NewItemsDefaultLocation">
1938 <title>NewItemsDefaultLocation</title>
1940 <para>Asks: When items are created, give them the temporary
1941 location of ___ (should be a location code, or blank to
1945 <section id="z3950NormalizeAuthor">
1946 <title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
1948 <para>Defaults: Don't copy & 701,702,700</para>
1950 <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
1951 commas) to the correct author tags when importing a record using
1954 <para>Description for z3950NormalizeAuthor:</para>
1958 <para>This preference allows for ‘Personal Name
1959 Authorities' to replace authors as the bibliographic
1960 authority. This preference should only be considered by
1961 libraries using UNIMARC.</para>
1965 <para>Values for z3950NormalizeAuthor:</para>
1973 <para>Don't copy</para>
1977 <para>Description for z3950AuthorAuthFields:</para>
1981 <para>This preference defines which MARC fields will be used
1982 for ‘Personal Name Authorities' to replace authors as
1983 the bibliographic authorities. This preference only applies to
1984 those using UNIMARC encoding. The MARC fields selected here
1985 will only be used if ‘z3950NormalizeAuthor' is set to
1986 “Copy". The default field are 700, 701, and 702.</para>
1992 <section id="catspineprefs">
1993 <title>Spine Labels</title>
1997 <section id="SpineLabelAutoPrint">
1998 <title>SpineLabelAutoPrint</title>
2000 <para>Default: don't</para>
2002 <para>Asks: When using the quick spine label printer, ___
2003 automatically pop up a print dialog.</para>
2005 <para>Values:</para>
2018 <section id="SpineLabelFormat">
2019 <title>SpineLabelFormat</title>
2021 <para>Default: <itemcallnumber><copynumber></para>
2023 <para>Asks: Include the following fields on a quick-printed spine
2024 label: (Enter in columns from the biblio, biblioitems or items
2025 tables, surrounded by < and >.)</para>
2028 <section id="SpineLabelShowPrintOnBibDetails">
2029 <title>SpineLabelShowPrintOnBibDetails</title>
2031 <para>Default: Don't display</para>
2033 <para>Asks: ___ buttons on the bib details page to print item
2034 spine labels.</para>
2036 <para>Values:</para>
2040 <para>Display</para>
2043 <screeninfo>'Print Label' link appears on bibliographic
2044 record in the staff client</screeninfo>
2048 <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2055 <para>Don't display</para>
2062 <section id="circprefs">
2063 <title>Circulation</title>
2065 <para><emphasis>Get there:</emphasis> More > Administration >
2066 Global System Preferences > Circulation</para>
2068 <section id="circcheckoutpolicy">
2069 <title>Checkout Policy</title>
2073 <section id="AllFinesNeedOverride">
2074 <title>AllFinesNeedOverride</title>
2076 <para>Default: Require</para>
2078 <para>Asks: ___ staff to manually override all fines, even fines
2080 linkend="noissuescharge">noissuescharge</link>.</para>
2082 <para>Values:</para>
2086 <para>Don't require</para>
2090 <para>Require</para>
2094 <para>Description:</para>
2098 <para>This preference let's you decide if you want to always
2099 be warned that the patron has fines when checking out. If you
2100 have it set to 'Require' then no matter how much money the
2101 patron owes a message will pop up warning you that the patron
2107 <section id="AllowFineOverride">
2108 <title>AllowFineOverride</title>
2110 <para>Default: Don't allow</para>
2112 <para>Asks: ___ staff to manually override and check out items to
2113 patrons who have more than <link
2114 linkend="noissuescharge">noissuescharge</link> in fines.</para>
2116 <para>Values:</para>
2124 <para>Don't allow</para>
2128 <para>Description:</para>
2132 <para>This preference lets you decide if you staff can check
2133 out to patrons who owe more money than you usually let them
2134 carry on their account. If set to 'Allow' staff will be warned
2135 that the patrons owes money, but it won't stop the staff from
2136 checking out to the patron.</para>
2141 <section id="AllowItemsOnHoldCheckout">
2142 <title>AllowItemsOnHoldCheckout</title>
2144 <para>Default: Don't allow</para>
2146 <para>Asks: ___ checkouts of items reserved to someone else. If
2147 allowed do not generate RESERVE_WAITING and RESERVED warning. This
2148 allows self checkouts for those items.</para>
2150 <para>Values:</para>
2158 <para>Don't allow</para>
2163 <para>This system preference relates only to SIP based self
2164 checkout, not Koha's web based self checkout.</para>
2167 <para>Description:</para>
2171 <para>When this preference is set to 'Allow' patrons will be
2172 able to use your external self check machine to check out a
2173 book to themselves even if it's on hold for someone else. If
2174 you would like Koha to prevent people from checking out books
2175 that are on hold for someone else set this preference to
2176 "Don't allow."</para>
2181 <section id="AllowNotForLoanOverride">
2182 <title>AllowNotForLoanOverride</title>
2184 <para>Default: Allow</para>
2186 <para>Asks: ___ staff to override and check out items that are
2187 marked as not for loan.</para>
2189 <para>Values:</para>
2197 <para>Don't allow</para>
2201 <para>Description:</para>
2205 <para>This parameter is a binary setting which controls the
2206 ability of staff (patrons will always be prevented from
2207 checking these items out) to check out items that are marked
2208 as “not for loan". Setting it to “Allow" would
2209 allow such items to be checked out, setting it to “Don't
2210 allow" would prevent this. This setting determines whether
2211 items meant to stay in the library, such as reference
2212 materials, and other library resources can be checked out by
2218 <section id="AllowRenewalLimitOverride">
2219 <title>AllowRenewalLimitOverride</title>
2221 <para>Default: Allow</para>
2223 <para>Asks: ___ staff to manually override the renewal limit and
2224 renew a checkout when it would go over the renewal limit.</para>
2226 <para>Values:</para>
2234 <para>Don't allow</para>
2238 <para>Description:</para>
2242 <para>This preference is a binary setting which controls the
2243 ability of staff to override the limits placed on the number
2244 of times an item can be renewed. Setting it to “Allow"
2245 would allow such limits to be overridden, setting it to
2246 “Don't allow" would prevent this. This is a preference
2247 in which if it is set to “allow" it would allow the
2248 library staff to use their judgment for overriding the renew
2249 limit for special cases, setting it to “Don't allow"
2250 prevents an opportunity for abuse by the library staff.</para>
2255 <section id="AutomaticItemReturn">
2256 <title>AutomaticItemReturn</title>
2258 <para>Default: Do</para>
2260 <para>Asks: ___ automatically transfer items to their home branch
2261 when they are returned.</para>
2263 <para>Values:</para>
2275 <para>Description:</para>
2279 <para>This preference is a binary setting which determines
2280 whether an item is returned to its home branch automatically
2281 or not. If set to “Don't", the staff member checking an
2282 item in at a location other than the item's home branch will
2283 be asked whether the item will remain at the non-home branch
2284 (in which case the new location will be marked as a holding
2285 location) or returned. Setting it to “Do" will ensure
2286 that items checked in at a branch other than their home branch
2287 will be sent to that home branch.</para>
2292 <section id="CircControl">
2293 <title>CircControl</title>
2295 <para>Default: the library the item is from</para>
2297 <para>Asks: Use the checkout and fines rules of ___</para>
2299 <para>Values:</para>
2303 <para>the library the item is from</para>
2307 <para>The circulation and fines policies will be
2308 determined by the library that owns the item</para>
2314 <para>the library the patron is from</para>
2318 <para>The circulation and fines policies will be
2319 determined the patron's home library</para>
2325 <para>the library you are logged in at</para>
2329 <para>The circulation and fines policies will be
2330 determined by the library that checked the item out to the
2338 <section id="HomeOrHoldingBranch">
2339 <title>HomeOrHoldingBranch</title>
2341 <para>Default: the library the item was checked out from</para>
2343 <para>Asks: Use the checkout and fines rules of ___</para>
2345 <para>Description:</para>
2349 <para>This preference establishes what may be done with a
2350 loaned item once the item has been returned. It deals with
2351 situations in which one library branch has borrowed materials
2352 from a different branch. Essentially it decides whether a
2353 library may check the borrowed item back out to its patron or
2354 if it must immediately send the item back to the owning
2359 <para>Values:</para>
2363 <para>the library the item is from</para>
2367 <para>the library the item was checked out from</para>
2372 <para>It is not recommend that this setting be changed after
2373 initial setup of Koha</para>
2377 <para>This preference does nothing unless the
2378 IndependantBranches preference is set to 'Prevent'.</para>
2383 <para><emphasis>Get there: </emphasis>More > Administration
2384 > Global System Preferences > Admin > <link
2385 linkend="IndependantBranches">IndependantBranches</link></para>
2390 <section id="InProcessingToShelvingCart">
2391 <title>InProcessingToShelvingCart</title>
2393 <para>Default: Don't move</para>
2395 <para>Asks: ___ items that have the location PROC to the location
2396 CART when they are checked in.</para>
2398 <para>Values:</para>
2402 <para>Don't move</para>
2411 <section id="IssuingInProcess">
2412 <title>IssuingInProcess</title>
2414 <para>Default: Don't prevent</para>
2416 <para>Asks: ___ patrons from checking out an item whose rental
2417 charge would take them over the limit.</para>
2419 <para>Values:</para>
2423 <para>Don't prevent</para>
2427 <para>Prevent</para>
2431 <para>Description:</para>
2435 <para>This preference determines if a patron can check items
2436 out if there is an overdue fine on the account and any of the
2437 materials the patron wishes to check out will potentially tip
2438 the account balance over the maximum fines policy the library
2439 has in place.</para>
2443 <para>Example: Your library has a $5 limit set for 'fines' (ie,
2444 after incurring $5 in fines, a patron can no longer check out
2445 items). A patron comes to the desk with 5 items to check out (4
2446 books and a video) The patron has $4 in charges already on their
2447 account. One of the videos has a rental charge of $1, therefore
2448 making the total fines on the patron's account suddenly $5 (the
2452 <section id="maxoutstanding">
2453 <title>maxoutstanding</title>
2455 <para>Default: 5</para>
2457 <para>Asks: Prevent patrons from making holds on the OPAC if they
2458 owe more than ___ USD in fines.</para>
2461 <section id="noissuescharge">
2462 <title>noissuescharge</title>
2464 <para>Default: 5</para>
2466 <para>Asks: Prevent patrons from checking out books if they have
2467 more than ___ USD in fines.</para>
2469 <para>Description:</para>
2473 <para>This preference is the maximum amount of money owed to
2474 the library before the user is banned from borrowing more
2475 items. This also coincides with <link
2476 linkend="maxoutstanding">maxoutstanding</link> that limits
2477 patrons from placing holds when the maximum amount is owed to
2483 <section id="OverduesBlockCirc">
2484 <title>OverduesBlockCirc</title>
2486 <para>Default: Ask for confirmation</para>
2488 <para>Asks: ___ when checking out to a borrower that has overdues
2491 <para>Values:</para>
2495 <para>Ask for confirmation</para>
2499 <para>Will not let you check an item out to patrons with
2500 overdues until a librarian confirms that it is okay</para>
2510 <para>Block all patrons with overdue items from being able
2517 <para>Don't block</para>
2521 <para>Allow all patrons with overdue items to continue to
2529 <section id="OverdueNoticeBcc">
2530 <title>OverdueNoticeBcc</title>
2532 <para>Asks: Send all notices as a BCC to this email address
2535 <para>This preference makes it so that a librarian can get a copy
2536 of every notice sent out to patrons.<tip>
2537 <para>If you'd like more than one person to receive the blind
2538 copy you can simply enter in multiple email addresses
2539 separated by commas.</para>
2543 <section id="PrintNoticesMaxLines">
2544 <title>PrintNoticesMaxLines</title>
2546 <para>Asks: Include up to ___ item lines in a printed overdue
2550 <para>If the number of items is greater than this number, the
2551 notice will end with a warning asking the borrower to check
2552 their online account for a full list of overdue items.</para>
2556 <para>Set to 0 to include all overdue items in the notice, no
2557 matter how many there are.</para>
2561 <para>This preference only refers to the print notices, not
2562 those sent via email.</para>
2566 <section id="RenewalPeriodBase">
2567 <title>RenewalPeriodBase</title>
2569 <para>Default: the old due date of the checkout</para>
2571 <para>Asks: When renewing checkouts, base the new due date on
2574 <para>Values:</para>
2578 <para>the old due date of the checkout</para>
2582 <para>the current date</para>
2587 <section id="ReturnBeforeExpiry">
2588 <title>ReturnBeforeExpiry</title>
2590 <para>Default: Don't require</para>
2592 <para>Asks: ___ patrons to return books before their accounts
2593 expire (by restricting due dates to before the patron's expiration
2596 <para>Values:</para>
2600 <para>Don't require</para>
2604 <para>Require</para>
2608 <para>Description:</para>
2612 <para>This is preference may prevent a patron from having
2613 items checked out after their library card has expired. If
2614 this is set to “Require", then a due date of any checked
2615 out item can not be set for a date which falls after the
2616 patron's card expiration. If the setting is left “Don't
2617 require" then item check out dates may exceed the expiration
2618 date for the patron's library card.</para>
2623 <section id="ReturnToShelvingCart">
2624 <title>ReturnToShelvingCart</title>
2626 <para>Default: Don't move</para>
2628 <para>Asks: ___ all items to the location CART when they are
2631 <para>Values:</para>
2635 <para>Don't move</para>
2644 <section id="TransfersMaxDaysWarning">
2645 <title>TransfersMaxDaysWarning</title>
2647 <para>Default: 3</para>
2649 <para>Asks: Show a warning on the "Transfers to Receive" screen if
2650 the transfer has not been received ___ days after it is
2653 <para>Description:</para>
2657 <para>The TransferMaxDaysWarning preference is set at a
2658 default number of days. This preference allows for a warning
2659 to appear after a set amount of time if an item being
2660 transferred between library branches has not been received.
2661 The warning will appear in the <link
2662 linkend="transferstoreceive">Transfers to Receive</link>
2668 <section id="UseBranchTransferLimits">
2669 <title>UseBranchTransferLimits &
2670 BranchTransferLimitsType</title>
2672 <para>Defaults: Don't enforce & collection code</para>
2674 <para>Asks: ___ branch transfer limits based on ___</para>
2676 <para>UseBranchTransferLimits Values:</para>
2680 <para>Don't enforce</para>
2684 <para>Enforce</para>
2688 <para>BranchTransferLimitsType Values:</para>
2692 <para>collection code</para>
2696 <para>item type</para>
2700 <para>BranchTransferLimitsType Description:</para>
2704 <para>This parameter is a binary setting which determines
2705 whether items are transferred according to item type or
2706 collection code. This value determines how the library manager
2707 is able to restrict what items can be transferred between the
2713 <section id="useDaysMode">
2714 <title>useDaysMode</title>
2716 <para>Default: Don't include</para>
2718 <para>Asks: Calculate the due date using ___.</para>
2720 <para>Values:</para>
2724 <para>circulation rules only.</para>
2728 <para>the calendar to push the due date to the next open
2733 <para>the calendar to skip all days the library is
2738 <para>Description:</para>
2742 <para>This preference controls how scheduled library closures
2743 affect the due date of a material. The 'the calendar to skip
2744 all days the library is closed' setting allows for a scheduled
2745 closure not to count as a day in the loan period, the
2746 'circulation rules only' setting would not consider the
2747 scheduled closure at all, and 'the calendar to push the due
2748 date to the next open day' would only effect the due date if
2749 the day the item is due would fall specifically on the day of
2754 <para>Example:</para>
2758 <para>The library has put December 24th and 25th in as
2759 closures on the calendar. A book checked out by a patron has a
2760 due date of December 25th according to the circulation and
2761 fine rules. If this preference is set to 'circulation rules
2762 only' then the item will remain due on the 25th. If the
2763 preference is set to 'the calendar to push the due date to the
2764 next open day' then the due date will be December 26th. If the
2765 preference is set to 'the calendar to skip all days the
2766 library is closed' then the due date will be pushed to the
2767 27th of December to accommodate for the two closed
2772 <para>The calendar is defined on a branch by branch basis. To
2773 learn more about the calendar, check out the '<link
2774 linkend="calholidays">Calendar & Holidays</link>' section of
2779 <section id="circfinespolicy">
2780 <title>Fines Policy</title>
2784 <section id="finesCalendar">
2785 <title>finesCalendar</title>
2787 <para>Default: not including the days the library is closed</para>
2789 <para>Asks: Calculate fines based on days overdue ___</para>
2791 <para>Values:</para>
2795 <para>directly</para>
2799 <para>not including the days the library is closed</para>
2803 <para>Description:</para>
2807 <para>This preference will determine whether or not fines will
2808 be accrued during instances when the library is closed.
2809 Examples include holidays, library in-service days, etc.
2810 Choosing 'not including the days the library is closed"
2811 setting will enable Koha to access its <link
2812 linkend="calholidays">Calendar</link> module and be
2813 considerate of dates when the library is closed. To make use
2814 of this setting the administrator must first access Koha's
2815 calendar and mark certain days as “holidays" ahead of
2820 <para>The calendar is defined on a branch by branch basis. To
2821 learn more about the calendar, check out the '<link
2822 linkend="calholidays">Calendar & Holidays</link>' section of
2826 <section id="finesMode">
2827 <title>finesMode</title>
2829 <para>Default: Calculate (but only for mailing to the
2832 <para>Asks: ___ fines</para>
2834 <para>Values:</para>
2838 <para>Calculate (but only for mailing to the admin)</para>
2842 <para>Calculate and charge</para>
2846 <para>Don't calculate</para>
2851 <para>Requires that you have the fines cron job running
2852 (misc/cronjobs/fines.pl)</para>
2857 <section id="circholdspolicy">
2858 <title>Holds Policy</title>
2862 <section id="AllowHoldDateInFuture">
2863 <title>AllowHoldDateInFuture</title>
2865 <para>Default: Allow</para>
2867 <para>Asks: ___ hold requests to be placed that do not enter the
2868 waiting list until a certain future date.</para>
2870 <para>Values:</para>
2878 <para>Don't allow</para>
2883 <section id="AllowHoldsOnDamagedItems">
2884 <title>AllowHoldsOnDamagedItems</title>
2886 <para>Default: Allow</para>
2888 <para>Asks: ___ hold requests to be placed on damaged
2891 <para>Values:</para>
2899 <para>Don't allow</para>
2903 <para>Description:</para>
2907 <para>This parameter is a binary setting which controls
2908 whether or not hold requests can be placed on items that are
2909 marked as “damaged" (items are marked as damaged by
2910 editing subfield 4 on the item record). Setting this value to
2911 “Don't allow" will prevent anyone from placing a hold on
2912 such items, setting it to “Allow" will allow it. This
2913 preference is important because it determines whether or not a
2914 patron can place a request for an item that might be in the
2915 process of being repaired or not in good condition. The
2916 library may wish to set this to “Don't allow" if they
2917 were concerned about their patrons not receiving the item in a
2918 timely manner or at all (if it is determined that the item is
2919 beyond repair). Setting it to “Allow" would allow a
2920 patron to place a hold on an item and therefore receive it as
2921 soon as it becomes available.</para>
2926 <section id="AllowHoldPolicyOverride">
2927 <title>AllowHoldPolicyOverride</title>
2929 <para>Default: Allow</para>
2931 <para>Asks: ___ staff to override hold policies when placing
2934 <para>Values:</para>
2942 <para>Don't allow</para>
2946 <para>Description:</para>
2950 <para>This preference is a binary setting which controls
2951 whether or not the library staff can override the circulation
2952 and fines rules as they pertain to the placement of holds.
2953 Setting this value to “Don't allow" will prevent anyone
2954 from overriding, setting it to “Allow" will allow it.
2955 This setting is important because it determines how strict the
2956 libraries rules for placing holds are. If this is set to
2957 “Allow", exceptions can be made for patrons who are
2958 otherwise normally in good standing with the library, but
2959 there is opportunity for the staff to abuse this function. If
2960 it is set to “Don't allow", no abuse of the system is
2961 possible, but it makes the system entirely inflexible in
2962 respect to holds.</para>
2967 <section id="AllowOnShelfHolds">
2968 <title>AllowOnShelfHolds</title>
2970 <para>Default: Allow</para>
2972 <para>Asks: ___ hold requests to be placed on items that are not
2975 <para>Values:</para>
2983 <para>Don't Allow</para>
2987 <para>Description:</para>
2991 <para>This preference is a binary setting which controls the
2992 ability of patrons to place holds on items that are not
2993 currently checked out. Setting it to “Don't allow"
2994 allows borrowers to place holds on items that are checked out
2995 but not on items that are on the shelf (or assumed available
2996 in the library), setting it to “Allow" allows borrowers
2997 to place holds on any item that is available for loan whether
2998 it is checked out or not. This setting might be set to "Allow"
2999 if the library system is a multi branch system and patrons
3000 used the hold system to request items from other libraries, or
3001 if the library wanted to allow users to place holds on items
3002 from home through the OPAC. Setting it to “Don't allow"
3003 would enforce a first come, first served standard.</para>
3008 <section id="AutoResumeSuspendedHolds">
3009 <title>AutoResumeSuspendedHolds</title>
3011 <para>Default: Allow</para>
3013 <para>Asks: ___ suspended holds to be automatically resumed by a
3016 <para>Values:</para>
3024 <para>Don't allow</para>
3028 <para>Description:</para>
3032 <para>If this preference is set to 'Allow' then all suspended
3033 holds will be able to have a date at which they automatically
3034 become unsuspended. If you have this preference set to 'Allow'
3035 you will also need the <link
3036 linkend="unsuspendholdcron">Unsuspend Holds</link> cron job
3042 <section id="canreservefromotherbranches">
3043 <title>canreservefromotherbranches</title>
3045 <para>Default: Allow</para>
3047 <para>Asks: ___ a user from one library to place a hold on an item
3048 from another library</para>
3050 <para>Description:</para>
3054 <para>This preference is a binary setting which determines
3055 whether patrons can place holds on items from other branches.
3056 If the preference is set to “Allow" patrons can place
3057 such holds, if it is set to “Don't allow" they cannot.
3058 This is an important setting because it determines if users
3059 can use Koha to request items from another branch. If the
3060 library is sharing an installation of Koha with other
3061 independent libraries which do not wish to allow interlibrary
3062 borrowing it is recommended that this parameter be set to
3063 “Don't allow".</para>
3067 <para>Values:</para>
3075 <para>Don't allow (with <link
3076 linkend="IndependantBranches">independent
3077 branches</link>)</para>
3082 <section id="DisplayMultiPlaceHold">
3083 <title>DisplayMultiPlaceHold</title>
3085 <para>Default: Don't enable</para>
3087 <para>Asks: ___ the ability to place holds on multiple biblio from
3088 the search results</para>
3090 <para>Values:</para>
3094 <para>Don't enable</para>
3103 <section id="emailLibrarianWhenHoldIsPlaced">
3104 <title>emailLibrarianWhenHoldIsPlaced</title>
3106 <para>Default: Don't enable</para>
3108 <para>Asks: ___ sending an email to the Koha administrator email
3109 address whenever a hold request is placed.</para>
3111 <para>Values:</para>
3115 <para>Don't enable</para>
3123 <para>Description:</para>
3127 <para>This preference enables Koha to email the library staff
3128 whenever a patron requests an item to be held. While this
3129 function will immediately alert the librarian to the patron's
3130 need, it is extremely impractical in most library settings. In
3131 most libraries the hold lists are monitored and maintained
3132 from a separate interface. That said, many libraries that
3133 allow on shelf holds prefer to have this preference turned on
3134 so that they are alerted to pull an item from the
3140 <para>In order for this email to send you must have a <link
3141 linkend="notices">notice</link> template with the code of
3146 <para>This notice will only be sent if the <link
3147 linkend="msgqueuecron">process_message_queue.pl cronjob</link>
3148 being run periodically to send the messages.</para>
3152 <section id="ExpireReservesMaxPickUpDelay">
3153 <title>ExpireReservesMaxPickUpDelay</title>
3155 <para>Default: Don't allow</para>
3157 <para>Asks: ___ holds to expire automatically if they have not
3158 been picked by within the time period specified in <link
3159 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
3161 <para>Values:</para>
3169 <para>Don't allow</para>
3173 <para>Description:</para>
3177 <para>If set to 'allow' this will cancel holds that have been
3178 waiting for longer than the number of days specified in the
3180 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
3181 system preference. Holds will only be cancelled if the <link
3182 linkend="expiredholdscron">Expire Holds cron job</link> is
3188 <section id="ExpireReservesMaxPickUpDelayCharge">
3189 <title>ExpireReservesMaxPickUpDelayCharge</title>
3191 <para>Default: 0</para>
3193 <para>Asks: If using <link
3194 linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
3195 charge a borrower who allows his or her waiting hold to expire a
3196 fee of ___ USD</para>
3198 <para>Description:</para>
3202 <para>If you are expiring holds that have been waiting too
3203 long you can use this preference to charge the patron for not
3204 picking up their hold. If you don't charge patrons for items
3205 that aren't picked up you can leave this set to the default
3206 which is 0. Holds will only be cancelled and charged if the
3207 <link linkend="expiredholdscron">Expire Holds cron job</link>
3213 <section id="maxreserves">
3214 <title>maxreserves</title>
3216 <para>Default: 50</para>
3218 <para>Asks: Patrons can only have ___ holds at once.</para>
3221 <section id="OPACAllowHoldDateInFuture">
3222 <title>OPACAllowHoldDateInFuture</title>
3224 <para>Default: Allow</para>
3226 <para>Asks: ___ patrons to place holds that don't enter the
3227 waiting list until a certain future date.</para>
3229 <para>Values:</para>
3238 linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
3239 must also be enabled for this to work</para>
3245 <para>Don't allow</para>
3250 <section id="OPACAllowUserToChooseBranch">
3251 <title>OPACAllowUserToChooseBranch</title>
3253 <para>Default: Allow</para>
3255 <para>Asks: ___ a user to choose the branch to pick up a hold
3258 <para>Values:</para>
3266 <para>Don't allow</para>
3270 <para>Description:</para>
3274 <para>Changing this preference will not prevent staff from
3275 being able to transfer titles from one branch to another to
3276 fill a hold, it will only prevent patrons from saying they
3277 plan on picking a book up at a branch other than their home
3283 <section id="ReservesControlBranch">
3284 <title>ReservesControlBranch</title>
3286 <para>Default: item's home library</para>
3288 <para>Asks: Check the ___ to see if the patron can place a hold on
3291 <para>Values:</para>
3295 <para>item's home library.</para>
3299 <para>patron's home library.</para>
3304 <section id="ReservesMaxPickUpDelay">
3305 <title>ReservesMaxPickUpDelay</title>
3307 <para>Default: 7</para>
3309 <para>Asks: Mark a hold as problematic if it has been waiting for
3310 more than ___ days.</para>
3312 <para>Description:</para>
3316 <para>This preference (based on calendar days, not the <link
3317 linkend="calholidays">Koha holiday calendar</link>) puts an
3318 expiration date on an item a patron has on hold. After this
3319 expiration date the staff will have the option to release the
3320 unclaimed hold which then may be returned to the library shelf
3321 or issued to the next patron on the item's hold list. Items
3322 that are 'expired' by this preference are moved to the 'Holds
3323 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
3324 Pickup</link>' report.</para>
3329 <section id="ReservesNeedReturns">
3330 <title>ReservesNeedReturns</title>
3332 <para>Default: Don't automatically</para>
3334 <para>Asks: ___ mark holds as found and waiting when a hold is
3335 placed specifically on them and they are already checked
3338 <para>Values:</para>
3342 <para>Automatically</para>
3346 <para>Don't automatically</para>
3350 <para>Description:</para>
3354 <para>This preference refers to ‘item specific' holds
3355 where the item is currently on the library shelf. This
3356 preference allows a library to decide whether an ‘item
3357 specific' hold is marked as “Waiting" at the time the
3358 hold is placed or if the item will be marked as
3359 “Waiting" after the item is checked in. This preference
3360 will tell the patron that their item is ‘Waiting' for
3361 them at their library and ready for check out.</para>
3366 <section id="holdqueueweight">
3367 <title>StaticHoldsQueueWeight &
3368 RandomizeHoldsQueueWeight</title>
3370 <para>StaticHoldsQueueWeight Default: 0</para>
3372 <para>RandomizeHoldsQueueWeight Default: in that order</para>
3374 <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
3375 separated by commas; if empty, uses all libraries) ___</para>
3377 <para>RandomizeHoldsQueueWeight Values:</para>
3381 <para>in random order</para>
3385 <para>If StaticHoldsQueueWeight is left at the default
3386 Koha will randomize all libraries, otherwise it will
3387 randomize the libraries listed.</para>
3393 <para>in that order</para>
3397 <para>If StaticHoldsQueueWeight is left at the default
3398 then this will use all of your branches in alphabetical
3399 order, otherwise it will use the branches in the order
3400 that you entered them in the StaticHoldsQueueWeight
3407 <para>Descriptions:</para>
3411 <para>These preferences control how the <link
3412 linkend="holdsqueue">Holds Queue report</link> is generated
3413 using <link linkend="buildholdscron">a cron job</link>.</para>
3415 <para>If you do not want all of your libraries to participate
3416 in the on-shelf holds fulfillment process, you should list the
3417 the libraries that *do* participate in the process here by
3418 inputting all the participating library's branchcodes,
3419 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
3421 <para>By default, the holds queue will be generated such that
3422 the system will first attempt to hold fulfillment using items
3423 already at the pickup library if possible. If there are no
3424 items available at the pickup library to fill a hold,
3425 build_holds_queue.pl will then use the list of libraries
3426 defined in StaticHoldsQueueWeight. If
3427 RandomizeHoldsQueueWeight is disabled ( which it is by default
3428 ), the script will assign fulfillment requests in the order
3429 the branches are placed in the StaticHoldsQueueWeight system
3432 <para>For example, if your system has three libraries, of
3433 varying sizes ( small, medium and large ) and you want the
3434 burden of holds fulfillment to be on larger libraries before
3435 smaller libraries, you would want StaticHoldsQueueWeight to
3436 look something like "LRG,MED,SML".</para>
3438 <para>If you want the burden of holds fulfillment to be spread
3439 out equally throughout your library system, simply enable
3440 RandomizeHoldsQueueWeight. When this system preference is
3441 enabled, the order in which libraries will be requested to
3442 fulfill an on-shelf hold will be randomized each time the list
3443 is regenerated.</para>
3445 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
3446 at this time. Doing so will cause the build_holds_queue script
3447 to ignore RandomizeHoldsQueueWeight, causing the script to
3448 request hold fulfillment not randomly, but by alphabetical
3454 <section id="SuspendHoldsIntranet">
3455 <title>SuspendHoldsIntranet</title>
3457 <para>Default: Allow</para>
3459 <para>Asks: ___ holds to be suspended from the intranet.</para>
3461 <para>Values:</para>
3469 <para>Don't allow</para>
3473 <para>Description:</para>
3477 <para>The holds suspension feature can be turned on and off in
3478 the staff client by altering this system preference. If this
3479 is set to 'allow' you will want to set the <link
3480 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
3481 system preference.</para>
3486 <section id="SuspendHoldsOpac">
3487 <title>SuspendHoldsOpac</title>
3489 <para>Default: Allow</para>
3491 <para>Asks: ___ holds to be suspended from the OPAC.</para>
3493 <para>Values:</para>
3501 <para>Don't allow</para>
3505 <para>Description:</para>
3509 <para>The holds suspension feature can be turned on and off in
3510 the OPAC by altering this system preference. If this is set to
3511 'allow' you will want to set the <link
3512 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
3513 system preference.</para>
3519 <section id="circinterfaceprefs">
3520 <title>Interface</title>
3524 <section id="AllowAllMessageDeletion">
3525 <title>AllowAllMessageDeletion</title>
3527 <para>Default: Don't allow</para>
3529 <para>Asks: ___ staff to delete messages added from other
3532 <para>Values:</para>
3540 <para>Don't allow</para>
3545 <section id="CircAutocompl">
3546 <title>CircAutocompl</title>
3548 <para>Default: Try</para>
3550 <para>Asks: ___ to automatically fill in the member when entering
3551 a patron search on the circulation screen.</para>
3553 <para>Description:</para>
3557 <para>This preference is a binary setting which determines
3558 whether auto-completion of fields is enabled or disabled for
3559 the circulation input field. Setting it to “Try" would
3560 enable a staff member to begin typing a name or other value
3561 into the field and have a menu pop up with suggestions for
3562 completing it. Setting it to “Don't try" would disable
3563 this feature. This preference can make staff members' jobs
3564 easier or it could potentially slow down the page loading
3569 <para>Values:</para>
3573 <para>Don't try</para>
3580 <screeninfo>When CircAutocompl is turned on search results
3581 will appear below the search box</screeninfo>
3585 <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
3593 <section id="CircAutoPrintQuickSlip">
3594 <title>CircAutoPrintQuickSlip</title>
3596 <para>Default: open a print quick slip window</para>
3598 <para>Asks: When an empty barcode field is submitted in
3599 circulation ___</para>
3601 <para>Values:</para>
3605 <para>clear the screen</para>
3609 <para>open a print quick slip window</para>
3613 <para>Description:</para>
3617 <para>If this preference is set to open a quick slip for
3618 printing it will eliminate the need for the librarian to click
3619 the print button to generate a checkout receipt for the patron
3620 they're checking out to. If the preference is set to clear the
3621 screen then "checking out" an empty barcode will clear the
3622 screen of the patron you were last working with.</para>
3627 <section id="FilterBeforeOverdueReport">
3628 <title>FilterBeforeOverdueReport</title>
3630 <para>Default: Don't require</para>
3632 <para>Asks: ___ staff to choose which checkouts to show before
3633 running the overdues report.</para>
3635 <para>Description:</para>
3639 <para>Koha's overdue report shows you all of the overdue items
3640 in your library system. If you have a large library system
3641 you'll want to set this preference to 'Require' to force those
3642 running the report to first limit the data generated to a
3643 branch, date range, patron category or other such filter.
3644 Requiring that the report be filtered before it's run prevents
3645 your staff from running a system heavy report and slowing down
3646 other operations in the system.</para>
3649 <screeninfo>Overdue Report Filters</screeninfo>
3653 <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
3660 <para>Values:</para>
3664 <para>Don't require</para>
3668 <para>Require</para>
3673 <section id="FineNotifyAtCheckin">
3674 <title>FineNotifyAtCheckin</title>
3676 <para>Default: Don't notify</para>
3678 <para>Asks: ___ librarians of overdue fines on the items they are
3681 <para>Values:</para>
3685 <para>Don't notify</para>
3693 <para>Description:</para>
3697 <para>With this preference set to 'Notify' all books that have
3698 overdue fines owed on them will pop up a warning when checking
3699 them in. This warning will need to acknowledged before you can
3700 continue checking items in. With this preference set to 'Don't
3701 notify,' you will still see fines owed on the patron record,
3702 you just won't have an additional notification at check
3706 <screeninfo>Fine notification at checkin</screeninfo>
3710 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
3718 <section id="DisplayClearScreenButton">
3719 <title>DisplayClearScreenButton</title>
3721 <para>Default: Show</para>
3723 <para>Asks: ___ a button to clear the current patron from the
3724 screen on the circulation screen.</para>
3726 <para>Values:</para>
3730 <para>Don't show</para>
3733 <screeninfo>No X in the top right</screeninfo>
3737 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
3747 <screeninfo>X in the top right will clear the
3752 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
3760 <section id="itemBarcodeInputFilter">
3761 <title>itemBarcodeInputFilter</title>
3763 <para>Default: Don't filter</para>
3765 <para>Asks: ___ scanned patron barcodes.</para>
3767 <para>Values:</para>
3771 <para>Convert from CueCat format</para>
3775 <para>Don't filter</para>
3779 <para>Remove spaces from</para>
3783 <para>Remove the first number from T-prefix style</para>
3787 <para>This format is common among those libraries
3788 migrating from Follett systems</para>
3795 <section id="NoticeCSS">
3796 <title>NoticeCSS</title>
3798 <para>Asks: Include the stylesheet at ___ on Notices.<important>
3799 <para>This should be a complete URL, starting with
3803 <para>Description:</para>
3807 <para>If you would like to style your notices with a
3808 consistent set of fonts and colors you can use this preference
3809 to point Koha to a stylesheet specifically for your
3815 <section id="numReturnedItemsToShow">
3816 <title>numReturnedItemsToShow</title>
3818 <para>Default: 20</para>
3820 <para>Asks : Show the ___ last returned items on the checkin
3824 <section id="previousIssuesDefaultSortOrder">
3825 <title>previousIssuesDefaultSortOrder</title>
3827 <para>Default: earliest to latest</para>
3829 <para>Asks: Sort previous checkouts on the circulation page from
3830 ___ due date.</para>
3832 <para>Values:</para>
3836 <para>earliest to latest</para>
3840 <para>latest to earliest</para>
3845 <section id="RecordLocalUseOnReturn">
3846 <title>RecordLocalUseOnReturn</title>
3848 <para>Default: Don't record</para>
3850 <para>Asks: ___ local use when an unissued item is checked
3853 <para>Values:</para>
3857 <para>Don't record</para>
3865 <para>Description:</para>
3869 <para>When this preference is set to "Don't record" you can
3870 record local use of items by checking items out to the
3871 statistical patron. With this preference set to "Record" you
3872 can record local use by checking out to the statistical patron
3873 and/or by checking in a book that is not currently checked
3879 <section id="soundon">
3880 <title>soundon</title>
3882 <para>Default: Don't enable</para>
3884 <para>Asks: ___ circulation sounds during checkin and checkout in
3885 the staff interface.</para>
3887 <para>Values:</para>
3891 <para>Don't enable</para>
3900 <para>This feature is not supported by all browsers. Requires
3901 an HTML5 compliant browser.</para>
3905 <section id="SpecifyDueDate">
3906 <title>SpecifyDueDate</title>
3908 <para>Default: Allow</para>
3910 <para>Asks: ___ staff to specify a due date for a checkout.</para>
3912 <para>Due dates are calculated using your circulation and fines
3913 rules, but staff can override that if you allow them to specify a
3914 due date at checkout.</para>
3916 <para>Description:</para>
3920 <para>This preference allows for circulation staff to change a
3921 due date from the automatic due date to another calendar date.
3922 This option would be used for circumstances in which the due
3923 date may need to be decreased or extended in a specific
3924 circumstance. The “Allow" setting would allow for this
3925 option to be utilized by staff, the “Don't allow"
3926 setting would bar staff from changing the due date on
3931 <para>Values:</para>
3939 <para>Don't allow</para>
3944 <section id="todaysIssuesDefaultSortOrder">
3945 <title>todaysIssuesDefaultSortOrder</title>
3947 <para>Default: latest to earliest</para>
3949 <para>Asks: Sort today's checkouts on the circulation page from
3950 ___ due date.</para>
3952 <para>Values:</para>
3956 <para>earliest to latest</para>
3960 <para>latest to earliest</para>
3965 <section id="UseTablesortForCirc">
3966 <title>UseTablesortForCirc</title>
3968 <para>Default: Don't enable</para>
3970 <para>Asks: ___ the sorting of current patron checkouts on the
3971 circulation screen.</para>
3973 <para>Values:</para>
3977 <para>Don't enable</para>
3986 <para>Enabling this function may slow down circulation time for
3987 patrons with many checkouts.</para>
3991 <section id="WaitingNotifyAtCheckin">
3992 <title>WaitingNotifyAtCheckin</title>
3994 <para>Default: Don't notify</para>
3996 <para>Asks: ___ librarians of waiting holds for the patron whose
3997 items they are checking in.</para>
3999 <para>Values:</para>
4003 <para>Don't notify</para>
4010 <screeninfo>Notification that a hold is waiting</screeninfo>
4014 <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
4021 <para>Description:</para>
4025 <para>When checking in books you can choose whether or not to
4026 have a notice pop up if the patron who returned the book has a
4027 hold waiting for pick up. If you choose 'Notify' for
4028 WaitingNotifyAtCheckin then every time a hold is found for the
4029 patron who had the book out last a message will appear on your
4030 check in screen.</para>
4036 <section id="circscoprefs">
4037 <title>Self Checkout</title>
4041 <section id="AllowSelfCheckReturns">
4042 <title>AllowSelfCheckReturns</title>
4044 <para>Default: Don't allow</para>
4046 <para>Asks: ___ patrons to return items through web-based self
4047 checkout system.</para>
4049 <para>Values:</para>
4057 <para>Don't allow</para>
4061 <para>Description:</para>
4065 <para>This preference is used to determine if you want patrons
4066 to be allowed to return items through your self check
4067 machines. By default Koha's self check interface is simply for
4068 checking items out.</para>
4073 <section id="AutoSelfCheckAllowed">
4074 <title>AutoSelfCheckAllowed, AutoSelfCheckID &
4075 AutoSelfCheckPass</title>
4078 <para>Most libraries will want to leave this set to 'Don't
4079 allow.' This preference turns off the requirement to log into
4080 the self checkout machine with a staff username and password by
4081 storing the username and password for automatic login.</para>
4084 <para>AutoSelfCheckAllowed Default: Don't allow</para>
4086 <para>Asks: ___ the web-based self checkout system to
4087 automatically login with this staff login ___ and this password
4090 <para>AutoSelfCheckAllowed Values:</para>
4098 <para>Don't allow</para>
4102 <para>AutoSelfCheckID needs to be set to the username of a staff
4103 member with 'circulate' <link
4104 linkend="patronpermissions">permissions</link>.</para>
4106 <para>AutoSelfCheckPass needs to be set to the password of a staff
4107 member with 'circulate' <link
4108 linkend="patronpermissions">permissions</link>.</para>
4111 <section id="SelfCheckHelpMessage">
4112 <title>SelfCheckHelpMessage</title>
4114 <para>Asks: Include the following HTML in the Help page of the
4115 web-based self checkout system</para>
4117 <para>Description:</para>
4121 <para>Clicking the 'Help' link in the top right of the self
4122 checkout interface opens up a three step process for using the
4123 self check interface. Adding HTML to this system preference
4124 will print that additional help text above what's already
4130 <section id="SelfCheckoutByLogin">
4131 <title>SelfCheckoutByLogin</title>
4133 <para>Default: Barcode</para>
4135 <para>Asks: Have patrons login into the web-based self checkout
4136 system with their ___</para>
4138 <para>Values:</para>
4142 <para>Barcode</para>
4145 <screeninfo>Self Checkout Patron Card Number</screeninfo>
4149 <imagedata fileref="images/circ/selfcheckout.png"/>
4156 <para>Username and password</para>
4159 <screeninfo>Shelf checkout by login</screeninfo>
4163 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
4170 <para>Description:</para>
4174 <para>This preference lets you decide how your patrons will
4175 log in to the self checkout machine. Barcode is the patron's
4176 card number and their username and password is set using the
4177 opac/staff username and password fields on the patron
4183 <section id="SelfCheckTimeout">
4184 <title>SelfCheckTimeout</title>
4186 <para>Default: 120</para>
4188 <para>Asks: Time out the current patron's web-based self checkout
4189 system login after ___ seconds.</para>
4191 <para>Description:</para>
4195 <para>After the machine is idle for the time entered in this
4196 preference the self check out system will log out the current
4197 patron and return to the starting screen.</para>
4202 <section id="ShowPatronImageInWebBasedSelfCheck">
4203 <title>ShowPatronImageInWebBasedSelfCheck</title>
4205 <para>Default: Don't show</para>
4207 <para>Asks: ___ the patron's picture (if one has been added) when
4208 they use the web-based self checkout.</para>
4210 <para>Values:</para>
4214 <para>Don't show</para>
4223 <section id="WebBasedSelfCheck">
4224 <title>WebBasedSelfCheck</title>
4226 <para>Default: Don't enable</para>
4228 <para>Asks: ___ the web-based self checkout system.</para>
4230 <para>Values:</para>
4234 <para>Don't enable</para>
4242 <para>Enabling this preference will allow access to the <link
4243 linkend="selfcheckout">self checkout</link> module in Koha.</para>
4248 <section id="creatorprefs">
4249 <title>Creators</title>
4251 <para>These preferences have to do with creating content.</para>
4253 <para><emphasis>Get there:</emphasis> More > Administration >
4254 Global System Preferences > Creators</para>
4256 <section id="creatorpatcardprefs">
4257 <title>Patron Cards</title>
4259 <para>These preferences are in reference to the <link
4260 linkend="patroncardcreator">Patron Card Creator</link> tool.</para>
4262 <section id="ImageLimit">
4263 <title>ImageLimit</title>
4265 <para>Asks: Limit the number of creator images stored in the
4266 database to ___ images.</para>
4271 <section id="enhancedcontent">
4272 <title>Enhanced Content</title>
4274 <para><emphasis>Get there:</emphasis> More > Administration >
4275 Global System Preferences > Enhanced Content</para>
4278 <para>Always read the terms of service associated with external data
4279 sources to be sure that you are using the products within the
4280 allowed limits.</para>
4284 <para>You cannot have more than one service for cover images
4285 (including local cover images) set up. If you set up more than one
4286 you will get multiple cover images. Instead choose only one source
4287 for cover images.</para>
4290 <section id="frbrenhancedprefs">
4295 <section id="FRBRizeEditions">
4296 <title>FRBRizeEditions</title>
4298 <para>Default: Don't show</para>
4300 <para>Asks: ___ other editions of an item on the staff
4303 <para>Values:</para>
4307 <para>Don't show</para>
4314 <screeninfo>Editions tab in staff client</screeninfo>
4318 <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
4325 <para>Description:</para>
4329 <para>Using the rules set forth in the Functional Requirements
4330 for Bibliographic records, this option, when enabled, pulls
4331 all editions of the same title available in your collection
4332 regardless of material type. Items will appear under an
4333 'Editions' tab on the detail page for the title in question..
4334 According to <emphasis>Libraries Unlimited's Online Dictionary
4335 for Library and Information Science</emphasis> (<ulink
4336 url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>),
4337 FRBRizing the catalog involves collating MARC records of
4338 similar materials. FRBRization brings together entities (sets
4339 of Works, Expressions, or Manifestations), rather than just
4340 sets of Items. It can aid patrons in selecting related items,
4341 expressions, and manifestations that will serve their needs.
4342 When it is set to "Show", the OPAC will query one or more ISBN
4343 web services for associated ISBNs and display an Editions tab
4344 on the details pages. Once this preference is enabled, the
4345 library must select one of the ISBN options (<link
4346 linkend="ThingISBN">ThingISBN</link> or <link
4347 linkend="XISBN">XISBN</link>). This option is only for the
4348 Staff Client; the OPACFRBRizeEditions option must be enabled
4349 to have the Editions tab appear on the OPAC.</para>
4354 <para>Requires that you turn on one or more of the ISBN services
4355 (<link linkend="ThingISBN">ThingISBN</link> or <link
4356 linkend="XISBN">XISBN</link>)</para>
4360 <section id="OPACFRBRizeEditions">
4361 <title>OPACFRBRizeEditions</title>
4363 <para>Default: Don't show</para>
4365 <para>Asks: ___ other editions of an item on the OPAC.</para>
4367 <para>Description:</para>
4371 <para>Using the rules set forth in the Functional Requirements
4372 for Bibliographic records, this option, when enabled, pulls
4373 all editions of the same title available in your collection
4374 regardless of material type. Items will appear under an
4375 'Editions' tab on the detail page for the title in question..
4376 According to <emphasis>Libraries Unlimited's Online Dictionary
4377 for Library and Information Science</emphasis> (<ulink
4378 url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>),
4379 FRBRizing the catalog involves collating MARC records of
4380 similar materials. FRBRization brings together entities (sets
4381 of Works, Expressions, or Manifestations), rather than just
4382 sets of Items. It can aid patrons in selecting related items,
4383 expressions, and manifestations that will serve their needs.
4384 When it is set to "Show", the OPAC will query one or more ISBN
4385 web services for associated ISBNs and display an Editions tab
4386 on the details pages. Once this preference is enabled, the
4387 library must select one of the ISBN options (<link
4388 linkend="ThingISBN">ThingISBN</link> or <link
4389 linkend="XISBN">XISBN</link>). This option is only for the
4390 OPAC; the 'FRBRizeEditions' option must be turned “On"
4391 to have the Editions tab appear on the Staff Client.</para>
4395 <para>Values:</para>
4399 <para>Don't show</para>
4406 <screeninfo>Editions tab in the OPAC</screeninfo>
4410 <imagedata fileref="images/admin/globalprefs/editions.png"/>
4417 <para>This preference pulls all editions of the same title
4418 available in your collection regardless of material type. Items
4419 will appear under an 'Editions' tab on the detail page for the
4420 title in question.</para>
4423 <para>Requires that you turn on one or more of the ISBN services
4424 (<link linkend="ThingISBN">ThingISBN</link> or <link
4425 linkend="XISBN">XISBN</link>)</para>
4430 <section id="amazonprefs">
4431 <title>Amazon</title>
4435 <section id="AmazonEnabled">
4436 <title>AmazonEnabled</title>
4438 <para>Default: Don't use</para>
4440 <para>Asks: ___ data from Amazon on the staff interface (including
4441 reviews and "Search Inside" links on item detail pages).</para>
4443 <para>Values:</para>
4447 <para>Don't use</para>
4456 <para>This requires that you have signed up for and entered an
4462 <para>Sign up at: <ulink
4463 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4467 <para>Enter your key in the <link
4468 linkend="AWSAccessKeyID">AWSAccessKeyID</link> system
4473 <para>Description:</para>
4477 <para>This preference does not display any content but instead
4478 enables other Amazon-related preferences (<link
4479 linkend="AmazonCoverImages">AmazonCoverImages</link>, <link
4480 linkend="AmazonSimilarItems">AmazonSimilarItems</link>, <link
4481 linkend="AmazonReviews">AmazonReviews</link>). Before turning
4482 this feature to "Use", the library must first set <link
4483 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4484 linkend="AWSPrivateKey">AWSPrivateKey</link>. Furthermore, if
4485 Amazon content is enabled, other jacket services should be
4486 disabled to avoid interference. This preference applies only
4487 to the Staff Client. In order to display Amazon content on the
4488 OPAC, please set the <link
4489 linkend="OPACAmazonEnabled">OPACAmazonEnabled</link>
4495 <section id="OPACAmazonEnabled">
4496 <title>OPACAmazonEnabled</title>
4498 <para>Default: Don't use</para>
4500 <para>Asks: ___ data from Amazon on the OPAC (including reviews
4501 and "Search Inside" links on item detail pages).</para>
4503 <para>Values:</para>
4507 <para>Don't use</para>
4516 <para>This requires that you have signed up for and entered an
4522 <para>Sign up at: <ulink
4523 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4527 <para>Set your enter your key in the <link
4528 linkend="AWSAccessKeyID">AWSAccessKeyID</link> system
4533 <para>Description:</para>
4537 <para>This preference does not display any content but instead
4538 enables other Amazon-related preferences (<link
4539 linkend="AmazonCoverImages">AmazonCoverImages</link>, <link
4540 linkend="AmazonSimilarItems">AmazonSimilarItems</link>, <link
4541 linkend="AmazonReviews">AmazonReviews</link>). Before turning
4542 this feature to "Use", the library must first set <link
4543 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4544 linkend="AWSPrivateKey">AWSPrivateKey</link>. Furthermore, if
4545 Amazon content is enabled, other jacket services should be
4546 disabled to avoid interference. This preference applies only
4547 to the OPAC. In order to display Amazon content on the Staff
4548 Client, please set the <link
4549 linkend="AmazonEnabled">AmazonEnabled</link>
4555 <section id="AmazonLocale">
4556 <title>AmazonLocale</title>
4558 <para>Default: American</para>
4560 <para>Asks: Use Amazon data from its ___ website.</para>
4566 <para>American</para>
4570 <para>British</para>
4574 <para>Canadian</para>
4586 <para>Japanese</para>
4591 <section id="AWSAccessKeyID">
4592 <title>AWSAccessKeyID</title>
4594 <para>Asks: Access Amazon content using the access key ___</para>
4596 <para>Sign up at: <ulink
4597 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4599 <para>Description:</para>
4603 <para>If the library has signed up for an Amazon Web Services
4604 (AWS) account, it will be assigned an Access Key ID. In order
4605 to enable Amazon content, cover images, reviews, and similar
4606 item suggestions, the library's Access Key ID must be entered
4611 <para>Once signed up your keys can be accessed by logging into
4612 your account and going to the 'Security Credentials' page. Your
4613 Access Key will be listed next to the date it was created.</para>
4616 <screeninfo>Amazon Access Keys</screeninfo>
4620 <imagedata fileref="images/admin/globalprefs/amazonkeys.png"/>
4626 <section id="AWSPrivateKey">
4627 <title>AWSPrivateKey</title>
4629 <para>Asks: Access Amazon content (other than book jackets) using
4630 the private key ___</para>
4632 <para>Sign up at: <ulink
4633 url="http://aws.amazon.com/">http://aws.amazon.com/</ulink></para>
4635 <para>Description:</para>
4639 <para>If the library has signed up for an Amazon Web Services
4640 (AWS) account, it will be assigned a Secret Access Key. In
4641 order to enable Amazon reviews and similar item suggestions,
4642 the library's Secret Access Key must be entered here.</para>
4646 <para>Once signed up your keys can be accessed by logging into
4647 your account and going to the 'Security Credentials' page. Next to
4648 your Access key is a link that says 'Show,' clicking this will
4649 open up your secret access key or your AWSPrivateKey.</para>
4652 <screeninfo>Amazon Private Key</screeninfo>
4656 <imagedata fileref="images/admin/globalprefs/amazonkeys.png"/>
4662 <section id="AmazonAssocTag">
4663 <title>AmazonAssocTag</title>
4665 <para>Asks: Put the associate tag ___ on links to Amazon.</para>
4668 <para>This can net your library referral fees if a patron
4669 decides to buy an item after clicking through to Amazon from
4673 <para>Description:</para>
4677 <para>An Amazon Associates Tag allows a library to earn a
4678 percentage of all purchases made on Amazon when a patron
4679 accesses Amazon's site via links on the library's website.
4680 More information about the Amazon Associates program is
4681 available at Amazon's Affiliate Program's website, <ulink
4682 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
4683 Before a tag can be obtained, however, the library must first
4684 apply for an Amazon Web Services (AWS) account. Applications
4685 are free of charge and can be made at <ulink
4686 url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
4687 Once an AWS account has been established, the library can then
4688 obtain the Amazon Associates Tag.</para>
4692 <para>Sign up at: <ulink
4693 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
4696 <section id="AmazonCoverImages">
4697 <title>AmazonCoverImages</title>
4699 <para>Default: Don't show</para>
4701 <para>Asks: ___ cover images from Amazon on search results and
4702 item detail pages on the staff interface.</para>
4704 <para>Values:</para>
4708 <para>Don't show</para>
4716 <para>Description:</para>
4720 <para>This preference makes it possible to either allow or
4721 prevent Amazon cover images from being displayed in the Staff
4722 Client. Cover images are retrieved by Amazon, which pulls the
4723 content based on the first ISBN number in the item's MARC
4724 record. Amazon offers this service free of charge, but
4725 interested libraries must first establish an Amazon Web
4726 Services (AWS) account (<ulink
4727 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4728 the value for this preference is set to "Show", the cover
4729 images will appear in the Staff Client, and if it is set to
4730 "Don't show", the images will not appear. If activating this
4731 feature, the library must first set <link
4732 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4733 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4734 you're using Amazon cover images, all other cover image
4735 services must be disabled. If they are not disabled, they will
4736 prevent AmazonCoverImages from functioning properly.</para>
4741 <para>Requires that <link
4742 linkend="AmazonEnabled">AmazonEnabled</link> is set to
4747 <section id="AmazonReviews">
4748 <title>AmazonReviews</title>
4750 <para>Default: Don't show</para>
4752 <para>Asks: ___ reviews from Amazon on item detail pages on the
4753 staff interface.</para>
4755 <para>Values:</para>
4759 <para>Don't show</para>
4767 <para>Description:</para>
4771 <para>This preference makes it possible to either allow or
4772 prevent Amazon reviews from being displayed in the Staff
4773 Client. Amazon offers this service free of charge, but
4774 interested libraries must first establish an Amazon Web
4775 Services (AWS) account (<ulink
4776 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4777 the value is set to "Show", the reviews will appear in the
4778 Staff Client, and if it is set to "Don't show", the reviews
4779 will not appear. Before setting this to "Show", the library
4780 must first set <link
4781 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4782 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4783 AmazonReviews is enabled, all other review services should be
4784 disabled to avoid interference.</para>
4789 <para>Since a change in terms of service by Amazon, this feature
4790 no longer works.</para>
4794 <section id="AmazonSimilarItems">
4795 <title>AmazonSimilarItems</title>
4797 <para>Default: Don't show</para>
4799 <para>Asks: ___ similar items, as determined by Amazon, on item
4800 detail pages on the staff interface.</para>
4802 <para>Values:</para>
4806 <para>Don't show</para>
4814 <para>This will use Amazon data to determine if you have
4815 similar items in your collection - it will not show items
4816 that you do not already have cataloged at your
4823 <para>Description:</para>
4827 <para>This preference makes it possible to either allow or
4828 prevent Amazon's suggestions for Similar Items from being
4829 displayed in the Staff Client. Amazon offers this service free
4830 of charge, but interested libraries must first establish an
4831 Amazon Web Services (AWS) account (<ulink
4832 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4833 the value is set to "Show", the Similar Items suggestions will
4834 appear in the Staff Client, and if it is set to "Don't show",
4835 the suggestions will not appear. Before enabling this
4836 preference, the library must first set <link
4837 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4838 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4839 AmazonSimilarItems is enabled, all other similar item services
4840 should be disabled to avoid interference.</para>
4845 <para>Since a change in terms of service by Amazon, this feature
4846 no longer works.</para>
4850 <section id="OPACAmazonCoverImages">
4851 <title>OPACAmazonCoverImages</title>
4853 <para>Default: Don't show</para>
4855 <para>Asks: ___ cover images from Amazon on search results and
4856 item detail pages on the OPAC.</para>
4858 <para>Values:</para>
4862 <para>Don't show</para>
4870 <para>Description:</para>
4874 <para>This preference makes it possible to either allow or
4875 prevent Amazon cover images from being displayed in the OPAC.
4876 Cover images are retrieved by Amazon, which pulls the content
4877 based on the first ISBN number in the item's MARC record.
4878 Amazon offers this service free of charge, but interested
4879 libraries must first establish an Amazon Web Services (AWS)
4881 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4882 the value for this preference is set to "Show", the cover
4883 images will appear in the OPAC, and if it is set to "Don't
4884 show", the images will not appear. If activating this feature,
4885 the library must first set <link
4886 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4887 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4888 you're using Amazon cover images, all other cover image
4889 services must be disabled. If they are not disabled, they will
4890 prevent AmazonCoverImages from functioning properly.</para>
4895 <para>Requires that <link
4896 linkend="OPACAmazonEnabled">OPACAmazonEnabled</link> is set to
4901 <section id="OPACAmazonSimilarItems">
4902 <title>OPACAmazonSimilarItems</title>
4904 <para>Default: Don't show</para>
4906 <para>Asks: ___ similar items, as determined by Amazon, on item
4907 detail pages on the OPAC.</para>
4909 <para>Values:</para>
4913 <para>Don't show</para>
4921 <para>This will use Amazon data to determine if you have
4922 similar items in your collection - it will not show items
4923 that you do not already have cataloged at your
4930 <para>Description:</para>
4934 <para>This preference makes it possible to either allow or
4935 prevent Amazon's suggestions for Similar Items from being
4936 displayed in the OPAC. Amazon offers this service free of
4937 charge, but interested libraries must first establish an
4938 Amazon Web Services (AWS) account (<ulink
4939 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4940 the value is set to "Show", the Similar Items suggestions will
4941 appear in the OPAC, and if it is set to "Don't show", the
4942 suggestions will not appear. Before enabling this preference,
4943 the library must first set <link
4944 linkend="AWSAccessKeyID">AWSAccessKeyID</link> and <link
4945 linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally, if
4946 AmazonSimilarItems is enabled, all other similar item services
4947 should be disabled to avoid interference.</para>
4952 <para>Since a change in terms of service by Amazon, this feature
4953 no longer works.</para>
4957 <section id="OPACAmazonReviews">
4958 <title>OPACAmazonReviews</title>
4960 <para>Default: Don't show</para>
4962 <para>Asks: ___ reviews from Amazon on item detail pages on the
4965 <para>Values:</para>
4969 <para>Don't show</para>
4977 <para>Description:</para>
4981 <para>This preference makes it possible to either allow or
4982 prevent Amazon reviews from being displayed in the OPAC.
4983 Amazon offers this service free of charge, but interested
4984 libraries must first establish an Amazon Web Services (AWS)
4986 url="http://aws.amazon.com">http://aws.amazon.com</ulink>). If
4987 the value is set to "Show", the reviews will appear in the
4988 OPAC, and if it is set to "Don't show", the reviews will not
4989 appear. Before setting this to "Show", the library must first
4990 set <link linkend="AWSAccessKeyID">AWSAccessKeyID</link> and
4991 <link linkend="AWSPrivateKey">AWSPrivateKey</link>. Finally,
4992 if AmazonReviews is enabled, all other review services should
4993 be disabled to avoid interference.</para>
4998 <para>Since a change in terms of service by Amazon, this feature
4999 no longer works.</para>
5004 <section id="Babelthequeprefs">
5005 <title>Babelthèque</title>
5009 <section id="Babeltheque">
5010 <title>Babeltheque</title>
5012 <para>Default: Don't</para>
5014 <para>Asks: ___ include information (such as reviews and
5015 citations) from Babelthèque in item detail pages on the
5018 <para>Description:</para>
5022 <para>This preference makes it possible to display a
5023 Babeltheque tab in the OPAC, allowing patrons to access tags,
5024 reviews, and additional title information provided by
5025 Babeltheque. The information which Babeltheque supplies is
5026 drawn from the French language-based <ulink
5027 url="http://www.babelio.com/">Babelio.com</ulink>, a French
5028 service similar to LibraryThing for Libraries. More
5029 information about Babeltheque is available through its
5031 url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
5032 Libraries that wish to allow access to this information must
5033 first register for the service at <ulink
5034 url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
5035 Please note that this information is only provided in
5040 <para>Values:</para>
5047 <screeninfo>Data from Babelthèque on the bib
5052 <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
5064 <section id="Babeltheque_url_js">
5065 <title>Babeltheque_url_js</title>
5067 <para>Asks: ___ Defined the url for the Babeltheque javascript
5068 file (eg. http://www.babeltheque.com/bw_XX.js)</para>
5071 <section id="Babeltheque_url_update">
5072 <title>Babeltheque_url_update</title>
5074 <para>Asks: ___ Defined the url for the Babeltheque update
5076 http://www.babeltheque.com/.../file.csv.bz2).</para>
5080 <section id="btcontentprefs">
5081 <title>Baker & Taylor</title>
5084 <para>This is a pay service, you must contact Baker & Taylor
5085 to subscribe to this service before setting these options.</para>
5088 <section id="BakerTaylorEnabled">
5089 <title>BakerTaylorEnabled</title>
5091 <para>Default: Don't add</para>
5093 <para>Asks: ___ Baker and Taylor links and cover images to the
5094 OPAC and staff client. This requires that you have entered in a
5095 username and password (which can be seen in image links).</para>
5097 <para>Values:</para>
5105 <para>Don't add</para>
5109 <para>Description:</para>
5113 <para>This preference makes it possible to display Baker &
5114 Taylor content (book reviews, descriptions, cover images,
5115 etc.) in both the Staff Client and the OPAC. Libraries that
5116 wish to display Baker & Taylor content must first register
5117 and pay for this service with Baker & Taylor (<ulink
5118 url="http://www.btol.com">http://www.btol.com</ulink>). If
5119 Baker & Taylor content is enabled be sure to turn off
5120 other cover and review services to prevent
5121 interference.</para>
5126 <para>To use this you will need to also set the <link
5127 linkend="btuserpass">BakerTaylorUsername &
5128 BakerTaylorPassword</link> system preferences</para>
5132 <section id="BakerTaylorBookstoreURL">
5133 <title>BakerTaylorBookstoreURL</title>
5135 <para>Asks: Baker and Taylor "My Library Bookstore" links should
5136 be accessed at https:// ___ isbn</para>
5138 <para>Description:</para>
5142 <para>Some libraries generate additional funding for the
5143 library by selling books and other materials that are
5144 purchased from or have been previously leased from Baker &
5145 Taylor. These materials can be accessed via a link on the
5146 library's website. This service is often referred to as
5147 “My Library Bookstore." In order to participate in this
5148 program, the library must first register and pay for the
5149 service with Baker & Taylor. Additional information about
5150 this and other services provided by Baker & Taylor is
5151 available at the Baker & Taylor website, <ulink
5152 url="http://www.btol.com">http://www.btol.com</ulink>. The
5153 BakerTaylorBookstoreURL preference establishes the URL in
5154 order to link to the library's Baker & Taylor-backed
5155 online bookstore, if such a bookstore has been established.
5156 The default for this field is left blank; if no value is
5157 entered, the links to My Library Bookstore will remain
5158 inactive. If enabling this preference, enter the library's
5159 Hostname and Parent Number in the appropriate location within
5160 the URL. The “key" value (key=) should be appended to
5161 the URL, and https:// should be prepended.</para>
5165 <para>This should be filled in with something like
5166 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
5169 <para>Leave it blank to disable these links.</para>
5173 <para>Be sure to get this information from Baker & Taylor
5174 when subscribing.</para>
5178 <section id="btuserpass">
5179 <title>BakerTaylorUsername & BakerTaylorPassword</title>
5181 <para>Asks: Access Baker and Taylor using username ___ and
5184 <para>Descriptions:</para>
5188 <para>This setting in only applicable if the library has a
5189 paid subscription to the external Content Café service
5190 from Baker & Taylor. Use the box provided to enter in the
5191 library's Content Café username and password. Also,
5192 ensure that the <link
5193 linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
5195 linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
5196 settings are properly set. The Content Café service is
5197 a feed of enhanced content such as cover art, professional
5198 reviews, and summaries that is displayed along with Staff
5199 Client/OPAC search results. For more information on this
5200 service please see the Baker & Taylor website: <ulink
5201 url="http://www.btol.com">http://www.btol.com</ulink></para>
5206 <para>Be sure to get this information from Baker & Taylor
5207 when subscribing.</para>
5212 <section id="googleprefs">
5213 <title>Google</title>
5217 <section id="GoogleJackets">
5218 <title>GoogleJackets</title>
5220 <para>Default: Don't add</para>
5222 <para>Asks: ___ cover images from Google Books to search results
5223 and item detail pages on the OPAC.</para>
5225 <para>Values:</para>
5233 <para>Don't add</para>
5237 <para>Description:</para>
5241 <para>This setting controls the display of applicable cover
5242 art from the free Google Books database, via the Google Books
5243 API. Please note that to use this feature, all other cover
5244 services should be turned off.</para>
5250 <section id="librarythingprefs">
5251 <title>LibraryThing</title>
5253 <para>LibraryThing for Libraries is a pay service. You must first
5254 contact LibraryThing directly for pricing and subscription
5255 information. Learn more at <ulink
5256 url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
5257 Also, for further configuration instructions please see the
5258 LibraryThing Wiki: <ulink
5259 url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
5261 <section id="ThingISBN">
5262 <title>ThingISBN</title>
5264 <para>Default: Don't use</para>
5266 <para>Asks: ___ the ThingISBN service to show other editions of a
5269 <para>Values:</para>
5273 <para>Don't use</para>
5281 <para>Description:</para>
5285 <para>Set to 'Use' to display an “Editions" tab on the
5286 item's detail page. Editions are listed, complete with cover
5287 art (if you have one of the cover services enabled) and
5288 bibliographic information. The feed comes from LibraryThing's
5289 ThingISBN web service. This is a free service to
5290 non-commercial sites with fewer than 1,000 requests per
5296 <para>Requires <link
5297 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5298 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
5303 <para>This is separate from Library Thing for Libraries and does
5304 not have a cost associated with it.</para>
5308 <section id="LibraryThingForLibrariesEnabled">
5309 <title>LibraryThingForLibrariesEnabled</title>
5311 <para>Default: Don't show</para>
5313 <para>Asks: ___ reviews, similar items, and tags from Library
5314 Thing for Libraries on item detail pages on the OPAC.</para>
5316 <para>Values:</para>
5320 <para>Don't show</para>
5328 <para>Description:</para>
5332 <para>This setting is only applicable if the library has a
5333 paid subscription to the external LibraryThing for Libraries
5334 service. This service can provide patrons with the display of
5335 expanded information on catalog items such as book
5336 recommendations. It also can offer advanced features like
5337 tagged browsing, patron written reviews, and a virtual library
5338 display accessed from the details tab.</para>
5343 <para>If this is set to 'show' you will need to enter a value in
5345 linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
5346 system preference.</para>
5350 <section id="LibraryThingForLibrariesID">
5351 <title>LibraryThingForLibrariesID</title>
5353 <para>Asks: Access Library Thing for Libraries using the customer
5356 <para>Description:</para>
5360 <para>This setting is only applicable if the library has a
5361 paid subscription to the external LibraryThing for Libraries
5362 service. Use the box provided to enter in the library's
5363 LibraryThing for Libraries ID as provided to the library by
5364 LibraryThing. The ID number is a series of numbers in the form
5365 ###-#########, and can be found on the library's account page
5366 at LibraryThing for Libraries. This service can provide
5367 patrons with the display of expanded information on catalog
5368 items such as book recommendations and cover art. It also can
5369 offer advanced features like tagged browsing, patron written
5370 reviews, and a virtual library display accessed from the
5376 <section id="LibraryThingForLibrariesTabbedView">
5377 <title>LibraryThingForLibrariesTabbedView</title>
5379 <para>Default: in line with bibliographic information</para>
5381 <para>Asks: Show Library Thing for Libraries content ___</para>
5383 <para>Values:</para>
5387 <para>in line with bibliographic information</para>
5391 <para>in tabs</para>
5395 <para>Description:</para>
5399 <para>This setting is only applicable if the library has a
5400 paid subscription to the external LibraryThing for Libraries
5401 service. This service can provide patrons with the display of
5402 expanded information on catalog items such as book
5403 recommendations and cover art. It also can offer advanced
5404 features like tagged browsing, patron written reviews, and a
5405 virtual library display accessed from the details tab.</para>
5411 <section id="localimages">
5412 <title>Local Cover Images</title>
5416 <section id="AllowMultipleCovers">
5417 <title>AllowMultipleCovers</title>
5419 <para>Default: Don't allow</para>
5421 <para>Asks: ___ multiple images to be attached to each
5422 bibliographic record.</para>
5424 <para>Values:</para>
5432 <para>Don't allow</para>
5436 <para>Description:</para>
5440 <para>If this preference is set to 'Allow' then you can upload
5441 multiple images that will appear in the images tab on the bib
5442 record in the OPAC and the staff client. This preference
5443 requires that either one or both <link
5444 linkend="LocalCoverImages">LocalCoverImages</link> and <link
5445 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
5446 set to 'Display.'</para>
5449 <screeninfo>Multiple cover images</screeninfo>
5453 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
5461 <section id="LocalCoverImages">
5462 <title>LocalCoverImages</title>
5464 <para>Default: Don't display</para>
5466 <para>Asks: ___ local cover images on intranet search and details
5469 <para>Values:</para>
5473 <para>Display</para>
5477 <para>Don't display</para>
5481 <para>Description:</para>
5485 <para>Setting this preference to 'Display' allows you to
5486 upload your own cover images to bib records and display them
5487 on the detail page in the staff client. At this time the cover
5488 will only show under the 'Images' tab on the holdings table on
5489 the detail display, not next to the title at the top left or
5490 on the search results.</para>
5495 <section id="OPACLocalCoverImages">
5496 <title>OPACLocalCoverImages</title>
5498 <para>Default: Don't display</para>
5500 <para>Asks: ___ local cover images on OPAC search and details
5503 <para>Values:</para>
5507 <para>Display</para>
5511 <para>Don't display</para>
5515 <para>Description:</para>
5519 <para>Setting this preference to 'Display' allows you to
5520 upload your own cover images to bib records and display them
5521 on the detail page and search results in the OPAC.</para>
5527 <section id="novelistselect">
5528 <title>Novelist Select</title>
5530 <para>Novelist Select is not a free service. Contact your Ebsco
5531 representitive to get your log in information to embed this content
5532 in the OPAC.<important>
5533 <para>Novelist Select does not include cover images for the
5534 search results and bibliographic detail pages. You can choose
5535 any other cover image service for this content.</para>
5538 <section id="NovelistSelectEnabled">
5539 <title>NovelistSelectEnabled</title>
5541 <para>Default: Don't add</para>
5543 <para>Asks: ___ Novelist Select content to the OPAC.</para>
5545 <para>Values:</para>
5553 <para>Don't add</para>
5558 <para>Enabling this requires that you have entered in a user
5559 profile and password in the <link
5560 linkend="NovelistSelectProfile">NovelistSelectProfile &
5561 NovelistSelectPassword</link> preferences</para>
5562 </important>Description:</para>
5566 <para>Novelist Select from Ebsco is a subscription service
5567 that can provide additional content in the OPAC.</para>
5572 <section id="NovelistSelectProfile">
5573 <title>NovelistSelectProfile & NovelistSelectPassword</title>
5575 <para>Asks: Access Novelist Select using user profile ___ and
5576 password ___.</para>
5579 <para>This information will be visible if someone views the
5580 source code on your OPAC.</para>
5583 <para>Description:</para>
5587 <para>Novelist Select from Ebsco is a subscription service
5588 that can provide additional content in the OPAC.</para>
5593 <section id="NovelistSelectView">
5594 <title>NovelistSelectView</title>
5596 <para>Default: in an OPAC tab</para>
5598 <para>Asks: Display Novelist Select content ___</para>
5600 <para>Description:</para>
5604 <para>Novelist Select provides a lot of content, for that
5605 reason you have four choices of where to display this content.
5606 The default view is in a tab in the holdings table.</para>
5609 <screeninfo>Novelist Select in a tab</screeninfo>
5613 <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
5618 <para>The content is the same if you choose to show it above
5619 the holdings table or below it. If shown in the right column
5620 of the page it's the same content, but displays a bit
5621 differently since space is limited.</para>
5624 <screeninfo>Novelist Select on the side</screeninfo>
5628 <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
5635 <para>Values:</para>
5639 <para>above the holdings table</para>
5643 <para>below the holdings table</para>
5647 <para>in an OPAC tab</para>
5651 <para>under the Save Record dropdown on the right</para>
5657 <section id="oclcprefs">
5662 <section id="XISBN">
5663 <title>XISBN</title>
5665 <para>Default: Don't use</para>
5667 <para>Asks: ___ the OCLC xISBN service to show other editions of a
5670 <para>Description:</para>
5674 <para>Set to 'Use' to display an “Editions" tab on the
5675 item's detail page. Editions are listed, complete with cover
5676 art and bibliographic information. The feed comes from OCLC's
5677 xISBN web service. The feed limit for non-commercial sites is
5678 1000 requests per day.</para>
5682 <para>Values:</para>
5686 <para>Don't use</para>
5695 <para>Requires <link
5696 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5697 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
5702 <section id="OCLCAffiliateID">
5703 <title>OCLCAffiliateID</title>
5705 <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
5708 <para>Description:</para>
5712 <para>This setting is only applicable if the library has an
5713 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
5714 via the XISBN programming interface. Simply enter the
5715 library's OCLC Affiliate ID in the box provided. Please note
5716 that using this data is only necessary if <link
5717 linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
5718 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
5719 <link linkend="XISBN">XISBN</link> settings are enabled. For
5720 more information on this service please visit the OCLC
5722 url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
5727 <para>Unless you have signed up for an ID with OCLC, you are
5728 limited to 1000 requests per day. Available at: <ulink
5729 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
5733 <section id="XISBNDailyLimit">
5734 <title>XISBNDailyLimit</title>
5736 <para>Default: 999</para>
5738 <para>Asks: Only use the xISBN service ___ times a day.</para>
5741 <para>Unless you have signed up for an ID with OCLC, you are
5742 limited to 1000 requests per day. Available at: <ulink
5743 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
5748 <section id="OpenLibraryPrefs">
5749 <title>Open Library</title>
5751 <section id="OpenLibraryCovers">
5752 <title>OpenLibraryCovers</title>
5754 <para>Default: Don't add</para>
5756 <para>Asks: ___ cover images from Open Library to search results
5757 and item detail pages on the OPAC.</para>
5759 <para>Values:</para>
5767 <para>Don't add</para>
5771 <para>Description:</para>
5775 <para>This setting controls the display of applicable cover
5776 art from the free Open Library database, via the Open Library
5777 API. Please note that to use this feature, all other cover
5778 services should be turned off.</para>
5784 <section id="Syndeticsprefs">
5785 <title>Syndetics</title>
5787 <para>Syndetics is a pay service. You must first contact Syndetics
5788 directly for pricing and subscription information.</para>
5790 <section id="SyndeticsEnabled">
5791 <title>SyndeticsEnabled</title>
5793 <para>Default: Don't use</para>
5795 <para>Asks: ___ content from Syndetics.</para>
5797 <para>Values:</para>
5801 <para>Don't use</para>
5809 <para>Description:</para>
5813 <para>When this option is enabled any of the Syndetics options
5819 <para>Requires that you enter your <link
5820 linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
5821 this content will appear.</para>
5825 <section id="SyndeticsClientCode">
5826 <title>SyndeticsClientCode</title>
5828 <para>Asks: Use the client code ___ to access Syndetics.</para>
5830 <para>Description:</para>
5834 <para>Once the library signs up for Syndetics' services,
5835 Syndetics will provide the library with an access code. (Visit
5836 the Syndetics homepage at <ulink
5837 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
5838 for more information.) This is the code that must be entered
5839 to access Syndetics' subscription services. Syndetics is a
5840 paid subscription service. This value must be entered before
5841 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
5842 be enabled. If the code is lost, corrupted, or forgotten, a
5843 new one can be obtained from <ulink
5844 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
5849 <para>You will need to get your client code directly from
5854 <section id="SyndeticsCoverImages">
5855 <title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
5857 <para>SyndeticsCoverImages Default: Don't show</para>
5859 <para>SyndeticsCoverImageSize Default: medium</para>
5861 <para>Asks: ___ cover images from Syndetics on search results and
5862 item detail pages on the OPAC in a ___ size.</para>
5864 <para>Descriptions:</para>
5868 <para>When enabled, SyndeticsCoverImages, allows libraries to
5869 display Syndetics' collection of full-color cover images for
5870 books, videos, DVDs and CDs on their OPAC. For each book or
5871 item that comes up during a user search, the cover image for
5872 that title will be displayed. Since these cover images come in
5873 three sizes, the optimum size must be selected using the
5874 SyndeticsCoverImageSize preference after SyndeticsCoverImages
5875 are enabled. Syndetics cover images come in two sizes:
5876 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
5877 Syndetics is a paid subscription service. The <link
5878 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
5879 be entered and the <link
5880 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
5881 be activated before this service can be used. Other cover
5882 image preferences should also be disabled to avoid
5883 interference.</para>
5887 <para>SyndeticsCoverImages Values:</para>
5891 <para>Don't show</para>
5899 <para>SyndeticsCoverImageSize Values:</para>
5912 <section id="SyndeticsAuthorNotes">
5913 <title>SyndeticsAuthorNotes</title>
5915 <para>Default: Don't show</para>
5917 <para>Asks: ___ notes about the author of a title from Syndetics
5918 on item detail pages on the OPAC.</para>
5920 <para>Values:</para>
5924 <para>Don't show</para>
5932 <para>Description:</para>
5936 <para>When this option is set to "Show", Syndetics provides
5937 notes and short author biographies for more that 300,000
5938 authors, in both fiction and nonfiction. With this option
5939 enabled the library can display Syndetics Author Notes on the
5940 OPAC. According to the Syndetics Solutions website (<ulink
5941 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
5942 Author Notes include lists of contributors for many
5943 multi-author texts and compilations. The <link
5944 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
5945 be entered and the <link
5946 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
5947 be activated before this service can be used.</para>
5952 <section id="SyndeticsAwards">
5953 <title>SyndeticsAwards</title>
5955 <para>Default: Don't show</para>
5957 <para>Asks: ___ information from Syndetics about the awards a
5958 title has won on item detail pages on the OPAC.</para>
5960 <para>Values:</para>
5964 <para>Don't show</para>
5972 <para>Description:</para>
5976 <para>When this option is set to "Show", Syndetics provides
5977 its clients with a list of awards that any title has won. With
5978 this service enabled the library can display those awards for
5979 each book on its website. For each book or item that comes up
5980 during a user search, the list of awards for that title will
5981 be displayed. When a user clicks on a given award, information
5982 about that award is presented along with a list of the other
5983 titles that have won that award. If the user clicks on any
5984 title in the list, they will see holdings information about
5985 that title in their region. This option is a paid subscription
5987 linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
5988 be entered and the <link
5989 linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
5990 be activated before this service can be used.</para>
5995 <section id="SyndeticsEditions">
5996 <title>SyndeticsEditions</title>
5998 <para>Default: Don't show</para>
6000 <para>Asks: ___ information about other editions of a title from
6001 Syndetics on item detail pages on the OPAC</para>
6003 <para>Description:</para>
6007 <para>When enabled this option shows information on other
6008 editions of a title from Syndetics on the item detail pages of
6009 the OPAC. Syndetics is a paid subscription service. The <link
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>
6017 <para>Values:</para>
6021 <para>Don't show</para>
6030 <para>Requires <link
6031 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
6036 <section id="SyndeticsExcerpt">
6037 <title>SyndeticsExcerpt</title>
6039 <para>Default: Don't show</para>
6041 <para>Asks: ___ excerpts from of a title from Syndetics on item
6042 detail pages on the OPAC.</para>
6044 <para>Values:</para>
6048 <para>Don't show</para>
6056 <para>Description:</para>
6060 <para>This preference allows Syndetics to display excerpts
6061 given to them from selected publishers. The excerpts are
6062 available from prominently reviewed new titles, both fiction
6063 and non-fiction. The excerpts include poems, essays, recipes,
6064 forwards and prefaces. Automatic links provided by the ISBNs
6065 within local MARC records are required to integrate Syndetics
6066 secured, high-speed Internet servers to the library OPACs. For
6067 more information see (<ulink
6068 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6073 <section id="SyndeticsReviews">
6074 <title>SyndeticsReviews</title>
6076 <para>Default: Don't show</para>
6078 <para>Asks: ___ reviews of a title from Syndetics on item detail
6079 pages on the OPAC.</para>
6081 <para>Values:</para>
6085 <para>Don't show</para>
6093 <para>Description:</para>
6097 <para>Syndetics Reviews is an accumulation of book reviews
6098 available from a variety of journals and serials. The reviews
6099 page displays colored images of reviewed books dust jackets,
6100 partnered with the names of the journal or serial providing
6101 the review. Clicking on an icon opens a window revealing the
6102 book title, author's name, book cover icon and the critic's
6103 opinion of the book. Automatic links provided by the ISBNs
6104 within local MARC records are required to integrate Syndetics
6105 secured, high-speed Internet servers to the library OPACs. For
6106 more information see (<ulink
6107 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6112 <section id="SyndeticsSeries">
6113 <title>SyndeticsSeries</title>
6115 <para>Default: Don't show</para>
6117 <para>Asks: ___ information on other books in a title's series
6118 from Syndetics on item detail pages on the OPAC.</para>
6120 <para>Values:</para>
6124 <para>Don't show</para>
6132 <para>Description:</para>
6136 <para>Each fiction title within a series is linked to the
6137 complete series record. The record displays each title in
6138 reading order and also displays the publication order, if
6139 different. Alternate series titles are also displayed.
6140 Automatic links provided by the ISBNs within local MARC
6141 records are required to integrate Syndetics secured, high-
6142 speed Internet servers to the library OPACs. For more
6143 information see (<ulink
6144 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6149 <section id="SyndeticsSummary">
6150 <title>SyndeticsSummary</title>
6152 <para>Default: Don't show</para>
6154 <para>Asks: ___ a summary of a title from Syndetics on item detail
6155 pages on the OPAC.</para>
6157 <para>Values:</para>
6161 <para>Don't show</para>
6169 <para>Description:</para>
6173 <para>Providing more than 5.6 million summaries and
6174 annotations derived from book jackets, edited publisher copy,
6175 or independently written annotations from Book News, Inc.
6176 Covering fiction and non-fiction, this summaries option
6177 provides annotations on both trade and scholarly titles. For
6178 more information see (<ulink
6179 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6184 <section id="SyndeticsTOC">
6185 <title>SyndeticsTOC</title>
6187 <para>Default: Don't show</para>
6189 <para>Asks: ___ the table of contents of a title from Syndetics on
6190 item detail pages on the OPAC.</para>
6192 <para>Values:</para>
6196 <para>Don't show</para>
6204 <para>Description:</para>
6208 <para>This preference allows staff and patrons to review the
6209 Table of Contents from a wide variety of publications from
6210 popular self-help books to conference proceedings. Specific
6211 Information access is the main purpose for this option,
6212 allowing patrons guidance to their preferred section of the
6213 book. Special arrangements with selected book services is used
6214 to obtain the table of contents for new publications each
6215 year. Automatic links provided by the ISBNs within local MARC
6216 records are required to integrate Syndetics secured,
6217 high-speed Internet servers to the library OPACs. For more
6218 information see (<ulink
6219 url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6225 <section id="taggingprefs">
6226 <title>Tagging</title>
6228 <section id="TagsEnabled">
6229 <title>TagsEnabled</title>
6231 <para>Default: Allow</para>
6233 <para>Asks: ___ patrons and staff to put tags on items.</para>
6235 <para>Values:</para>
6243 <para>Don't allow</para>
6247 <para>Description:</para>
6251 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
6252 added to identify an item. Tags allow patrons to classify
6253 materials on their own. TagsEnabled is the main switch that
6254 permits the tagging features. TagsEnable must be set to
6255 'Allow' to allow for other tagging features.</para>
6260 <section id="TagsModeration">
6261 <title>TagsModeration</title>
6263 <para>Default: Don't require</para>
6265 <para>Asks: ___ that tags submitted by patrons be reviewed by a
6266 staff member before being shown.</para>
6268 <para>Values:</para>
6272 <para>Don't require</para>
6276 <para>Require</para>
6280 <para>Description:</para>
6284 <para>When set to 'Require,' all tags to be first filtered by
6285 the tag moderator. Only approved tags will be visible to
6286 patrons. When set to 'Don't require' tags will bypass the tag
6287 moderator and patrons' tags to be immediately visible. When
6288 this preference is enabled the moderator, a staff member,
6289 would approve the tag in the Staff Client. The moderator will
6290 have the option to approve or reject each pending tag
6295 <para>When moderation is required all tags go through the tag
6296 moderation tool before becoming visible.</para>
6300 <para><emphasis>Get there:</emphasis> More > Tools >
6301 <link linkend="tagsmoderation">Tags</link></para>
6306 <section id="TagsShowOnList">
6307 <title>TagsShowOnList</title>
6309 <para>Default: 6</para>
6311 <para>Asks: Show ___ tags on search results on the OPAC.</para>
6314 <para>Set the value to 0 (zero) to turn this feature off.</para>
6318 <section id="TagsInputOnList">
6319 <title>TagsInputOnList</title>
6321 <para>Default: Allow</para>
6323 <para>Asks: ___ patrons to input tags on search results on the
6326 <para>Values:</para>
6333 <screeninfo>Tags on Search Results</screeninfo>
6337 <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
6344 <para>Don't allow</para>
6349 <section id="TagsShowOnDetail">
6350 <title>TagsShowOnDetail</title>
6352 <para>Default: 10</para>
6354 <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
6357 <para>Set the value to 0 (zero) to turn this feature off.</para>
6361 <section id="TagsInputOnDetail">
6362 <title>TagsInputOnDetail</title>
6364 <para>Default: Allow</para>
6366 <para>Asks: ___ patrons to input tags on item detail pages on the
6369 <para>Values:</para>
6376 <screeninfo>Add Tags on Detail</screeninfo>
6380 <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
6387 <para>Don't allow</para>
6392 <section id="TagsExternalDictionary">
6393 <title>TagsExternalDictionary</title>
6395 <para>Asks: Allow tags in the dictionary of the ispell executable
6396 ___ on the server to be approved without moderation.</para>
6398 <para>Description:</para>
6402 <para>The dictionary includes a list of accepted and rejected
6403 tags. The accepted list includes all the tags that have been
6404 pre-allowed. The rejected list includes tags that are not
6405 allowed. This preference identifies the "accepted" dictionary
6406 used. Ispell is an open source dictionary which can be used as
6407 a list of accepted terms. Since the dictionary allows for
6408 accurately spelled obscenities, the libraries policy may
6409 dictate that modifications are made to the Ispell dictionary
6410 if this preference is use. For more information about Ispell
6412 url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
6413 Enter the path on your server to a local ispell executable,
6414 used to set $Lingua::Ispell::path.</para>
6421 <section id="l18nprefs">
6422 <title>I18N/L10N</title>
6424 <para><emphasis><emphasis>These preferences control your
6425 Internationalization and Localization
6426 settings.</emphasis></emphasis></para>
6428 <para><emphasis>Get there:</emphasis> More > Administration >
6429 Global System Preferences > I18N/L10N</para>
6431 <section id="CalendarFirstDayOfWeek">
6432 <title>CalendarFirstDayOfWeek</title>
6434 <para>Default: Sunday</para>
6436 <para>Asks: Use ___ as the first day of week in the calendar.</para>
6438 <para>Values:</para>
6450 <para>Description:</para>
6454 <para>Using this preference you can control what day shows as
6455 the first day of the week in the calendar pop ups throughout
6456 Koha and on the Calendar tool. If you change this preference and
6457 don't see a change in your browser try clearing your cache since
6458 it makes changes to the Javascript on these pages.</para>
6463 <section id="dateformat">
6464 <title>dateformat</title>
6466 <para>Default: mm/dd/yyyy</para>
6468 <para>Asks: Format dates like ___</para>
6470 <para>Values:</para>
6474 <para>dd/mm/yyyy</para>
6478 <para>mm/dd/yyyy</para>
6482 <para>yyyy/mm/dd</para>
6486 <para>Description:</para>
6490 <para>This preference controls how the date is displayed. The
6491 options are the United States method, mm/dd/yyyy (04/24/2010),
6492 the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
6493 International Standard of Organization, yyyy/mm/dd (2010/04/24).
6494 The International Standard of Organization would primarily be
6495 used by libraries with locations in multiple nations that may
6496 use different date formats, to have a single display type, or if
6497 the library would be in a region that does not use the United
6498 States or metric method. More information regarding the ISO date
6499 format can be found at <ulink
6500 url="http://www.iso.org/iso/iso_catalogue.htm">http://www.iso.org/iso/iso_catalogue.htm</ulink>.</para>
6505 <section id="languagepref">
6506 <title>language</title>
6508 <para>Default: English</para>
6510 <para>Asks: Enable the following languages on the staff
6513 <para>Values:</para>
6517 <para>English</para>
6521 <para>To install additional languages you need to run
6522 misc/translation/install-code.pl. For example, to install French you
6523 would run the following command <emphasis>install-code.pl
6524 fr-FR</emphasis> to make the templates, once they exist and are in
6525 the right place then they will show up as an option in this
6529 <section id="opaclanguages">
6530 <title>opaclanguages</title>
6532 <para>Default: English</para>
6534 <para>Asks: Enable the following languages on the OPAC</para>
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="opaclanguagesdisplay">
6553 <title>opaclanguagesdisplay</title>
6555 <para>Default: Don't allow</para>
6557 <para>Asks: ___ patrons to select their language on the OPAC.</para>
6559 <para>Values:</para>
6566 <screeninfo>When this preference is on, patrons can choose
6567 their language from a list at the bottom of the
6572 <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
6579 <para>Don't allow</para>
6585 <section id="localprefs">
6586 <title>Local Use</title>
6588 <para><emphasis><emphasis>These preferences are defined
6589 locally.</emphasis></emphasis></para>
6591 <para><emphasis>Get there:</emphasis> More > Administration >
6592 Global System Preferences > Local Use<tip>
6593 <para>Sometimes preferences which are either new or outdated will
6594 appear in this tab, if you didn't add any preferences to this tab
6595 then it's best to ignore preferences listed here.</para>
6602 <para>Logs keep track of transaction on the system. You can decide
6603 which actions you want to log and which you don't using these
6606 <para><emphasis>Get there:</emphasis> More > Administration >
6607 Global System Preferences > Logs</para>
6609 <section id="AuthoritiesLog">
6610 <title>AuthoritiesLog</title>
6612 <para>Default: Don't log</para>
6614 <para>Asks: ___ changes to authority records.</para>
6616 <para>Values:</para>
6620 <para>Don't log</para>
6629 <section id="BorrowersLog">
6630 <title>BorrowersLog</title>
6632 <para>Default: Log</para>
6634 <para>Asks: ___ changes to patron records.</para>
6636 <para>Values:</para>
6640 <para>Don't log</para>
6649 <section id="CataloguingLog">
6650 <title>CataloguingLog</title>
6652 <para>Default: Don't log</para>
6654 <para>Asks: ___ any changes to bibliographic or item records.</para>
6656 <para>Values:</para>
6660 <para>Don't log</para>
6669 <para>Since this occurs whenever a book is cataloged, edited, or
6670 checked in or out it can be very resource intensive - slowing down
6675 <section id="FinesLog">
6676 <title>FinesLog</title>
6678 <para>Default: Log</para>
6680 <para>Asks: ___ when overdue fines are charged or automatically
6683 <para>Values:</para>
6687 <para>Don't log</para>
6696 <section id="IssueLog">
6697 <title>IssueLog</title>
6699 <para>Default: Log</para>
6701 <para>Asks: ___ when items are checked out.</para>
6703 <para>Values:</para>
6707 <para>Don't log</para>
6716 <section id="LetterLog">
6717 <title>LetterLog</title>
6719 <para>Default: Log</para>
6721 <para>Asks: ___ when an automatic claim notice is sent.</para>
6723 <para>Values:</para>
6727 <para>Don't log</para>
6736 <para>This log tracks all notices that go to patrons including the
6737 overdue notices.</para>
6741 <section id="ReturnLog">
6742 <title>ReturnLog</title>
6744 <para>Default: Log</para>
6746 <para>Asks: ___ when items are returned.</para>
6748 <para>Values:</para>
6752 <para>Don't log</para>
6761 <section id="SubscriptionLog">
6762 <title>SubscriptionLog</title>
6764 <para>Default: Log</para>
6766 <para>Asks: ___ when serials are added, deleted or changed.</para>
6768 <para>Values:</para>
6772 <para>Don't log</para>
6782 <section id="opacprefs">
6785 <para><emphasis>Get there:</emphasis> More > Administration >
6786 Global System Preferences > OPAC</para>
6788 <section id="opacappearanceprefs">
6789 <title>Appearance</title>
6791 <para>These preferences control how things appear in the
6794 <section id="AuthorisedValueImages">
6795 <title>AuthorisedValueImages</title>
6797 <para>Default: Don't show</para>
6799 <para>Asks: ___ images for authorized values (such as lost
6800 statuses and locations) in search results and item detail pages on
6803 <para>Values:</para>
6807 <para>Don't show</para>
6815 <para><emphasis>Get there:</emphasis> More > Administration
6816 > <link linkend="authorizedvalues">Authorized
6817 Values</link></para>
6820 <section id="BiblioDefaultView">
6821 <title>BiblioDefaultView</title>
6823 <para>Default: in simple form</para>
6825 <para>Asks: By default, show bib records ___</para>
6827 <para>Values:</para>
6831 <para>as specified in the ISBD template.</para>
6835 <para>See <link linkend="isbdpref">ISBD</link> preference
6836 for more information</para>
6842 <para>in simple form.</para>
6846 <para>in their MARC format.</para>
6850 <para>Description:</para>
6854 <para>This preference determines the level of bibliographic
6855 detail that the patron will see on the OPAC detail page. The
6856 simple form displays the graphical interface; MARC format
6857 displays the MARC21 cataloging view; ISBD displays the ISBD
6858 (International Standard Bibliographic Description, AACR2)
6864 <section id="COinSinOPACResults">
6865 <title>COinSinOPACResults</title>
6867 <para>Default: Include</para>
6869 <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
6872 <para>Values:</para>
6876 <para>Don't include</para>
6880 <para>If you choose not to include COinS on the search
6881 results, it will still be loaded on the individual
6882 bibliographic records.</para>
6888 <para>Include</para>
6892 <para>Enabling this feature will slow OPAC search response
6899 <para>Description:</para>
6903 <para>COinS stands for ContextObjects in Spans. COinS is a
6904 method to embed bibliographic metadata in the HTML code of web
6905 pages. This allows bibliographic software to publish
6906 machine-readable bibliographic items and client reference
6907 management software (such as Zotero) to retrieve bibliographic
6908 metadata. The metadata can also be sent to an OpenURL
6909 resolver. This allows, for instance, searching for a copy of a
6910 book in one's own library.</para>
6915 <section id="DisplayOPACiconsXSLT">
6916 <title>DisplayOPACiconsXSLT</title>
6918 <para>Default: Don't show</para>
6920 <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
6921 ___ icons for itemtype and authorized values.<important>
6923 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
6925 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
6926 must be set to use an XSLT stylesheet for this to show
6927 (default or custom)</para>
6930 <para>Values:</para>
6934 <para>Don't show</para>
6941 <screeninfo>DisplayOPACiconsXSLT</screeninfo>
6945 <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
6953 <para>See the <link linkend="XSLTiTypes">XSLT Icon
6954 Guide</link> for more information on these icons.</para>
6958 <section id="hidelostitems">
6959 <title>hidelostitems</title>
6961 <para>Default: Don't show</para>
6963 <para>Asks: ___ lost items on search and detail pages.</para>
6965 <para>Description:</para>
6969 <para>Items that are marked lost by the library can either be
6970 shown or not shown on the OPAC. By setting the value to
6971 “Don't show," the lost item is not shown on the OPAC. By
6972 setting the value “Show," the lost item is shown on the
6973 OPAC for patrons to view with a status of 'lost.'</para>
6977 <para>Values:</para>
6981 <para>Don't show</para>
6988 <screeninfo>Lost item showing in the OPAC</screeninfo>
6992 <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
7000 <section id="LibraryName">
7001 <title>LibraryName</title>
7003 <para>Asks: Show ___ as the name of the library on the
7007 <para>This value will appear in the title bar of the
7012 <para>Edit '<link linkend="opacheader">opacheader</link>' if
7013 you'd like to add a library name above your search box on the
7018 <screeninfo>Browser title and address bar</screeninfo>
7022 <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
7028 <section id="OpacAddMastheadLibraryPulldown">
7029 <title>OpacAddMastheadLibraryPulldown</title>
7031 <para>Default: Don't add</para>
7033 <para>Asks: ___ a library select pulldown menu on the OPAC
7036 <para>Values:</para>
7043 <screeninfo>Library select box on Koha OPAC</screeninfo>
7047 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
7054 <para>Don't Add</para>
7057 <screeninfo>No library select box on Koha OPAC</screeninfo>
7061 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
7069 <section id="OPACBaseURL">
7070 <title>OPACBaseURL</title>
7072 <para>Asks: The OPAC is located at http:// ___</para>
7075 <para>This must be filled in correctly for RSS, unAPI, and
7076 search plugins to work.</para>
7080 <para>This must be filled in to show 'OPAC View' links from bib
7081 records in the staff client:</para>
7085 <screeninfo>With OPACBaseURL set, links to the OPAC will appear
7086 on each individual bib record in the staff client</screeninfo>
7090 <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
7096 <section id="opaccolorstylesheet">
7097 <title>opaccolorstylesheet</title>
7099 <para>Asks: Include the additional CSS stylesheet ___ to override
7100 specified settings from the default stylesheet.</para>
7102 <para>Description:</para>
7106 <para>The preference can look for stylesheets in the template
7107 directory for your OPAC language, for instance:
7108 /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file,
7109 opac-mystyles.css to this directory, you can specify it by
7110 entering opac-mystyles.css in your opaccolorstylesheet system
7111 preference. This adds your custom stylesheet as a linked
7112 stylesheet alongside the OPAC's default CSS files. This method
7113 is preferable because linked stylesheets are cached by the
7114 user's browser, meaning upon repeat visits to your site the
7115 user's browser will not have to re-download the stylesheet,
7116 instead using the copy in the browser's cache.</para>
7120 <para>If you would rather, you can upload your CSS to another
7121 server and enter the full URL pointing to it's location
7122 remember to begin the URL with http://</para>
7127 <para>Leave this field blank to disable it</para>
7131 <para>This file will add a linked CSS, not replace the
7132 existing default CSS.</para>
7136 <section id="opaccredits">
7137 <title>opaccredits</title>
7139 <para>Asks: Include the following HTML in the footer of all pages
7143 <para>Click the 'Click to edit; link to enter HTML to appear at
7144 the bottom of every page in the OPAC</para>
7148 <screeninfo>HTML version of a footer for your OPAC</screeninfo>
7152 <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
7158 <screeninfo>A sample of what can appear in your OPAC
7159 credits/footer</screeninfo>
7163 <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
7168 <para>Description:</para>
7172 <para>This setting is for credits that will appear at the
7173 bottom of your OPAC pages. Credits traditionally encompass
7174 copyright information, last date updated, hyperlinks or other
7175 information represented in an HTML format. This is static
7176 information and any updates must be entered manually.</para>
7180 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7181 Regions</link> section.</para>
7184 <section id="OPACDisplay856uAsImage">
7185 <title>OPACDisplay856uAsImage</title>
7187 <para>Default: Neither details or results page</para>
7189 <para>Asks: Display the URI in the 856u field as an image on:
7192 <para>Values:</para>
7196 <para>Both results and details pages</para>
7201 <para>Not implemented yet</para>
7208 <para>Detail page only</para>
7214 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
7215 needs to be on for this preference to work.</para>
7221 <screeninfo>Showing the 856u as an image</screeninfo>
7225 <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
7232 <para>Neither details or results page</para>
7236 <para>Results page only</para>
7241 <para>Not yet implemented</para>
7248 <para>Description:</para>
7252 <para>In addition to this option being set, the corresponding
7253 XSLT option must be turned on. Also, the corresponding 856q
7254 field must have a valid MIME image extension (e.g., "jpg") or
7255 MIME image type (i.e. starting with "image/"), or the generic
7256 indicator "img" entered in the field. When all of the
7257 requirements are met, an image file will be displayed instead
7258 of the standard link text. Clicking on the image will open it
7259 in the same way as clicking on the link text. When you click
7260 on the image it should open to full size, in the current
7261 window or in a new window depending on the value in the system
7263 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
7266 <screeninfo>Sample 856 in MARC Record</screeninfo>
7270 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
7278 <section id="OPACDisplayRequestPriority">
7279 <title>OPACDisplayRequestPriority</title>
7281 <para>Default: Don't</para>
7283 <para>Asks: ___ patrons the priority level of their holds in the
7286 <para>Values:</para>
7290 <para>Don't show</para>
7297 <screeninfo>Patron record in the OPAC shows where in line
7298 the patron waits for their hold.</screeninfo>
7302 <imagedata fileref="images/admin/globalprefs/OPACDisplayRequestPriority.png"/>
7309 <para><link linkend="opacuserlogin">opacuserlogin</link>
7310 needs to be set to 'allow'</para>
7317 <section id="OpacExportOptions">
7318 <title>OpacExportOptions</title>
7321 bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
7323 <para>Asks: List export options that should be available from OPAC
7324 detail page separated by |: ___</para>
7326 <para>Description:</para>
7330 <para>In the OPAC on the right of each bib record there is a
7331 menu that allows for saving the record in various formats.
7332 This patch will allow you to define which options are in the
7333 pull down menu. Available options are: BIBTEX (bibtex), Dublin
7334 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
7335 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
7336 without local use -9xx, x9x, xx9- fields and subfields
7337 (marcstd), MODS (mods), and RIS (ris).</para>
7342 <section id="OpacFavicon">
7343 <title>OpacFavicon</title>
7345 <para>Asks: Use the image at ___ for the OPAC's favicon.
7347 <para>This should be a complete URL, starting with
7352 <para>Turn your logo into a favicon with the <ulink
7353 url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
7356 <para>Description:</para>
7360 <para>The favicon is the little icon that appears next to the
7361 URL in the address bar in most browsers. The default value for
7362 this field (if left blank) is the small 'K' in the Koha
7366 <screeninfo>Default Koha Favicon</screeninfo>
7370 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
7378 <section id="opacheader">
7379 <title>opacheader</title>
7381 <para>Asks: Include the following HTML in the header of all pages
7385 <screeninfo>Sample HTML to be displayed at the top of my
7390 <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
7396 <para>This value will appear above the main content of your
7401 <screeninfo>OPAC display of the value from
7402 'opacheader'</screeninfo>
7406 <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
7412 <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
7413 you'd like to edit the contents of the <title> tag</para>
7416 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7417 Regions</link> section.</para>
7420 <section id="OpacHighlightedWords">
7421 <title>OpacHighlightedWords</title>
7423 <para>Default: Don't highlight</para>
7425 <para>Asks: ___ words the patron searched for in their search
7428 <para>Values:</para>
7432 <para>Don't highlight</para>
7436 <para>Highlight</para>
7441 <section id="OpacKohaUrl">
7442 <title>OpacKohaUrl</title>
7444 <para>Default: Don't show</para>
7446 <para>Values:</para>
7450 <para>Don't show</para>
7458 <para>Description:</para>
7462 <para>When this preference is set to 'Show' text will appear
7463 in the bottom right of the OPAC footer stating 'Powered by
7464 Koha' and linking to the official Koha website.</para>
7467 <screeninfo>Powered by Koha</screeninfo>
7471 <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
7479 <section id="opaclayoutstylesheet">
7480 <title>opaclayoutstylesheet</title>
7482 <para>Default: opac.css</para>
7484 <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
7485 OPAC, instead of the default</para>
7487 <para>Description:</para>
7491 <para>This setting's function is to point to the *.css file
7492 used to define the OPAC layout. A *.css file is a cascading
7493 stylesheet which is used in conjunction with HTML to set how
7494 the HTML page is formatted and will look on the OPAC. There
7495 are two stylesheets that come with the system; opac.css and
7496 opac2.css. A custom stylesheet may also be used. A style sheet
7497 designated in the <link
7498 linkend="opacstylesheet">opacstylesheet</link> preference will
7499 override the stylesheet listed here. The stylesheets listed in
7500 the opaclayoutstylesheet preference are held on the Koha
7506 <para>Leave this field blank to disable it and let Koha use the
7507 default file instead</para>
7511 <section id="OpacMaintenance">
7512 <title>OpacMaintenance</title>
7514 <para>Default: Don't show</para>
7516 <para>Asks: ___ a warning that the OPAC is under maintenance,
7517 instead of the OPAC itself. <note>
7518 <para>this shows the same warning as when the database needs
7519 to be upgraded, but unconditionally.</para>
7522 <para>Description:</para>
7526 <para>This preference allows the system administrator to turn
7527 off the OPAC during maintenance and display a message to
7528 users. When this preference is switched to “Show" the
7529 OPAC is not usable. The text of this message is not editable
7530 at this time.</para>
7534 <para>Values:</para>
7538 <para>Don't show</para>
7546 <para>When this preference is set to show the maintenance
7547 message the ability to search the OPAC is disabled and a
7548 message appears</para>
7551 <screeninfo>OPAC Maintenance Message</screeninfo>
7555 <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
7565 <section id="OpacMainUserBlock">
7566 <title>OpacMainUserBlock</title>
7568 <para>Default: Welcome to Koha... <hr></para>
7570 <para>Asks: Show the following HTML in its own column on the main
7571 page of the OPAC</para>
7573 <para>HTML entered in this field will appear in the center of the
7574 main page of your OPAC</para>
7577 <screeninfo>Sample OpacMainUserBlock appears below the search
7582 <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
7587 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7588 Regions</link> section.</para>
7591 <section id="OPACMySummaryHTML">
7592 <title>OPACMySummaryHTML</title>
7594 <para>Asks: Include a "Links" column on the "my summary" tab when
7595 a user is logged in to the OPAC, with the following HTML (leave
7596 blank to disable).</para>
7598 <para>Description:</para>
7602 <para>In this preference you can enter HTML that will appear
7603 on the 'Checked Out' tab on the 'My Summary' section when
7604 logged in to the OPAC. The placeholders {BIBLIONUMBER},
7605 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
7606 from the displayed record. This can be used to enter in
7607 'share' links for social networks or generate searches against
7608 other library catalogs.</para>
7611 <screeninfo>Example of 'Links' column with a value in the
7612 OPACMySummaryHTML preference</screeninfo>
7616 <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
7623 <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>
7624 <br />TITLE: {TITLE}
7625 <br />AUTHOR: {AUTHOR}
7626 <br />ISBN: {ISBN}
7627 <br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
7630 <section id="OpacNav">
7631 <title>OpacNav</title>
7633 <para>Default: Important links here.</para>
7635 <para>Asks: Show the following HTML on the left hand column of the
7636 main page and patron account on the OPAC (generally navigation
7640 <screeninfo>Sample navigation links</screeninfo>
7644 <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
7649 <para>Learn more in the <link linkend="editableopac">OPAC Editable
7650 Regions</link> section.</para>
7653 <section id="OpacNavBottom">
7654 <title>OpacNavBottom</title>
7656 <para>Asks: Show the following HTML on the left hand column of the
7657 main page and patron account on the OPAC, after <link
7658 linkend="OpacNav">OpacNav</link>, and before patron account links
7659 if available:</para>
7661 <para>Description: When a patron is logged in to their account
7662 they see a series of tabs to access their account information.
7663 <link linkend="OpacNav">OpacNav</link> appears above this list of
7664 tabs and OpacNavBottom will appear below them. When not on the
7665 patron account pages the HTML in OpacNavBottom will just appear
7666 right below <link linkend="OpacNav">OpacNav</link>.</para>
7669 <screeninfo>OpacNav and OpacNavBottom on Patron
7670 Account</screeninfo>
7674 <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
7680 <section id="OPACNoResultsFound">
7681 <title>OPACNoResultsFound</title>
7683 <para>No Default</para>
7685 <para>Asks: Display this HTML when no results are found for a
7686 search in the OPAC</para>
7688 <para>This HTML will display below the existing notice that no
7689 results were found for your search.</para>
7692 <screeninfo>HTML in OPACNoResultsFound will appear below lines
7693 that look like this</screeninfo>
7697 <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
7703 <section id="OpacPublic">
7704 <title>OpacPublic</title>
7706 <para>Default: Enable</para>
7708 <para>Asks: ___ Koha OPAC as public. Private OPAC requires
7709 authentication before accessing the OPAC.</para>
7711 <para>Values:</para>
7715 <para>Don't enable</para>
7723 <para>Description:</para>
7727 <para>This preference determines if your OPAC is accessible
7728 and searchable by anyone or only by members of the library. If
7729 set to 'Don't enable' only members who are logged into the
7730 OPAC can search. Most libraries will leave this setting at its
7731 default of 'Enable' to allow their OPAC to be searched by
7732 anyone and only require login for access to personalized
7738 <section id="OPACResultsSidebar">
7739 <title>OPACResultsSidebar</title>
7741 <para>Asks: Include the following HTML under the facets in OPAC
7742 search results</para>
7744 <para>Description:</para>
7748 <para>The HTML entered in this preference will appear on the
7749 search results pages below the list of facets on the left side
7750 of the screen.</para>
7755 <section id="OPACSearchForTitleIn">
7756 <title>OPACSearchForTitleIn</title>
7758 <para>Default: <li><a
7759 href="http://worldcat.org/search?q={TITLE}"
7760 target="_blank">Other Libraries (WorldCat)</a></li>
7762 href="http://www.scholar.google.com/scholar?q={TITLE}"
7763 target="_blank">Other Databases (Google
7764 Scholar)</a></li> <li><a
7765 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
7766 target="_blank">Online Stores
7767 (Bookfinder.com)</a></li></para>
7769 <para>Asks: Include a "More Searches" box on the detail pages of
7770 items on the OPAC, with the following HTML (leave blank to
7774 <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
7775 {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
7776 from the displayed record.</para>
7780 <para>You can use this field to add social networking share
7781 links by using code similar to this</para>
7783 <programlisting></ul></div></div><div class="detailtagcell">
7785 src="http://connect.facebook.net/en_US/all.js#xfbml=1"></script><fb:like
7786 href="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}" show_faces="true"
7787 width="450" font=""></fb:like>
7788 <div><a href="http://twitter.com/share" class="twitter-share-button"
7789 data-url="http://opac.mylibrary.tld/bib/{BIBLIONUMBER}" data-text="I'm reading
7790 this" data-count="horizontal">Tweet</a><script type="text/javascript"
7791 src="http://platform.twitter.com/widgets.js"></script></div></div><div><div><ul></programlisting>
7793 <para>The starting </ul> is necessary to break out of the
7794 'Search for this Title In' pull down menu</para>
7797 <screeninfo>OPACSearchForTitleIn with Social Networking
7802 <imagedata fileref="images/admin/globalprefs/OPACSearchForTitleIn.png"/>
7809 <section id="OPACShowCheckoutName">
7810 <title>OPACShowCheckoutName</title>
7812 <para>Default: Don't show</para>
7814 <para>Asks: ___ the name of the patron that has an item checked
7815 out on item detail pages on the OPAC.</para>
7817 <para>Values:</para>
7821 <para>Don't show</para>
7829 <para>Description:</para>
7833 <para>This preference allows all patrons to see who has the
7834 item checked out if it is checked out. In small corporate
7835 libraries (where the OPAC is behind a firewall and not
7836 publicly available) this can be helpful so coworkers can just
7837 contact the patron with the book themselves. In larger public
7838 and academic libraries setting this to 'Show' would pose
7839 serious privacy issues.</para>
7844 <section id="OpacShowRecentComments">
7845 <title>OpacShowRecentComments</title>
7847 <para>Default: Don't show</para>
7849 <para>Asks: ___ a link to recent comments in the OPAC
7852 <para>Values:</para>
7856 <para>Don't show</para>
7864 <para>Description:</para>
7868 <para>If you have chosen to allow comments in your OPAC by
7869 setting <link linkend="reviewson">reviewson</link> to 'Allow'
7870 you can include a link to the recent comments under the search
7871 box at the top of your OPAC with this preference.</para>
7874 <screeninfo>Recent Comments link on OPAC</screeninfo>
7878 <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
7886 <section id="opacsmallimage">
7887 <title>opacsmallimage</title>
7889 <para>Asks: Use the image at ___ in the OPAC header, instead of
7890 the Koha logo. If this image is a different size than the Koha
7891 logo, you will need to customize the CSS.</para>
7893 <para>Description:</para>
7897 <para>The opacsmallimage system pref is a little tricky to
7898 deal with because you really have to tweak some CSS at the
7899 same time. The default CSS defines a region just large enough
7900 to display the Koha logo, and if your logo doesn't match the
7901 Koha logo's dimensions (120 pixels wide by 38 pixels high), it
7902 won't display correctly.</para>
7907 <para>This should be a complete URL, starting with
7912 <section id="OpacStarRatings">
7913 <title>OpacStarRatings</title>
7915 <para>Default: no</para>
7917 <para>Asks: Show star-ratings on ___ pages.</para>
7919 <para>Values:</para>
7927 <para>only details</para>
7930 <screeninfo>Star Ratings on the Details Page</screeninfo>
7934 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
7941 <para>results and details</para>
7944 <screeninfo>OPAC Star Ratings on the Search
7945 Results</screeninfo>
7949 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
7956 <para>Description:</para>
7960 <para>Star ratings are a way for your patrons to leave ratings
7961 without having to leave a full review. Patrons who are not
7962 logged in will only be able to see the stars, once logged in
7963 patrons can click on the stars on the details page to leave
7964 their own rating. Clicking on the stars on the search results
7965 will not submit a rating.</para>
7970 <section id="opacstylesheet">
7971 <title>opacstylesheet</title>
7973 <para>Asks: Use the remote CSS stylesheet ___ on all pages in the
7974 OPAC, instead of the default.</para>
7976 <para>Description:</para>
7980 <para>This preference allows the administrator to completely
7981 replace the default stylesheet with their own alternate
7982 stylesheet. This allows the administrator to completely
7983 customize the look of the OPAC. To change the stylesheet,
7984 enter a complete URL, including the http:// to the custom
7985 stylesheet. Content in the custom/alternate stylesheet will
7986 overwrite any data in the default stylesheet defined in the
7988 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link>
7989 setting. The default stylesheet will likely be found at
7990 http://your_koha_address/opac-
7991 tmpl/prog/en/css/opac.css</para>
7996 <para>Leave this field blank to disable it and let Koha use the
7997 default file instead</para>
8001 <para>This should be a complete URL, starting with
8006 <section id="opacthemes">
8007 <title>opacthemes</title>
8009 <para>Default: prog</para>
8011 <para>Asks: Use the ___ theme on the OPAC.</para>
8013 <para>Values:</para>
8022 <section id="OPACURLOpenInNewWindow">
8023 <title>OPACURLOpenInNewWindow</title>
8025 <para>Default: don't</para>
8027 <para>Asks: When patrons click on a link to another website from
8028 your OPAC (like Amazon or OCLC), ___ open the website in a new
8031 <para>Values:</para>
8043 <para>Description:</para>
8047 <para>This preference determines if URLs in the OPAC will open
8048 in a new window or not. When clicking on a link in the OPAC, a
8049 patron does not need to worry about navigating away from their
8050 search results.</para>
8055 <section id="OPACUserCSS">
8056 <title>OPACUserCSS</title>
8058 <para>Asks: Include the following CSS on all pages in the
8061 <para>Description:</para>
8065 <para>OPACUserCSS allows the administrator to enter styles
8066 that will overwrite the OPAC's default CSS as defined in
8067 ‘opaclayoutstylesheet' or ‘opacstylesheet'. Styles
8068 may be entered for any of the selectors found in the default
8069 style sheet. The default stylesheet will likely be found at
8070 http://your_koha_address/opac-tmpl/prog/en/css/opac.css.
8072 linkend="opaccolorstylesheet">opaccolorstylesheet</link>,
8074 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> and
8075 <link linkend="opacstylesheet">opacstylesheet</link> this
8076 preference will embed the CSS directly on your OPAC
8082 <section id="opacuserjs">
8083 <title>opacuserjs</title>
8085 <para>Asks: Include the following JavaScript on all pages in the
8089 <screeninfo>OPAC login box before opacuserjs edit</screeninfo>
8093 <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
8099 <screeninfo>JavaScript in opacuserjs to change the OPAC login
8104 <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
8110 <screeninfo>New OPAC login box after editing
8111 opacuserjs</screeninfo>
8115 <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
8120 <para>Description:</para>
8124 <para>This preference allows the administrator to enter
8125 JavaScript or JQuery that will be embedded across all pages of
8126 the OPAC. Administrators may use this preference to customize
8127 some of the interactive sections of Koha, customizing the text
8128 for the login prompts, for example. Sample JQuery scripts used
8129 by Koha libraries can be found on the wiki: <ulink
8130 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
8135 <section id="OPACXSLTDetailsDisplay">
8136 <title>OPACXSLTDetailsDisplay</title>
8138 <para>Default: default</para>
8140 <para>Asks: Display OPAC details using XSLT stylesheet at
8143 <para>Values:</para>
8147 <para>leave empty to not use the XSLT stylesheet</para>
8151 <para>In previous versions of Koha this was the setting
8152 that read 'normally'</para>
8158 <para>enter "default" for the default one</para>
8162 <para>put a path to define a XSLT file</para>
8166 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
8170 <para>If in a multi-language system you can enter
8171 {langcode} in the path to tell Koha to look in the right
8172 language folder</para>
8177 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
8182 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
8190 <para>put an URL for an external specific stylesheet</para>
8194 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
8200 <para>Description:</para>
8204 <para>XSLT stylesheets allow for the customization of the
8205 details shows on the screen when viewing a bib record. This
8206 preference will allow you either use the default look that
8207 comes with Koha or design your own stylesheet.</para>
8212 <section id="OPACXSLTResultsDisplay">
8213 <title>OPACXSLTResultsDisplay</title>
8215 <para>Default: default</para>
8217 <para>Asks: Display OPAC results using XSLT stylesheet at
8220 <para>Values:</para>
8224 <para>leave empty to not use the XSLT stylesheet</para>
8228 <para>In previous versions of Koha this was the setting
8229 that read 'normally'</para>
8235 <para>enter "default" for the default one</para>
8239 <para>put a path to define a XSLT file</para>
8243 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
8247 <para>If in a multi-language system you can enter
8248 {langcode} in the path to tell Koha to look in the right
8249 language folder</para>
8254 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
8259 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
8267 <para>put an URL for an external specific stylesheet</para>
8271 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
8277 <para>Description:</para>
8281 <para>XSLT stylesheets allow for the customization of the
8282 details shows on the screen when viewing the search results.
8283 This preference will allow you either use the default look
8284 that comes with Koha or design your own stylesheet.</para>
8290 <section id="opacfeaturesprefs">
8291 <title>Features</title>
8295 <section id="numSearchRSSResults">
8296 <title>numSearchRSSResults</title>
8298 <para>Default: 50</para>
8300 <para>Asks: Display ___ search results in the RSS feed.</para>
8302 <para>Description:</para>
8306 <para>By default the RSS feed that is automatically generated
8307 for every search results page will list 50 items. This can
8308 sometimes be too much for some RSS feed readers and for some
8309 people this isn't enough. This preference allows you to adjust
8310 this number to show the best number of results for your
8316 <section id="OpacAuthorities">
8317 <title>OpacAuthorities</title>
8319 <para>Default: Allow</para>
8321 <para>Asks: ___ patrons to search your authority records.</para>
8323 <para>Description:</para>
8327 <para>This preference displays the link on the OPAC for the
8328 authority search (titled 'Browse by Subject'). By setting the
8329 preference to “Allow" patrons can use this search link
8335 <para>While labeled 'Browse' it is important to note that this
8336 is in fact an authority search, not an authority browse.</para>
8339 <screeninfo>Authority Search in the OPAC</screeninfo>
8343 <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
8349 <para>Values:</para>
8357 <para>A link labeled 'Browse by Subject' will appear at
8358 the top of your OPAC under the search box</para>
8361 <screeninfo>'Browse by Subject' link under search box on
8366 <imagedata fileref="images/admin/globalprefs/OpacAuthorities.png"/>
8375 <para>Don't allow</para>
8380 <section id="opacbookbag">
8381 <title>opacbookbag</title>
8383 <para>Default: Allow</para>
8385 <para>Asks: ___ patrons to store items in a temporary "Cart" on
8388 <para>Values:</para>
8396 <para>Don't allow</para>
8400 <para>Description:</para>
8404 <para>This preference allows the user to temporarily save a
8405 list of items found on the catalog. By using the Book Bag, or
8406 Cart, the user can print out or email a list of items found.
8407 The user does not need to be logged in. This list is temporary
8408 and will be emptied, or cleared, at the end of the
8414 <section id="OpacBrowser">
8415 <title>OpacBrowser</title>
8418 <para>This preference only applies to French systems at this
8422 <para>Default: Don't allow</para>
8424 <para>Asks: ___ patrons to browse subject authorities on
8427 <para>Values:</para>
8435 <para>Don't allow</para>
8440 <para>run the <link linkend="authbrowsercron">Authorities
8441 Browser Cron Job</link> to create the browser list</para>
8445 <section id="OpacBrowseResults">
8446 <title>OpacBrowseResults</title>
8448 <para>Default: enable</para>
8450 <para>Asks: ___ browsing and paging search results from the OPAC
8453 <para>Values:</para>
8457 <para>disable</para>
8464 <screeninfo>Browsing and Paging Search Results</screeninfo>
8468 <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
8475 <para>Description:</para>
8479 <para>This preference will control the option to return to
8480 your results and/or browse them from the detail page in the
8486 <section id="OPACFinesTab">
8487 <title>OPACFinesTab</title>
8489 <para>Default: Allow</para>
8491 <para>Asks: ___ patrons to access the Fines tab on the My Account
8492 page on the OPAC.</para>
8494 <para>Values:</para>
8502 <para><link linkend="opacuserlogin">opacuserlogin</link>
8503 needs to be set to 'allow'</para>
8509 <para>Don't allow</para>
8514 <section id="OpacPasswordChange">
8515 <title>OpacPasswordChange</title>
8517 <para>Default: Allow</para>
8519 <para>Asks: ___ patrons to change their own password on the
8522 <para>Values:</para>
8530 <para><link linkend="opacuserlogin">opacuserlogin</link>
8531 needs to be set to 'allow'</para>
8537 <para>Don't allow</para>
8542 <para>Enabling this will break LDAP authentication.</para>
8546 <section id="OPACPatronDetails">
8547 <title>OPACPatronDetails</title>
8549 <para>Default: Allow</para>
8551 <para>Asks: ___ patrons to notify the library of changes to their
8552 contact information from the OPAC.</para>
8554 <para>Values:</para>
8562 <para><link linkend="opacuserlogin">opacuserlogin</link>
8563 needs to be set to 'allow'</para>
8569 <para>Don't allow</para>
8573 <para>Description:</para>
8577 <para>If patrons are allowed to notify the library of changes
8578 an email will be sent to the library administration email
8579 address with the changes. Lines that start with the field name
8580 in all caps are the lines that the patron made changes
8586 <section id="OPACpatronimage">
8587 <title>OPACpatronimage</title>
8589 <para>Default: Don't show</para>
8591 <para>Asks: ___ patron images on the patron information page in
8594 <para>Values:</para>
8598 <para>Don't show</para>
8606 <para>Description:</para>
8610 <para>If <link linkend="patronimages">patronimages</link> is
8611 set to allow the upload of patron images via the staff client,
8612 then setting this preference to 'show' will show the patron
8613 what image you have on file for them when they view their
8614 personal information on their account in the OPAC.</para>
8619 <section id="OpacTopissue">
8620 <title>OpacTopissue</title>
8622 <para>Default: Don't allow</para>
8624 <para>Asks: ___ patrons to access a list of the most checked out
8625 items on the OPAC.</para>
8627 <para>Values:</para>
8635 <para>A link to 'Most Popular' will appear at the top of
8639 <screeninfo>'Most Popular' link under the search
8644 <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
8653 <para>Don't allow</para>
8657 <para>Description:</para>
8661 <para>This preference allows the administrator to choose to
8662 show the “Most Popular" link at the top of the OPAC
8663 under the search box. The “Most Popular" page shows the
8664 top circulated items in the library, as determined by the
8665 number of times a title has been circulated. This allows users
8666 to see what titles are popular in their community. It is
8667 recommended that you leave this preference set to 'Don't
8668 allow' until you have been live on Koha for a couple of
8669 months, otherwise the data that it shows will not be an
8670 accurate portrayal of what's popular in your library.</para>
8673 <screeninfo>Sample top issues page</screeninfo>
8677 <imagedata fileref="images/admin/globalprefs/topissues.png"/>
8685 <section id="opacuserlogin">
8686 <title>opacuserlogin</title>
8688 <para>Default: Allow</para>
8690 <para>Asks: ___ patrons to log in to their accounts on the
8693 <para>Values:</para>
8701 <para>Don't allow</para>
8705 <para>The OPAC will still be searchable if patrons can't
8706 log in, this just disables the patron account access via
8714 <section id="RequestOnOpac">
8715 <title>RequestOnOpac</title>
8717 <para>Default: Allow</para>
8719 <para>Asks: ___ patrons to place holds on items from the
8722 <para>Values:</para>
8730 <para><link linkend="opacuserlogin">opacuserlogin</link>
8731 needs to be set to 'allow'</para>
8737 <para>Don't allow</para>
8742 <section id="reviewson">
8743 <title>reviewson</title>
8745 <para>Default: Allow</para>
8747 <para>Asks: ___ patrons to make comments on items on the
8750 <para>Values:</para>
8758 <para>Patrons comments/reviews all require moderation
8759 before they appear in the OPAC</para>
8763 <para><link linkend="opacuserlogin">opacuserlogin</link>
8764 needs to be set to 'Allow'</para>
8770 <para>Don't allow</para>
8774 <para>Description:</para>
8778 <para>This button allows the patrons to submit comments on
8779 books they have read via the OPAC. If this preference is set
8780 to “Allow" reviews are first sent to the staff client
8781 for staff approval before the review is displayed in the OPAC.
8782 The staff member who reviews and approves comments may find
8783 the pending comments on the <link
8784 linkend="comments">Comments</link> tool. The staff member can
8785 then choose to approve or delete the comments.</para>
8790 <section id="ShowReviewer">
8791 <title>ShowReviewer</title>
8793 <para>Default: full name</para>
8795 <para>Asks: Show ___ of commenter with comments in OPAC.</para>
8797 <para>Values:</para>
8801 <para>first name</para>
8805 <para>first name and last initial</para>
8809 <para>full name</para>
8813 <para>last name</para>
8817 <para>no name</para>
8821 <para>username</para>
8825 <para>Description:</para>
8829 <para>If you would like to protect your patron's privacy in
8830 the OPAC you can choose to hide their names or parts of their
8831 names from any of the comments they leave on bib records in
8832 your system. <link linkend="reviewson">reviewson</link> needs
8833 to be set to 'Allow' for this to preference to come in to
8839 <section id="ShowReviewerPhoto">
8840 <title>ShowReviewerPhoto</title>
8842 <para>Default: Show</para>
8844 <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
8846 <para>Values:</para>
8858 <para><link linkend="reviewson">reviewson</link> needs to
8859 be set to 'Allow' and <link
8860 linkend="ShowReviewer">ShowReviewer</link> needs to be set
8861 to 'Show' for this to preference to come in to play</para>
8864 <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
8868 <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
8877 <para>Description:</para>
8881 <para>This system preference allows libraries to show avatars
8882 next to patron's comments in the OPAC. These avatars are
8883 pulled from the <ulink
8884 url="https://www.libravatar.org">Libravatar</ulink> library,
8885 an open source powered product that allows Internet users to
8886 choose a small icon to display next to their name on various
8887 different websites. The library has no control over the images
8888 the patron chooses to display.</para>
8893 <section id="SocialNetworks">
8894 <title>SocialNetworks</title>
8896 <para>Default: Disable</para>
8898 <para>Asks: ___ social network links in opac detail pages</para>
8900 <para>Values:</para>
8904 <para>Disable</para>
8911 <screeninfo>Social Networks</screeninfo>
8915 <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
8922 <para>Description:</para>
8926 <para>This preference will enable a line of social network
8927 share buttons below the right hand column on the detail pages
8928 of records in the OPAC.</para>
8933 <para>In order for these share buttons to work when clicked you
8934 must have filled in your <link
8935 linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
8939 <section id="suggestionspref">
8940 <title>suggestion</title>
8942 <para>Default: Allow</para>
8944 <para>Asks: ___ patrons to make purchase suggestions on the
8947 <para>Values:</para>
8955 <para><link linkend="opacuserlogin">opacuserlogin</link>
8956 needs to be set to 'allow' unless <link
8957 linkend="AnonSuggestions">AnonSuggestions</link> is set to
8964 <para>Don't allow</para>
8970 <section id="opacpolicyprefs">
8971 <title>Policy</title>
8975 <section id="AllowPurchaseSuggestionBranchChoice">
8976 <title>AllowPurchaseSuggestionBranchChoice</title>
8978 <para>Default: Don't allow</para>
8980 <para>Asks: ___ patrons to select branch when making a purchase
8983 <para>Values:</para>
8991 <para>Don't allow</para>
8995 <para>Description:</para>
8999 <para>If your library system lets patrons make purchase
9000 suggestions for a specific branch you can set this preference
9001 to 'Allow' to add a branch selection option to the purchase
9002 suggestion form.</para>
9007 <section id="OpacAllowPublicListCreation">
9008 <title>OpacAllowPublicListCreation</title>
9010 <para>Default: Allow</para>
9012 <para>Asks: ___ opac users to create public lists</para>
9014 <para>Values:</para>
9022 <para>Don't allow</para>
9026 <para>Description:</para>
9030 <para>Public lists are visible to anyone who visits your OPAC.
9031 With this preference you can control whether or now patrons
9032 are allowed to create these public lists. If this is set to
9033 "Don't allow" then only staff will be able to create public
9039 <para>This preference will only be taken in to account if you
9040 have <link linkend="virtualshelves">virtualshelves</link> set to
9045 <section id="OpacAllowSharingPrivateLists">
9046 <title>OpacAllowSharingPrivateLists</title>
9049 <para>This feature is not active yet but will be released
9053 <para>Default: Don't allow</para>
9055 <para>Asks: ___ opac users to share private lists with other
9058 <para>Values:</para>
9066 <para>Don't allow</para>
9070 <para>Description:</para>
9074 <para>This feature will add the option for patrons to share
9075 their lists with other patrons.</para>
9080 <section id="OPACFineNoRenewals">
9081 <title>OPACFineNoRenewals</title>
9083 <para>Default: 99999</para>
9085 <para>Asks: Only allow patrons to renew their own books on the
9086 OPAC if they have less than ___ USD in fines</para>
9089 <para>Leave this field blank to disable</para>
9093 <para>To allow renewals in the OPAC, <link
9094 linkend="opacuserlogin">opacuserlogin</link> needs to be set to
9099 <section id="OpacHiddenItems">
9100 <title>OpacHiddenItems</title>
9102 <para>Asks: Allows to define custom rules for hiding specific
9103 items at opac. <tip>
9104 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
9105 directory for more information</para>
9108 <para>Description:</para>
9112 <para>In this field you can enter criteria for items you would
9113 like to hide from display in the OPAC. This field takes any
9114 combination of item fields (from the items table in the Koha
9115 database) for blocking. For example a value of:</para>
9117 <para><programlisting>itype: [07, 10]
9118 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
9119 07 or 10 as well as items that have a shelving location of
9120 STAFF or ISO.</para>
9122 <para>In items my items.itype 07 is defined in Item Types
9123 Administration as Staff Assigned My items.itype 10 in Item
9124 Types is Archival Copy The locations STAFF and ISO are in
9125 Authorized Values for category=LOC STAFF means it's assigned
9126 to the staff reading room and ISO means it is in the isolation
9132 <section id="OPACItemHolds">
9133 <title>OPACItemHolds</title>
9135 <para>Default: Allow</para>
9137 <para>Asks: ___ patrons to place holds on specific items in the
9140 <para>Values:</para>
9148 <para>Patrons can place holds on specific items as well as
9149 the next available item.</para>
9153 <para><link linkend="opacuserlogin">opacuserlogin</link>
9154 needs to be set to 'allow'</para>
9160 <para>Don't allow</para>
9164 <para>If this is disabled, users can only put a hold on
9165 the next available item.</para>
9172 <section id="OpacRenewalAllowed">
9173 <title>OpacRenewalAllowed</title>
9175 <para>Default: Don't allow</para>
9177 <para>Asks: ___ patrons to renew their own books on the
9180 <para>Values:</para>
9188 <para><link linkend="opacuserlogin">opacuserlogin</link>
9189 needs to be set to 'allow'</para>
9195 <para>Don't allow</para>
9199 <para>Staff will still be able to renew items for patrons
9200 via the staff client</para>
9206 <para>Description:</para>
9210 <para>This preference allows the administration to choose if
9211 patrons can renew their checked out materials via their
9212 checked out history in the OPAC. It allows patrons to renew
9213 their materials without having to contact the library or
9214 having to return to the library.</para>
9219 <section id="OpacRenewalBranch">
9220 <title>OpacRenewalBranch</title>
9222 <para>Default: the branch the item was checked out from</para>
9224 <para>Asks: Use ___ as branchcode to store in the statistics
9227 <para>Values:</para>
9235 <para>'OPACRenew'</para>
9239 <para>the item's home branch</para>
9243 <para>the patron's home branch</para>
9247 <para>the branch the item was checked out from</para>
9251 <para>Description:</para>
9255 <para>This value is used in the statistics table to help with
9256 reporting. The statistics table in Koha keeps track of all
9257 checkouts and renewals, this preference defines which branch
9258 is entered in to the table when a patron renews an item for
9259 themselves via the OPAC.</para>
9264 <section id="OPACViewOthersSuggestions">
9265 <title>OPACViewOthersSuggestions</title>
9267 <para>Default: Don't show</para>
9269 <para>Asks: ___ purchase suggestions from other patrons on the
9272 <para>Values:</para>
9276 <para>Don't show</para>
9284 <para><link linkend="opacuserlogin">opacuserlogin</link>
9285 needs to be set to 'allow'</para>
9292 <section id="SearchMyLibraryFirst">
9293 <title>SearchMyLibraryFirst</title>
9295 <para>Default: Don't limit</para>
9297 <para>Asks: ___ patrons' searches to the library they are
9298 registered at.</para>
9300 <para>Values:</para>
9304 <para>Don't limit</para>
9308 <para>Searching the OPAC will show results from all
9313 <para>If you're a one branch system, choose 'Don't
9324 <para>Patrons will still be able to search other libraries
9325 via the Advanced search page - but will be limited to
9326 searches for their library only from the basic search
9331 <para><link linkend="opacuserlogin">opacuserlogin</link>
9332 needs to be set to 'allow'</para>
9339 <section id="singleBranchMode">
9340 <title>singleBranchMode</title>
9342 <para>Default: Don't allow</para>
9344 <para>Asks: ___ patrons to select their branch on the OPAC.</para>
9346 <para>Values:</para>
9354 <para><link linkend="opacuserlogin">opacuserlogin</link>
9355 needs to be set to 'allow'</para>
9361 <para>Don't allow</para>
9365 <para>Description:</para>
9369 <para>This preference is for libraries that have branches but
9370 do not want to share their items among other branches within
9371 their system. If the preference is set to “Don't allow"
9372 then holdings will be shown for all branches within a system.
9373 On the “Home" screen of the OPAC users have the choice
9374 of narrowing down results by item location. Setting this
9375 preference to “Allow" will display only one branch's
9382 <section id="opacprivacyprefs">
9383 <title>Privacy</title>
9387 <section id="AnonSuggestions">
9388 <title>AnonSuggestions</title>
9390 <para>Default: Don't allow</para>
9392 <para>Asks: ___ patrons that aren't logged in to make purchase
9393 suggestions. <important>
9394 <para>If set to 'Allow', suggestions are connected to the
9395 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
9398 <para>Values:</para>
9406 <para>Don't allow</para>
9411 <section id="AnonymousPatron">
9412 <title>AnonymousPatron</title>
9414 <para>Default: 0</para>
9416 <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for
9417 anonymous suggestions and reading history) <tip>
9418 <para>Before setting this preference <link
9419 linkend="addnewpatron">create a patron</link> to be used for
9420 all anonymous suggestions and/or reading history items. This
9421 patron can be any type and should be named something to make
9422 it clear to you that they're anonymous (ex. Anonymous
9427 <section id="EnableOpacSearchHistory">
9428 <title>EnableOpacSearchHistory</title>
9430 <para>Default: Keep</para>
9432 <para>Asks: ___ patron search history in the OPAC.</para>
9434 <para>Values:</para>
9438 <para>Don't keep</para>
9447 <section id="OPACPrivacy">
9448 <title>OPACPrivacy</title>
9450 <para>Default: Don't allow</para>
9452 <para>Asks: ___ patrons to choose their own privacy settings for
9453 their reading history. <important>
9454 <para>This requires <link
9455 linkend="opacreadinghistory">opacreadinghistory</link> set to
9457 linkend="AnonymousPatron">AnonymousPatron</link> to be set to
9458 your anonymous patron's borrowernumber.</para>
9461 <para>Values:</para>
9469 <para>Don't allow</para>
9474 <section id="opacreadinghistory">
9475 <title>opacreadinghistory</title>
9477 <para>Default: Allow</para>
9479 <para>Asks: ___ patrons to see what books they have checked out in
9483 <para>Enabling this will make it so that patrons can view their
9484 circulation history in the OPAC unless you have OPACPrivacy set
9489 <para>This data is stored in the system regardless of your
9490 choice, unless your patrons have chosen to never have their
9491 reading history kept.</para>
9496 <section id="shelfbrowseprefs">
9497 <title>Shelf Browser</title>
9501 <section id="OPACShelfBrowser">
9502 <title>OPACShelfBrowser</title>
9504 <para>Default: Show</para>
9506 <para>Asks: ___ a shelf browser on item details pages, allowing
9507 patrons to see what's near that item on the shelf.</para>
9509 <para>Values:</para>
9513 <para>Don't show</para>
9520 <screeninfo>OPACShelfBrowser</screeninfo>
9524 <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
9531 <para>Description:</para>
9535 <para>This preference allows patrons to view what is located
9536 on the shelf near the item they looked up. The shelf browser
9537 option appears on the details page to the right of each items'
9538 call number. Clicking the 'Browse Shelf' link allows for a
9539 virtual shelf browsing experience via the OPAC and lets
9540 patrons see other books that may relate to their search and
9541 items that sit on the shelf near the item they are looking
9547 <para>This uses up a fairly large amount of resources on your
9548 server, and should be avoided if your collection has a large
9549 number of items.</para>
9553 <section id="ShelfBrowserUsesCcode">
9554 <title>ShelfBrowserUsesCcode</title>
9556 <para>Default: Don't use</para>
9558 <para>Asks: ___ the item collection code when finding items for
9559 the shelf browser.</para>
9561 <para>Values:</para>
9565 <para>Don't use</para>
9573 <para>Description:</para>
9577 <para>If your library uses collection codes then you might
9578 want the shelf browser to take into consideration what
9579 collection the books belong to when populating the virtual
9580 shelf browser.</para>
9585 <section id="ShelfBrowserUsesHomeBranch">
9586 <title>ShelfBrowserUsesHomeBranch</title>
9588 <para>Default: Use</para>
9590 <para>Asks: ___ the item home branch when finding items for the
9591 shelf browser.</para>
9593 <para>Values:</para>
9597 <para>Don't use</para>
9605 <para>Description:</para>
9609 <para>If you have a multiple branch system you may want to
9610 make sure that Koha takes into consideration what branch owns
9611 the books when populating the virtual shelf browser for
9617 <section id="ShelfBrowserUsesLocation">
9618 <title>ShelfBrowserUsesLocation</title>
9620 <para>Default: Use</para>
9622 <para>Asks: ___ the item location when finding items for the shelf
9625 <para>Values:</para>
9629 <para>Don't use</para>
9637 <para>Description:</para>
9641 <para>If your library uses shelving locations then you might
9642 want the shelf browser to take into consideration what
9643 shelving location the books belong to when populating the
9644 virtual shelf browser.</para>
9651 <section id="patronprefs">
9652 <title>Patrons</title>
9654 <para><emphasis>Get there:</emphasis> More > Administration >
9655 Global System Preferences > Patrons</para>
9657 <section id="AddPatronLists">
9658 <title>AddPatronLists</title>
9660 <para>Default: specific categories</para>
9662 <para>Asks: List ___ under the new patron menu.</para>
9664 <para>Values:</para>
9668 <para>general patron types</para>
9671 <screeninfo>Add patron options with AddPatronLists set to
9672 general patron types</screeninfo>
9676 <imagedata fileref="images/admin/globalprefs/AddPatronLists-category.png"/>
9683 <para>specific categories</para>
9686 <screeninfo>Add patron options with AddPatronLists set to
9687 specific categories</screeninfo>
9691 <imagedata fileref="images/admin/globalprefs/AddPatronLists-specific.png"/>
9699 <section id="AutoEmailOPACUser">
9700 <title>AutoEmailOpacUser</title>
9702 <para>Default: Don't send</para>
9704 <para>Asks: ___ an email to newly created patrons with their account
9707 <para>Description:</para>
9711 <para>AutoEmailOpacUser allows library users to be notified by
9712 email of their account details when a new account is opened at
9713 the email address specified in the <link
9714 linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
9715 preference. The email contains the username and password given
9716 to or chosen by the patron when signing up for their account and
9717 can be customized by editing the <link
9718 linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
9722 <para>Values:</para>
9726 <para>Don't send</para>
9735 <section id="AutoEmailPrimaryAddress">
9736 <title>AutoEmailPrimaryAddress</title>
9738 <para>Default: alternate</para>
9740 <para>Asks: Use ___ patron email address for sending out
9743 <para>Values:</para>
9747 <para>alternate</para>
9751 <para>first valid</para>
9763 <para>Description:</para>
9767 <para>If you choose 'first valid' as the value for
9768 AutoEmailPrimaryAddress the system will check the email fields
9769 in this order: home, work, then alternate. Otherwise the system
9770 will use the email address you specify.</para>
9775 <section id="autoMemberNum">
9776 <title>autoMemberNum</title>
9778 <para>Default: Do</para>
9780 <para>Asks: ___ default the card number field on the patron addition
9781 screen to the next available card number</para>
9783 <para>Values:</para>
9791 <para>If the largest currently used card number is
9792 26345000012941, then this field will default to
9793 26345000012942 for the next patron</para>
9803 <para>Description:</para>
9807 <para>This preference determines if the patron's barcode is
9808 automatically calculated. This prevents the person setting up
9809 the library card account from having to assign a number to the
9810 new card. If set to 'Do' the system will calculate a new patron
9811 barcode by adding 1 to the maximum barcode already present in
9812 the database.</para>
9817 <section id="BorrowerMandatoryField">
9818 <title>BorrowerMandatoryField</title>
9820 <para>Default: surname|cardnumber|barcode</para>
9822 <para>Asks: The following database columns must be filled in on the
9823 patron entry screen: ___</para>
9825 <para>Description:</para>
9829 <para>This preference enables the system administrator to choose
9830 which fields your library would like required for patron
9831 accounts. Enter field names separated by | (bar). This ensures
9832 that basic information is included in each patron record. If a
9833 patron leaves one of the required fields blank an error message
9834 will issue and the account will not be created.</para>
9839 <para>Separate columns with |</para>
9843 <para>For help with field names, ask your system administrator or
9845 url="http://schema.koha-community.org/tables/borrowers.html">view
9846 the database structure</ulink> associated with the borrowers
9851 <section id="borrowerRelationship">
9852 <title>borrowerRelationship</title>
9854 <para>Default: father|mother</para>
9856 <para>Asks: Guarantors can be the following of those they guarantee
9859 <para>Description:</para>
9863 <para>This preference enables the system administrator to define
9864 valid relationships between a guarantor (usually a parent) &
9865 a guarantee (usually a child). Defining values for this field
9866 does not make the guarantor field required when adding a
9867 guarantee type patron. This preference creates a drop down list
9868 identifying the relationship of the guarantor to the guarantee.
9869 To disable the ability to add children types in Koha you can
9870 leave this field blank.</para>
9875 <para>Input multiple choices separated by |</para>
9879 <section id="BorrowerRenewalPeriodBase">
9880 <title>BorrowerRenewalPeriodBase</title>
9882 <para>Default: current date</para>
9884 <para>Asks: When renewing borrowers, base the new expiry date on
9887 <para>Values:</para>
9891 <para>current date.</para>
9895 <para>current membership expiry date.</para>
9899 <para>Description:</para>
9903 <para>This preference controls what the patron's new expiration
9904 date will be when you renew their card. Using the 'current date'
9905 will add the subscription period to today's date when
9906 calculating the new expiration date. Using 'current membership
9907 expiry date' will add the subscription period to the old
9908 expiration date for the patron when renewing their
9914 <section id="BorrowersTitles">
9915 <title>BorrowersTitles</title>
9917 <para>Default: Mr|Mrs|Miss|Ms</para>
9919 <para>Asks: Borrowers can have the following titles ___</para>
9921 <para>Description:</para>
9925 <para>This preference allows the staff to choose the titles that
9926 can be assigned to patrons. The choices present as a drop down
9927 list when creating a patron record.</para>
9932 <para>Input multiple choices separated by |</para>
9936 <section id="BorrowerUnwantedField">
9937 <title>BorrowerUnwantedField</title>
9939 <para>Asks: The following database columns will not appear on the
9940 patron entry screen: ___</para>
9942 <para>Description:</para>
9946 <para>This preference enables the system administrator to choose
9947 which fields your library doesn't need to see on the patron
9948 entry form. Enter field names separated by | (bar).</para>
9953 <para>Separate columns with |</para>
9957 <para>For help with field names, ask your system administrator or
9959 url="http://schema.koha-community.org/tables/borrowers.html">view
9960 the database structure</ulink> associated with the borrowers
9965 <section id="checkdigit">
9966 <title>checkdigit</title>
9968 <para>Default: Don't</para>
9970 <para>Asks: ___ check and construct borrower card numbers in the
9971 Katipo style.</para>
9973 <para>Values:</para>
9986 <para>This overrides <link
9987 linkend="autoMemberNum">autoMemberNum</link> if on.</para>
9991 <section id="EnhancedMessagingPreferences">
9992 <title>EnhancedMessagingPreferences</title>
9994 <para>Default: Allow</para>
9996 <para>Asks: ___ patrons to choose which notices they receive and
9997 when they receive them.</para>
9999 <para>Values:</para>
10007 <para>Don't allow</para>
10012 <para>This only applies to certain kinds of notices, overdue
10013 notices will be sent based on the library's rules, not the
10014 patron's choice.</para>
10017 <para>Description:</para>
10021 <para>These messages are in addition to the overdue notices that
10022 the library sends. The difference between these notices and
10023 overdues is that the patron can opt-in and out of these. Setting
10024 this preference to 'Allow' will allow patrons to choose to
10025 receive any one of the following messages:</para>
10029 <para>Item Checkout : A notice that lists all the of the
10030 items the patron has just checked out, this is an electronic
10031 form of the checkout receipt</para>
10035 <para>Item Due : A notice on the day and item is due back at
10040 <para>Hold Filled : A notice when you have confirmed the
10041 hold is waiting for the patron</para>
10045 <para>Item Checkin : A notice that lists all the of the
10046 items the patron has just checked in</para>
10050 <para>Advanced Notice : A notice in advance of the patron's
10051 items being due (The patron can choose the number of days in
10059 <section id="ExtendedPatronAttributes">
10060 <title>ExtendedPatronAttributes</title>
10062 <para>Default: Enable</para>
10064 <para>Asks: ___ searching, editing and display of custom attributes
10067 <para>Values:</para>
10071 <para>Don't enable</para>
10075 <para>Enable</para>
10079 <para>Define attributes in Koha administration</para>
10083 <para>Get there: More > Administration > <link
10084 linkend="patronattributetypes">Patron Attribute
10085 Types</link></para>
10091 <para>Description:</para>
10095 <para>Patron attributes are library-defined custom fields that
10096 can be applied to patron records.</para>
10101 <para>Use custom attributes for fields that the default patron
10102 record does not support such as driver's license number or student
10107 <section id="intranetreadinghistory">
10108 <title>intranetreadinghistory</title>
10110 <para>Default: Allow</para>
10112 <para>Asks: ___ staff to access a patron's checkout
10114 <para>If you have the <link
10115 linkend="OPACPrivacy">OPACPrivacy</link> preference set to
10116 'Allow' and the patron has decided to not have their history
10117 kept staff will only see currently checked out items.</para>
10118 </important></para>
10120 <para>Values:</para>
10128 <para>Don't allow</para>
10133 <para>This data is stored in the system regardless of your
10138 <section id="MaxFine">
10139 <title>MaxFine</title>
10141 <para>Default: 9999</para>
10143 <para>Asks: The late fine for a specific checkout will only go up to
10147 <section id="memberofinstitution">
10148 <title>memberofinstitution</title>
10150 <para>Default: Don't</para>
10152 <para>Asks: ___ allow patrons to be linked to institutions</para>
10154 <para>Values:</para>
10167 <para>In order to allow this, the library must have Institution
10168 patrons to link members to</para>
10172 <section id="minPasswordLength">
10173 <title>minPasswordLength</title>
10175 <para>Default: 3</para>
10177 <para>Asks: Login passwords for staff and patrons must be at least
10178 ___ characters long.</para>
10181 <para>This applies to both the staff login and the patron OPAC
10186 <section id="NotifyBorrowerDeparture">
10187 <title>NotifyBorrowerDeparture</title>
10189 <para>Default: 30</para>
10191 <para>Asks: Show a notice that a patron is about to expire ___ days
10194 <para>Description:</para>
10198 <para>When the patron attempts to check out materials, a warning
10199 will appear in the check out window of the Staff Client telling
10200 the librarian that the patrons account is about to
10206 <para>This notice will appear on the patron's record in the staff
10211 <section id="patronimages">
10212 <title>patronimages</title>
10214 <para>Default: Allow</para>
10216 <para>Asks: ___ images to be uploaded and shown for patrons on the
10217 staff client.</para>
10219 <para>Values:</para>
10227 <para>Don't allow</para>
10232 <section id="PatronsPerPage">
10233 <title>PatronsPerPage</title>
10235 <para>Default: 20</para>
10237 <para>Asks: By default, show ___ results per page in the staff
10241 <section id="SMSSendDriver">
10242 <title>SMSSendDriver</title>
10244 <para>Asks: Use the SMS::Send:: ___ driver to send SMS
10247 <para>Some examples of values are:</para>
10251 <para>SMS::Send::Us::Ipipi</para>
10255 <para>SMS::Send::US::TMobile</para>
10259 <para>SMS::Send::US::Verizon</para>
10263 <para>Additional values can be found here: <ulink
10264 url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
10268 <para>Only drivers available as Perl modules will work in this
10269 preference, so make sure a Perl module is available before
10270 choosing an SMS service.</para>
10273 <para>Once a driver is entered in the preference an option will
10274 appear in the staff client and the OPAC on the patron messaging form
10275 to choose to receive messages as SMS</para>
10278 <screeninfo>SMSSendDriver Options</screeninfo>
10282 <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
10288 <para>You must allow <link
10289 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
10290 for this to work.</para>
10294 <section id="TalkingTechItivaPhoneNotification">
10295 <title>TalkingTechItivaPhoneNotification</title>
10297 <para>Default: Disable</para>
10299 <para>Asks: ___ patron phone notifications using Talking Tech i-tiva
10300 (overdues, predues and holds notices currently supported).</para>
10302 <para>Values:</para>
10306 <para>Disable</para>
10310 <para>Enable</para>
10314 <para>Description:</para>
10318 <para>To learn more about setting up this third party product
10319 view the <link linkend="talkingtechappendix">Talking Tech
10320 Appendix</link>.</para>
10325 <para>Requires that you have <link
10326 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
10327 set to Allow to use.</para>
10331 <section id="uppercasesurnames">
10332 <title>uppercasesurnames</title>
10334 <para>Default: Don't</para>
10336 <para>Asks: ___ store and display surnames (last names) in upper
10339 <para>Values:</para>
10353 <section id="searchingprefs">
10354 <title>Searching</title>
10356 <para><emphasis>Get there:</emphasis> More > Administration >
10357 Global System Preferences > Searching</para>
10359 <section id="searchfeatureprefs">
10360 <title>Features</title>
10364 <section id="NoZebra">
10365 <title>NoZebra</title>
10367 <para>Default: Use</para>
10369 <para>Asks: ___ the Zebra search engine. Searches are very slow on
10370 even modest sized collections when Zebra is off.</para>
10372 <para>Values:</para>
10376 <para>Don't use</para>
10385 <section id="NoZebraIndexes">
10386 <title>NoZebraIndexes</title>
10388 <para>Default: See the <link linkend="nozebradefault">Systems
10389 Preferences Appendix</link></para>
10392 <section id="OpacGroupResults">
10393 <title>OpacGroupResults</title>
10395 <para>Default: Don't use</para>
10397 <para>Asks: ___ PazPar2 to group similar results on the
10400 <para>Values:</para>
10404 <para>Don't use</para>
10413 <para>This requires that <ulink
10414 url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
10415 and running.</para>
10419 <section id="QueryAutoTruncate">
10420 <title>QueryAutoTruncate</title>
10422 <para>Default: automatically</para>
10424 <para>Asks: Perform wildcard searching (where, for example, Har
10425 would match Harry and harp) ___ (The * character would be used
10426 like so: Har* or *logging.)</para>
10428 <para>Values:</para>
10432 <para>automatically</para>
10436 <para>only if * is added</para>
10440 <para>Description:</para>
10444 <para>This setting allows for searches to be automatically
10445 truncated or for additional characters to be added to the end
10446 of a search string. When set to "automatically" the search
10447 string automatically ends with a wildcard function. For
10448 example, a search for the word “invent" with auto
10449 truncation enabled will also retrieve results for inventor,
10450 invention, inventory, etc. If you don't want this to happen
10451 automatically you can still be perform wildcard searches
10452 manually by adding an asterisk (*). Typing “invent*"
10453 even with auto truncation disabled will retrieve the same
10454 inventor, invention, inventory results. Auto truncation
10455 bypasses the necessity to type long search strings in their
10461 <section id="QueryFuzzy">
10462 <title>QueryFuzzy</title>
10464 <para>Default: Try</para>
10466 <para>Asks: ___ to match similarly spelled words in a search (for
10467 example, a search for flang would also match flange and
10470 <para>Values:</para>
10474 <para>Don't try</para>
10482 <para>Description:</para>
10486 <para>This preference enables “fuzzy" searching, in
10487 which the search engine returns results that are similar to,
10488 but not exactly matching, the word or words entered by the
10489 user. This preference enables the search function to
10490 compensate for slightly misspelled names or phrases.</para>
10495 <para>Requires that <link linkend="NoZebra">NoZebra</link> is
10496 set to 'Use' and <link linkend="UseICU">UseICU</link> set to
10501 <section id="QueryRemoveStopwords">
10502 <title>QueryRemoveStopwords</title>
10504 <para>Default: Don't remove</para>
10506 <para>Asks: ___ stop words specified in Koha from searches.</para>
10508 <para>Values:</para>
10512 <para>Don't remove</para>
10517 <para>If <link linkend="NoZebra">NoZebra</link> is set
10518 to 'Use' leave this preference set to 'Don't
10526 <para>Remove</para>
10530 <para>Requires that you have updated your Koha <link
10531 linkend="stopwordsadmin">Stop Words</link> list</para>
10538 <para>Requires that NoZebra is set to 'Don't use'</para>
10542 <para>Zebra, on its own, handles a few of the most common stop
10547 <section id="QueryStemming">
10548 <title>QueryStemming</title>
10550 <para>Default: Try</para>
10552 <para>Asks: ___ to match words of the same base in a search</para>
10554 <para>Values:</para>
10558 <para>Don't try</para>
10566 <para>A search for enabling would also match enable and
10573 <para>Description:</para>
10577 <para>This preference enables word stemming. Stemming allows
10578 the search function to return multiple versions of the same
10579 word, as well as related terms (i.e., both fish and fishing
10580 would be returned).</para>
10585 <para>Requires that <link linkend="NoZebra">NoZebra</link> is
10586 set to 'Use'</para>
10590 <section id="QueryWeightFields">
10591 <title>QueryWeightFields</title>
10593 <para>Default: Enable</para>
10595 <para>Asks: ___ ranking of search results by relevance</para>
10597 <para>Values:</para>
10601 <para>Disable</para>
10605 <para>Enable</para>
10610 <para>Requires that <link linkend="NoZebra">NoZebra</link> is
10611 set to 'Use'</para>
10615 <section id="TraceCompleteSubfields">
10616 <title>TraceCompleteSubfields</title>
10618 <para>Default: Force</para>
10620 <para>Asks: ___ subject tracings in the OPAC and Staff Client to
10621 search only for complete-subfield matches.</para>
10623 <para>Values:</para>
10627 <para>Don't force</para>
10631 <para>Searches for subject keywords (example:
10632 opac-search.pl?q=su:World%20Wide%20Web)</para>
10642 <para>Searches for complete subject fields (example:
10643 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
10649 <para>Description:</para>
10653 <para>When TraceCompleteSubfields is set to "force," clicking
10654 on links in non-authority controlled subject tracings will
10655 only find other records where the entire subfields match.
10656 Leaving it at "don't force" does a keyword search of the
10657 subject indexes.</para>
10662 <para>This preference assumes that you're using XSLT stylesheets
10663 as set in the <link
10664 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
10669 <section id="TraceSubjectSubdivisions">
10670 <title>TraceSubjectSubdivisions</title>
10672 <para>Default: Include</para>
10674 <para>Asks: ___ subdivisions for searches generated by clicking on
10675 subject tracings.</para>
10677 <para>Values:</para>
10681 <para>Don't include</para>
10685 <para>Searches for subject keywords (example:
10686 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
10692 <para>Include</para>
10696 <para>Searches for complete subject fields (example:
10697 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
10703 <para>Description:</para>
10707 <para>When TraceSubjectSubdivisions is set to "Include," if
10708 you click on a subject with subdivisions (subfields other than
10709 'a') they will be searched along with the subject heading
10710 (subfield 'a'). To have only the subject heading (subfield
10711 'a') searched, set this preference to "Don't include."</para>
10716 <para>This preference assumes that you're using XSLT stylesheets
10717 as set in the <link
10718 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
10723 <section id="UseICU">
10724 <title>UseICU</title>
10726 <para>Default: Not using</para>
10728 <para>Asks: ___ ICU Zebra indexing.</para>
10730 <para>Values:</para>
10734 <para>Not using</para>
10742 <para>Description:</para>
10746 <para>ICU is a set of code libraries providing Unicode and
10747 Globalization support for software applications. What this
10748 means is ICU Zebra indexing is only necessary if you use
10749 non-roman characters in your cataloging. If using ICU Zebra
10750 indexing you will want to not use <link
10751 linkend="QueryFuzzy">QueryFuzzy</link>.</para>
10756 <para>This setting will not affect Zebra indexing, it should
10757 only be used to tell Koha that you have activated ICU indexing
10758 if you have actually done so, since there is no way for Koha to
10759 figure this out on its own.</para>
10763 <para>Talk to your system administrator when changing this
10764 preference to make sure that your system is set up properly for
10765 this to work.</para>
10770 <section id="searchresultsprefs">
10771 <title>Results Display</title>
10775 <section id="defaultSortField">
10776 <title>defaultSortField & defaultSortOrder</title>
10778 <para>defaultSortField Default: author</para>
10780 <para>defaultSortOrder Default: ascending</para>
10782 <para>Asks: By default, sort search results in the staff client by
10785 <para>Description:</para>
10789 <para>These preferences set the default sort field and sort
10790 order for searches on the staff side. Regardless of your
10791 choice, the other sort options are still available in the drop
10792 down list on the advanced search page.</para>
10796 <para>defaultSortField Values:</para>
10800 <para>author</para>
10804 <para>call number</para>
10808 <para>date added</para>
10812 <para>date of publication</para>
10816 <para>relevance</para>
10824 <para>total number of checkouts</para>
10828 <para>defaultSortOrder Values:</para>
10832 <para>ascending</para>
10836 <para>descending</para>
10840 <para>from A to Z</para>
10844 <para>from Z to A</para>
10849 <section id="displayFacetCount">
10850 <title>displayFacetCount</title>
10852 <para>Default: Don't show</para>
10854 <para>Asks: ___ facet counts.</para>
10856 <para>Description:</para>
10860 <para>This preference lets you decide if you show how many
10861 times a facet is used in your search results in the OPAC and
10862 the staff client. The relevance of these numbers highly
10863 depends on the value of the <link
10864 linkend="maxRecordsForFacets">maxRecordsForFacets</link>
10865 preference. Showing these numbers can potentially effect the
10866 performance of your searching, so test your system with
10867 different values for this preference to see what works
10872 <para>Values:</para>
10876 <para>Don't show</para>
10883 <screeninfo>Number of times each Facet is found in
10884 results</screeninfo>
10888 <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
10896 <section id="FacetLabelTruncationLength">
10897 <title>FacetLabelTruncationLength</title>
10899 <para>Default: 20</para>
10901 <para>Asks: Truncate facets length to ___ characters, in
10902 OPAC/staff interface.</para>
10904 <para>Description:</para>
10908 <para>In the OPAC and the staff client your facets are cut off
10909 at 20 characters by default. Depending on your layout this may
10910 be too many or two few letters, this preference lets you
10911 decide what number is best for your library's design.</para>
10916 <section id="maxItemsInSearchResults">
10917 <title>maxItemsInSearchResults</title>
10919 <para>Default: 20</para>
10921 <para>Asks: Show up to ___ items per biblio in the search
10924 <para>Description:</para>
10928 <para>This preference will let you set how many results
10929 display by default when a search is run on the Staff
10935 <section id="maxRecordsForFacets">
10936 <title>maxRecordsForFacets</title>
10938 <para>Default: 20</para>
10940 <para>Asks: Build facets based on ___ records from the search
10943 <para>Description:</para>
10947 <para>By default Koha only bases facets on the first page of
10948 results (usually 20 results). This preference lets you tell
10949 Koha to based the facet descriptions and numbers on any number
10950 of search results returned. The higher this number the longer
10951 it will take for your search results to return, so test with
10952 various different values to find the best balance for your
10958 <section id="numSearchResults">
10959 <title>numSearchResults</title>
10961 <para>Default: 20</para>
10963 <para>Asks: By default, show ___ results per page in the staff
10967 <section id="opacdefaultsort">
10968 <title>OPACdefaultSortField & OPACdefaultSortOrder</title>
10970 <para>OPACdefaultSortField Default: relevance</para>
10972 <para>OPACdefaultSortOrder Default: ascending</para>
10974 <para>Asks: By default, sort search results in the OPAC by ___,
10977 <para>Description:</para>
10981 <para>These preferences set the default sort field and sort
10982 order for searches on the OPAC. Regardless of your choice, the
10983 other sort options are still available in the drop down list
10984 on the advanced search page.</para>
10988 <para>OPACdefaultSortField Values:</para>
10992 <para>author</para>
10996 <para>call number</para>
11000 <para>date added</para>
11004 <para>date of publication</para>
11008 <para>relevance</para>
11016 <para>total number of checkouts</para>
11020 <para>OPACdefaultSortOrder Values:</para>
11024 <para>ascending</para>
11028 <para>descending</para>
11032 <para>from A to Z</para>
11036 <para>from Z to A</para>
11043 <section id="OPACItemsResultsDisplay">
11044 <title>OPACItemsResultsDisplay</title>
11046 <para>Default: Don't show</para>
11048 <para>Asks: ___ an item's branch, location and call number in OPAC
11049 search results.</para>
11051 <para>Values:</para>
11055 <para>Don't show</para>
11063 <para>Description:</para>
11067 <para>This setting selects the information about an item that
11068 will display in the search results page of the OPAC. The
11069 results can display the status of an item and/or full details
11070 including branch, location, and call number. While the 'Show'
11071 option allows for more information to be displayed on the
11072 search results page, the information can be overwhelming for
11073 large collections with multiple branches.</para>
11078 <section id="OPACnumSearchResults">
11079 <title>OPACnumSearchResults</title>
11081 <para>Default: 20</para>
11083 <para>Asks: By default, show ___ results per page in the
11088 <section id="searchformprefs">
11089 <title>Search Form</title>
11091 <section id="AdvancedSearchTypes">
11092 <title>AdvancedSearchTypes</title>
11094 <para>Default: itemtype</para>
11096 <para>Asks: Show tabs in OPAC and staff-side advanced search for
11097 limiting searches on the ___ fields (separate values with
11100 <para>Description:</para>
11104 <para>On the advanced search page you can choose to allow
11105 filters on one or all of the following: Item types
11106 (itemtypes), Collection Codes (ccode) and Shelving Location
11107 (loc). If you would like to be able to limit searches on item
11108 type and shelving location for example you would enter
11109 itemtypes|loc in the preference input box. The order of these
11110 fields will determine the order of the tabs in the OPAC and
11111 staff client advanced search screens. Values within the search
11112 type are OR'ed together, while each different search type is
11113 AND'ed together in the query limits. The current stored values
11114 are supported without any required modification.Each set of
11115 advanced search fields are displayed in tabs in both the OPAC
11116 and staff client. The first value in the AdvancedSearchTypes
11117 syspref is the selected tab; if no values are present,
11118 "itemtypes" is used. For non-itemtype values, the value in
11119 AdvancedSearchTypes must match the Authorised Value name, and
11120 must be indexed with 'mc-' prefixing that name.</para>
11123 <screeninfo>Searching by Item Type and Shelving
11124 Location</screeninfo>
11128 <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
11136 <section id="expandedSearchOption">
11137 <title>expandedSearchOption</title>
11139 <para>Default: don't show</para>
11141 <para>Asks: By default, ___ "More options" on the OPAC and staff
11142 advanced search pages.</para>
11144 <para>Values:</para>
11148 <para>don't show</para>
11159 <section id="serialsprefs">
11160 <title>Serials</title>
11162 <para><emphasis>Get there:</emphasis> More > Administration >
11163 Global System Preferences > Serials</para>
11165 <section id="opacSerialDefaultTab">
11166 <title>opacSerialDefaultTab</title>
11168 <para>Default: Subscriptions tab</para>
11170 <para>Asks: Show ___ as default tab for serials in OPAC. <important>
11171 <para>Please note that the Serial Collection tab is currently
11172 available only for systems using the UNIMARC standard.</para>
11173 </important></para>
11175 <para>Values:</para>
11179 <para>Holdings tab</para>
11183 <para>Serial Collection tab</para>
11187 <para>Subscriptions tab</para>
11192 <section id="OPACSerialIssueDisplayCount">
11193 <title>OPACSerialIssueDisplayCount</title>
11195 <para>Default: 3</para>
11197 <para>Asks: Show the ___ previous issues of a serial on the
11200 <para>Description:</para>
11204 <para>This preference allows the administrator to select the
11205 number of recent issues for each serial which appear in the OPAC
11206 when the serial is accessed. This is just the default value,
11207 patrons can always click to see a full list of serials.</para>
11212 <section id="RenewSerialAddsSuggestion">
11213 <title>RenewSerialAddsSuggestion</title>
11215 <para>Default: Don't add</para>
11217 <para>Asks: ___ a suggestion for a biblio when its attached serial
11220 <para>Values:</para>
11228 <para>Don't add</para>
11232 <para>Description:</para>
11236 <para>If set to "Add", this preference will automatically add a
11237 serial to the Acquisitions Purchase Suggestions menu when
11238 clicking the 'renew' option. If you don't use the Acquisitions
11239 module to manage serials purchases it's best to leave this set
11240 as 'Don't add.'</para>
11245 <section id="RoutingListAddReserves">
11246 <title>RoutingListAddReserves</title>
11248 <para>Default: Place</para>
11250 <para>Asks: ___ received serials on hold if they are on a routing
11253 <para>Values:</para>
11261 <para>Don't place</para>
11266 <section id="RoutingListNote">
11267 <title>RoutingListNote</title>
11269 <para>Asks: Include following note on all routing lists</para>
11271 <para>Description:</para>
11275 <para>Text entered in this box will appear below the routing
11276 list information.</para>
11281 <section id="RoutingSerials">
11282 <title>RoutingSerials</title>
11284 <para>Default: Don't add</para>
11286 <para>Asks: ___ received serials to the routing list.</para>
11288 <para>Description:</para>
11292 <para>This preference determines if serials routing lists are
11293 enabled or disabled for the library. When set to “Add",
11294 serials routing is enabled and a serial can be directed through
11295 a list of people by identifying who should receive it next. The
11296 list of people can be established for each serial to be passed
11297 using the Serials module. This preference can be used to ensure
11298 each person who needs to see a serial when it arrives at the
11299 library will get it. Learn more in the <link
11300 linkend="routinglist">routing list</link> section of this
11305 <para>Values:</para>
11313 <para>Don't add</para>
11318 <section id="StaffSerialIssueDisplayCount">
11319 <title>StaffSerialIssueDisplayCount</title>
11321 <para>Default: 3</para>
11323 <para>Asks: Show the ___ previous issues of a serial on the staff
11326 <para>Description:</para>
11330 <para>This preference allows the administrator to select the
11331 number of recent issues for each serial which appear in the
11332 Staff Client when the serial is accessed. This is just the
11333 default value, staff members can always click to see a full list
11339 <section id="SubscriptionDuplicateDroppedInput">
11340 <title>SubscriptionDuplicateDroppedInput</title>
11342 <para>Asks: List of fields which must not be rewritten when a
11343 subscription is duplicated (Separated by pipe |) ___</para>
11345 <para>Description:</para>
11349 <para>When duplicating a subscription sometimes you don't want
11350 all of the fields duplicated, using this preference you can list
11351 the fields that you don't want to be duplicated. These field
11352 names come from the subscription table in the Koha database.
11353 Learn what fields are in that table on the <ulink
11354 url="http://schema.koha-community.org/tables/subscription.html">Koha
11355 DB Schema</ulink> site.</para>
11360 <section id="SubscriptionHistory">
11361 <title>SubscriptionHistory</title>
11363 <para>Default: full history</para>
11365 <para>Asks: When showing the subscription information for a
11366 bibliographic record, preselect ___ view of serial issues.</para>
11368 <para>Values:</para>
11372 <para>brief history</para>
11375 <screeninfo>Brief History</screeninfo>
11379 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
11386 <para>full history</para>
11389 <screeninfo>Full History</screeninfo>
11393 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
11400 <para>Description:</para>
11404 <para>This preference determines what information appears in the
11405 OPAC when the user clicks the More Details option. The
11406 ‘brief' option displays a one-line summary of the volume
11407 and issue numbers of all issues of that serial held by the
11408 library. The ‘full' option displays a more detailed
11409 breakdown of issues per year, including information such as the
11410 issue date and the status of each issue.</para>
11416 <section id="staffprefs">
11417 <title>Staff Client</title>
11419 <para><emphasis>Get there:</emphasis> More > Administration >
11420 Global System Preferences > Staff Client</para>
11422 <section id="staffappearprefs">
11423 <title>Appearance</title>
11427 <section id="Display856uAsImage">
11428 <title>Display856uAsImage</title>
11430 <para>Default: Neither details or results page</para>
11432 <para>Asks: Display the URI in the 856u field as an image on:
11435 <para>Values:</para>
11439 <para>Both results and details pages</para>
11444 <para>Not implemented yet</para>
11451 <para>Detail page only</para>
11457 linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
11458 needs to be on for this preference to work.</para>
11464 <screeninfo>Showing the 856u as an image</screeninfo>
11468 <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
11475 <para>Neither details or results page</para>
11479 <para>Results page only</para>
11484 <para>Not yet implemented</para>
11491 <para>Description:</para>
11495 <para>In addition to this option being set, the corresponding
11496 XSLT option must be turned on. Also, the corresponding 856q
11497 field must have a valid MIME image extension (e.g., "jpg") or
11498 MIME image type (i.e. starting with "image/"), or the generic
11499 indicator "img" entered in the field. When all of the
11500 requirements are met, an image file will be displayed instead
11501 of the standard link text. Clicking on the image will open it
11502 in the same way as clicking on the link text. When you click
11503 on the image it should open to full size, in the current
11504 window or in a new window depending on the value in the system
11506 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
11509 <screeninfo>Sample 856 Field</screeninfo>
11513 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
11521 <section id="intranet_includes">
11522 <title>intranet_includes</title>
11524 <para>Default: includes</para>
11526 <para>Asks: Use include files from the ___ directory in the
11527 template directory, instead of includes/. (Leave blank to
11531 <section id="intranetcolorstylesheet">
11532 <title>intranetcolorstylesheet</title>
11534 <para>Asks: Include the stylesheet /intranet-tmpl/prog/en/css/ ___
11535 on all pages in the staff interface.</para>
11537 <para>Description:</para>
11541 <para>This preference is used to set the background color and
11542 style of the Staff Client. The value is a .css file. The
11543 system administrator should determine which file is
11544 appropriate.</para>
11549 <para>Leave this field blank to disable.</para>
11553 <section id="IntranetFavicon">
11554 <title>IntranetFavicon</title>
11556 <para>Asks: Use the image at ___ for the Staff Client's favicon.
11558 <para>This should be a complete URL, starting with
11560 </important></para>
11563 <para>Turn your logo into a favicon with the <ulink
11564 url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
11567 <para>Description:</para>
11571 <para>The favicon is the little icon that appears next to the
11572 URL in the address bar in most browsers. The default value for
11573 this field (if left blank) is the small 'K' in the Koha
11577 <screeninfo>Default Koha Favicon</screeninfo>
11581 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
11589 <section id="IntranetmainUserblock">
11590 <title>IntranetmainUserblock</title>
11592 <para>Asks: Show the following HTML in its own column on the main
11593 page of the staff client</para>
11596 <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
11600 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
11606 <screeninfo>Message from IntranetmainUserblock as it appears on
11607 the Staff Client main page</screeninfo>
11611 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
11617 <section id="IntranetNav">
11618 <title>IntranetNav</title>
11620 <para>Asks: Show the following HTML in the More menu at the top of
11621 each page on the staff client (should be a list of links or
11625 <section id="intranetstylesheet">
11626 <title>intranetstylesheet</title>
11628 <para>Asks: Include the stylesheet at ___ on all pages in the
11629 staff interface, instead of the default.</para>
11631 <para>Description:</para>
11635 <para>The Intranetstylesheet preference is a layout and design
11636 feature for the intranet or staff client. To change the
11637 stylesheet from the original, place in this preference the
11638 file path to the style sheet - include the entire url starting
11639 with http://. This preference allows a library to customize
11640 the appearance of the Staff Client.</para>
11645 <para>This should be a complete URL, starting with
11650 <section id="IntranetUserCSS">
11651 <title>IntranetUserCSS</title>
11653 <para>Asks: Include the following CSS on all pages in the staff
11657 <section id="intranetuserjs">
11658 <title>intranetuserjs</title>
11660 <para>Asks: Include the following JavaScript on all pages in the
11661 staff interface</para>
11664 <screeninfo>Sample JavaScript to alter the staff client
11669 <imagedata fileref="images/admin/globalprefs/intranetuserjs-code.png"/>
11675 <screeninfo>Link to Self Checkout appears on staff client login
11676 because of JavaScript</screeninfo>
11680 <imagedata fileref="images/admin/globalprefs/intranetuserjs.png"/>
11685 <para>Description:</para>
11689 <para>This preference allows the administrator to enter
11690 JavaScript or JQuery that will be embedded across all pages of
11691 the Staff Client. Administrators may use this preference to
11692 customize some of the interactive sections of Koha,
11693 customizing the text for the login prompts, for example.
11694 Sample JQuery scripts used by Koha libraries can be found on
11696 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
11701 <section id="SlipCSS">
11702 <title>SlipCSS</title>
11704 <para>Asks: Include the stylesheet at ___ on Issue and Reserve
11706 <para>This should be a complete URL, starting with
11708 </important></para>
11710 <para>Description:</para>
11714 <para>If you would like to style your receipts or slips with a
11715 consistent set of fonts and colors you can use this preference
11716 to point Koha to a stylesheet specifically for your
11722 <section id="StaffAuthorisedValueImages">
11723 <title>StaffAuthorisedValueImages</title>
11725 <para>Default: Show</para>
11727 <para>Asks: ___ images for authorized values (such as lost
11728 statuses and locations) in search results.</para>
11730 <para>Values:</para>
11734 <para>Don't show</para>
11743 <section id="staffClientBaseURL">
11744 <title>staffClientBaseURL</title>
11746 <para>Asks: The staff client is located at http:// ___</para>
11749 <section id="template">
11750 <title>template</title>
11752 <para>Default: prog</para>
11754 <para>Asks: Use the ___ theme on the staff interface.</para>
11756 <para>Values:</para>
11765 <section id="XSLTDetailsDisplay">
11766 <title>XSLTDetailsDisplay</title>
11768 <para>Default: default</para>
11770 <para>Asks: Display details in the staff client using XSLT
11771 stylesheet at ___</para>
11773 <para>Values:</para>
11777 <para>leave empty to not use the XSLT stylesheet</para>
11781 <para>In previous versions of Koha this was the setting
11782 that read 'normally'</para>
11785 <screeninfo>Detail display without XSLT
11786 stylesheets</screeninfo>
11790 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
11799 <para>enter "default" for the default one</para>
11802 <screeninfo>Detail display using XSLT
11803 stylesheets</screeninfo>
11807 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
11814 <para>put a path to define a XSLT file</para>
11818 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
11822 <para>If in a multi-language system you can enter
11823 {langcode} in the path to tell Koha to look in the right
11824 language folder</para>
11829 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
11834 http://mykoha.org/{langcode}/stylesheet.xsl</para>
11842 <para>put an URL for an external specific stylesheet</para>
11846 <para>ex: http://mykoha.org/stylesheet.xsl</para>
11852 <para>Description:</para>
11856 <para>XSLT stylesheets allow for the customization of the
11857 details shows on the screen when viewing a bib record. This
11858 preference will allow you either use the default look that
11859 comes with Koha or design your own stylesheet.</para>
11864 <section id="XSLTResultsDisplay">
11865 <title>XSLTResultsDisplay</title>
11867 <para>Default: default</para>
11869 <para>Asks: Display results in the staff client using XSLT
11870 stylesheet at ___</para>
11872 <para>Values:</para>
11876 <para>leave empty to not use the XSLT stylesheet</para>
11880 <para>In previous versions of Koha this was the setting
11881 that read 'normally'</para>
11887 <para>enter "default" for the default one</para>
11891 <para>put a path to define a XSLT file</para>
11895 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
11899 <para>If in a multi-language system you can enter
11900 {langcode} in the path to tell Koha to look in the right
11901 language folder</para>
11906 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
11911 http://mykoha.org/{langcode}/stylesheet.xsl</para>
11919 <para>put an URL for an external specific stylesheet</para>
11923 <para>ex: http://mykoha.org/stylesheet.xsl</para>
11929 <para>Description:</para>
11933 <para>XSLT stylesheets allow for the customization of the
11934 details shows on the screen when viewing the search results.
11935 This preference will allow you either use the default look
11936 that comes with Koha or design your own stylesheet.</para>
11941 <section id="yuipath">
11942 <title>yuipath</title>
11944 <para>Default: included with Koha</para>
11946 <para>Asks: Use the Yahoo UI libraries ___</para>
11948 <para>Values:</para>
11952 <para>from Yahoo's servers</para>
11956 <para>With this option there is less demand on your
11957 servers, but if the Internet goes down there will be
11964 <para>included with Koha</para>
11968 <para>With this option calls are made faster, and they
11969 will still work if the Internet goes down</para>
11975 <para>Description:</para>
11979 <para>The yuipath preference allows for the user to define a
11980 local path or web URL to the Yahoo User Interface Library
11982 url="http://developer.yahoo.com/yui/2/">http://developer.yahoo.com/yui/2/</ulink>).
11983 This library is a resource of developer tools including
11984 JavaScript and style sheets.</para>
11990 <section id="staffoptsprefs">
11991 <title>Options</title>
11993 <section id="HidePatronName">
11994 <title>HidePatronName</title>
11996 <para>Default: Show</para>
11998 <para>Asks: ___ the names of patrons that have items checked out
11999 or on hold on detail pages or the "Place Hold" screen.</para>
12001 <para>Values:</para>
12005 <para>Don't show</para>
12014 <section id="intranetbookbag">
12015 <title>intranetbookbag</title>
12017 <para>Default: Show</para>
12019 <para>Asks: ___ the cart option in the staff client.</para>
12021 <para>Values:</para>
12025 <para>Don't show</para>
12034 <section id="viewISBD">
12035 <title>viewISBD</title>
12037 <para>Default: Allow</para>
12039 <para>Asks: ___ staff to view records in ISBD form on the staff
12042 <para>Values:</para>
12050 <para>Don't allow</para>
12055 <section id="viewLabeledMARC">
12056 <title>viewLabeledMARC</title>
12058 <para>Default: Allow</para>
12060 <para>Asks: ___ staff to view records in labeled MARC form on the
12061 staff client.</para>
12063 <para>Values:</para>
12071 <para>Don't allow</para>
12076 <section id="viewMARC">
12077 <title>viewMARC</title>
12079 <para>Default: Allow</para>
12081 <para>Asks: ___ staff to view records in plain MARC form on the
12082 staff client.</para>
12084 <para>Values:</para>
12092 <para>Don't allow</para>
12099 <section id="webserviceprefs">
12100 <title>Web Services</title>
12102 <para><emphasis>Get there:</emphasis> More > Administration >
12103 Global System Preferences > Web Services</para>
12105 <section id="ilsdiprefs">
12106 <title>ILS-DI</title>
12110 <section id="ILS-DI">
12111 <title>ILS-DI</title>
12113 <para>Default: Disable</para>
12115 <para>Asks: ___ ILS-DI services for OPAC users</para>
12117 <para>Values:</para>
12121 <para>Disable</para>
12125 <para>Enable</para>
12130 <section id="ILS-DIAuthorized_IPs">
12131 <title>ILS-DI:AuthorizedIPs</title>
12133 <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
12137 <section id="oaiprefs">
12138 <title>OAI-PMH</title>
12142 <section id="OAI-PMH">
12143 <title>OAI-PMH</title>
12145 <para>Default: Disable</para>
12147 <para>Asks: ___ Koha's OAI-PMH server.</para>
12149 <para>Values:</para>
12153 <para>Disable</para>
12157 <para>Enable</para>
12161 <para>Description:</para>
12165 <para>For the Open Archives Initiative-Protocol for Metadata
12166 Harvesting (OAI-PMH) there are two groups of
12167 ‘participants': Data Providers and Service Providers.
12168 Data Providers (open archives, repositories) provide free
12169 access to metadata, and may, but do not necessarily, offer
12170 free access to full texts or other resources. OAI-PMH provides
12171 an easy to implement, low barrier solution for Data Providers.
12172 Service Providers use the OAI interfaces of the Data Providers
12173 to harvest and store metadata. Note that this means that there
12174 are no live search requests to the Data Providers; rather,
12175 services are based on the harvested data via OAI-PMH. Koha at
12176 present can only act as a Data Provider. It can not harvest
12177 from other repositories. The biggest stumbling block to having
12178 Koha harvest from other repositories is that MARC is the only
12179 metadata format that Koha indexes natively. Visit <ulink
12180 url="http://www.oaforum.org/tutorial/english/page3.htm">http://www.oaforum.org/tutorial/english/page3.htm</ulink>
12181 for diagrams of how OAI-PMH works.</para>
12185 <para>Learn more about OAI-PMH at: <ulink
12186 url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
12189 <section id="OAI-PMHarchiveID">
12190 <title>OAI-PMH:archiveID</title>
12192 <para>Default: KOHA-OAI-TEST</para>
12194 <para>Asks: Identify records at this site with the prefix ___
12198 <section id="OAI-PMHAutoUpdateSets">
12199 <title>OAI-PMH:AutoUpdateSets</title>
12201 <para>Default: Disable</para>
12203 <para>Asks: ___ automatic update of OAI-PMH sets when a
12204 bibliographic record is created or updated.</para>
12206 <para>Values:</para>
12210 <para>Disable</para>
12214 <para>Enable</para>
12219 <section id="OAI-PMHConfFile">
12220 <title>OAI-PMH:ConfFile</title>
12222 <para>If this preference is left empty, Koha's OAI Server operates
12223 in normal mode, otherwise it operates in extended mode. In
12224 extended mode, it's possible to parameter other formats than
12225 marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
12226 configuration file which list available metadata formats and XSL
12227 file used to create them from marcxml records.</para>
12229 <para>For more information, see the <link
12230 linkend="oaiconfsample">sample conf file</link> in the
12234 <section id="OAI-PMHMaxCount">
12235 <title>OAI-PMH:MaxCount</title>
12237 <para>Default: 50</para>
12239 <para>Asks: Only return ___ records at a time in response to a
12240 ListRecords or ListIdentifiers query.</para>
12242 <para>Description:</para>
12246 <para>This is the maximum number of records that would be
12247 returned based on ListRecord or ListIdentifier queries from
12248 harvesters. ListRecords harvest the entire records while the
12249 ListIdentifier is an abbreviated form of ListRecords,
12250 retrieving only headers rather than records.</para>
12258 <section id="basicparams">
12259 <title>Basic Parameters</title>
12261 <para><emphasis>Get there:</emphasis> More > Administration</para>
12264 <para>Configure all 'parameters' in the order they appear.</para>
12267 <section id="libsgroups">
12268 <title>Libraries & Groups</title>
12270 <para>When setting up your Koha system you will want to add
12271 information for every library that will be sharing your system. This
12272 data is used in several areas of Koha.</para>
12276 <para><emphasis>Get there:</emphasis> More > Administration
12277 > Basic Parameters > Libraries and Groups</para>
12281 <para>When visiting this page you are presented with a list of the
12282 libraries and groups that have already been added to the
12286 <screeninfo>Library List</screeninfo>
12290 <imagedata fileref="images/admin/basicparams/librarylist.png"/>
12296 <screeninfo>Group Lists</screeninfo>
12300 <imagedata fileref="images/admin/basicparams/grouplists.png"/>
12305 <section id="addingalibrary">
12306 <title>Adding a Library</title>
12308 <para>To add a new library:</para>
12312 <para>Click 'New Library'</para>
12316 <para>The top of the form asks for some basics about the
12320 <screeninfo>Basic Library Info</screeninfo>
12324 <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
12331 <para>The library code should not contain any spaces and be
12332 10 or fewer characters. This code will be used as a unique
12333 identifier in the database.</para>
12337 <para>The name will be displayed on the OPAC wherever the
12338 library name displays to the public and should be a name
12339 that makes sense to your patrons.</para>
12343 <para>If you have <link
12344 linkend="addinglibgroup">groups</link> set up you can choose
12345 what group this library belongs to after entering in the
12346 code and name</para>
12352 <para>Next you can enter basic contact info about the
12356 <screeninfo>Library Contact Info</screeninfo>
12360 <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
12367 <para>The address and contact fields can be used to make
12368 notices custom for each library</para>
12372 <para>The email address field is not required, but it should
12373 be filled for every library in your system</para>
12378 <para>Be sure to enter a library email address to make
12379 sure that notices are sent to and from the right
12387 <para>If the URL field is populated then the library name
12388 will be linked in the holdings table on the OPAC</para>
12391 <screeninfo>Linked Library Name</screeninfo>
12395 <imagedata fileref="images/admin/basicparams/librarylink.png"/>
12402 <para>The OPAC Info box is for you to put information about
12403 the library that will appear in the OPAC when the branch
12404 name is moused over in the holdings table</para>
12407 <screeninfo>OPAC Info</screeninfo>
12411 <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
12418 <para>IP Address does not have be filled in unless you plan
12419 on limiting access to your staff client to a specific IP
12425 <para>An IP address is required if you have enabled
12427 linkend="AutoLocation">AutoLocation</link></para>
12434 <para>Finally, if you have any notes you can put them here.
12435 These will not show in the OPAC</para>
12442 <para>Of the fields listed, only 'Library code' and 'Name' are
12449 <section id="editingalibrary">
12450 <title>Editing/Deleting a Library</title>
12452 <para>You will be unable to delete any library that has patrons or
12453 items attached to it.</para>
12456 <screeninfo>Staff will be presented with a warning when trying to
12457 delete a library that is being used</screeninfo>
12461 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
12466 <para>Each library will have an 'Edit' link to the right of it.
12467 Click this link to edit/alter details associated with the library in
12471 <para>You will be unable to edit the 'Library code'</para>
12475 <section id="addinglibgroup">
12476 <title>Adding a group</title>
12478 <para>To add a Search Domain or Library Property Group click the
12479 'New Group' button at the top of the screen</para>
12482 <screeninfo>Add group form</screeninfo>
12486 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
12491 <para>Of the fields on the group form, 'Category code' and 'Name'
12492 are the only required fields</para>
12494 <section id="searchdomaingroups">
12495 <title>Search Domain Groups</title>
12497 <para>Search Domain Groups allow you to search a group of
12498 libraries at the same time instead of searching just one library
12499 or all libraries.</para>
12502 <screeninfo>Search Domain Groups</screeninfo>
12506 <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
12511 <para>To see Search Domain Groups in action visit the staff client
12512 advanced search page in your Koha system:</para>
12515 <screeninfo>Library group search on staff client</screeninfo>
12519 <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
12525 <section id="libpropertygroups">
12526 <title>Library Property Groups</title>
12528 <para>You can assign specific categories to your libraries by
12529 adding groups for them</para>
12532 <screeninfo>Library Property Groups</screeninfo>
12536 <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
12541 <para>Properties are then applied to libraries via the add or edit
12542 library form</para>
12545 <screeninfo>Groups on the Add/Modify library form</screeninfo>
12549 <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
12557 <section id="itemtypeadmin">
12558 <title>Item Types</title>
12560 <para>Koha allows you to organize your collection by item types and
12561 collection codes.</para>
12565 <para><emphasis>Get there:</emphasis> More > Administration
12566 > Basic Parameters > Item Types</para>
12570 <para>Item types typically refer to the material type (book, cd, dvd,
12571 etc), but can be used in any way that works for your library.</para>
12574 <screeninfo>Item Types</screeninfo>
12578 <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
12583 <section id="additemtype">
12584 <title>Adding Item Types</title>
12586 <para>To add a new item type, simply click the 'New Item Type'
12587 button at the top of the Item Types page.</para>
12590 <screeninfo>Sample DVD Item Type</screeninfo>
12594 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
12601 <para>In the 'Item Type' field, enter a short code for your item
12606 <para>The description is the plain text definition of the item
12611 <para>You can choose to have an image associated with your item
12616 <para>You can choose from a series of image
12621 <para>You can link to a remote image</para>
12625 <para>Or you can just have no image associated with the item
12631 <para>To have your item type images appear in the OPAC you
12632 need to set noItemTypeImages to 'Show'</para>
12637 <para><emphasis>Get there: </emphasis>More >
12638 Administration > Global System Preferences > <link
12639 linkend="adminprefs">Admin</link></para>
12647 <para>For items that do not circulate, check the 'Not for loan'
12652 <para>Items marked 'Not for loan' will appear in the
12653 catalog, but cannot be checked out to patrons</para>
12659 <para>Enter the total number of renewals allowed for the item
12660 type in the 'Renewals' box</para>
12664 <para id="rentalcharge">For items that you charge a rental fee
12665 for, enter the total fee you charge in the 'Rental charge'
12671 <para>Do not enter symbols in this field, only numbers and
12672 decimal points (ex. $5.00 should be entered as 5 or
12678 <para>This will charge the patron on checkout</para>
12684 <para>When finished, click 'Save Changes'</para>
12689 <para>All fields, with the exception of the 'Item Type'
12690 will be editable from the Item Types list</para>
12697 <para>Your new item type will now appear on the list</para>
12700 <screeninfo>New DVD Item Type</screeninfo>
12704 <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
12712 <section id="edititemtype">
12713 <title>Editing Item Types</title>
12715 <para>Each item type has an Edit button beside it. To edit an item
12716 simply click the 'Edit' link.</para>
12719 <para>You will not be able to edit the code you assigned as the
12720 'Item Type' but you will be able to edit the description for the
12725 <section id="deleteitemtype">
12726 <title>Deleting Item Types</title>
12728 <para>Each item has a Delete button beside it. To delete an item,
12729 simply click the 'Delete' link.</para>
12732 <para>You will not be able to delete item types that are being
12733 used by items within your system.</para>
12737 <screeninfo>Warning when you try to delete an item that is in
12742 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
12749 <section id="authorizedvalues">
12750 <title>Authorized Values</title>
12752 <para>Authorized values can be used in several areas of Koha. One
12753 reason you would add an authorized value category would be to control
12754 the values that can be entered into MARC fields by catalogers.</para>
12758 <para><emphasis>Get there:</emphasis> More > Administration
12759 > Basic Parameters > Authorized Values</para>
12763 <section id="existingauthvalues">
12764 <title>Existing Values</title>
12766 <para>Koha installs with pre-defined values that your library is
12767 likely to use, for instance 'Lost'.</para>
12771 <para>Asort1</para>
12775 <para>Used for acquisitions statistical purposes</para>
12781 <para>Asort2</para>
12785 <para>Used for acquisitions statistical purposes</para>
12791 <para id="bornotes">BOR_NOTES</para>
12795 <para>Values for custom patron notes that appear on the
12796 circulation screen and the OPAC</para>
12802 <para>Bsort1</para>
12806 <para>Used for patron statistical purposes</para>
12812 <para>Bsort2</para>
12816 <para>Used for patron statistical purposes</para>
12826 <para>Is the shelving cart location, used by <link
12827 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
12829 linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
12835 <para id="ccode">CCODE</para>
12839 <para>Collection codes (appears when cataloging and working
12846 <para>DAMAGED</para>
12850 <para>Descriptions for items marked as damaged (appears when
12851 cataloging and working with items)</para>
12857 <para>HINGS_AS</para>
12861 <para>General Holdings: Acquisition Status Designator ::
12862 This data element specifies acquisition status for the unit
12863 at the time of the holdings report.a</para>
12869 <para>HINGS_C</para>
12873 <para>General Holdings: Completeness Designator</para>
12879 <para>HINGS_PF</para>
12883 <para>Physical Form Designators</para>
12889 <para>HINGS_RD</para>
12893 <para>General Holdings: Retention Designator :: This data
12894 element specifies the retention policy for the unit at the
12895 time of the holdings report.</para>
12901 <para>HINGS_UT</para>
12905 <para>General Holdings: Type of Unit Designator</para>
12911 <para id="shelvelocvals">LOC</para>
12915 <para>Shelving location (usually appears when adding or
12916 editing an item)</para>
12922 <para id="lost">LOST</para>
12926 <para>Descriptions for the items marked as lost (appears
12927 when adding or editing an item)</para>
12932 <para>Values given to lost statuses should be numeric and
12933 not alphabetical in order for statuses to appear
12941 <para id="manualinvvals">MANUAL_INV</para>
12945 <para>Values for manual invoicing types</para>
12951 <para id="notforloan">NOT_LOAN</para>
12955 <para>Reasons why a title is not for loan</para>
12960 <para>Values given to lost statuses should be numeric and
12961 not alphabetical in order for statuses to appear
12968 <para>Negative number values will still allow holds (use
12969 for on order statuses for example) where as positive
12970 numbers will not allow holds or checkouts</para>
12981 <para>The location to be used for <link
12982 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>
12983 (change description as desired), also the location expected
12985 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>.</para>
12991 <para id="restricted">RESTRICTED</para>
12995 <para>Restricted status of an item</para>
13001 <para id="suggestauthorized">SUGGEST</para>
13005 <para>List of patron suggestion reject or accept reasons
13006 (appears when managing suggestions)</para>
13012 <para>WITHDRAWN</para>
13016 <para>Description of a withdrawn item (appears when adding
13017 or editing an item)</para>
13023 <para>YES_NO</para>
13027 <para>A generic authorized value field that can be used
13028 anywhere you need a simple yes/no pull down menu.</para>
13035 <section id="newauthvalcat">
13036 <title>Add new Authorized Value Category</title>
13038 <para>In addition to the existing categories that come by default
13039 with Koha, librarians can add their own authorized value categories
13040 to control data that is entered into the system. To add a new
13045 <para>Click 'New Category'</para>
13048 <screeninfo>New Authorized Category form</screeninfo>
13052 <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
13059 <para>Limit your Category to 10 characters (something short to
13060 make it clear what the category is for)</para>
13065 <para>Category cannot have spaces or special characters
13066 other than underscores and hyphens in it.</para>
13073 <para>When adding a new category you're asked to create at least
13074 one authorized value</para>
13078 <para>Enter a code for your Authorized Value into the
13079 'Authorized value' field</para>
13084 <para>Authorized value is limited to 80 characters and
13085 cannot have spaces or special characters other than
13086 underscores and hyphens in it.</para>
13093 <para>Use the Description field for the actual value that
13094 will be displayed. If you want something different to show
13095 in the OPAC, enter a 'Description (OPAC)'</para>
13099 <para>If you have <link
13100 linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
13102 linkend="AuthorisedValueImages">AuthorisedValueImages</link>
13103 set to show images for authorized values you can choose the
13104 image under 'Choose an icon'</para>
13110 <para>Click 'Save'</para>
13114 <para>Your new category and value will appear on the list of
13115 Authorized Values</para>
13118 <screeninfo>Custom Authorized Value on list of
13119 values</screeninfo>
13123 <imagedata fileref="images/admin/basicparams/authvallist.png"/>
13131 <section id="newauthval">
13132 <title>Add new Authorized Value</title>
13134 <para>New authorized values can be added to any existing or new
13135 category. To add a value:</para>
13139 <para>Click 'New authorized value for ...'</para>
13142 <screeninfo>New Authorized Value form</screeninfo>
13146 <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
13153 <para>Enter a code for your Authorized Value into the
13154 'Authorized value' field</para>
13159 <para>Authorized value is limited to 80 characters and
13160 cannot have spaces or special characters other than
13161 underscores and hyphens in it.</para>
13168 <para>Use the Description field for the actual value that will
13169 be displayed. If you want something different to show in the
13170 OPAC, enter a 'Description (OPAC)'</para>
13174 <para>If you have <link
13175 linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
13177 linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
13178 to show images for authorized values you can choose the image
13179 under 'Choose an icon'</para>
13183 <para>Click 'Save'</para>
13187 <para>The new value will appear in the list along with existing
13191 <screeninfo>List of authorized values in MARC504
13192 category</screeninfo>
13196 <imagedata fileref="images/admin/basicparams/authvals.png"/>
13206 <section id="patscirc">
13207 <title>Patrons & Circulation</title>
13209 <para>Settings for controlling circulation and patron
13210 information.</para>
13212 <section id="patcats">
13213 <title>Patron Categories</title>
13215 <para>Patron categories allow you to organize your patrons into
13216 different roles, age groups, and patron types.</para>
13220 <para><emphasis>Get there:</emphasis> More > Administration
13221 > Patrons & Circulation > Patron Categories</para>
13226 <screeninfo>Patron category list</screeninfo>
13230 <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
13235 <para>Patrons are assigned to one of six main categories:</para>
13243 <para>Most common patron type, usually used for a general
13244 'Patron' category.</para>
13254 <para>Children patrons can have a guardian to be attached to
13265 <para>Librarians (and library workers) should be assigned the
13266 staff category so that you can <link
13267 linkend="patronpermissions">set their permissions</link> and
13268 give them access to the staff client.</para>
13274 <para>Organizational</para>
13278 <para>Organizational patrons are organizations. Organizations
13279 can be used as guarantors for Professional patrons.</para>
13285 <para>Professional</para>
13289 <para>Professional patrons can be linked to Organizational
13296 <para>Statistical</para>
13300 <para>This patron type is used strictly for statistical
13301 purposes, such as in house use of items.</para>
13307 <section id="addingpatroncat">
13308 <title>Adding a patron category</title>
13310 <para>To add a new patron category click 'New Category' at the top
13314 <screeninfo>New patron category form</screeninfo>
13318 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
13325 <para>The 'Category Code' is an identifier for your new
13331 <para>The category code is limited to 10 characters
13332 (numbers and letters)</para>
13338 <para>This field is required in order to save your patron
13339 category. If left blank you will be presented with an
13343 <screeninfo>Missing fields error</screeninfo>
13347 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13357 <para>Enter a plain text version of the category in the
13358 'Description' field.</para>
13363 <para>This field is required in order to save your patron
13364 category. If left blank you will be presented with an
13368 <screeninfo>Missing fields error</screeninfo>
13372 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13382 <para>Enrollment period (in months) should be filled in if you
13383 have a limited enrollment period for your patrons (eg. Student
13384 cards expire after 9 months or until a specific date)</para>
13389 <para>You cannot enter both a month limit and a date
13390 until. Choose to enter either one or the other.</para>
13396 <para>This field is required in order to save your patron
13397 category. If left blank you will be presented with an
13401 <screeninfo>Missing fields error</screeninfo>
13405 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13415 <para>Some patron categories can have a minimum age (in years)
13416 requirement associated with them, enter this age in the 'Age
13421 <para>Patron categories can also have a maximum age (in years)
13422 associated with them (such as children), enter this age in the
13423 'Upperage limit'</para>
13427 <para>If you charge a membership fee for your patrons (such as
13428 those who live in another region) you can enter that in the
13429 'Enrollment fee' field.</para>
13434 <para>Only enter numbers and decimals in this field</para>
13441 <para>If you want your patron to receive overdue notices, set
13442 the 'Overdue notice required' to 'Yes'</para>
13446 <para>You can decide on a patron category basis if lost items
13447 are shown in the staff client by making a choice from the 'Lost
13448 items in staff client' pull down</para>
13451 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
13455 <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
13463 <para>Note that this is only applicable in the staff
13464 client, so changing this value on patron categories who do
13465 not have access to the staff client won't make any
13473 <para>If you charge patrons for placing holds on items, enter
13474 the fee amount in the 'Hold fee' field.</para>
13479 <para>Only enter numbers and decimals in this field</para>
13486 <para>In the 'Category type' field choose one of the six main
13487 parent categories</para>
13490 <screeninfo>Six main patron categories</screeninfo>
13494 <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
13502 <para>This field is required in order to save your patron
13503 category. If left blank you will be presented with an
13507 <screeninfo>Missing fields error</screeninfo>
13511 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
13521 <para>Finally you can assign advanced messaging preferences by
13522 default to a patron category</para>
13527 <para>Requires that you have <link
13528 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
13535 <para>These can be changed for individual patrons, this
13536 setting is just a default to make it easier to set up
13537 messages for an entire category</para>
13546 <section id="citytowns">
13547 <title>Cities and Towns</title>
13549 <para>To standardize patron input you can define cities or towns
13550 within your region so that when new patrons are added librarians
13551 simply have to select the town from a list instead of having to type
13552 the town and zip (or postal) code information.</para>
13556 <para><emphasis>Get there:</emphasis> More > Administration
13557 > Patrons & Circulation > Cities and Towns</para>
13561 <section id="addingcity">
13562 <title>Adding a City</title>
13564 <para>To add a new city, click the 'New City' button at the top of
13565 the page and enter the city name, state, zip/postal code and
13569 <screeninfo>New city entry form</screeninfo>
13573 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
13578 <para>One you click Submit, your city will be saved and will be
13579 listed on the Cities and Towns page</para>
13582 <screeninfo>List of Cities</screeninfo>
13586 <imagedata fileref="images/admin/patroncirc/cities.png"/>
13591 <para>Cities can be edited or deleted at any time.</para>
13594 <section id="citiesonpatform">
13595 <title>Viewing Cities on Patron Add Form</title>
13597 <para>If you have defined local cities using the New city form, then
13598 when adding or editing a patron record you will see those cities in
13599 a pull down menu to make city selection easy.</para>
13602 <screeninfo>Cities pull down on the patron record</screeninfo>
13606 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
13611 <para>This will allow for easy entry of local cities into the patron
13612 record without risking the potential for typos or mistaken
13613 zip/postal codes.</para>
13617 <section id="roadtypes">
13618 <title>Road Types</title>
13620 <para>To standardize patron input you can define road types within
13621 your region so that when new patrons are added librarians simply have
13622 to select the road from a list instead of having to type it in.</para>
13625 <para>If you want your patrons to have their road types abbreviated
13626 all of the time then you can enter the appropriate abbreviations
13627 here, if you'd like the road types to always be spelled out you can
13628 do that here as well.</para>
13631 <section id="addroadtype">
13632 <title>Adding Road Types</title>
13634 <para>To add a road type, click 'New Road Type' and then enter the
13635 road type the way you'd like it displayed.</para>
13638 <screeninfo>New Road</screeninfo>
13642 <imagedata fileref="images/admin/patroncirc/newroad.png"/>
13647 <para>Once you submit the form, your new road type will be listed on
13648 the Road Types page</para>
13651 <screeninfo>Roads in Koha</screeninfo>
13655 <imagedata fileref="images/admin/patroncirc/roads.png"/>
13661 <section id="roadtypeonpatform">
13662 <title>Viewing Road Types on Patron Add form</title>
13664 <para>When adding or editing a patron, if you have road types
13665 defined, there will be a pull down to choose the road type
13669 <screeninfo>Road types on patron record</screeninfo>
13673 <imagedata fileref="images/admin/patroncirc/patronroad.png"/>
13680 <section id="patronattributetypes">
13681 <title>Patron Attribute Types</title>
13683 <para>Patron attributes can be used to define custom fields to
13684 associate with your patron records. In order to enable the use of
13685 custom fields you need to set the <link
13686 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
13687 system preference.</para>
13691 <para><emphasis>Get there:</emphasis> More > Administration
13692 > Patrons & Circulation > Patron attribute types</para>
13696 <para>A common use for this field would be for a student ID number or
13697 a Driver's license number.</para>
13700 <screeninfo>List of Patron Attributes</screeninfo>
13704 <imagedata fileref="images/admin/patroncirc/attributes.png"/>
13709 <section id="addpatattributes">
13710 <title>Adding Patron Attributes</title>
13712 <para>To add a new Patron Attribute Type, click the 'New Patron
13713 Attribute Type' button at the top of the page</para>
13716 <screeninfo>Add Patron Attribute Type form</screeninfo>
13720 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
13727 <para>In the 'Patron attribute type code', enter a short code to
13728 identify this field</para>
13733 <para>This field is limited to 10 characters (numbers and
13734 letters only)</para>
13740 <para>This setting cannot be changed after an attribute is
13748 <para>In the 'Description' field, enter a longer (plain text)
13749 explanation of what this field will contain</para>
13753 <para>Check the box next to 'Repeatable' to let a patron record
13754 have multiple values of this attribute.</para>
13759 <para>This setting cannot be changed after an attribute is
13767 <para>If 'Unique identifier' is checked, the attribute will be a
13768 unique identifier which means, if a value is given to a patron
13769 record, the same value cannot be given to a different
13775 <para>This setting cannot be changed after an attribute is
13783 <para>Check 'Allow password' to make it possible to associate a
13784 password with this attribute.</para>
13788 <para>Check 'Display in OPAC' to display this attribute on a
13789 patron's details page in the OPAC.</para>
13793 <para>Check 'Searchable' to make this attribute searchable in
13794 the staff patron search.</para>
13798 <para>Check 'Display in check-out' to make this attribute
13799 visible in the patron's short detail display on the left of the
13800 checkout screen and other patron pages</para>
13803 <screeninfo>Show attribute in patron detail on the
13808 <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
13815 <para>Authorized value category; if one is selected, the patron
13816 record input page will only allow values to be chosen from the
13817 authorized value list.</para>
13821 <para>You will first need to add an authorized value list
13822 for it to appear in this menu</para>
13826 <para><emphasis>Get there: </emphasis>More >
13827 Administration > Basic Parameters > <link
13828 linkend="authorizedvalues">Authorized
13829 Values</link></para>
13836 <para>an authorized value list is not enforced during
13837 batch patron import.</para>
13844 <para>If you'd like to only show this attribute on patrons of
13845 one type choose that patron type from the 'Category' pull
13850 <para>If you have a lot of attributes it might be handy to group
13851 them so that you can easily find them for editing. If you create
13852 an <link linkend="authorizedvalues">Authorized Value</link> for
13853 PA_CLASS it will show in the 'Class' pull down and you can then
13854 change your attributes page to have sections of
13858 <screeninfo>Patron Attributes Sorted</screeninfo>
13862 <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
13869 <para>Click Save to save your new attribute</para>
13873 <para>Once added your attribute will appear on the list of
13874 attributes and also on the patron record add/edit form</para>
13877 <screeninfo>Patron Attributes list on the Patron add/edit
13882 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
13887 <para>If you have set up classes for organizing attributes they will
13888 appear that way on the add/edit patron form</para>
13891 <screeninfo>Grouped Attributes</screeninfo>
13895 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
13901 <section id="editpatattributes">
13902 <title>Editing/Deleting Patron Attributes</title>
13904 <para>Each patron attribute has an edit and a delete link beside it
13905 on the list of attributes.</para>
13907 <para>Some fields in the attribute will not be editable once
13912 <para>Patron attribute type code</para>
13916 <para>Repeatable</para>
13920 <para>Unique identifier</para>
13924 <para>You will be unable to delete an attribute if it's in
13928 <screeninfo>Warning when trying to delete an attribute that is in
13933 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
13940 <section id="circfinerules">
13941 <title>Circulation and Fine Rules</title>
13943 <para>These rules define how your items are circulated, how/when fines
13944 are calculated and how holds are handled.</para>
13948 <para><emphasis>Get there:</emphasis> More > Administration
13949 > Patrons & Circulation > Circulation and fines
13954 <para>The rules are applied from most specific to less specific, using
13955 the first found in this order:</para>
13959 <para>same library, same patron type, same item type</para>
13963 <para>same library, same patron type, all item type</para>
13967 <para>same library, all patron types, same item type</para>
13971 <para>same library, all patron types, all item types</para>
13975 <para>all libraries, same patron type, same item type</para>
13979 <para>all libraries, same patron type, all item types</para>
13983 <para>all libraries, all patron types, same item type</para>
13987 <para>all libraries, all patron types, all item types</para>
13992 <para>If you are a single library system choose your branch name
13993 before creating rules (sometimes having only rules for the 'all
13994 libraries' option can cause issues with holds)</para>
13998 <para>At the very least you will need to set a default circulation
13999 rule. This rule should be set for all item types, all libraries
14000 and all patron categories. That will catch all instances that do
14001 not match a specific rule. When checking out if you do not have a
14002 rule for all libraries, all item types and all patron types then
14003 you may see patrons getting blocked from placing holds. You will
14004 also want a rule for your specific library set for all item types
14005 and all patron types to avoid this holds issue. Koha needs to know
14006 what rule to fall back on.</para>
14007 </important></para>
14009 <section id="defaultcircrules">
14010 <title>Default Circulation Rules</title>
14012 <para>Using the issuing rules matrix you can define rules that
14013 depend on patron/item type combos. To set your rules, choose a
14014 library from the pull down (or 'all libraries' if you want to apply
14015 these rules to all branches):</para>
14018 <screeninfo>Libraries to apply the rules to</screeninfo>
14022 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
14027 <para>From the matrix you can choose any combination of patron
14028 categories and item types to apply the rules to</para>
14031 <screeninfo>Setting issuing rules for your libraries</screeninfo>
14035 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
14042 <para>First choose which patron category you'd like the rule to
14043 be applied to. If you leave this to 'All' it will apply to all
14044 patron categories</para>
14048 <para>Choose the 'Item Type' you would like this rule to apply
14049 to. If you leave this to 'All' it will apply to all item
14054 <para>Limit the number of items a patron can have checked out at
14055 the same time by entering a number in the 'Current Checkouts
14056 Allowed' field</para>
14060 <para>Define the period of time an item can be checked out to a
14061 patron by entering the number of units (days or hours) in the
14062 'Loan Period' box.</para>
14066 <para>Choose which unit of time, Days or Hours, that the loan
14067 period and fines will be calculate in</para>
14071 <para>You can also define a hard due date for a specific patron
14072 category and item type. A hard due date ignores your usual
14073 circulation rules and makes it so that all items of the type
14074 defined are due on, before or after the date you specify.</para>
14078 <para>'Fine Amount' should have the amount you would like to
14079 charge for overdue items</para>
14084 <para>Enter only numbers and decimal points (no currency
14092 <para>Enter the 'Fine Charging Interval' in the unit you set
14093 (ex. charge fines every 1 day, or every 2 hours)</para>
14097 <para>The 'Fine Grace Period' is the period of time an item can
14098 be overdue before you start charging fines.</para>
14103 <para>This can only be set for the Day unit, not in
14111 <para>If your library 'fines' patrons by suspending their
14112 account you can enter the number of days their fine should be
14113 suspended in the 'Suspension in Days' field</para>
14118 <para>This can only be set for the Day unit, not in
14126 <para>Next decide if the patron can renew this item type and if
14127 so, enter how many times they can renew it in the 'Renewals
14128 Allowed' box</para>
14132 <para>If the patron can place holds on this item type, enter the
14133 total numbers of items (of this type) that can be put on hold in
14134 the 'Holds Allowed' field</para>
14138 <para>Finally, if you charge a <link
14139 linkend="rentalcharge">rental fee</link> for the item type and
14140 want to give a specific patron type a discount on that fee,
14141 enter the percentage discount (without the % symbol) in the
14142 'Rental Discount' field</para>
14146 <para>When finished, click 'Add' to save your changes. To modify a
14147 rule, create a new one with the same patron type and item type. If
14148 you would like to delete your rule, simply click the 'Delete' link
14149 to the right of the rule.</para>
14151 <para>To save time you can clone rules from one library to another
14152 by choosing the clone option above the rules matrix.</para>
14155 <screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
14159 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
14164 <para>After choosing to clone you will be presented with a
14165 confirmation message.</para>
14168 <screeninfo>Circulation & Fine Rules Successfully Cloned
14169 Message</screeninfo>
14173 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
14179 <section id="defaultcheckoutpolicy">
14180 <title>Default Checkouts and Hold Policy</title>
14182 <para>You can set a default maximum number of checkouts and hold
14183 policy that will be used if none is defined below for a particular
14184 item type or category.</para>
14187 <screeninfo>Default Checkouts and Hold Policy</screeninfo>
14191 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
14196 <para>From this menu you can set a default to apply to all item
14197 types and patrons in the library.</para>
14201 <para>In 'Total Current Checkouts Allowed' enter the total
14202 number of items patrons can have checked out at one time</para>
14206 <para>Control where patrons can place holds from using the 'Hold
14207 Policy' menu</para>
14211 <para>From Any Library: Patrons from any library may put
14212 this item on hold. (default if none is defined)</para>
14216 <para>From Home Library: Only patrons from the item's home
14217 library may put this book on hold.</para>
14221 <para>No Holds Allowed: No patron may put this book on
14228 <para>Control where the item returns to once it is checked
14233 <para>Item returns home</para>
14237 <para>Item returns to issuing branch</para>
14241 <para>Item floats</para>
14245 <para>When an item floats it stays where it was checked
14246 in and does not ever return 'home'</para>
14254 <para>Once your policy is set, you can unset it by clicking the
14255 'Unset' link to the right of the rule</para>
14260 <section id="checkoutperpatron">
14261 <title>Checkouts Per Patron</title>
14263 <para>For this library, you can specify the maximum number of loans
14264 that a patron of a given category can make, regardless of the item
14268 <screeninfo>Set default checkouts per patron category</screeninfo>
14272 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
14278 <para>If the total amount loanable for a given patron category is
14279 left blank, no limit applies, except possibly for a limit you
14280 define for a specific item type.</para>
14284 <section id="holdpolicies">
14285 <title>Item Hold Policies</title>
14287 <para>For this library, you can edit rules for given itemtypes,
14288 regardless of the patron's category. Currently, this means hold
14292 <screeninfo>Hold policies per item type</screeninfo>
14296 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
14301 <para>The various Hold Policies have the following effects:</para>
14305 <para>From Any Library: Patrons from any library may put this
14306 item on hold. (default if none is defined)</para>
14310 <para>From Home Library: Only patrons from the item's home
14311 library may put this book on hold.</para>
14315 <para>No Holds Allowed: No patron may put this book on
14321 <para>Note that if the system preference <link
14322 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
14323 set to 'allow', these policies can be overridden by your
14324 circulation staff.</para>
14328 <para>These policies are based on the patron's home branch, not
14329 the branch that the reserving staff member is from.</para>
14332 <para>The various Return Policies have the following effects:</para>
14336 <para>Item returns home: The item will prompt the librarian to
14337 transfer the item to its home library</para>
14343 linkend="AutomaticItemReturn">AutomaticItemReturn</link>
14344 preference is set to automatically transfer the items
14345 home, then a prompt will not appear</para>
14352 <para>Item returns to issuing branch: The item will prompt the
14353 librarian to transfer the item back to the library where it was
14360 linkend="AutomaticItemReturn">AutomaticItemReturn</link>
14361 preference is set to automatically transfer the items
14362 home, then a prompt will not appear</para>
14369 <para>Item floats: The item will not be transferred from the
14370 branch it was checked in at, instead it will remain there until
14371 transferred manually or checked in at another branch</para>
14377 <section id="libtransferlimits">
14378 <title>Library Transfer Limits</title>
14380 <para>Limit the ability to transfer items between libraries based on
14381 the library sending, the library receiving, and the collection code
14386 <para><emphasis>Get there:</emphasis> More > Administration
14387 > Patrons & Circulation > Library Transfer Limits</para>
14391 <para>These rules only go into effect if the preference <link
14392 linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is
14393 set to 'enforce'.</para>
14395 <para>Before you begin you will want to choose which library you are
14396 setting these limits for.</para>
14399 <screeninfo>Choose the library you're setting limits
14404 <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
14409 <para>Transfer limits are set based on the collections codes you have
14410 applied via the <link linkend="authorizedvalues">Authorized
14411 Value</link> administration area.</para>
14414 <screeninfo>Collection Code values assigned in the Authorized Value
14419 <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
14424 <para>Collection codes will appear as tabs above the
14428 <screeninfo>Collection Code tabs</screeninfo>
14432 <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
14437 <para>Check the boxes for the libraries that you accept checkins from
14438 for the item type you have selected at the top (in the example below -
14442 <screeninfo>Example transfer limits set up</screeninfo>
14446 <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
14451 <para>In the above example, Centerville library will allow patrons to
14452 return items from all libraries except Liberty and Franklin to their
14456 <section id="itemcircalerts">
14457 <title>Item Circulation Alerts</title>
14459 <para>Libraries can decide if they want to have patrons automatically
14460 notified of circulation events (check ins and check outs).</para>
14464 <para><emphasis>Get there:</emphasis> More > Administration
14465 > Patrons & Circulation > Item Circulation Alerts</para>
14469 <para>These preferences are set based on patron types and item
14473 <para>These preference can be overwritten by changes in the
14474 individual patron's messaging preferences.</para>
14477 <para>To set up circulation alerts:</para>
14481 <para>Choose your library from the pull down at the top of the
14485 <screeninfo>Libraries to set Circulation Alerts</screeninfo>
14489 <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
14496 <para>To set preferences for all libraries, keep the menu set
14497 to 'Default'</para>
14503 <para>By default all item types and all patrons are notified of
14504 check ins and check outs. To change this, click on the item/patron
14505 type combo that you would like to stop notices for.</para>
14508 <screeninfo>Circulation Alert Matrix</screeninfo>
14512 <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
14519 <para>In the above example, Juveniles and Kids will not
14520 receive check out notices.</para>
14528 <section id="catadmin">
14529 <title>Catalog Administration</title>
14531 <para>Set these controls before you start cataloging on your Koha
14536 <para><emphasis>Get there:</emphasis> More > Administration >
14541 <section id="marcbibframeworks">
14542 <title>MARC Bibliographic Frameworks</title>
14544 <para>Think of Frameworks as templates for creating new bibliographic
14545 records. Koha comes with some predefined frameworks that can be edited
14546 or deleted, and librarians can create their own frameworks for content
14547 specific to their libraries.</para>
14551 <para><emphasis>Get there:</emphasis> More > Administration
14552 > Catalog > MARC Bibliographic Frameworks</para>
14557 <screeninfo>Frameworks List</screeninfo>
14561 <imagedata fileref="images/admin/cataloging/frameworks.png"/>
14567 <para>Do not delete or edit the Default Framework since this will
14568 cause problems with your cataloging records - always create a new
14569 template based on the Default Framework, or alter the other
14573 <para>After clicking the 'MARC structure' link to the right of each
14574 framework you can decide how many fields you want to see on one screen
14575 by using the pagination options at the top of the table.</para>
14578 <screeninfo>Pagination options</screeninfo>
14582 <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
14587 <section id="addframework">
14588 <title>Add New Framework</title>
14590 <para>To add a new framework</para>
14594 <para>Click 'New Framework'</para>
14597 <screeninfo>Add Framework Form</screeninfo>
14601 <imagedata fileref="images/admin/cataloging/addframework.png"/>
14608 <para>Enter a code of 4 or fewer characters</para>
14612 <para>Use the Description field to enter a more detailed
14613 definition of your framework</para>
14619 <para>Click 'Submit'</para>
14623 <para>Once your Framework is added click 'MARC structure' to the
14624 right of it on the list of Frameworks</para>
14627 <screeninfo>Choose basis for new Framework</screeninfo>
14631 <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
14638 <para>You will be asked to choose a Framework to base your
14639 new Framework off of, this will make it easier than starting
14640 from scratch</para>
14646 <para>Once your Framework appears on the screen you can edit or
14647 delete each field by following the instructions for <link
14648 linkend="editsubfields">editing subfields</link></para>
14653 <section id="editframeworks">
14654 <title>Edit Existing Frameworks</title>
14656 <para>Clicking 'Edit' to the right of a Framework will only allow
14657 you to edit the Description for the Framework:</para>
14660 <screeninfo>Edit Framework</screeninfo>
14664 <imagedata fileref="images/admin/cataloging/editframework.png"/>
14669 <para>To make edits to the fields associated with the Framework you
14670 must first click 'MARC Structure' and then follow the instructions
14671 for <link linkend="editsubfields">editing subfields</link></para>
14674 <section id="addsubfieldsframework">
14675 <title>Add subfields to Frameworks</title>
14677 <para>To add a field to a Framework click the 'New Tag' button at
14678 the top of the Framework definition</para>
14681 <screeninfo>New Tag Button</screeninfo>
14685 <imagedata fileref="images/admin/cataloging/newtag.png"/>
14690 <para>This will open up a blank form for entering MARC field
14694 <screeninfo>Add a new tag to framework</screeninfo>
14698 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
14703 <para>Enter the information about your new tag:</para>
14707 <para>The 'Tag' is the MARC field number</para>
14711 <para>The 'Label for lib' is the text that will appear in the
14712 staff client when in the cataloging module</para>
14716 <para>The 'Label for OPAC' is the text that will appear in the
14717 OPAC when viewing the MARC version of the record</para>
14721 <para>If this field can be repeated, check the 'Repeatable'
14726 <para>If this field is mandatory, check the 'Mandatory'
14731 <para>If you want this field to be a pull down with limited
14732 possible answers, choose which 'Authorized value' list you want
14737 <para>When you're finished, click 'Save Changes' and you will be
14738 presented with your new field</para>
14741 <screeninfo>New tag and link to subfields</screeninfo>
14745 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
14750 <para>To the right of the new field is a link to 'Subfields,' you
14751 will need to add subfields before this tag will appear in your MARC
14752 editor. The process of entering the settings for the new subfield is
14753 the same as those found in the <link linkend="editsubfields">editing
14754 subfields in frameworks</link> section of this manual.</para>
14757 <section id="editsubfields">
14758 <title>Edit Framework Subfields</title>
14760 <para>Frameworks are made up of MARC fields and subfields. To make
14761 edits to most Frameworks you must edit the fields and subfields.
14762 Clicking 'Edit' to the right of each subfield will allow you to make
14763 changes to the text associated with the field</para>
14766 <screeninfo>Modify MARC Field</screeninfo>
14770 <imagedata fileref="images/admin/cataloging/editfield.png"/>
14777 <para>Each field has a tag (which is the MARC tag)</para>
14781 <para>The 'Label for lib' is what will show in the staff
14782 client if you have <link
14783 linkend="advancedMARCeditor">advancedMARCeditor</link> set
14784 to display labels</para>
14788 <para>The 'Label for OPAC' is what will show on the MARC
14789 view in the OPAC</para>
14793 <para>If you check 'Repeatable' then the field will have a
14794 plus sign next to it allowing you to add multiples of that
14799 <para>If you check 'Mandatory' the record will not be
14800 allowed to save unless you have a value assigned to this
14805 <para>'Authorized value' is where you define an <link
14806 linkend="authorizedvalues">authorized value</link> that your
14807 catalogers can choose from a pull down to fill this field
14814 <para>To edit the subfields associated with the tag, click
14815 'Subfields' to the right of the tag on the 'MARC Structure'
14820 <para>From the list of subfields you can click 'Delete' to the
14821 right of each to delete the subfields</para>
14825 <para>To edit the subfields click 'Edit Subfields'</para>
14828 <screeninfo>Editing the 504 Subfield</screeninfo>
14832 <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
14839 <para>For each subfield you can set the following values</para>
14843 <para>Text for librarian</para>
14847 <para>what appears before the subfield in the librarian
14854 <para>Text for OPAC</para>
14858 <para>what appears before the field in the OPAC.</para>
14862 <para>If left empty, the text for librarian is used
14871 <para>Repeatable</para>
14875 <para>the field will have a plus sign next to it
14876 allowing you to add multiples of that tag</para>
14882 <para>Mandatory</para>
14886 <para>the record will not be allowed to save unless you
14887 have a value assigned to this tag</para>
14893 <para>Managed in tab</para>
14897 <para>defines the tab where the subfield is shown. All
14898 subfields of a given field must be in the same tab or
14899 ignored. Ignore means that the subfield is not
14906 <para>Default value</para>
14910 <para>defines what you want to appear in the field by
14911 default, this will be editable, but it saves time if you
14912 use the same note over and over or the same value in a
14913 field often.</para>
14919 <para>hidden</para>
14923 <para>allows you to select from 19 possible visibility
14924 conditions, 17 of which are implemented. They are the
14929 <para>-9 => Future use</para>
14933 <para>-8 => Flag</para>
14937 <para>-7 => OPAC !Intranet !Editor
14942 <para>-6 => OPAC Intranet !Editor
14947 <para>-5 => OPAC Intranet !Editor
14952 <para>-4 => OPAC !Intranet !Editor
14957 <para>-3 => OPAC !Intranet Editor
14962 <para>-2 => OPAC !Intranet Editor
14967 <para>-1 => OPAC Intranet Editor Collapsed</para>
14971 <para>0 => OPAC Intranet Editor !Collapsed</para>
14975 <para>1 => !OPAC Intranet Editor Collapsed</para>
14979 <para>2 => !OPAC !Intranet Editor
14984 <para>3 => !OPAC !Intranet Editor
14989 <para>4 => !OPAC Intranet Editor
14994 <para>5 => !OPAC !Intranet !Editor
14999 <para>6 => !OPAC Intranet !Editor
15004 <para>7 => !OPAC Intranet !Editor
15009 <para>8 => !OPAC !Intranet !Editor
15014 <para>9 => Future use • URL : if checked,
15015 the subfield is an URL, and can be clicked</para>
15021 <para>( ! means 'not visible' or in the case of
15022 Collapsed 'not Collapsed')</para>
15028 <para>Is a URL</para>
15032 <para>if checked, it means that the subfield is a URL
15033 and can be clicked</para>
15043 <para>If you enter a field/subfield here (200b), a link
15044 appears after the subfield in the MARC Detail view. This
15045 view is present only in the staff client, not the OPAC.
15046 If the librarian clicks on the link, a search is done on
15047 the database for the field/subfield with the same value.
15048 This can be used for 2 main topics :</para>
15052 <para>on a field like author (200f in UNIMARC), put
15053 200f here, you will be able to see all bib records
15054 with the same author.</para>
15058 <para>on a field that is a link (4xx) to reach
15059 another bib record. For example, put 011a in 464$x,
15060 will find the serials that are with this
15068 <para>This value should not change after data has been
15069 added to your catalog</para>
15076 <para>Koha link</para>
15080 <para>Koha is multi-MARC compliant. So, it does not know
15081 what the 245$a means, neither what 200$f (those 2 fields
15082 being both the title in MARC21 and UNIMARC). So, in this
15083 list you can "map" a MARC subfield to its meaning. Koha
15084 constantly maintains consistency between a subfield and
15085 its meaning. When the user want to search on "title",
15086 this link is used to find what is searched (245 if
15087 you're MARC21, 200 if you're UNIMARC).</para>
15093 <para>Authorized value</para>
15097 <para>means the value cannot by typed by the librarian,
15098 but must be chosen from a pull down generated by the
15099 <link linkend="authorizedvalues">authorized value</link>
15104 <para>In the example above, the 504a field will show the
15105 MARC504 Authorized Values when cataloging</para>
15108 <screeninfo>Example of an Authorized
15109 Subfield</screeninfo>
15113 <imagedata fileref="images/admin/cataloging/504auth.png"/>
15122 <para>Thesaurus</para>
15126 <para>means that the value is not free text, but must be
15127 searched in the authority/thesaurus of the selected
15134 <para>Plugin</para>
15138 <para>means the value is calculated or managed by a
15139 plugin. Plugins can do almost anything.</para>
15143 <para>For example, in UNIMARC there are plugins for
15144 every 1xx fields that are coded fields. The plugin is a
15145 huge help for cataloger ! There are also two plugins
15146 (unimarc_plugin_210c and unimarc_plugin_225a that can
15147 "magically" find the editor from an ISBN, and the
15148 collection list for the editor)</para>
15156 <para>To save your changes simply click the 'Save Changes'
15157 button at the top of the screen</para>
15164 <section id="importexportframeworks">
15165 <title>Import/Export Frameworks</title>
15167 <para>Next to each framework is a link to either import or export
15168 the framework.</para>
15170 <section id="exportframeworks">
15171 <title>Export Framework</title>
15173 <para>To export a framework simply click the 'Export' link to the
15174 right of framework title.</para>
15177 <screeninfo>Export link next to framework</screeninfo>
15181 <imagedata fileref="images/admin/cataloging/importexport.png"/>
15186 <para>When you click 'Export' you will be prompted to choose what
15187 format to export the file in.</para>
15190 <screeninfo>Export formats</screeninfo>
15194 <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
15199 <para>A framework exported this way can be imported into any other
15200 Koha installation using the import framework option.</para>
15203 <section id="importframeworks">
15204 <title>Import Framework</title>
15206 <para>An easy way to create a new framework is to import it from
15207 another Koha database. To import a framework you first need to
15208 create <link linkend="addframework">a new framework</link>. Once
15209 you have that framework, click 'Import' to the right of the new
15213 <screeninfo>Import link next to framework</screeninfo>
15217 <imagedata fileref="images/admin/cataloging/importexport.png"/>
15222 <para>You will be prompted to find a file on your computer to
15223 import into the framework.</para>
15226 <screeninfo>Choose a file to import</screeninfo>
15230 <imagedata fileref="images/admin/cataloging/importfile.png"/>
15235 <para>You will be asked to confirm your actions before the file is
15239 <screeninfo>Confirm your desire to import</screeninfo>
15243 <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
15248 <para>As your file is uploaded you will see an image that will
15249 confirm that the system is working.</para>
15252 <screeninfo>Import timer</screeninfo>
15256 <imagedata fileref="images/admin/cataloging/importtimer.png"/>
15261 <para>Once your import is complete you will be brought to the
15262 framework edit tool where you can make any changes you need to the
15263 framework you imported.</para>
15268 <section id="kohamarcmapping">
15269 <title>Koha to MARC Mapping</title>
15271 <para>While Koha stores the entire MARC record, it also stores common
15272 fields for easy access in various tables in the database. Koha to MARC
15273 Mapping is used to tell Koha where to find these values in the MARC
15274 record. In many cases you will not have to change the default values
15275 set by in this tool on installation, but it is important to know that
15276 the tool is here and can be used at any time.</para>
15280 <para><emphasis>Get there:</emphasis> More > Administration
15281 > Catalog > Koha to MARC Mapping</para>
15285 <para>The Koha to MARC Mapping page offers you the option of choosing
15286 from one of three tables in the database to assign values to.</para>
15289 <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
15293 <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
15298 <para>After choosing the table you would like to view, click 'OK.' To
15299 edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
15302 <screeninfo>Map MARC Field to Koha Field</screeninfo>
15306 <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
15311 <para>Choose which MARC field you would like to map to this Koha Field
15312 and click the 'OK' button. If you would like to clear all mappings,
15313 click the 'Click to "Unmap"' button.</para>
15316 <para>At this time you can map only 1 MARC field to 1 Koha field.
15317 This means that you won't be able to map both the 100a and the 700a
15318 to the author field, you need to choose one or the other.</para>
15324 <section id="keywordmapping">
15325 <title>Keywords to MARC Mapping</title>
15327 <para>This tool will allow you to map MARC fields to a set of
15328 predefined keywords.</para>
15332 <para><emphasis>Get there:</emphasis> More > Administration
15333 > Catalog > Keywords to MARC Mapping</para>
15338 <para>This tool only effects sites that are not using the XSLT
15339 Stylesheets.</para>
15342 <para>At this time the only keyword in use is 'subtitle.'</para>
15344 <para>Using this tool you can define what MARC field prints to the
15345 detail screen of the bibliographic record using keywords. The
15346 following example will use the subtitle field.</para>
15348 <para>Using the Framework pull down menu, choose the <link
15349 linkend="marcbibframeworks">Framework</link> you would like to apply
15350 this rule to. For example, the subtitle for books can be found in the
15351 245$b field.</para>
15354 <screeninfo>Assigning Book Subtitle</screeninfo>
15358 <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
15363 <para>However the subtitle for DVDs appears in 245$p</para>
15366 <screeninfo>Assigning DVD Subtitle</screeninfo>
15370 <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
15375 <para>Using this tool you can tell Koha to print the right field as
15376 the subtitle when viewing the bibliographic record in the OPAC.</para>
15379 <screeninfo>Subtitle display in the OPAC</screeninfo>
15383 <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
15388 <para>This tool can be used to chain together pieces of the record as
15389 well. If you want the series number to show in the title on your
15390 search results you simply have to map 490 $v to 'subtitle' along with
15392 <para>Chain together the fields you want to show after the item
15393 title in the order in which you want them to appear.</para>
15396 <para>Future developments will include additional keyword assigned
15400 <section id="marcbibframeworkstest">
15401 <title>MARC Bibliographic Framework Test</title>
15403 <para>Checks the MARC structure.</para>
15407 <para><emphasis>Get there:</emphasis> More > Administration
15408 > Catalog > MARC Bibliographic Framework Test</para>
15412 <para>If you change your MARC Bibliographic framework it's recommended
15413 that you run this tool to test for errors in your definition.</para>
15416 <screeninfo>Framework Test</screeninfo>
15420 <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
15426 <section id="authoritiesadmin">
15427 <title>Authority Types</title>
15429 <para>Authority Types are basically MARC Frameworks for Authority
15430 records and because of that they follow the same editing rules found
15431 in the <link linkend="marcbibframeworks">MARC Bibliographic
15432 Frameworks</link> section of this manual. Koha comes with many of the
15433 necessary Authority frameworks already installed. To learn how to add
15434 and edit Authority Types, simply review the <link
15435 linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
15436 section of this manual.</para>
15440 <para><emphasis>Get there:</emphasis> More > Administration
15441 > Catalog > Authority Types</para>
15446 <section id="classificationsources">
15449 <firstname id="classsourceauthor">Savitra</firstname>
15451 <surname>Sirohi</surname>
15454 <orgname>Nucsoft OSS Labs</orgname>
15458 <pubdate id="classsourcepubdate">August 2010</pubdate>
15460 <othercredit id="classsourceeditor" role="copyeditor">
15461 <firstname>Nicole C.</firstname>
15463 <surname>Engard</surname>
15465 <contrib id="classsourcecredit">Fixed typos, changed content where
15466 necessary and added new screenshots.</contrib>
15470 <title>Classification Sources</title>
15472 <para>Source of classification or shelving scheme is an <link
15473 linkend="authorizedvalues">Authorized Values</link> category that is
15474 mapped to field 942$2 in Koha's MARC Bibliographic frameworks.</para>
15478 <para><emphasis>Get there:</emphasis> More > Administration
15479 > Catalog > Classification sources</para>
15484 <screeninfo>Classification Sources</screeninfo>
15488 <imagedata fileref="images/admin/cataloging/classsources.png"/>
15493 <para>Commonly used values of this field are:</para>
15497 <para>ddc - Dewey Decimal Classification</para>
15501 <para>lcc - Library of Congress Classification</para>
15505 <para>If you chose to install classification sources during Koha's
15506 installation, you would see other values too:</para>
15510 <para>ANSCR (sound recordings)</para>
15514 <para>SuDOC classification</para>
15518 <para>Universal Decimal Classification</para>
15522 <para>Other/Generic Classification</para>
15526 <section id="addingclasssource">
15527 <title>Adding/Editing Classification Sources</title>
15529 <para>You can add your own source of classification by using the New
15530 Classification Source button. To edit use the Edit link.</para>
15533 <screeninfo>Add classification source</screeninfo>
15537 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
15542 <para>When creating or editing:</para>
15546 <para>You will need to enter a code and a description.</para>
15550 <para>Check the 'Source in use?' checkbox if you want the value
15551 to appear in the drop down list for this category.</para>
15555 <para>Select the appropriate <link
15556 linkend="classfilingrules">filing rule</link> from the drop down
15564 <section id="classfilingrules">
15565 <title>Classification Filing Rules</title>
15567 <para>Filing rules determine the order in which items are placed on
15570 <para>Values that are pre-configured in Koha are:</para>
15582 <para>Generic</para>
15586 <para>Filing rules are mapped to <link
15587 linkend="addingclasssource">Classification sources</link>. You can
15588 setup new filing rules by using the New Filing Rule button. To edit
15589 use the Edit link.</para>
15591 <para>When creating or editing:</para>
15595 <para>Enter a code and a description</para>
15599 <para>Choose an appropriate filing routine - dewey, generic or
15606 <section id="recordmatchingrules">
15607 <title>Record Matching Rules</title>
15609 <para>Record matching rules are used when importing MARC records into
15614 <para><emphasis>Get there:</emphasis> More > Administration
15615 > Catalog > Record Matching Rules</para>
15619 <para>The rules that you set up here will be referenced with you <link
15620 linkend="stagemarc">Stage MARC Records for Import</link>.</para>
15622 <para>To create a new matching rule :</para>
15626 <para>Click 'New Record Matching Rule'</para>
15629 <screeninfo>Add record matching rule</screeninfo>
15633 <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
15640 <para>Choose a unique name and enter it in the 'Matching rule
15645 <para>'Description' can be anything you want to make it clear
15646 to you what rule you're picking</para>
15650 <para>'Match threshold' - The total number of 'points' a
15651 biblio must earn to be considered a 'match'</para>
15655 <para>Match points are set up to determine what fields to
15660 <para>'Search index' can be found by looking at the
15661 ccl.properties file on your system which tells the zebra
15662 indexing what data to search for in the MARC data".</para>
15666 <para>'Score' - The number of 'points' a match on this field
15667 is worth. If the sum of each score is greater than the match
15668 threshold, the incoming record is a match to the existing
15673 <para>Enter the MARC tag you want to match on in the 'Tag'
15678 <para>Enter the MARC tag subfield you want to match on in the
15679 'Subfields' field</para>
15683 <para>'Offset' - For use with control fields, 001-009</para>
15687 <para>'Length' - For use with control fields, 001-009</para>
15691 <para>Koha only has one 'Normalization rule' that removes
15692 extra characters such as commas and semicolons. The value you
15693 enter in this field is irrelevant to the normalization
15698 <para>'Required match checks' - ??</para>
15706 <section id="samplerecordmatch">
15707 <title>Sample Record Matching Rule: Control Number</title>
15710 <screeninfo>LOC Matching Rule</screeninfo>
15714 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
15721 <para>Match threshold: 100</para>
15725 <para>Matchpoints (just the one):</para>
15729 <para>Search index: Control-number</para>
15733 <para>Score: 101</para>
15737 <para>Tag: 001</para>
15742 <para>this field is for the control number assigned by the
15743 organization creating, using, or distributing the
15751 <para>Subfields: a</para>
15755 <para>Offset: 0</para>
15759 <para>Length: 0</para>
15763 <para>Normalization rule: Control-number</para>
15767 <para>Required Match checks: none (remove the blank one)</para>
15770 <screeninfo>Remove match check</screeninfo>
15774 <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
15783 <section id="oaisetsconfig">
15784 <title>OAI Sets Configuration</title>
15786 <para>On this page you can create, modify and delete OAI-PMH
15789 <section id="oaicreate">
15790 <title>Create a set</title>
15792 <para>To create a set:</para>
15796 <para>Click on the link 'Add a new set'</para>
15800 <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
15804 <para>Then you can add descriptions for this set. To do this
15805 click on 'Add description' and fill the newly created text box.
15806 You can add as many descriptions as you want.</para>
15810 <para>Click on 'Save' button'</para>
15815 <section id="oaimodify">
15816 <title>Modify/Delete a set</title>
15818 <para>To modify a set, just click on the link 'Modify' on the same
15819 line of the set you want to modify. A form similar to set creation
15820 form will appear and allow you to modify the setSpec, setName and
15821 descriptions.</para>
15823 <para>To delete a set, just click on the link 'Delete' on the same
15824 line of the set you want to delete.</para>
15827 <section id="oaimapping">
15828 <title>Define mappings</title>
15830 <para>Here you can define how a set will be build (what records will
15831 belong to this set) by defining mappings. Mappings are a list of
15832 conditions on record content. A record only need to match one
15833 condition to belong to the set.</para>
15837 <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
15838 example if you want to include in this set all records that have
15839 a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
15840 and 'Value' with XXX.</para>
15844 <para>If you want to add another condition, click on 'OR' button
15845 and repeat step 1.</para>
15849 <para>Click on 'Save'</para>
15853 <para>To delete a condition, just leave at least one of 'Field',
15854 'Subfield' or 'Value' empty and click on 'Save'.<note>
15855 <para>Actually, a condition is true if value in the
15856 corresponding subfield is strictly equal to what is defined if
15857 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
15858 set where condition is 999$9 = 'XXX'.</para>
15861 <para>And it is case sensitive : a record having 999$9 = 'xxx' will
15862 not belong to a set where condition is 999$9 = 'XXX'.</para>
15865 <section id="oaibuild">
15866 <title>Build sets</title>
15868 <para>Once you have configured all your sets, you have to build the
15869 sets. This is done by calling the script
15870 misc/migration_tools/build_oai_sets.pl.</para>
15875 <section id="acqadmin">
15876 <title>Acquisitions</title>
15880 <para><emphasis>Get there:</emphasis> More > Administration >
15881 Acquisitions</para>
15885 <section id="currexchangeadmin">
15886 <title>Currencies and Exchange Rates</title>
15888 <para>If you place orders from more than one country you will want to
15889 input currency exchange rates so that your acquisitions module will
15890 properly calculate totals.</para>
15894 <para><emphasis>Get there:</emphasis> More > Administration
15895 > Acquisitions > Currencies and Exchange Rates</para>
15900 <screeninfo>Currencies</screeninfo>
15904 <imagedata fileref="images/admin/acquisitions/currencies.png"/>
15910 <para>This data is not automatically updated, so be sure to keep it
15911 up to date so that your accounting is kept correct.</para>
15914 <para>The active currency is the main currency you use in your
15915 library. Your active currency will have a check mark in the 'Active'
15916 column. If you don't have an active currency you will see an error
15917 message telling you to choose an active currency.</para>
15920 <screeninfo>No active currency warning</screeninfo>
15924 <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
15930 <section id="budgetplanning">
15931 <title>Budgets</title>
15933 <para>Budgets are the top level used for tracking accounting values
15934 related to acquisitions.</para>
15938 <para><emphasis>Get there:</emphasis> More > Administration
15939 > Acquisitions > Budgets</para>
15943 <para>An example would be to create a budget for the current year and
15944 then breaking that into Funds for different areas of the
15947 <section id="addbudget">
15948 <title>Add a budget</title>
15950 <para>Budgets can either be created from scratch or by duplicating
15951 the previous year's budget.</para>
15953 <para>To duplicate a budget from a previous year, click on the link
15954 for the budget name from the list of budgets</para>
15957 <screeninfo>Budgets List</screeninfo>
15961 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
15966 <para>On the screen listing the budget breakdown click the Edit
15967 button at the top and choose to Duplicate budget</para>
15970 <screeninfo>Duplicate Budget</screeninfo>
15974 <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
15979 <para>You will be presented with a form where you simply need to
15980 enter the new start and end date and save the budget.</para>
15983 <screeninfo>New Duplicate Budget</screeninfo>
15987 <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
15992 <para>This will not only duplicate your budget, but all of the funds
15993 associated with that budget so that you can reuse budgets and funds
15994 from year to year.</para>
15996 <para>If you haven't used Koha before for acquisitions then you'll
15997 need to start fresh with a new budget. To add a new budget click the
15998 'New Budget' button.</para>
16001 <screeninfo>New Budget Form</screeninfo>
16005 <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
16012 <para>Choose the time period this budget is for, whether it's an
16013 academic year, a fiscal year, a quarter, etc.</para>
16017 <para>The Description should be something that will help you
16018 identify the budget when ordering</para>
16022 <para>In the amount box do not use any symbols, simply enter the
16023 amount of the budget with numbers and decimals.</para>
16027 <para>Marking a budget active makes it usable when placing
16028 orders in the acquisitions module, even if the order is placed
16029 after the budget end date. This will allow you to record orders
16030 that were places in a previous budget period.</para>
16034 <para>Locking a budget means that Funds will not be able to be
16035 modified by librarians</para>
16039 <para>Once you have made your edits, click the 'Save Changes'
16040 button. You will be brought to a list of your existing
16044 <screeninfo>List of Budgets</screeninfo>
16048 <imagedata fileref="images/admin/acquisitions/budgetlist.png"/>
16055 <section id="funds">
16056 <title>Funds</title>
16060 <para><emphasis>Get there:</emphasis> More > Administration
16061 > Acquisitions > Funds</para>
16065 <section id="addbudgetfund">
16066 <title>Add a Fund</title>
16068 <para>A fund is added to a budget.</para>
16071 <para>A <link linkend="addbudget">budget</link> must be defined
16072 before a fund can be created.</para>
16073 </important>To add a new fund click the New button and then choose
16074 which Budget you would like to add the fund to.</para>
16077 <screeninfo>Choose which budget to add a fund to</screeninfo>
16081 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
16086 <para>In the form that appears you wan to enter the basics about
16090 <screeninfo>New Fund Form</screeninfo>
16094 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
16099 <para>The three first fields are required, the rest are
16104 <para>Fund Code is a unique identifier for your fund</para>
16108 <para>The Fund Name should be something that librarians will
16113 <para>Amount should be entered with only numbers and decimals,
16114 no other characters</para>
16118 <para><emphasis>Encumbrance ??</emphasis></para>
16122 <para><emphasis>Expenditure ??</emphasis></para>
16126 <para>You can choose to assign this fund to a librarian. Doing
16127 so will make it so that only that librarian can make changes to
16132 <para>Choose which library will be using this fund</para>
16136 <para>You can restrict who can order from this fund by choosing
16137 either the owner or the library from the 'Restrict access to'
16141 <screeninfo>Restrict Fund Access</screeninfo>
16145 <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
16152 <para>Notes are simply for any descriptive notes you might want
16153 to add so that librarians know when to use this fund</para>
16157 <para>Planning categories are used for statistical purposes. To
16158 learn more about planning categories, check out the <link
16159 linkend="planningcatfaq">Planning Category FAQ</link>.</para>
16163 <para>When complete, click 'Submit' and you will be brought to a
16164 list of all of the funds for the budget.</para>
16167 <screeninfo>List of funds</screeninfo>
16171 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
16176 <para>To the right of each fund you will find the 'Edit,' 'Delete,'
16177 and 'Add Child Fund' options. A child fund simply a sub-fund of the
16178 fund listed. An example would be to have a fund for 'Fiction' and
16179 under that have a fund for 'New Releases' and a fund for 'Science
16180 Fiction.' It is an optional way to further organize your
16184 <section id="fundsplanning">
16185 <title>Budget Planning</title>
16187 <para>When viewing the list of funds click the 'Planning' button and
16188 choose how you would like to plan to spend your budget.</para>
16191 <screeninfo>Planning pull down menu</screeninfo>
16195 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
16200 <para>If you choose 'Plan by MONTHS' you will see the budgeted
16201 amount broken down by months:</para>
16204 <screeninfo>Budget Planning Formula</screeninfo>
16208 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
16213 <para>To hide some of the columns you can click the minus sign (-)
16214 to the right (or below as in the screenshot above) the dates. To add
16215 more columns you can click the 'Show a column' link found below the
16216 'Fund Remaining' heading.</para>
16219 <screeninfo>Choose columns to add</screeninfo>
16223 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
16228 <para>From here you can plan your budget spending by manually
16229 entering values or by clicking the 'Auto-fill row' button. If you
16230 choose to auto-fill the form the system will try to divide the
16231 amount accordingly, you may have to make some edits to split things
16232 more accurately.</para>
16235 <screeninfo>Auto-filled columns</screeninfo>
16239 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
16244 <para>Once your changes are made, click the 'Save' button. If you
16245 would like to export your data as a CSV file you can do so by
16246 entering a file name in the 'Output to a file named' field and
16247 clicking the 'Output' button.</para>
16250 <screeninfo>Export planning as CSV</screeninfo>
16254 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
16262 <section id="additionaladmin">
16263 <title>Additional Parameters</title>
16267 <para><emphasis>Get there:</emphasis> More > Administration >
16268 Additional Parameters</para>
16272 <section id="stopwordsadmin">
16273 <title>Stop Words</title>
16276 <para>If NoZebra is set to 'Use' this option will not appear on the
16277 administration menu</para>
16280 <para>Stop words are words that you want the search system to
16285 <para>>Get there: More > Administration > Additional
16286 Parameters > Stop Words</para>
16290 <para>Koha comes with a standard list of stop words that can be edited
16291 by visiting the Stop Word administration area.</para>
16294 <screeninfo>Stop word list</screeninfo>
16298 <imagedata fileref="images/admin/additional/stopwords.png"/>
16303 <para>To add a new stop word to the list, click the 'New Stop Word'
16304 button and add the word you'd like ignored</para>
16307 <screeninfo>New stop word</screeninfo>
16311 <imagedata fileref="images/admin/additional/newstop.png"/>
16317 <para>If you change something in this table, ask your administrator
16318 to run misc/batchRebuildBiblioTables.pl script.</para>
16322 <section id="z3950admin">
16323 <title>Z39.50 Servers</title>
16325 <para>Koha has a powerful copy cataloging tool. Using Koha you can
16326 connect to any Z39.50 target that is publicly available or that you
16327 have the log in information to.</para>
16331 <para><emphasis>Get there:</emphasis> More > Administration
16332 > Additional Parameters > Z39.50 Servers</para>
16336 <para>Koha comes with a default list of Z39.50 targets set up that you
16337 can add to, edit or delete</para>
16340 <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
16344 <imagedata fileref="images/admin/additional/z39list.png"/>
16349 <para>To find additional targets you use IndexData's IRSpy: <ulink
16350 url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink></para>
16352 <section id="addztarget">
16353 <title>Add a Z39.50 Target</title>
16357 <para>From the main Z39.50 page, click 'New Z39.50
16362 <para>Userid and Password are only required for servers that
16363 are password protected</para>
16368 <screeninfo>New Z39.50 Server Form</screeninfo>
16372 <imagedata fileref="images/admin/additional/newz39.png"/>
16380 <section id="suggestztarget">
16381 <title>Suggested Z39.50 Targets</title>
16383 <para>The following targets have been used successfully by other
16384 Koha libraries (in the Americas):</para>
16388 <para>BIBLIOS z3950.biblios.net:210 bibliographic</para>
16392 <para>BIG COUNTRY KOHA bcls.kohalibrary.com:210 bcls_koha</para>
16396 <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
16401 <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
16405 <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
16410 <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
16414 <para>LIBRARY OF CONGRESS z3950.loc.gov:7090 Voyager</para>
16418 <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
16423 <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
16427 <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
16431 <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210
16436 <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
16441 <para>TRI-UNI 129.97.129.194:7090 voyager</para>
16445 <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
16453 <chapter id="tools">
16454 <title>Tools</title>
16456 <para>Tools in Koha all perform some sort of action. Often many of the
16457 items listed under Tools in Koha are referred to as 'Reports' in other
16458 library management systems.</para>
16462 <para><emphasis>Get there:</emphasis> More > Tools</para>
16466 <section id="patrontools">
16467 <title>Patrons and Circulation</title>
16471 <section id="comments">
16472 <title>Comments</title>
16476 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16477 and Circulation > Comments</para>
16481 <para>All comments added by patrons via the OPAC to bibliographic
16482 records require moderation by the librarians. If there are comments
16483 awaiting moderation they will be listed on the main staff dashboard
16484 under the Tools label:</para>
16487 <screeninfo>Comments pending approval</screeninfo>
16491 <imagedata fileref="images/tools/comments/commentswaiting.png"/>
16496 <para>To moderate comments click on the notification on the main
16497 dashboard or go directly to the Comments Tool and click 'Approve' or
16498 'Delete' to the right of the comments awaiting moderation.</para>
16501 <screeninfo>Comment awaiting moderation</screeninfo>
16505 <imagedata fileref="images/tools/comments/commentmoderation.png"/>
16510 <para>If there are no comments to moderate you will see a message
16511 saying just that</para>
16514 <screeninfo>No comments to moderate</screeninfo>
16518 <imagedata fileref="images/tools/comments/nocomments.png"/>
16523 <para>You can also review and unapprove comments you have approved in
16524 the past by choosing the 'Approved comments' tab</para>
16527 <screeninfo>Approved comments</screeninfo>
16531 <imagedata fileref="images/tools/comments/commentapproved.png"/>
16537 <section id="patronimport">
16538 <title>Patron Import</title>
16542 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16543 and Circulation > Import Patrons</para>
16547 <para>The patron import tool can be used at any time to add patrons in
16548 bulk. It is commonly used in universities and schools when a new batch
16549 of students registers.</para>
16551 <section id="createpatronfile">
16552 <title>Creating Patron File</title>
16554 <para>Your Koha installation comes with a blank CSV file that you
16555 can use as a template for your patron records. If you would like to
16556 create the file yourself, make sure that your file has the following
16557 fields in this order as the header row:</para>
16559 <para>borrowernumber, cardnumber, surname, firstname, title,
16560 othernames, initials, streetnumber, streettype, address, address2,
16561 city, zipcode, country, email, phone, mobile, fax, emailpro,
16562 phonepro, B_streetnumber, B_streettype, B_address, B_address2,
16563 B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth,
16564 branchcode, categorycode, dateenrolled, dateexpiry, gonenoaddress,
16565 lost, debarred, contactname, contactfirstname, contacttitle,
16566 guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
16567 password, flags, userid, opacnote, contactnote, sort1, sort2,
16568 altcontactfirstname, altcontactsurname, altcontactaddress1,
16569 altcontactaddress2, altcontactaddress3, altcontactzipcode,
16570 altcontactcountry, altcontactphone, smsalertnumber,
16571 patron_attributes</para>
16574 <para>The 'password' value should be stored in plain text, and
16575 will be converted to a md5 hash (which is an encrypted version of
16576 the password).</para>
16580 <para>If your passwords are already encrypted, talk to your
16581 systems administrator about options</para>
16587 <para>Date formats should match your <link
16588 linkend="dateformat">system preference</link>, and must be
16589 zero-padded, e.g. '01/02/2008'.</para>
16593 <para>The fields 'branchcode' and 'categorycode' are required and
16594 must match valid entries in your database.</para>
16598 <para>If loading <link linkend="patronattributetypes">patron
16599 attributes</link>, the 'patron_attributes' field should contain a
16600 comma-separated list of attribute types and values.</para>
16604 <para>The attribute type code and a colon should precede each
16609 <para>For example: <emphasis
16610 role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis
16611 role="bold">STARTDATE:January 1
16612 2010,TRACK:Day</emphasis></para>
16616 <para>If an input record has more than one attribute, the
16617 fields should either be entered as an unquoted string
16618 (previous examples), or with each field wrapped in
16619 separate double quotes and delimited by a comma:</para>
16623 <para><emphasis role="bold">"STARTDATE:January 1,
16624 2010","TRACK:Day"</emphasis></para>
16628 <para>This syntax would be required if the data might
16629 have a comma in it, like a date string.</para>
16639 <section id="importpatrons">
16640 <title>Importing Patrons</title>
16642 <para>Once you have created your file, you can use the Patron Import
16643 Tool to bring the data into Koha.</para>
16646 <screeninfo>Import Patron Form</screeninfo>
16650 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
16657 <para>Choose your CSV file and choose to match on 'Cardnumber'
16658 to prevent adding of duplicate card numbers to the system</para>
16662 <para>Next you can choose default values to apply to all patrons
16663 you are importing</para>
16667 <para>ex. If you're importing patrons specific to one branch
16668 you can use the field on the Import form to apply the branch
16669 code to all those you are importing.</para>
16675 <para>Finally you need to decide on what data you want to
16676 replace if there are duplicates.</para>
16679 <screeninfo>Record matching options</screeninfo>
16683 <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
16690 <para>A matching record is found using the field you chose
16691 for matching criteria to prevent duplication</para>
16695 <para>If you included patron attributes in your file you can
16696 decide whether to add your values to existing values or
16697 erase existing values and enter only your new values.</para>
16705 <section id="notices">
16706 <title>Notices & Slips</title>
16710 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
16711 and Circulation > Notices & Slips</para>
16715 <para>All notices and circulation receipts (or slips) generated by
16716 Koha can be customized using the Notices & Slips Tool. The system
16717 comes with several predefined templates that will appear when you
16718 first visit this tool.</para>
16721 <screeninfo>Notices & Slips Tool</screeninfo>
16725 <imagedata fileref="images/tools/notices/notices.png"/>
16730 <para>Each notice can be edited, but only a few can be deleted, this
16731 is to prevent system errors should a message try to send without a
16732 template. Each notice and slip can be edited on a per library basis,
16733 by default you will see the notices for all libraries.</para>
16735 <para>If you have a style you'd like applied to all slips you can
16736 point the <link linkend="SlipCSS">SlipCSS</link> preference to a
16737 stylesheet. The same is true for notices, using the <link
16738 linkend="NoticeCSS">NoticeCSS</link> preference to define a
16741 <section id="addnotices">
16742 <title>Adding Notices & Slips</title>
16744 <para>To add a new notice or slip</para>
16748 <para>Click 'New Notice'</para>
16751 <screeninfo>New Notice Form</screeninfo>
16755 <imagedata fileref="images/tools/notices/newnotice.png"/>
16762 <para>Choose which library this notice or slip is for</para>
16766 <para>Choose the module this notice is related to</para>
16770 <para>The Code is limited to 20 characters</para>
16775 <para>When working with the overdue notices you want each
16776 notice at each branch to have a unique code. Think about
16777 using the branch code in front of the notice code for each
16785 <para>Use the name field to expand on your Code</para>
16790 <para>With overdue notices, be sure to put your branch
16791 name in the description as well so that it will be visible
16792 when setting up your <link
16793 linkend="noticetriggers">triggers</link>.</para>
16800 <para>If you plan on writing the notice or slip in HTML check
16801 the 'HTML Message' box, otherwise the content will be generated
16802 as plain text</para>
16806 <para>Message Subject is what will appear in the subject line of
16811 <para>In the message body feel free to type whatever message you
16812 feel is best, use the fields on the left hand side to enter
16813 individualized data from the from database.</para>
16818 <para>Overdue notices can use
16819 <<items.content>> tags by themselves, or use
16820 <item></item> to span all of the tags. Learn
16821 more about the <link linkend="noticemarkup">Overdue Notice
16822 Markup</link></para>
16826 <para>On overdue notices make sure to use
16827 <<items.content>> tags to print out the
16828 data related to all items that are overdue.</para>
16834 <para>The other option, only for overdue notices, is
16835 to use the <item></item> tags to span the
16836 line so that it will print out multiple lines One
16837 example for the <item></item> tag option
16840 <para><item>"<<biblio.title>>" by
16841 <<biblio.author>>,
16842 <<items.itemcallnumber>>, Barcode:
16843 <<items.barcode>> , Checkout date:
16844 <<issues.issuedate>>, Due date:
16845 <<issues.date_due>> Fine:
16846 <fine>USD</fine> Due date:
16847 <<issues.date_due>> </item></para>
16855 <para>Only the overdue notices take advantage of the
16856 <item></item> tags, all other notices
16857 referencing items need to use
16858 <<items.content>></para>
16865 <section id="noticemarkup">
16866 <title>Overdue Notice Markup</title>
16868 <para>When creating your overdue notices there are two tags in
16869 addition to the various database fields that you can use in your
16870 notices.<important>
16871 <para>These new tags only work on the overdue notices, not
16872 other circulation related notices at this time.</para>
16873 </important></para>
16877 <para><item></item> which should enclose all
16878 fields from the biblio, biblioitems, and items tables.</para>
16882 <para><fine></fine> which should be enclosed by
16883 the item tag and should enclose a currency identifier per ISO
16884 4217. If this tag is present with a proper identifier, the
16885 fine for that item will be displayed in the proper currency
16890 <para>Note: ISO 4217 changes from time to time therefore
16891 all currencies may not be supported. If you find one that
16892 is not supported, please file a bug with the
16893 Locale::Currency::Format author Tan D Nguyen <tnguyen
16894 at cpan doe org>.</para>
16900 <para>An example of using these two tags in a notice template
16901 might be like:</para>
16903 <programlisting> The following item(s) is/are currently overdue:
16905 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item></programlisting>
16907 <para>Which, assuming two items were overdue, would result in a
16908 notice like:<programlisting> The following item(s) is/are currently overdue:
16910 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
16911 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50</programlisting></para>
16915 <section id="existingnotices">
16916 <title>Existing Notices & Slips</title>
16918 <para>Among the default notices are notices for several common
16919 actions within Koha. All of these notices can be customized by
16920 altering their text via the Notices & Slips tool and their style
16921 using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
16922 define a stylesheet. Here are some of what those notices do</para>
16926 <para id="ACCTDETAILS">ACCTDETAILS</para>
16930 <para>Sent to patrons when their account is set up if the
16931 <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
16932 preference is set to 'Send'</para>
16938 <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
16942 <para>Used in the claim acquisition module</para>
16946 <para><emphasis>Get there:</emphasis> More > Acquisitions
16947 > Late issues</para>
16953 <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
16957 <para>This notice is used if two criteria are met:</para>
16962 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
16963 is set to 'Allow'</para>
16967 <para>The patron has requested to receive this
16972 <para><emphasis>Get there: </emphasis>OPAC >
16973 Login > my messaging</para>
16977 <para><emphasis>Get there: </emphasis>Staff Client
16978 > Patron Record > <link
16979 linkend="patnotices">Notices</link></para>
16987 <para>When this notice references the branches table it is
16988 referring to the pickup branch information.</para>
16994 <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
16995 that a hold has been placed)</para>
16999 <para>This notice requires the <link
17000 linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
17001 system preference to be set to 'Enable'</para>
17005 <para>When this notice references the branches table it is
17006 referring to the pickup branch information.</para>
17012 <para id="HOLD_PRINT">HOLD_PRINT (Printed notice when hold
17013 available for pickup)</para>
17017 <para>This notice is used for hold confirmation notices that
17018 are sent out in print format. This will not effect what the
17019 email notice looks like.</para>
17023 <para>When this notice references the branches table it is
17024 referring to the pickup branch information.</para>
17030 <para id="ODUE">ODUE (Overdue Notice)</para>
17034 <para>This notice is used to send Overdue Notices to
17039 <para>See a <link linkend="samplenotice">Sample Overdue
17040 Notice</link></para>
17044 <para>Requires that you set <link
17045 linkend="noticetriggers">Overdue Notice/Status
17046 Triggers</link></para>
17052 <para id="RLIST">RLIST (Routing List)</para>
17056 <para>Used in the serials module to notify patrons/staff of
17057 new issues of a serial</para>
17061 <para><emphasis>Get there:</emphasis> More > Serials
17062 > <link linkend="newsubscription">New
17063 Subscription</link></para>
17069 <para>You have the option to select the 'Routing List'
17070 notice when creating a new subscription (Choose from the
17071 'Patron notification' drop down).</para>
17076 <para>Notice also that if you'd like to notify patrons of
17077 new serial issues, you can click on 'define a notice'
17078 which will take you to the 'Notices' tool</para>
17085 <para>There are also a set of predefined slips (or receipts) listed
17086 on this page. All of these slips can be customized by altering their
17087 text via the Notices & Slips tool and their style using the
17088 <link linkend="SlipCSS">SlipCSS</link> preference to define a
17089 stylesheet. Here is what those slips are used for:</para>
17093 <para>ISSUEQSLIP</para>
17097 <para>Used to print the quick slip in circulation</para>
17101 <para>The quick slip only includes items that were checked
17108 <para>ISSUESLIP</para>
17112 <para>Used to print a full slip in circulation</para>
17116 <para>The slip or receipt will show items checked out today
17117 as well as items that are still checked out</para>
17123 <para>RESERVESLIP</para>
17127 <para>Used to print a holds slip</para>
17131 <para>The holds slip is generated when a hold is
17138 <para>TRANSFERSLIP</para>
17142 <para>Used to print a transfer slip</para>
17146 <para>The transfer slip is printed when you confirm a
17147 transfer from one branch to another in your system</para>
17155 <section id="noticetriggers">
17156 <title>Overdue Notice/Status Triggers</title>
17160 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17161 and Circulation > Overdue Notice/Status Triggers</para>
17165 <para>In order to send the overdue notices that you defined using the
17166 <link linkend="notices">Notices</link> tool, you need to first set the
17167 triggers to have these messages.</para>
17170 <para>In order to have overdue notices sent to your patrons, you
17171 need to <link linkend="addingpatroncat">set that patron
17172 category</link> to require overdue notices.</para>
17175 <para>The Overdue Notice/Status Triggers tool gives the librarian the
17176 power to send up to three notices to each patron type notifying them
17177 of overdue items</para>
17180 <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
17184 <imagedata fileref="images/tools/triggers.png"/>
17191 <para>Delay is the number of days after an issue is due before an
17192 action is triggered.</para>
17197 <para>If you want Koha to trigger an action (send a letter
17198 or restrict member), a delay value is required.</para>
17205 <para>To send additional notices, click on the tabs for 'Second'
17206 and 'Third' notice</para>
17210 <para>If you would like to prevent a patron from checking items
17211 out because of their overdue items, check the 'Restrict' box, this
17212 will put a notice on the patron's record at checkout informing the
17213 librarian that the patron cannot check out due to overdue
17218 <para>See a <link linkend="samplenotice">Sample Overdue
17219 Notice</link></para>
17224 <section id="patroncardcreator">
17225 <title>Patron Card Creator</title>
17229 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17230 and Circulation > Patron Card Creator</para>
17234 <para>The Patron Card Creator allow you to use layouts and templates
17235 which you design to print a nearly unlimited variety of patron cards
17236 including barcodes. Here are some of the features of the Patron Card
17237 Creator module:</para>
17241 <para>Customize patron card layouts</para>
17245 <para>Design custom card templates for printed patron cards</para>
17249 <para>Build and manage batches of patron cards</para>
17253 <para>Export single or multiple batches</para>
17257 <para>Export single or multiple patron cards from within a
17262 <para>Export card data as a PDF readable by any standard PDF
17263 reader, making patron cards printable directly on a printer</para>
17267 <para>At the top of each screen within the Patron Card Creator, you
17268 will see a toolbar allowing quick access to relevant functions. The
17269 menu to the left of each screen also allows easy access to the
17270 different sections of the Patron Card Creator. The bread crumb trail
17271 near the top of each screen will give specific indication as to where
17272 you are within the Patron Card Creator module and allow quick
17273 navigation to previously traversed sections. And finally, you can find
17274 more detailed information on each section of the Patron Card Creator
17275 by clicking the online help link at the upper left-hand corner of
17278 <section id="patrontemplate">
17279 <title>Templates</title>
17283 <para><emphasis>Get there:</emphasis> More > Tools >
17284 Patron Card Creator > Templates</para>
17288 <para>A template is the label/card stock you are using. This might
17289 be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
17290 Avery 28371 for your patron cards, just to give a couple of
17291 examples. These labels will include all of the information you will
17292 need for setting up a Koha, this information may be on the
17293 packaging, and if not it can usually be found on the vendor's
17296 <section id="addcardtemplate">
17297 <title>Add a Template</title>
17299 <para>To add a new template, you want to click on the 'Templates'
17300 button at the top of your page and choose 'New Template'</para>
17303 <screeninfo>New Template Button</screeninfo>
17307 <imagedata fileref="images/tools/patroncards/newtemplate.png"/>
17312 <para>Using the form that appears you can define the template for
17313 your sheet of labels or cards.</para>
17316 <screeninfo>Add Patron Card Template</screeninfo>
17320 <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
17327 <para>Template ID will be automatically generated after saving
17328 your template, this is simply a system generated unique
17333 <para>Template Code should be something you can use to
17334 identify your template on a list of templates</para>
17338 <para>You can use the Template Description to add additional
17339 information about the template</para>
17343 <para>The Units pull down is used to define what measurement
17344 scale you're going to be using for the template. This should
17345 probably match the unit of measurement used on the template
17346 description provided by the product vendor.</para>
17349 <screeninfo>Measurement Units</screeninfo>
17353 <imagedata fileref="images/tools/patroncards/units.png"/>
17360 <para>The measurements can be found on the vendor product
17361 packaging or website.</para>
17365 <para>A profile is a set of "adjustments" applied to a given
17366 template just prior to printing which compensates for
17367 anomalies unique and peculiar to a given printer (to which the
17368 profile is assigned).</para>
17372 <para>Before picking a profile try printing some sample
17373 cards so that you can easily define a profile that is
17374 right for your printer/template combination.</para>
17378 <para>After finding any anomalies in the printed document,
17379 <link linkend="addcardprofile">create a profile</link> and
17380 assign it to the template.</para>
17386 <para>After saving, your templates will appear on the 'Manage
17387 Templates' page.</para>
17390 <screeninfo>Manage Templates</screeninfo>
17394 <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
17401 <section id="patronprofile">
17402 <title>Profiles</title>
17406 <para><emphasis>Get there:</emphasis> More > Tools >
17407 Patron Card Creator > Profiles</para>
17411 <para>A profile is a set of "adjustments" applied to a given <link
17412 linkend="patrontemplate">template</link> just prior to printing
17413 which compensates for anomalies unique and peculiar to a given
17414 printer (to which the profile is assigned). This means if you set a
17415 template up and then print a sample set of data and find that the
17416 items are not all aligned the same on each card, you need to set up
17417 a profile for each printer to make up for the differences in
17418 printing styles, such as the shifting of text to the left, right,
17419 top or bottom.</para>
17421 <para>If your cards are printing just the way you want, you will not
17422 need a profile.</para>
17424 <section id="addcardprofile">
17425 <title>Add a Profile</title>
17427 <para>To add a new profile, you want to click on the 'Profiles'
17428 button at the top of your page and choose 'New Profile'</para>
17431 <screeninfo>New Profile Button</screeninfo>
17435 <imagedata fileref="images/tools/patroncards/newprofile.png"/>
17440 <para>Using the form that appears you can create a profile to fix
17441 any problems with your template.</para>
17444 <screeninfo>Add Printer Profile</screeninfo>
17448 <imagedata fileref="images/tools/patroncards/addprofile.png"/>
17455 <para>The Printer Name and Paper Bin do not have to match your
17456 printer exactly, they are for your reference so you can
17457 remember what printer you have set the profile for. So if you
17458 want to use the Printer model number in printer name or you
17459 can call it 'the printer on my desk'</para>
17463 <para>Template will be filled in once you have chosen which
17464 template to apply the profile to on the <link
17465 linkend="addcardtemplate">template edit form</link></para>
17469 <para>The Units pull down is used to define what measurement
17470 scale you're going to be using for your profile.</para>
17473 <screeninfo>Units of Measurement</screeninfo>
17477 <imagedata fileref="images/tools/patroncards/units.png"/>
17484 <para>Offset describes what happens when the entire image is
17485 off center either vertically or horizontally and creep
17486 describes a condition where the distance between the labels
17487 changes across the page or up and down the page</para>
17491 <para>For these values, negative numbers move the error up
17492 and to the left and positive numbers move the error down
17493 and to the right</para>
17497 <para>Example: the text is .25" from the left edge of the
17498 first label, .28" from the left edge of the second label
17499 and .31" from the left edge of the third label. This means
17500 the horizontal creep should be set to .03" to make up for
17501 this difference.</para>
17507 <para>After saving, your profiles will appear on the 'Manage
17508 Profiles' page.</para>
17511 <screeninfo>Manage Profiles</screeninfo>
17515 <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
17520 <para>Once you have saved your new profile, you can return to the
17521 list of templates and choose to edit the template that this
17522 profile is for.</para>
17526 <section id="cardlayouts">
17527 <title>Layouts</title>
17531 <para><emphasis>Get there:</emphasis> More > Tools >
17532 Patron Card Creator > Layouts</para>
17536 <para>A layout defines the text and images that will be printed on
17537 to the card and where it will appear.</para>
17539 <section id="addcardlayout">
17540 <title>Add a Layout</title>
17542 <para>To add a new layout, you want to click on the 'Layouts'
17543 button at the top of your page and choose 'New Layout'</para>
17546 <screeninfo>New Layout Button</screeninfo>
17550 <imagedata fileref="images/tools/patroncards/newlayout.png"/>
17555 <para>Using the form that appears you can create a profile to fix
17556 any problems with your template.</para>
17559 <screeninfo>Add New Layout</screeninfo>
17563 <imagedata fileref="images/tools/patroncards/addlayout.png"/>
17570 <para>The name you assign to the layout is for your benefit,
17571 name it something that will be easy to identify at a later
17576 <para>The Units pull down is used to define what measurement
17577 scale you're going to be using for your layout.</para>
17580 <screeninfo>Units of Measurement</screeninfo>
17584 <imagedata fileref="images/tools/patroncards/units.png"/>
17591 <para>Next note if this layout is for the front or the back of
17592 the patron card</para>
17596 <para>You will need a layout for both the front and back
17597 of your card if you have 2-sided library cards</para>
17603 <para>You have the option of adding up to 3 lines of text to
17604 your card. Your text can be static text of your choosing
17605 and/or fields from the patron record. If you want to print
17606 fields from the patron record you want to put the field names
17607 in brackets like so - <firstname></para>
17611 <para>For each line of text, you can choose your font, font
17612 size and the location of the text on the card using the lower
17613 X and Y coordinates</para>
17617 <para>In order to show the barcode and the patron card number
17618 you will need to check the 'Print Card Number as Barcode'
17619 option. This will turn the patron card number into a barcode.
17620 If you want the number to print in human readable format you
17621 will need to check the 'Print Card Number as Text Under
17622 Barcode' option.</para>
17626 <para>Finally you can choose up to two images to print on the
17631 <para>One can be the <link
17632 linkend="uploadpatronimages">patron image</link> which you
17633 can resize to meet your needs.</para>
17637 <para>The other image can be something like a library logo
17638 or symbol that you uploaded using the '<link
17639 linkend="managecardimages">Manage Images</link>' module of
17640 the Patron Card Creator Tool.</para>
17646 <para>After saving, your layouts will appear on the 'Manage
17647 Layouts' page.</para>
17650 <screeninfo>Manage Layouts</screeninfo>
17654 <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
17661 <section id="patroncardbatches">
17662 <title>Batches</title>
17666 <para><emphasis>Get there:</emphasis> More > Tools >
17667 Patron Card Creator > Batches</para>
17671 <para>A batch is a collection of patrons for whom you want to
17672 generate cards.</para>
17674 <section id="addcardbatch">
17675 <title>Add a Batch</title>
17677 <para>To add a new batch, you want to click on the 'Batches'
17678 button at the top of your page and choose 'New Batch'</para>
17681 <screeninfo>New Batch Button</screeninfo>
17685 <imagedata fileref="images/tools/patroncards/newbatch.png"/>
17694 <section id="managecardimages">
17695 <title>Manage Images</title>
17699 <para><emphasis>Get there:</emphasis> More > Tools >
17700 Patron Card Creator > Manage Images</para>
17704 <para>Images uploaded using this tool will appear on the menu when
17705 creating <link linkend="cardlayouts">patron card layouts</link>. You
17706 are limited in how many images you can upload (not counting patron
17707 images) by the <link linkend="ImageLimit">ImageLimit</link> system
17711 <para>Images must be under 500k in size.</para>
17715 <para>Pictures uploaded with this tool should be at least 300dpi
17716 which is the minimum quality for a printable image.</para>
17719 <para>In the center of the screen is a simple upload form, simply
17720 browse for the file on your computer and give it a name you'll
17721 recognize later.</para>
17724 <screeninfo>Upload Images</screeninfo>
17728 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
17733 <para>Once the file is uploaded you will be presented with a
17734 confirmation message.</para>
17737 <screeninfo>Image Uploaded</screeninfo>
17741 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
17746 <para>And the image will be listed with all of your others on the
17747 right hand side of the page.</para>
17750 <screeninfo>Images</screeninfo>
17754 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
17759 <para>To delete one or multiple of these images, click the checkbox
17760 to the right of each image you want to delete and click the 'Delete'
17765 <section id="anonpatrons">
17766 <title>Patrons (anonymize, bulk-delete)</title>
17770 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17771 and Circulation > Patrons (anonymize, bulk-delete)</para>
17775 <para>This tool allows you to bulk anonymize circulation histories
17776 (this means that you keep records of how many times items were checked
17777 out - but not the patrons who checked the items out) or bulk delete
17778 patrons (remove them from the system completely).<important>
17779 <para>Patrons with outstanding fines or items checked out are not
17780 saved. They are not completely removed from the system (moved to
17781 the delete_borrowers table), but this tool does not provide as
17782 many checks as one may desire.</para>
17783 </important></para>
17786 <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
17790 <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
17795 <para>To either delete or anonymize patrons</para>
17799 <para>Check the task you would like to perform (Delete or
17804 <para>Enter a date before which you want to alter the data</para>
17808 <para>Click 'Next'</para>
17812 <para>A confirmation will appear asking if you're sure this is
17813 what you want to happen</para>
17816 <screeninfo>Patron Anonymize/Bulk Delete
17817 Confirmation</screeninfo>
17821 <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
17828 <para>Clicking 'Finish' will delete or anonymize your data</para>
17831 <screeninfo>Completed Process</screeninfo>
17835 <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
17843 <section id="tagsmoderation">
17844 <title>Tag Moderation</title>
17848 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17849 and Circulation > Tags</para>
17853 <para>Depending on your <link linkend="taggingprefs">tagging system
17854 preferences</link>, librarians may need to approve tags before they
17855 are published on the OPAC. This is done via the Tag Moderation Tool.
17856 If there are tags awaiting moderation they will be listed on the main
17857 staff dashboard under the Tools label:</para>
17860 <screeninfo>Tags pending approval</screeninfo>
17864 <imagedata fileref="images/tools/tagging/pendingtags.png"/>
17869 <para>To moderate the tags visit the Tags tool. When first visiting
17870 the tool, you will be presented with a list of tags that are pending
17871 approval or rejection by a librarian</para>
17874 <screeninfo>Tags pending moderation</screeninfo>
17878 <imagedata fileref="images/tools/tagging/tagpending.png"/>
17885 <para>To approve a tag, you can either click the 'Approve' button
17886 in line with the term, or check all terms you want to approve and
17887 click 'Approve' below the table.</para>
17891 <para>To reject a tag, you can either click the 'Reject' button in
17892 line with the term, or check all terms you want to approve and
17893 click 'Reject' below the table.</para>
17897 <para>Once a tag has been approved or rejected it will be moved to the
17898 appropriate list of tags. A summary of all tags will appear on the
17899 right of the screen.</para>
17902 <screeninfo>Summary of tags</screeninfo>
17906 <imagedata fileref="images/tools/tagging/tagsummary.png"/>
17911 <para>Even though a tag is approved or rejected, it can still be moved
17912 to another list. When viewing approved tags each tag has the option to
17916 <screeninfo>Approved Tags</screeninfo>
17920 <imagedata fileref="images/tools/tagging/tagapproved.png"/>
17925 <para>To check terms against the approved and rejected lists (and
17926 possibly against <link linkend="TagsExternalDictionary">the
17927 dictionary</link> you have assigned for tag moderation) simply enter
17928 the term into the search box on the bottom right of the screen to see
17929 the status of the term</para>
17932 <screeninfo>Sample Blacklist/Whitelist test search</screeninfo>
17936 <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
17942 <section id="uploadpatronimages">
17943 <title>Upload Patron Images</title>
17947 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
17948 and Circulation > Upload Patron Images</para>
17952 <para>Patron images can be uploaded in bulk if you are <link
17953 linkend="patronimages">allowing patron images</link> to be attached to
17954 patron records. These images can also be used when creating <link
17955 linkend="patroncardcreator">patron cards</link>.</para>
17959 <para>Create a txt file and title it "DATALINK.TXT" or
17960 "IDLINK.TXT"</para>
17964 <para>On each line in the text file enter the patron's card number
17965 followed by comma (or tab) and then the image file name</para>
17968 <screeninfo>Sample file and image</screeninfo>
17972 <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
17979 <para>Make sure that your TXT file is a plain text document,
17986 <para>Zip up the text file and the image files</para>
17990 <para>Go to the Upload Patron Images Tool</para>
17993 <screeninfo>Upload Image Tool for Single Image</screeninfo>
17997 <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
18004 <para>For a single image, simply point to the image file and enter
18005 the patron card number</para>
18009 <para>For multiple images, choose to upload a zip file</para>
18013 <para>After uploading you will be presented with a
18014 confirmation</para>
18017 <screeninfo>Image Upload Confirmation</screeninfo>
18021 <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
18029 <para>There is a limit of 520K on the size of the picture uploaded
18030 and it is recommended that the image be 200x300 pixels, but smaller
18031 images will work as well.</para>
18036 <section id="catalogtools">
18037 <title>Catalog</title>
18041 <section id="batchmodifyitems">
18042 <title>Batch item modification</title>
18046 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18047 > Batch item modification</para>
18051 <para>This tool will allow you to modify a batch of item records in
18055 <screeninfo>Batch Modification Tool</screeninfo>
18059 <imagedata fileref="images/tools/batchmod/batchmod.png"/>
18064 <para>From the tool you can choose to upload a file of barcodes or
18065 item ids, or you can scan items one by one into the box below the
18066 upload tool. Once you have your file uploaded or the barcodes listed
18067 you can click 'Continue.'</para>
18070 <screeninfo>Batch Modify Summary</screeninfo>
18074 <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
18079 <para>You will be presented with a summary of the items you want to
18080 modify. From here you can uncheck the items you don't want to modify
18081 before making changes in the form below. You can also hide columns you
18082 don't need to see to prevent having to scroll from left to right to
18083 see the entire item form.</para>
18085 <para>Using the edit form you can choose which fields to make edits
18086 to. By checking the checkbox to the right of each field you can clear
18087 the values in that field for the records you are modifying.</para>
18090 <screeninfo>Choose fields you want to change in bulk</screeninfo>
18094 <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
18099 <para>Once you have made you changes you will be presented with the
18100 resulting items.</para>
18103 <screeninfo>Item results summary</screeninfo>
18107 <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
18113 <section id="batchdeleteitems">
18114 <title>Batch item deletion</title>
18118 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18119 > Batch item deletion</para>
18123 <para>This tool will allow you to delete a batch of item records from
18126 <para>From the tool you can choose to upload a file of barcodes or
18127 item ids, or you can scan items one by one into the box below the
18128 upload tool.</para>
18131 <screeninfo>Batch Deletion Tool</screeninfo>
18135 <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
18140 <para>Once you have your file uploaded or the barcodes scanned you can
18141 click 'Continue.'</para>
18143 <para>You will be presented with a confirmation screen. From here you
18144 can uncheck the items you don't want to delete and decide if Koha
18145 should delete the bib record if the last item is being deleted before
18146 clicking 'Delete selected items.'</para>
18149 <screeninfo>Confirm Deletion</screeninfo>
18153 <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
18158 <para>If your file (or list of scanned barcodes) has more than 1000
18159 barcodes, Koha will be unable to present you with a list of the items.
18160 You will still be able to delete them, but not able to choose which
18161 items specifically to delete or delete the biblio records.</para>
18164 <screeninfo>More than 1000 records in the file</screeninfo>
18168 <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
18173 <para>If the items are checked out you will be presented with an error
18174 after clicking 'Delete selected items' and the items will not be
18178 <screeninfo>Items not Deleted</screeninfo>
18182 <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
18187 <para>If the items can be deleted they will be and you will be
18188 presented with a confirmation of your deletion.</para>
18191 <screeninfo>Batch Deletion Confirmation</screeninfo>
18195 <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
18201 <section id="exportbibs">
18202 <title>Export Bibliographic and Holdings Data (MARC Export)</title>
18206 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18207 > Export Bibliographic and Holdings Data</para>
18211 <para>Koha comes with a tool that will allow you to export your
18212 bibliographic and/or holdings data in bulk. This can be used to send
18213 your records to fellow libraries, organizations or services; or simply
18214 for backup purposes.</para>
18218 <para>Fill in the form in order to limit your export to a specific
18219 range (all fields are optional)</para>
18222 <screeninfo>Select Records to Export</screeninfo>
18226 <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
18233 <para>Choose to limit your export by any one or more of the
18234 following options</para>
18238 <para>Limit to a bib number range</para>
18242 <para>Limit to a specific item type</para>
18246 <para>Limit to a specific library</para>
18250 <para>Limit to a call number range</para>
18254 <para>Limit to an acquisition date range</para>
18260 <para>Next choose what to skip when exporting</para>
18263 <screeninfo>Export options</screeninfo>
18267 <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
18274 <para>By default items will be exported, if you would like
18275 to only export bibliographic data, check the 'Don't export
18280 <para>To limit your export only to items from the library
18281 you're logged in as (if you leave the 'Library' field set
18282 to 'All') or to the library you selected above check the
18283 'Remove non-local items' box</para>
18287 <para>You can also choose what fields you don't want to
18288 export. This can be handy if you're sharing your data, you
18289 can remove all local fields before sending your data to
18290 another library</para>
18296 <para>Finally choose the file type and file name</para>
18299 <screeninfo>File export format</screeninfo>
18303 <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
18310 <para>Choose to export your data in marc or marcxml
18315 <para>Choose the name you want your file to save as</para>
18321 <para>Click 'Export'</para>
18328 <section id="inventory">
18329 <title>Inventory/Stocktaking</title>
18333 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18334 > Inventory/Stocktaking</para>
18338 <para>Koha's Inventory Tool can be used in one of two ways, the first
18339 is by printing out a shelf list that you can then mark items off on,
18340 or by uploading a text files of barcodes gathered by a portable
18343 <para>If you do not have the ability to use your barcode scanner on
18344 the floor of the library, the first option available to you is to
18345 generate a shelf list based on criteria you enter.</para>
18348 <screeninfo>Inventory & Stocktaking Tool</screeninfo>
18352 <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
18357 <para>Choose which library, shelving location, call number range, item
18358 status and when the item was last seen to generate a shelf list that
18359 you can then print to use while walking around the library checking
18360 your collection</para>
18363 <screeninfo>Shelf List</screeninfo>
18367 <imagedata fileref="images/tools/inventory/shelflist.png"/>
18372 <para>Alternatively you can export the list to a CSV file for altering
18373 in an application on your desktop. Simply check the box next to
18374 'Export to csv file' to generate this file.</para>
18376 <para>Once you have found the items on your shelves you can return to
18377 this list and check off the items you found to have the system update
18378 the last seen date to today.</para>
18380 <para>If you have a portable scanner (or a laptop and USB scanner) you
18381 can walk through the library with the scanner in hand and scan
18382 barcodes as you come across them. Once finished you can then upload
18383 the text file generated by the scanner to Koha</para>
18386 <screeninfo>Barcode Import for Inventory Tool</screeninfo>
18390 <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
18395 <para>Choose the text file and the date you want to mark all items as
18396 seen and click 'Submit.'</para>
18399 <section id="labelcreator">
18400 <title>Label Creator</title>
18404 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18405 > Label Creator</para>
18409 <para>The Label Creator allow you to use layouts and templates which
18410 you design to print a nearly unlimited variety of labels including
18411 barcodes. Here are some of the features of the Label Creator
18416 <para>Customize label layouts</para>
18420 <para>Design custom label templates for printed labels</para>
18424 <para>Build and manage batches of labels</para>
18428 <para>Export single or multiple batches</para>
18432 <para>Export single or multiple labels from within a batch</para>
18436 <para>Export label data in one of three formats:</para>
18440 <para>PDF - Readable by any standard PDF reader, making labels
18441 printable directly on a printer</para>
18445 <para>CSV - Export label data after your chosen layout is
18446 applied allowing labels to be imported in to a variety of
18447 applications</para>
18451 <para>XML - Included as an alternate export format</para>
18457 <para>At the top of each screen within the Label Creator, you will see
18458 a toolbar allowing quick access to relevant functions. The menu to the
18459 left of each screen also allows easy access to the different sections
18460 of the Label Creator. The bread crumb trail near the top of each
18461 screen will give specific indication as to where you are within the
18462 Label Creator module and allow quick navigation to previously
18463 traversed sections. And finally, you can find more detailed
18464 information on each section of the Label Creator by clicking the
18465 online help link at the upper left-hand corner of every page.</para>
18467 <section id="labeltemplates">
18468 <title>Templates</title>
18472 <para><emphasis>Get there:</emphasis> More > Tools > Label
18473 Creator > Templates</para>
18477 <para>A template is based on the label/card stock you are using.
18478 This might be Avery 5160 for address labels, Gaylord 47-284 for
18479 spine labels or Avery 28371 for your patron cards, just to give a
18480 couple of examples. These labels will include all of the information
18481 you will need for setting up a Koha, this information may be on the
18482 packaging, and if not it can usually be found on the vendor's
18485 <section id="addlabeltemplate">
18486 <title>Add a Template</title>
18488 <para>To add a new template, you want to click on the 'Templates'
18489 button at the top of your page and choose 'New Template'</para>
18492 <screeninfo>New Label Template Option</screeninfo>
18496 <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
18501 <para>Using the form that appears you can define the template for
18502 your sheet of labels or cards.</para>
18505 <screeninfo>Label Template Form</screeninfo>
18509 <imagedata fileref="images/tools/labelcreator/labelform.png"/>
18516 <para>Template ID will be automatically generated after saving
18517 your template, this is simply a system generated unique
18522 <para>Template Code should be something you can use to
18523 identify your template on a list of templates</para>
18527 <para>You can use the Template Description to add additional
18528 information about the template</para>
18532 <para>The Units pull down is used to define what measurement
18533 scale you're going to be using for the template. This should
18534 probably match the unit of measurement used on the template
18535 description provided by the product vendor.</para>
18538 <screeninfo>Measurement Units</screeninfo>
18542 <imagedata fileref="images/tools/patroncards/units.png"/>
18549 <para>The measurements, number of columns and number of rows
18550 can be found on the vendor product packaging or
18556 <para>If you do not supply a left text margin in the
18557 template, a 3/16" (13.5 point) left text margin will
18558 apply by default.</para>
18565 <para>A profile is a set of "adjustments" applied to a given
18566 template just prior to printing which compensates for
18567 anomalies unique and peculiar to a given printer (to which the
18568 profile is assigned).</para>
18572 <para>Before picking a profile try printing some sample
18573 labels so that you can easily define a profile that is
18574 right for your printer/template combination.</para>
18578 <para>After finding any anomalies in the printed document,
18579 <link linkend="addlabelprofile">create a profile</link>
18580 and assign it to the template.</para>
18586 <para>After saving, your templates will appear on the 'Manage
18587 Templates' page.</para>
18590 <screeninfo>List of label templates</screeninfo>
18594 <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
18601 <section id="labelprofiles">
18602 <title>Profiles</title>
18606 <para><emphasis>Get there:</emphasis> More > Tools > Label
18607 Creator > Profiles</para>
18611 <para>A profile is a set of "adjustments" applied to a given <link
18612 linkend="addlabeltemplate">template</link> just prior to printing
18613 which compensates for anomalies unique and peculiar to a given
18614 printer (to which the profile is assigned). This means if you set a
18615 template up and then print a sample set of data and find that the
18616 items are not all aligned the same on each label, you need to set up
18617 a profile for each printer to make up for the differences in
18618 printing styles, such as the shifting of text to the left, right,
18619 top or bottom.</para>
18621 <para>If your labels are printing just the way you want, you will
18622 not need a profile.</para>
18624 <section id="addlabelprofile">
18625 <title>Add a Profile</title>
18627 <para>To add a new profile, you want to click on the 'Profiles'
18628 button at the top of your page and choose 'New Profile'</para>
18631 <screeninfo>New Profile Button</screeninfo>
18635 <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
18640 <para>Using the form that appears you can create a profile to fix
18641 any problems with your template.</para>
18644 <screeninfo>Create a Printer Profile</screeninfo>
18648 <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
18655 <para>The Printer Name and Paper Bin do not have to match your
18656 printer exactly, they are for your reference so you can
18657 remember what printer you have set the profile for. So if you
18658 want to use the Printer model number in printer name or you
18659 can call it 'the printer on my desk'</para>
18663 <para>Template will be filled in once you have chosen which
18664 template to apply the profile to on the <link
18665 linkend="addlabeltemplate">template edit form</link></para>
18669 <para>The Units pull down is used to define what measurement
18670 scale you're going to be using for your profile.</para>
18673 <screeninfo>Units of Measurement</screeninfo>
18677 <imagedata fileref="images/tools/patroncards/units.png"/>
18684 <para>Offset describes what happens when the entire image is
18685 off center either vertically or horizontally and creep
18686 describes a condition where the distance between the labels
18687 changes across the page or up and down the page</para>
18691 <para>For these values, negative numbers move the error up
18692 and to the left and positive numbers move the error down
18693 and to the right</para>
18697 <para>Example: the text is .25" from the left edge of the
18698 first label, .28" from the left edge of the second label
18699 and .31" from the left edge of the third label. This means
18700 the horizontal creep should be set to .03" to make up for
18701 this difference.</para>
18707 <para>After saving, your profiles will appear on the 'Manage
18708 Profiles' page.</para>
18711 <screeninfo>List of Profiles</screeninfo>
18715 <imagedata fileref="images/tools/labelcreator/profiles.png"/>
18720 <para>Once you have saved your new profile, you can return to the
18721 list of templates and choose to edit the template that this
18722 profile is for.</para>
18726 <section id="labellayouts">
18727 <title>Layouts</title>
18731 <para><emphasis>Get there:</emphasis> More > Tools > Label
18732 Creator > Layouts</para>
18736 <para>A layout is used to define the fields you want to appear on
18737 your labels.</para>
18739 <section id="addlabellayout">
18740 <title>Add a Layout</title>
18742 <para>To add a new layout, you want to click on the 'Layouts'
18743 button at the top of your page and choose 'New Layout'</para>
18746 <screeninfo>New Layout Button</screeninfo>
18750 <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
18755 <para>Using the form that appears you can create a profile to fix
18756 any problems with your template.</para>
18759 <screeninfo>Add New Layout</screeninfo>
18763 <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
18770 <para>The name of your layout can be anything you'd like to
18771 help you identify it later.</para>
18775 <para>If this is a barcode label you'll want to choose the
18776 encoding (Code 39 is the most common)</para>
18780 <para>The layout type can be any combination of bibliographic
18781 information and/or barcode. For example a spine label would
18782 just be Biblio whereas a label for your circulation staff to
18783 use to checkout the book would probably be
18784 Biblio/Barcode.</para>
18788 <para>The Bibliographic Data to Print includes any of the data
18789 fields that may be mapped to your MARC frameworks. You can
18790 choose from the preset list of fields or you can click on
18791 'List Fields' and enter your own data. In 'List Fields', you
18792 can specify MARC subfields as a 4-character tag-subfield
18793 string: (ie. 254a for the title field), You can also enclose a
18794 whitespace-separated list of fields to concatenate on one line
18795 in double quotes. (ie. "099a 099b" or "itemcallnumber
18796 barcode"). The fields available are from the database tables
18797 list below. Finally you could add in static text strings in
18798 single-quote (ie. 'Some static text here.')</para>
18802 <para>You can use the schema viewer (<ulink
18803 url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
18804 with the following tables to find field names to
18809 <para>Currently all fields in the following tables are
18810 used: items, biblioitems, biblio, branches</para>
18813 <screeninfo>List fields</screeninfo>
18817 <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
18828 <para>Choose if the label maker should print out the
18829 guidelines around each label</para>
18833 <para>Choose if you'd like Koha to try to split your call
18834 numbers (usually used on Spine Labels)</para>
18838 <para>Finally choose your text settings such as alignment,
18839 font type and size.</para>
18843 <para>After saving, your layouts will appear on the 'Manage
18844 Layouts' page.</para>
18848 <section id="labelbatches">
18849 <title>Batches</title>
18853 <para><emphasis>Get there:</emphasis> More > Tools > Label
18854 Creator > Batches</para>
18858 <para>Batches are made up of the barcodes you would like to print.
18859 Once in this tool you can search for the item records you would like
18860 to print out labels for.</para>
18862 <section id="addlabelbatch">
18863 <title>Add a Batch</title>
18865 <para>Batches can be created in one of two ways. The first is to
18866 click the 'Create Label Batch' link on the '<link
18867 linkend="managestaged">Staged MARC Management</link>' page:</para>
18870 <screeninfo>Create Label Batch Link on Staged Records
18875 <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
18880 <para>The other is to choose to create a new batch from the label
18881 creator tool</para>
18884 <screeninfo>Create New Batch</screeninfo>
18888 <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
18893 <para>You will be brought to an empty batch with an 'Add item(s)'
18894 button at the top of the page and a box to scan barcodes in
18898 <screeninfo>Add Items</screeninfo>
18902 <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
18907 <para>You can either scan barcodes in to the box provided and
18908 click the 'Add item(s)' button or you can click the 'Add item(s)'
18909 button with the barcodes box empty. Clicking 'Add item(s)' with
18910 nothing in the barcodes box will open a search window for you to
18911 find the items you want to add to the batch.</para>
18914 <screeninfo>Search for items for a Batch</screeninfo>
18918 <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
18923 <para>From the search results, click the check box next to the
18924 items you want to add to the batch and click the 'Add checked'
18925 button. You can also add items one by one by clicking the 'Add'
18926 link to the left of each item.</para>
18929 <screeninfo>Batch search results</screeninfo>
18933 <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
18938 <para>Once you have added all of the items click the 'Done'
18939 button. The resulting page will list the items you have
18943 <screeninfo>List of items in the batch</screeninfo>
18947 <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
18952 <para>To print your labels, click the 'Export Batch' button. To
18953 print only some of the labels, click the 'Export Item(s)' button.
18954 Either way you will be presented with a confirmation screen where
18955 you can choose your template and layout.</para>
18958 <screeninfo>Start batch export</screeninfo>
18962 <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
18967 <para>You will then be presented with three download options: PDF,
18968 Excel, and CSV.</para>
18971 <screeninfo>Batch save options</screeninfo>
18975 <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
18980 <para>After saving your file, simply print to the blank labels you
18981 have in your library.</para>
18986 <section id="quicklabelcreator">
18987 <title>Quick Spine Label Creator</title>
18991 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
18992 > Quick Spine Label Creator</para>
18997 <para>This tool does not use the label layouts or templates, it
18998 simply prints a spine label in the first spot on the label
19003 <para>Define the fields you want to print on the spine label in
19004 the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
19005 system preference</para>
19009 <para>Format your label printing by editing spinelabel.css found
19010 in koha-tmpl/intranet-tmpl/prog/en/css/</para>
19015 <para>To use this tool you simply need the barcode for the book you'd
19016 like to print the spine label for.</para>
19019 <screeninfo>Quick Spine Label Creator</screeninfo>
19023 <imagedata fileref="images/tools/quickspinelable.png"/>
19029 <section id="stagemarc">
19030 <title>Stage MARC Records for Import</title>
19034 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19035 > Stage MARC records for import</para>
19039 <para>Importing records into Koha includes two steps. The first is to
19040 stage records for import.</para>
19044 <para>First find the MARC file on your computer</para>
19047 <screeninfo>Stage MARC Records for Import</screeninfo>
19051 <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
19058 <para>Next you will be presented with options for record matching
19059 and item imports</para>
19062 <screeninfo>Upload options</screeninfo>
19066 <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
19073 <para>Enter 'Comments about this file' to identify your upload
19074 when going to the '<link linkend="managestaged">Manage Staged
19075 MARC Records</link>' tool</para>
19079 <para>Choose the character encoding</para>
19083 <para>Choose whether or not you want to look for matching
19088 <para>You can set up <link
19089 linkend="recordmatchingrules">record matching rules</link>
19090 through the administration area</para>
19096 <para>Next choose what to do with matching records if they are
19101 <para>Finally choose what to do with records that are
19106 <para>Next you can choose whether or not to import the item
19107 data found in the MARC records</para>
19113 <para>Click 'Stage for import'</para>
19117 <para>You will be presented with a confirmation of your MARC
19121 <screeninfo>MARC Import Confirmation</screeninfo>
19125 <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
19132 <para>To complete the process continue to the <link
19133 linkend="managestaged">Managed Staged MARC Records
19139 <section id="managestaged">
19140 <title>Staged MARC Record Management</title>
19144 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19145 > Staged MARC Record Management</para>
19149 <para>Once you have <link linkend="stagemarc">staged</link> your
19150 records for import you can complete the import using this tool.</para>
19153 <screeninfo>List of Staged MARC Records</screeninfo>
19157 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
19164 <para>From the list of staged records, click on the file name that
19165 you want to finish importing</para>
19169 <para>You will note that records that have already been
19170 imported will say so under 'Status'</para>
19176 <para>A summary of your import will appear along with the option
19177 to change your matching rules</para>
19180 <screeninfo>Manage Staged Records Batch</screeninfo>
19184 <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
19191 <para>Below the summary is the option to import the batch of bib
19192 records using a specific framework</para>
19195 <screeninfo>Choose Framework to Import Into</screeninfo>
19199 <imagedata fileref="images/tools/marcimport/importframework.png"/>
19206 <para>Choosing a framework other than 'Default' isn't
19207 necessary, but it's helpful for running reports and having the
19208 right bib level item type selected on import.</para>
19214 <para>Below the framework selection there will be a list of the
19215 records that will be imported</para>
19218 <screeninfo>List of Staged Records</screeninfo>
19222 <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
19229 <para>Review your summary before completing your import to
19230 make sure that your matching rule worked and that the records
19231 appear as you expect them to</para>
19237 <para>Click 'Import into catalog' to complete the import</para>
19240 <screeninfo>Import summary</screeninfo>
19244 <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
19251 <para>Once your import is complete a link to the new bib records
19252 will appear to the right of each title that was imported</para>
19256 <para>You can also undo your import by clicking the 'Undo import
19257 into catalog' button</para>
19261 <para>Records imported using this tool remain in the 'reservoir' until
19262 they are cleaned. These items will appear when searching the catalog
19263 from the <link linkend="cataloging">Cataloging</link> tool:</para>
19266 <screeninfo>Reservoir Results</screeninfo>
19270 <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
19275 <para>To clean items out of the 'reservoir':</para>
19279 <para>Visit the main screen of the Manage Staged MARC Records
19283 <screeninfo>List of Staged MARC Records</screeninfo>
19287 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
19294 <para>To clean a batch, click the 'Clean' button to the
19299 <para>You will be presented with a confirmation message</para>
19302 <screeninfo>Clean MARC Records Confirmation</screeninfo>
19306 <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
19313 <para>Accept the deletion and the records will be removed from
19314 the reservoir and the status will be changed to
19322 <section id="uploadlocalimages">
19323 <title>Upload Local Cover Image</title>
19327 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19328 > Upload Local Cover Image</para>
19332 <para>This tool will allow you to upload cover images for the
19333 materials in your catalog. To access this tool, staff will need the
19334 <link linkend="toolspermissions">upload_local_cover_images
19335 permission</link>. In order for images to show in the staff client
19336 and/or OPAC you will need to set your <link
19337 linkend="LocalCoverImages">LocalCoverImages</link> and/or <link
19338 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> preferences
19339 to 'Display.' Images can be uploaded in batches or one by one.</para>
19341 <para>If uploading a single image:</para>
19345 <para>Visit the tool and click the 'Browse' button to browse to
19346 the image on your local machine.</para>
19349 <screeninfo>Upload single cover image</screeninfo>
19353 <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
19360 <para>Click 'Upload file'</para>
19364 <para>Choose 'Image file' under the 'File type' section</para>
19368 <para>Enter the biblionumber for the record you're attaching this
19369 image to. This is not the same as the barcode, this is the system
19370 generated number assigned by Koha.</para>
19374 <para>Find the biblionumber by looking at the end of the URL
19375 in the address bar when on the detail page</para>
19378 <screeninfo>Biblionumber in URL</screeninfo>
19382 <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
19389 <para>or by clicking on the MARC tab on the detail page in the
19390 staff client</para>
19393 <screeninfo>Biblionumber on MARC Record</screeninfo>
19397 <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
19406 <para>If you would like to replace any other cover images you may
19407 have uploaded in the past, check the 'Replace existing covers' box
19408 under the 'Options' section</para>
19412 <para>Click 'Process images'</para>
19416 <para>You will be presented with a summary of the upload and a
19417 link to the record you have just added the image to</para>
19421 <para>If uploading a batch of images at once you will need to prepare
19422 a ZIP file first.</para>
19426 <para>Enter in to the ZIP file all the images you are
19431 <para>Also include a text file (*.TXT) named either datalink.txt
19432 or idlink.txt listing the biblionumber followed by the image name
19433 for each image one per line</para>
19437 <para>ex. 4091,image4091.jpg</para>
19440 <screeninfo>ZIP File Contents</screeninfo>
19444 <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
19453 <para>Browse your local computer to the ZIP file</para>
19457 <para>Click 'Upload file'</para>
19461 <para>Choose 'Zip file' under the 'File type' section</para>
19465 <para>If you would like to replace any other cover images you may
19466 have uploaded in the past, check the 'Replace existing covers' box
19467 under the 'Options' section</para>
19471 <para>Click 'Process images'</para>
19475 <para>You will be presented with a summary of the upload</para>
19478 <screeninfo>Upload Summary</screeninfo>
19482 <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
19489 <para>You will be able to see your cover images in the staff client on
19490 the detail page under the 'Image' tab in the holdings table at the
19494 <screeninfo>Cover images in the staff client</screeninfo>
19498 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
19503 <para>In the OPAC the cover images will also appear in the images tab,
19504 as well as next to the title and on the search results.</para>
19508 <section id="additionaltools">
19509 <title>Additional Tools</title>
19513 <section id="calholidays">
19514 <title>Calendar</title>
19518 <para><emphasis>Get there:</emphasis> More > Tools >
19519 Additional Tools > Calendar</para>
19523 <para>Libraries can define library closings and holidays to be used
19524 when calculating due dates. You can make use of the Calendar by
19525 turning on the proper system preferences:</para>
19529 <para><emphasis>Get there: </emphasis>More > Administration
19530 > Global System Preferences > Circulation > <link
19531 linkend="useDaysMode">useDaysMode</link></para>
19535 <para>Choose the method for calculating due date - either
19536 include days the library is closed in the calculation or don't
19537 include them.</para>
19543 <para><emphasis>Get there:</emphasis> More > Administration
19544 > Global System Preferences > Circulation > <link
19545 linkend="finesCalendar">finescalendar</link></para>
19549 <para>This will check the holiday calendar before charging
19557 <screeninfo>Calendar & Holidays Tools</screeninfo>
19561 <imagedata fileref="images/tools/calendar/calendar.png"/>
19566 <section id="addevents">
19567 <title>Adding Events</title>
19569 <para>Before adding events, choose the library you would like to
19570 apply the closings to. When adding events you will be asked if you
19571 would like to apply the event to one branch or all branches. To add
19572 events, simply</para>
19576 <para>Click on the date on the calendar that you would like to
19577 apply the closing to</para>
19580 <screeninfo>Calendar Add Form</screeninfo>
19584 <imagedata fileref="images/tools/calendar/calendaradd.png"/>
19591 <para>In the form that appears above the calendar, enter the
19592 closing information (for more info on each option click the
19593 question mark [?] to the right of the option)</para>
19597 <para>Library will be filled in automatically based on the
19598 library you chose from the pull down at the top of the
19603 <para>The day information will also be filled in
19604 automatically based on the date you clicked on the
19609 <para>In the description enter the reason the library is
19614 <para>Next you can choose if this event is a one time event
19615 or if it is repeatable.</para>
19619 <para>If this is a one day holiday choose 'Holiday only
19620 on this day'</para>
19624 <para>If this is a weekly closing (like a weekend day)
19625 then you can choose 'Holiday repeated every same day of
19630 <para>If this is an annual holiday closing choose
19631 'Holiday repeated yearly on the same date'</para>
19635 <para>If the library is going to be closed for the week
19636 or a range of time choose 'Holiday on a range' and enter
19637 a 'To Date' at the top</para>
19641 <para>If the library is going to be closed for a range
19642 of time each year (such as summer holidays for schools)
19643 choose 'Holiday repeated yearly on a range' and enter a
19644 'To Date' at the top</para>
19650 <para>Finally decide if this event should be applied to all
19651 libraries or just the one you have originally
19656 <para>If you'd rather enter all the holidays and then
19657 copy them all to another branch all at once you can use
19658 the copy menu below the calendar</para>
19661 <screeninfo>Copy holidays</screeninfo>
19665 <imagedata fileref="images/tools/calendar/copyholidays.png"/>
19676 <para>After saving you will see the event listed in the summary
19677 to the right the calendar</para>
19680 <screeninfo>Calendar Summary</screeninfo>
19684 <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
19692 <section id="editevents">
19693 <title>Editing Events</title>
19695 <para>To edit events</para>
19699 <para>Click on the event on the calendar that you want to change
19700 (do this by clicking on the date on the calendar, not the event
19701 listed in the summary)</para>
19704 <screeninfo>Edit holiday form</screeninfo>
19708 <imagedata fileref="images/tools/calendar/calendaredit.png"/>
19715 <para>From this form you can make edits to the holiday or delete
19716 the holiday completely. Both actions require that you click
19717 'Save' before the change will be made.</para>
19721 <para>Clicking on repeatable events will offer slightly
19722 different options</para>
19725 <screeninfo>Edit repeatable event</screeninfo>
19729 <imagedata fileref="images/tools/calendar/calendarexception.png"/>
19736 <para>In the form above you will note that there is now an
19737 option to 'Generate an exception for this repeated holiday,'
19738 choosing this option will allow you to make it so that this
19739 date is not closed even though the library is usually closed
19740 on this date.</para>
19747 <section id="calendarhelp">
19748 <title>Additional Help</title>
19750 <para>When adding or editing events you can get additional help by
19751 clicking on the question mark next to various different options on
19755 <screeninfo>Additional Calendar Help Buttons</screeninfo>
19759 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
19766 <section id="csvprofiles">
19767 <title>CSV Profiles</title>
19771 <para><emphasis>Get there:</emphasis> More > Tools >
19772 Additional Tools > CSV Profiles</para>
19776 <para>CSV Profiles are created to define how you would like your cart
19777 or list to export.</para>
19779 <section id="addcsvprofile">
19780 <title>Add CSV Profiles</title>
19782 <para>To add a CSV Profile</para>
19786 <para>Click 'CSV Profiles' from the Tools menu</para>
19789 <screeninfo>Add CSV Profile</screeninfo>
19793 <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
19800 <para>The 'Profile name' will appear on the export pull down
19801 list when choosing 'Download' from your cart or list</para>
19805 <para>The 'Profile description' is for your own
19810 <para>The 'CSV separator' is the character used to separate
19811 values and value groups</para>
19815 <para>The 'Field separator' is the character used to
19816 separate duplicate fields</para>
19820 <para>Example: You may have multiple 650 fields</para>
19826 <para>The 'Subfield separator' is the character used to
19827 separate duplicate subfields</para>
19831 <para>Example: You may have multiple $a subfields in a
19838 <para>The 'Encoding' field lets you define the encoding used
19839 when saving the file</para>
19843 <para>Finally format your CSV file using the 'Profile
19844 marcfields' fields</para>
19848 <para>Define which fields or subfields you want to
19849 export, separated by pipes. Example :
19850 200|210$a|301</para>
19855 <para>You can also use your own headers (instead of
19856 the ones from Koha) by prefixing the field number with
19857 an header, followed by the equal sign. Example :
19858 Personal name=200|Entry element=210$a|300|009</para>
19868 <section id="editcsvprofile">
19869 <title>Modify CSV Profiles</title>
19871 <para>Once you have created at least one CSV Profile an 'Edit
19872 profile' tab will appear next to the 'New profile' button.</para>
19875 <screeninfo>Modify CSV Profiles</screeninfo>
19879 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
19886 <para>Choose the profile you would like to edit and alter the
19887 necessary fields.</para>
19891 <para>To delete a profile, check the 'Delete selected profile'
19892 option before clicking 'Submit Query'</para>
19895 <screeninfo>Delete an existing CSV Profile</screeninfo>
19899 <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
19907 <section id="usecsvprofiles">
19908 <title>Using CSV Profiles</title>
19910 <para>Your CSV Profiles will appear on the export list or cart menu
19911 under the 'Download' button</para>
19914 <screeninfo>CSV Profiles on Download Menu</screeninfo>
19918 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
19925 <section id="logviewer">
19926 <title>Log Viewer</title>
19930 <para><emphasis>Get there:</emphasis> More > Tools >
19931 Additional Tools > Log Viewer</para>
19935 <para>Actions within the Koha system are tracked in log files. Your
19936 <link linkend="logs">system preferences</link> can be changed to
19937 prevent the logging of different actions. These logs can be viewed
19938 using the Log Viewer Tool.</para>
19941 <screeninfo>Log Viewer</screeninfo>
19945 <imagedata fileref="images/tools/logs/logviewer.png"/>
19950 <para>Choosing different combinations of menu options will produce the
19951 log file for that query.</para>
19954 <screeninfo>A query for all logs related to the Circulation module
19955 produces a result like this</screeninfo>
19959 <imagedata fileref="images/tools/logs/logresults.png"/>
19964 <para>You will note that real names do not appear on the log, only
19965 identifying numbers. You need to use the identifying numbers when
19966 searching the logs as well.</para>
19969 <section id="newstool">
19970 <title>News</title>
19974 <para><emphasis>Get there:</emphasis> More > Tools >
19975 Additional Tools > News</para>
19979 <para>Koha's news module allows librarians to post news to the OPAC,
19980 staff interface and circulation receipts.</para>
19983 <screeninfo>Koha News Module</screeninfo>
19987 <imagedata fileref="images/tools/news/news.png"/>
19992 <para>To add news to either the OPAC, the Staff Client or a
19993 Circulation receipt:</para>
19997 <para>Click 'New Entry'</para>
20000 <screeninfo>Add Koha News Form</screeninfo>
20004 <imagedata fileref="images/tools/news/addnews.png"/>
20011 <para>Under 'Display Location' choose whether to put the news
20012 on the OPAC, Slip (circulation receipt) or the Librarian
20013 (Staff) Interface.</para>
20017 <para>Choose a title for your entry</para>
20021 <para>Using the publication and expiration date fields you can
20022 control how long your item appears</para>
20026 <para>'Appear in position' lets you decide what order your
20027 news items appear in</para>
20031 <para>The 'News' box allows for the use of HTML for formatting
20032 of your news item</para>
20038 <para>After filling in all of the fields, click 'Submit'</para>
20042 <para>News in the OPAC will appear above the <link
20043 linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
20046 <screeninfo>News in the OPAC</screeninfo>
20050 <imagedata fileref="images/tools/news/opacnews.png"/>
20057 <para>News in the Staff Client will appear on the far left of the
20061 <screeninfo>News in the Staff Client</screeninfo>
20065 <imagedata fileref="images/tools/news/librariannews.png"/>
20072 <para>News on the circulation receipts will appear below the items
20073 that are checked out</para>
20076 <screeninfo>News at the bottom of the circulation
20077 receipt</screeninfo>
20081 <imagedata fileref="images/tools/news/slipnews.png"/>
20089 <section id="taskscheduler">
20090 <title>Task Scheduler</title>
20094 <para><emphasis>Get there:</emphasis> More > Tools >
20095 Additional Tools > Task Scheduler</para>
20099 <para>The task scheduler is a way to schedule reports to run whenever
20102 <para>To schedule a task, visit the Task Scheduler and fill in the
20106 <screeninfo>Task Scheduler</screeninfo>
20110 <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
20117 <para>Current Server Time shows the time on your server (schedule
20118 all of your reports to run based on that time - not on your local
20123 <para>Time should be entered as hh:mm (2 digit hour, 2 digit
20128 <para>Date should be entered using the calendar pop up</para>
20132 <para>From Report choose the report you want to schedule</para>
20136 <para>Choose whether to receive the text of or a link to the
20141 <para>In the Email filed enter the email of the person you want to
20142 receive your report</para>
20146 <para>Below the task scheduler form, there is a list of scheduled
20150 <screeninfo>Scheduled Tasks</screeninfo>
20154 <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
20159 <para>You can also schedule reports directly from the list of saved
20160 reports by clicking the 'Schedule' link</para>
20163 <screeninfo>Saved Reports List</screeninfo>
20167 <imagedata fileref="images/tools/tasksched/savedreports.png"/>
20172 <section id="taskscedtroubleshoot">
20173 <title>Troubleshooting</title>
20175 <para>Task scheduler will not work if the user the web server runs
20176 as doesn't have the permission to use it. To find out if the right
20177 user has the permissions necessary, check /etc/at.allow to see what
20178 users are in it. If you don't have that file, check etc/at.deny. If
20179 at.deny exists but is blank, then every user can use it. Talk to
20180 your system admin about adding the user to the right place to make
20181 the task scheduler work.</para>
20187 <chapter id="patrons">
20188 <title>Patrons</title>
20190 <para>Before importing and/or adding patrons be sure to set up your <link
20191 linkend="patcats">patron categories</link>.</para>
20193 <section id="addnewpatron">
20194 <title>Add a new patron</title>
20196 <para>Patrons are added by going to the 'Patrons' module.</para>
20200 <para>Click 'New'</para>
20203 <screeninfo>Choose patron type</screeninfo>
20207 <imagedata fileref="images/patrons/newpatron.png"/>
20214 <para>The fields that appear on the patron add form can be
20215 controlled by editing the <link
20216 linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
20221 <para>First enter the identifying information regarding your
20225 <screeninfo>Add Patron Form</screeninfo>
20229 <imagedata fileref="images/patrons/addpatronform.png"/>
20236 <para>Required fields are defined in the <link
20237 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
20238 system preference</para>
20242 <para>Salutation is populated by the <link
20243 linkend="BorrowersTitles">BorrowersTitles</link> system
20250 <para>Next enter the contact information</para>
20253 <screeninfo>Patron Contact Information</screeninfo>
20257 <imagedata fileref="images/patrons/addcontact.png"/>
20264 <para>For contact information, note that the primary phone and
20265 email addresses are the ones that appear on notices and slips
20266 printed during circulation (receipts, transfer slips and hold
20267 slips). The primary email is also the one that overdue notices
20268 and other messages go to.</para>
20274 <para>If this patron is a child, you will be asked to attach the
20275 child patron to an adult patron</para>
20278 <screeninfo>Guarantor Linking</screeninfo>
20282 <imagedata fileref="images/patrons/addGuarantor.png"/>
20289 <para>Click 'Set to Patron' to search your system for an
20290 existing patron</para>
20294 <para>If the Guarantor is not in the system, you can enter the
20295 first and last name in the fields available</para>
20299 <para>The relationships are set using the <link
20300 linkend="borrowerRelationship">borrowerRelationship</link>
20301 system preference</para>
20307 <para>If this patron is a professional, you will be asked to attach
20308 the patron to an organizational patron</para>
20311 <screeninfo>Organization Linking</screeninfo>
20315 <imagedata fileref="images/patrons/addOrg.png"/>
20322 <para>Click 'Set to Patron to search your system for an existing
20329 <para>Each patron can have an alternate contact</para>
20332 <screeninfo>Alternate Contact</screeninfo>
20336 <imagedata fileref="images/patrons/addaltcontact.png"/>
20343 <para>An alternate contact could be a parent or guardian. It can
20344 also be used in academic settings to store the patron's home
20351 <para>The library management section includes values that are used
20352 within the library</para>
20355 <screeninfo>Library Management</screeninfo>
20359 <imagedata fileref="images/patrons/addlibmanagement.png"/>
20366 <para>The card number field is automatically calculated if you
20367 have the <link linkend="autoMemberNum">autoMemberNum</link>
20368 system preference set that way</para>
20373 <para>For a newly installed system this preference will
20374 start at 1 and increment by 1 each time after. To have it
20375 start with the starting number of your barcodes, enter the
20376 first barcode by hand in the patron record and save the
20377 patron. After that the field will increment that number by
20385 <para>If you accidentally chose the wrong patron category at the
20386 beginning you can fix that here</para>
20390 <para>Sort 1 and 2 are used for statistical purposes within your
20397 <para>Next, the Library Setup section includes additional library
20401 <screeninfo>Library set-up options</screeninfo>
20405 <imagedata fileref="images/patrons/addlibsetup.png"/>
20412 <para>The registration date will automatically be filled in with
20413 today's date</para>
20417 <para>If your patron cards expire (based on your <link
20418 linkend="patcats">patron category settings</link>) the Expiry
20419 date will automatically be calculated</para>
20423 <para>The OPAC Note is a note for the patron - it will appear in
20424 the OPAC on the patron's record</para>
20428 <para>The Circulation Note is meant solely for your library
20429 staff and will appear when the circulation staff goes to check
20430 an item out to the patron</para>
20433 <screeninfo>Sample Circulation Note</screeninfo>
20437 <imagedata fileref="images/patrons/circnote.png"/>
20444 <para>The Staff/OPAC asks for the username and password to be
20445 used by the patron (and/or staff member) to log into their
20446 account in the OPAC and for staff to log in to the staff
20451 <para>Staff will only be able to use this log in info to log
20452 in to the staff client if they have the <link
20453 linkend="patronpermissions">necessary
20454 permissions</link>.</para>
20462 <para>If you have set <link
20463 linkend="patronattributetypes">additional patron attributes</link>
20464 up, these will appear next</para>
20467 <screeninfo>Additional Patron Attributes</screeninfo>
20471 <imagedata fileref="images/patrons/addattributes.png"/>
20478 <para id="setpatronmessaging">Finally, if you have <link
20479 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
20480 set to 'allow,' you can choose the messaging preferences for this
20484 <screeninfo>Patron Messaging Settings</screeninfo>
20488 <imagedata fileref="images/patrons/addpatronmsg.png"/>
20496 <para>These preferences will override any you set via the
20497 <link linkend="addingpatroncat">patron
20498 categories</link></para>
20504 <para>These preference can be altered by the patron via the
20512 <para>Once finished, click 'Save'</para>
20516 <para>If the system suspects this patron is a duplicate of another it
20517 will warn you.</para>
20520 <screeninfo>Patron Duplicate Suspected</screeninfo>
20524 <imagedata fileref="images/patrons/duplicatewarn.png"/>
20530 <section id="addstaffpatron">
20531 <title>Add a Staff Patron</title>
20533 <para>All staff members must be entered into Koha as patrons of the
20534 'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
20535 Patron</link> to add a staff member. To give the staff member
20536 permissions to access the staff client, follow the steps in <link
20537 linkend="patronpermissions">Patron Permissions</link></para>
20540 <para>Remember to assign your staff secure usernames and passwords
20541 since these will be used to log into the staff client.</para>
20545 <section id="addstatspatron">
20546 <title>Add a Statistical Patron</title>
20548 <para>One way to track use of in house items is to "check out" the
20549 materials to a statistical patron. The "check out" process doesn's check
20550 the book out, but instead tracks an in house use of the item. To use
20551 this method for tracking in house use you first will need a <link
20552 linkend="patcats">patron category</link> set up for your Statistical
20556 <screeninfo>In House Patron Category</screeninfo>
20560 <imagedata fileref="images/patrons/statspatcat.png"/>
20565 <para>Next, you will need to create a new patron of the statistical
20569 <screeninfo>New In House Patron</screeninfo>
20573 <imagedata fileref="images/patrons/newinhouse.png"/>
20578 <para>Next, follow the steps put forth in the '<link
20579 linkend="addnewpatron">Add a new Patron</link>' section of this manual.
20580 Since this patron is not a real person, simply fill in the required
20581 fields, the correct library and nothing else.</para>
20583 <para>To learn about other methods of tracking in house use visit the
20584 <link linkend="trackinhouse">Tracking inhouse use</link> section of this
20588 <section id="duplicatepatron">
20589 <title>Duplicate a Patron</title>
20591 <para>Sometimes when you're adding a new family to your system you don't
20592 want to type the contact information over and over. Koha allows for you
20593 to duplicate a patron and change only the parts you want to (or need to)
20598 <para>Open the patron you want to use as your base (the patron you
20599 want to duplicate information from)</para>
20603 <para>Click the 'Duplicate' button at the top of their record</para>
20606 <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
20610 <imagedata fileref="images/patrons/duplicatepatron.png"/>
20617 <para>All of the fields with the exception of first name, card
20618 number, username and password have been duplicated. Fill in the
20619 missing pieces and click 'Save'</para>
20622 <screeninfo>Duplicating Patron Form</screeninfo>
20626 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
20634 <para>Clicking in a field that is already populated with data
20635 will clear that field of all information (making it easier for
20636 you to type in something different)</para>
20643 <para>You will be brought to your new patron</para>
20646 <screeninfo>Newly created patron</screeninfo>
20650 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
20658 <section id="editpatrons">
20659 <title>Editing Patrons</title>
20661 <para>Patrons in Koha can be edited using one of many edit
20666 <para>To edit the entire patron record simply click the 'Edit'
20667 button at the top of the patron record.</para>
20670 <screeninfo>Main Patron Edit Menu</screeninfo>
20674 <imagedata fileref="images/patrons/patronedit.png"/>
20681 <para>Patron passwords are not recoverable. The stars show on the
20682 patron detail next to the Password label are always there even if a
20683 password isn't set. If a patron forgets their password the only
20684 option is to reset their password. To change the patron's password,
20685 click the 'Change Password' button</para>
20688 <screeninfo>Patron Password Change Form</screeninfo>
20692 <imagedata fileref="images/patrons/patronpassword.png"/>
20699 <para>Koha cannot display existing passwords. Leave the field
20700 blank to leave password unchanged.</para>
20704 <para>This form can automatically generate a random password if
20705 you click the link labeled "Click to fill with a randomly
20706 generated suggestion. Passwords will be displayed as
20713 <para>To edit a specific section of the patron record (for example
20714 the Library Use section) click the 'Edit' link below the
20718 <screeninfo>Library Use Section of Patron Record</screeninfo>
20722 <imagedata fileref="images/patrons/patroneditsection.png"/>
20729 <para>A patron image can be added by browsing for the image on your
20730 machine from the 'Manage Patron Image' section</para>
20733 <screeninfo>Manage Patron Image Form</screeninfo>
20737 <imagedata fileref="images/patrons/patronaddimage.png"/>
20744 <para>This form will not appear if you have the <link
20745 linkend="patronimages">patronimages</link> system preference to
20746 not allow patron images</para>
20750 <para>To add patron images in bulk, use the <link
20751 linkend="uploadpatronimages">Upload Patron Images</link>
20758 <para id="patronflags">Patrons can also be blocked from checking
20759 items out by setting Patron Flags</para>
20762 <screeninfo>Patron Warning Flags</screeninfo>
20766 <imagedata fileref="images/patrons/patronflags.png"/>
20773 <para>If you would like your circulation staff to confirm a
20774 patron's address before checking items out to the patron, you
20775 can see the 'Gone no Address' flag</para>
20778 <screeninfo>Patron's address in doubt</screeninfo>
20782 <imagedata fileref="images/patrons/patronaddress.png"/>
20789 <para>If you would like to bar a patron from the library you can
20790 set the 'Restricted' flag</para>
20794 <para>This flag can automatically be set with the <link
20795 linkend="noticetriggers">Overdue/Notice Status
20796 Triggers</link></para>
20799 <screeninfo>Patron restricted</screeninfo>
20803 <imagedata fileref="images/patrons/patronrestricted.png"/>
20812 <para>If you enter in a date and/or note related to the
20813 restriction you will see that in the restricted message as
20817 <screeninfo>Restricted until message</screeninfo>
20821 <imagedata fileref="images/patrons/restricteduntil.png"/>
20828 <para>If the patron reports that they have lost their card you
20829 can set the 'Lost Card' flag to prevent someone else from using
20830 that card to check items out</para>
20833 <screeninfo>Patron lost card</screeninfo>
20837 <imagedata fileref="images/patrons/patroncardlost.png"/>
20846 <para>Children patrons do not become adults automatically in Koha.
20847 To upgrade a child patron to and adult patron category click on the
20848 'More' menu and choose 'Update Child to Adult Patron'</para>
20851 <screeninfo>Update Child to Adult Patron</screeninfo>
20855 <imagedata fileref="images/patrons/updatetoadult.png"/>
20862 <para>You will then be presented with a pop up window asking
20863 which one of your adult patron categories this Child should be
20867 <screeninfo>Choose Adult Category to Update To</screeninfo>
20871 <imagedata fileref="images/patrons/choosadulttype.png"/>
20881 <section id="patronpermissions">
20882 <title>Patron Permissions</title>
20884 <para>Patron Permissions are used to allow staff members access to the
20885 staff client.</para>
20888 <para>In order for a staff member to log into the staff interface they
20889 must have (at the very least) 'catalogue' permissions which allow them
20890 to view the staff interface.</para>
20893 <section id="setpatronperms">
20894 <title>Setting Patron Permissions</title>
20896 <para>To set patron permissions, you must first <link
20897 linkend="addstaffpatron">have a patron of the 'Staff' type</link>
20902 <para>On the patron record click More and choose Set Permissions
20903 to alter patron permissions</para>
20906 <screeninfo>Set Patron Permissions</screeninfo>
20910 <imagedata fileref="images/patrons/editpatronpermissions.png"/>
20917 <para>You will be presented with a list of preferences, some of
20918 which can be expanded by clicking the plus sign to the left of the
20919 section title.</para>
20922 <screeninfo>Patron Permissions</screeninfo>
20926 <imagedata fileref="images/patrons/GranularPermissions.png"/>
20934 <section id="patronpermsdefined">
20935 <title>Patron Permissions Defined</title>
20941 <para>superlibrarian</para>
20945 <para>Access to all functions within the staff client</para>
20950 <para>With this selected there is no need to choose any
20951 other permissions</para>
20960 <para>circulate</para>
20964 <para>Ability to check (issue) books out and in and access the
20965 'Circulation' page in the staff client</para>
20969 <para>This section can be expanded (<link
20970 linkend="circpermissions">Learn more</link>)</para>
20976 <para>catalogue</para>
20980 <para>Allows staff members to search the catalog via the staff
20985 <para>Must be given to all staff members to allow them to
20986 login to the staff client</para>
20992 <para>parameters</para>
20996 <para>Provides access to all areas of the Administration
21003 <para>borrowers</para>
21007 <para>Allows staff members to add or modify patrons (with the
21008 exception of setting permissions)</para>
21014 <para>permissions</para>
21018 <para>Ability to set patron permissions</para>
21024 <para>reserveforothers</para>
21028 <para>Ability to place holds on books for patrons via the
21029 staff interface</para>
21033 <para>This section can be expanded (<link
21034 linkend="reservepermissions">Learn more</link>)</para>
21040 <para>borrow</para>
21044 <para>Grants staff members the rights to borrow books from the
21051 <para>editcatalogue</para>
21055 <para>Ability to catalog items (add and edit bibliographic and
21056 holdings data)</para>
21060 <para>This section can be expanded (<link
21061 linkend="catpermissions">Learn more</link>)</para>
21067 <para>updatecharges</para>
21071 <para>Manage patron accounts (including paying fines, adding
21072 credits, and creating invoices)</para>
21078 <para>acquisition</para>
21082 <para>Provides access to the acquisitions and patron purchase
21083 suggestion modules</para>
21087 <para>This section can be expanded (<link
21088 linkend="acqpermissions">Learn more</link>)</para>
21094 <para>management</para>
21098 <para>No longer in use</para>
21108 <para>Access to all items in the Tools section of the staff
21113 <para>This section can be expanded (<link
21114 linkend="toolspermissions">Learn more</link>)</para>
21120 <para>editauthorities</para>
21124 <para>Provides access to edit the authority record</para>
21130 <para>serials</para>
21134 <para>Allows access to the serials module</para>
21138 <para>This section can be expanded (<link
21139 linkend="serpermissions">Learn more</link>)</para>
21145 <para>reports</para>
21149 <para>Allow access to the Reports module (ability to create,
21150 edit and run all reports)</para>
21154 <para>Reports found on the Circulation page are not controlled
21155 by this permission</para>
21159 <para>This section can be expanded (<link
21160 linkend="reportpermissions">Learn more</link>)</para>
21166 <para>staffaccess</para>
21170 <para>Provides the ability to modify login / permissions for
21176 <para>Requires the borrowers permission above</para>
21183 <section id="circpermissions">
21184 <title>Granular Circulate Permissions</title>
21186 <para>If the staff member has 'circulate' permissions they have the
21187 ability to perform all of these actions. If you would like to
21188 control circulation permissions on a more granular level choose from
21189 these options:</para>
21193 <para>circulate_remaining_permissions</para>
21197 <para>All circulation rights except the ability to override
21204 <para>override_renewals</para>
21208 <para>Override blocked renewals</para>
21212 <para>Requires that the staff member also has
21213 circulate_remaining_permissions</para>
21220 <section id="reservepermissions">
21221 <title>Granular Holds Permissions</title>
21223 <para>If the staff member has 'reserveforothers' permissions they
21224 have the ability to perform all of these actions. If you would like
21225 to control holds permissions on a more granular level choose from
21226 these options:</para>
21230 <para>modify_holds_priority</para>
21234 <para>Allow staff members to alter the holds priority
21235 (moving patrons up and down the queue)</para>
21241 <para>place_holds</para>
21245 <para>Allows staff members to place holds for patrons via
21246 the staff interface</para>
21253 <section id="catpermissions">
21254 <title>Granular Cataloging Permissions</title>
21256 <para>If the staff member has 'editcatalogue' permissions they have
21257 the ability to perform all of these actions. If you would like to
21258 control cataloging permissions on a more granular level choose from
21259 these options:</para>
21263 <para>edit_catalogue</para>
21267 <para>Ability to access all cataloging functions via the
21268 <link linkend="cataloging">Cataloging</link> page</para>
21274 <para>edit_items</para>
21278 <para>Ability to make <link linkend="editingitems">edits to
21279 item records</link>, but not bib records</para>
21285 <para id="fastaddpermissions">fast_cataloging</para>
21289 <para>The ability to catalog using only the <link
21290 linkend="fastaddcat">Fast Add Framework</link> found on the
21291 <link linkend="circulation">Circulation</link> page</para>
21298 <section id="acqpermissions">
21299 <title>Granular Acquisitions Permissions</title>
21301 <para>If the staff member has 'acquisition' permissions they have
21302 the ability to perform all of these actions. If you would like to
21303 control acquisitions permissions on a more granular level choose
21304 from these options:</para>
21308 <para>budget_add_del</para>
21312 <para>Ability to add and delete budgets (not modify)</para>
21318 <para>budget_manage</para>
21322 <para>Manage budgets</para>
21328 <para>budget_modify</para>
21332 <para>Ability to edit existing budgets (not to add or
21339 <para>contracts_manage</para>
21343 <para>Manage contracts</para>
21349 <para>group_manage</para>
21353 <para>Manage orders and basket groups</para>
21359 <para>order_manage</para>
21363 <para>Manage orders and baskets</para>
21369 <para>order_receive</para>
21373 <para>Manage orders and baskets</para>
21379 <para>period_manage</para>
21383 <para>Manage periods</para>
21389 <para>planning_manage</para>
21393 <para>Manage budget planning</para>
21399 <para>vendors_manage</para>
21403 <para>Manage vendors</para>
21410 <section id="serpermissions">
21411 <title>Granular Serials Permissions</title>
21413 <para>If the staff member has 'serials' permissions they have the
21414 ability to perform all of these actions. If you would like to
21415 control serials permissions on a more granular level choose from
21416 these options:</para>
21420 <para>check_expiration</para>
21424 <para>Check the expiration of a serial</para>
21430 <para>claim_serials</para>
21434 <para>Claim missing serials</para>
21440 <para>create_subscription</para>
21444 <para>Create a new subscription</para>
21450 <para>delete_subscription</para>
21454 <para>Delete an existing subscription</para>
21460 <para>edit_subscription</para>
21464 <para>Edit (but not delete or create) an existing
21465 subscription</para>
21471 <para>receive_serials</para>
21475 <para>Receive serials on existing subscriptions</para>
21481 <para>renew_subscription</para>
21485 <para>Renew an existing subscription</para>
21491 <para>routing</para>
21495 <para>Manage routing lists</para>
21502 <section id="toolspermissions">
21503 <title>Granular Tools Permissions</title>
21505 <para>If the staff member has 'tools' permissions they have the
21506 ability to access and use all items under the Tools menu. If you
21507 would like to control which tools staff members have access to on a
21508 more granular level choose from these options:</para>
21512 <para>batch_upload_patron_images</para>
21516 <para>Upload patron images in batch or one at a time (Access
21517 to the <link linkend="uploadpatronimages">Image Upload
21518 Tool</link>)</para>
21524 <para>delete_anonymize_patrons</para>
21528 <para>Delete old borrowers and anonymize circulation/reading
21529 history (Access to the <link linkend="anonpatrons">Anonymize
21530 Patron Tool</link>)</para>
21536 <para>edit_calendar</para>
21540 <para>Define days when the library is closed (Access to the
21541 <link linkend="calholidays">Calendar/Holidays
21542 Tool</link>)</para>
21548 <para>edit_news</para>
21552 <para>Write news for the OPAC and staff interfaces (Access
21553 to the <link linkend="newstool">News Tool</link>)</para>
21559 <para>edit_notice_status_triggers</para>
21563 <para>Set notice/status triggers for overdue items (Access
21564 to the <link linkend="noticetriggers">Overdue Notice
21565 Status/Triggers Tool</link>)</para>
21571 <para>edit_notices</para>
21575 <para>Define notices (Access to the <link
21576 linkend="notices">Notices Tool</link>)</para>
21582 <para>export_catalog</para>
21586 <para>Export bibliographic and holdings data (Access to the
21587 <link linkend="exportbibs">Export Bibliographic &
21588 Holdings Data Tool</link>)</para>
21594 <para>import_patrons</para>
21598 <para>Import patron data (Access to the <link
21599 linkend="patronimport">Import Patrons Tool</link>)</para>
21605 <para>inventory</para>
21609 <para>Perform inventory (stocktaking) of your catalog
21610 (Access to the <link linkend="inventory">Inventory
21611 Tool</link>)</para>
21617 <para>items_batchdel</para>
21621 <para>Perform batch deletion of items (Access to the <link
21622 linkend="batchdeleteitems">Delete a queryset of items
21623 Tool</link>)</para>
21629 <para>items_batchmod</para>
21633 <para>Perform batch modification of items (Access to the
21634 <link linkend="batchmodifyitems">Modify a queryset of items
21635 Tool</link>)</para>
21641 <para>label_creator</para>
21645 <para>Create printable labels and barcodes from catalog and
21646 patron data (Access to the <link
21647 linkend="labelcreator">Label Creator</link> and <link
21648 linkend="quicklabelcreator">Quick Label Creator</link>
21655 <para>manage_csv_profiles</para>
21659 <para>Create and edit CSV profiles (Access to the <link
21660 linkend="csvprofiles">CSV Profiles Tool</link>)</para>
21666 <para>manage_staged_marc</para>
21670 <para>Managed staged MARC records, including completing and
21671 reversing imports (Access to the <link
21672 linkend="managestaged">Manage Staged MARC Records
21673 Tool</link>)</para>
21679 <para>moderate_comments</para>
21683 <para>Moderate patron comments (Access to the <link
21684 linkend="comments">Comments</link> and <link
21685 linkend="tagsmoderation">Tags</link> Tools)</para>
21691 <para>schedule_tasks</para>
21695 <para>Schedule tasks to run (Access to the <link
21696 linkend="taskscheduler">Task Scheduler Tool</link>)</para>
21702 <para>stage_marc_import</para>
21706 <para>Stage MARC records into the reservoir (Access to the
21707 <link linkend="stagemarc">Stage MARC Records
21708 Tool</link>)</para>
21714 <para>upload_local_cover_images</para>
21718 <para>Upload local cover images (Access to the <link
21719 linkend="uploadlocalimages">Upload Local Cover Image
21720 Tool</link>)</para>
21726 <para>view_system_logs</para>
21730 <para>Browse the system logs (Access to the <link
21731 linkend="logviewer">Log Viewer Tool</link>)</para>
21738 <section id="reportpermissions">
21739 <title>Granular Reports Permissions</title>
21741 <para>If the staff member has 'reports' permissions they have the
21742 ability to perform all of these actions. If you would like to
21743 control reports permissions on a more granular level choose from
21744 these options:</para>
21748 <para>create_reports</para>
21752 <para>The ability to create and edit but not run SQL
21759 <para>execute_reports</para>
21763 <para>The ability to run but not create or edit SQL
21773 <section id="patroninformation">
21774 <title>Patron Information</title>
21776 <para>When viewing a patron record you have the option to view
21777 information from one of many tabs found on the left hand side of the
21780 <section id="patcheckout">
21781 <title>Check Out</title>
21783 <para>For instruction on checking items out, view the <link
21784 linkend="checkingout">Checking Out</link> section of this
21788 <section id="patrondetails">
21789 <title>Details</title>
21791 <para>All patron information will appear on the Details tab. This
21792 includes all the contact information, notes, custom patron attributes,
21793 messaging preferences, etc entered when adding the patron.</para>
21795 <para>In the case of patrons who are marked as 'Child' or
21796 'Professional' and their Guarantors additional information will appear
21797 on their record.</para>
21801 <para>A child patron will list their Guarantor</para>
21804 <screeninfo>Guarantor listed and linked from the child
21805 record</screeninfo>
21809 <imagedata fileref="images/patrons/child.png"/>
21816 <para>On the Guarantor's record, all children and/or professionals
21817 will be listed</para>
21820 <screeninfo>Guarantees listed on the Guarantor's
21821 profile</screeninfo>
21825 <imagedata fileref="images/patrons/parent.png"/>
21832 <section id="patcircsummary">
21833 <title>Circulation Summary</title>
21835 <para>Below the patron's information on the details screen is a
21836 tabbed display of the items they have checked out, overdue, and on
21840 <screeninfo>Checkout summary</screeninfo>
21844 <imagedata fileref="images/patrons/checkoutsummary.png"/>
21849 <para>If they have family at the library staff can see what the
21850 other family members have checked out.</para>
21853 <screeninfo>Relative checkouts</screeninfo>
21857 <imagedata fileref="images/patrons/relativecheckouts.png"/>
21864 <section id="patronfines">
21865 <title>Fines</title>
21867 <para>The patron's complete accounting history will appear on the
21868 Fines tab. Contrary to its name, the Fines tab does not just show fine
21869 data, it also shows membership fees, rental fees, reserve fees and any
21870 other charge you may have for patrons.</para>
21873 <screeninfo>Patron Accounting Summary</screeninfo>
21877 <imagedata fileref="images/patrons/patronaccount.png"/>
21882 <section id="chargefines">
21883 <title>Charging Fines/Fees</title>
21885 <para>Most fees and fines will be charged automatically if the <link
21886 linkend="finescronjob">fines cron job</link> is running:</para>
21890 <para>Fines will be charged based on your <link
21891 linkend="circfinerules">Circulation & Fines
21892 Rules</link></para>
21896 <para>Hold fees will be charged based on the rules you set in
21897 the <link linkend="patcats">Patron Types & Categories</link>
21898 administration area</para>
21902 <para>Rental fees will be charged based on the settings in your
21903 <link linkend="itemtypeadmin">Item Types</link> administration
21908 <para>Marking an item 'Lost' via the cataloging module will
21909 automatically charge the patron the replacement cost for that
21915 <section id="payfines">
21916 <title>Pay/Reverse Fines</title>
21918 <para>Each line item can be paid in full (or written off) using the
21919 'Pay Fines' tab.</para>
21922 <screeninfo>Paying Fines</screeninfo>
21926 <imagedata fileref="images/patrons/makepayment.png"/>
21933 <para>Each line item can be paid in full, partially paid, or
21934 written off.</para>
21938 <para>Pay a fine in full</para>
21942 <para>Click "Pay" next to the fine you want to pay in
21947 <para>The full amount of the fine will be populated for you
21948 in the "Collect From Patron" box</para>
21951 <screeninfo>Pay fine</screeninfo>
21955 <imagedata fileref="images/patrons/payfine.png"/>
21962 <para>Click "Confirm"</para>
21966 <para>The fine will be removed from outstanding fines, and
21967 displayed as fully paid.</para>
21973 <para>Pay a partial fine</para>
21977 <para>Click "Pay" next to the fine you want to partially
21982 <para>Enter the amount you are collecting from the patron in
21983 the "Collect From Patron" box</para>
21986 <screeninfo>Pay partial fine</screeninfo>
21990 <imagedata fileref="images/patrons/paypartial.png"/>
21997 <para>Click "Confirm"</para>
22001 <para>The fine will be updated to show the original Amount,
22002 and the current Amount Outstanding</para>
22008 <para>Pay an amount towards all fines</para>
22012 <para>Click the "Pay Amount" button</para>
22016 <para>Enter the amount you are collecting from the patron in
22017 "Collect from Patron." The sum of all fines is shown in
22018 "Total Amount Outstanding"</para>
22021 <screeninfo>Pay Amount</screeninfo>
22025 <imagedata fileref="images/patrons/payamount.png"/>
22032 <para>Click "Confirm"</para>
22036 <para>The fine totals will be updated with the payment
22037 applied to oldest fines first.</para>
22043 <para>Pay Selected fines</para>
22047 <para>Check the selection boxes next to the fines you wish
22048 to pay, click "Pay Selected"</para>
22051 <screeninfo>Select lines to pay</screeninfo>
22055 <imagedata fileref="images/patrons/payselected-select.png"/>
22062 <para>Enter an amount to pay towards the fines.</para>
22065 <screeninfo>Pay Selected</screeninfo>
22069 <imagedata fileref="images/patrons/payselected.png"/>
22076 <para>Click "Confirm"</para>
22080 <para>The fine totals will be updated with the payment
22081 applied to the oldest selected fines first.</para>
22087 <para>Writeoff a single fine</para>
22091 <para>Click "Writeoff" next to the fine you wish to
22096 <para>The fine will be removed from outstanding fines, and
22097 displayed as written off.</para>
22103 <para>Writeoff All fines</para>
22107 <para>Click the "Writeoff All" button</para>
22111 <para>All fines will be removed from outstanding fines, and
22112 displayed as written off.</para>
22118 <para>If you accidentally mark and item as paid, you can reverse
22119 that line item by clicking 'Reverse' to the right of the
22123 <screeninfo>Reverse Link</screeninfo>
22127 <imagedata fileref="images/patrons/reverselink.png"/>
22134 <para>Once clicked a new line item will be added to the
22135 account, showing the payment as reversed</para>
22138 <screeninfo>Reversed Payment</screeninfo>
22142 <imagedata fileref="images/patrons/reversed.png"/>
22152 <section id="manualinvoice">
22153 <title>Creating Manual Invoices</title>
22155 <para>For fees that are not automatically charged, librarians can
22156 create a manual invoice</para>
22159 <screeninfo>Create Manual Invoice</screeninfo>
22163 <imagedata fileref="images/patrons/manualinvoice.png"/>
22170 <para>First choose the type of invoice you would like to
22175 <para>To add additional values to the manual invoice type
22176 pull down menu, add them to the <link
22177 linkend="manualinvvals">MANUAL_INV</link> Authorized
22184 <para>If the fee is associated with an item you can enter its
22185 barcode so that the line item shows a link to that item</para>
22189 <para>The description field is where you will enter the
22190 description of the charge</para>
22194 <para>In the amount field, do not enter currency symbols, only
22195 numbers and decimals</para>
22200 <section id="manualcredit">
22201 <title>Creating Manual Credits</title>
22203 <para>Manual credits can be used to pay off parts of fines, or to
22204 forgive a fine amount.</para>
22207 <screeninfo>Create Manual Credit</screeninfo>
22211 <imagedata fileref="images/patrons/manualcredit.png"/>
22218 <para>First choose the type of credit you'd like to apply</para>
22222 <para>If this credit is associated with an item you can enter
22223 that item's barcode so that the line item links to the right
22228 <para>The description field is where you will enter the
22229 description of the credit</para>
22233 <para>In the amount field, do not enter currency symbols, only
22234 numbers and decimals</para>
22239 <section id="printinglineitems">
22240 <title>Printing Invoices</title>
22242 <para>To the right of each account line there is a print link.
22243 Clicking that link will print an invoice for the line item that
22244 includes the date and description of the line item along with the
22245 total outstanding on the account.</para>
22248 <screeninfo>Sample Invoice</screeninfo>
22252 <imagedata fileref="images/patrons/patroninvoice.png"/>
22259 <section id="circhistory">
22260 <title>Circulation History</title>
22262 <para>The circulation history tab will appear if you have set the
22263 <link linkend="intranetreadinghistory">intranetreadinghistory</link>
22264 preference to allow it to appear. If you have the <link
22265 linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
22266 'Allow' and the patron has decided that the library cannot keep this
22267 information this tab will only show currently checked out
22271 <screeninfo>Patron Circulation History</screeninfo>
22275 <imagedata fileref="images/patrons/readinghistory.png"/>
22280 <para>If you would like to export a list of barcodes for the items
22281 checked in today you can find that option under the More menu on the
22282 top right of the page.</para>
22285 <screeninfo>Export today's checkins</screeninfo>
22289 <imagedata fileref="images/patrons/readinghistory-export.png"/>
22294 <para>This will generate a text file with one barcode per line.</para>
22297 <section id="patmodlog">
22298 <title>Modification Log</title>
22300 <para>If you have set your <link
22301 linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
22302 records, then this tab will appear. The Modification Log will show
22303 when changes were made to the patron record. If you also have turned
22304 on the <link linkend="IssueLog">IssueLog</link> and <link
22305 linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
22306 this screen as well.</para>
22309 <screeninfo>Changes to Patron</screeninfo>
22313 <imagedata fileref="images/patrons/borrowerlog.png"/>
22320 <para>The Librarian field shows the patron number for the
22321 librarian who made the changes</para>
22325 <para>The module lists 'MEMBERS' for the patron module</para>
22329 <para>The action will tell you what action was being logged</para>
22333 <para>The Object field lists the borrowernumber that is being
22334 modified (in the example above, it was my changing my own
22340 <section id="patnotices">
22341 <title>Notices</title>
22343 <para>The <link linkend="setpatronmessaging">patron's messaging
22344 preferences</link> are set when <link
22345 linkend="addnewpatron">adding</link> or <link
22346 linkend="editpatrons">editing</link> the patron. This tab will show
22347 the messages that have been sent and those that are queued to be
22351 <screeninfo>Patron Notices Tab</screeninfo>
22355 <imagedata fileref="images/patrons/patnoticestab.png"/>
22360 <para>Clicking on the message title will expand the view to show you
22361 the full text of the message that was sent.</para>
22364 <screeninfo>Full message text</screeninfo>
22368 <imagedata fileref="images/patrons/patnoticestab-full.png"/>
22375 <section id="patronsearch">
22376 <title>Patron Search</title>
22378 <para>Clicking on the link to the Patron module will bring you to a
22379 search/browse screen for patrons. From here you can search for a
22383 <screeninfo>Patron Search</screeninfo>
22387 <imagedata fileref="images/patrons/patronsearch.png"/>
22392 <para>Depending on what you have chosen for the 'Search fields' you can
22393 search for patrons in various different ways.</para>
22396 <screeninfo>Patron Search Fields</screeninfo>
22400 <imagedata fileref="images/patrons/patronfieldsearch.png"/>
22407 <para>Standard:</para>
22411 <para>Enter any part of their name, username, email address or
22418 <para>Email:</para>
22422 <para>Enter any part of their email address.</para>
22428 <para>Borrower number:</para>
22432 <para>Enter the Koha borrower number</para>
22438 <para>Phone number:</para>
22442 <para>Enter the phone number exactly as it is in the system or
22443 by using spaces between each batch of numbers.</para>
22447 <para>Example: To find (212) 555-1212 you can search for it
22448 exactly as it was entered or by searching for 212 555
22455 <para>If you want to filter your results to a specific branch or
22456 category, you can click the plus sign [+] to the right of the search
22460 <screeninfo>Advanced Patron Search</screeninfo>
22464 <imagedata fileref="images/patrons/patronfilter.png"/>
22469 <para>You can also browse through the patron records by clicking on the
22470 linked letters across the top.</para>
22473 <screeninfo>Patron Browse</screeninfo>
22477 <imagedata fileref="images/patrons/patronbrowse.png"/>
22484 <chapter id="circulation">
22485 <title>Circulation</title>
22487 <para>Circulation functions can be accessed in several different ways. On
22488 the main page of the staff client there are some quick links in the center
22489 of the page to check items out, in or transfer them. For a complete
22490 listing of Circulation functions you can visit the Circulation page which
22491 is linked from the top left of every page or from the center of the main
22494 <para>Before circulating your collection you will want to set your <link
22495 linkend="globalsysprefs">Global System Preferences</link>, <link
22496 linkend="basicparams">Basic Parameters</link> and <link
22497 linkend="patscirc">Patrons & Circulation Rules</link>.</para>
22499 <para>While in Circulation you can jump between the tabs on the quick
22500 search box at the top of the screen by using the following hot
22505 <para>jump to the catalog search with Alt+Q</para>
22509 <para>jump to the checkout with Alt+U</para>
22513 <para>this will not work for Mac users</para>
22519 <para>jump to the checkin with Alt+R</para>
22524 <para>Mac users use the OPTION button in place of ALT</para>
22527 <section id="checkingout">
22528 <title>Check Out (Issuing)</title>
22530 <para>To begin the checkout process you must enter the patron barcode or
22531 part of their name. The checkout option appears in three main
22536 <para>Check out option on the top of the main staff client</para>
22539 <screeninfo>Check out box on main Koha Staff Client
22544 <imagedata fileref="images/circ/checkoutmain.png"/>
22551 <para>Check out option on the patron record</para>
22554 <screeninfo>Check out tab on a patron record</screeninfo>
22558 <imagedata fileref="images/circ/checkoutpatron.png"/>
22565 <para>Check out option on the quick search bar on the circulation
22569 <screeninfo>Check out tab on quick search bar</screeninfo>
22573 <imagedata fileref="images/circ/circquickbox.png"/>
22580 <section id="checkitemout">
22581 <title>Checking Items Out</title>
22583 <para>To check an item out to a patron, first search for that patron
22584 using one of the many options listed above.</para>
22587 <screeninfo>Check Out Screen</screeninfo>
22591 <imagedata fileref="images/circ/checkingout.png"/>
22596 <para>At the top of the Check Out screen is a box for you to type or
22597 scan the item's barcode into.</para>
22602 <para>Many modern barcode scanners will send a 'return' to the
22603 browser, making it so that the 'Check Out' button is
22604 automatically clicked</para>
22609 <para>If the barcode is not found you will be prompted to use fast
22610 cataloging to add the item. Learn more about <link
22611 linkend="fastaddcat">fast cataloging</link> later in this
22616 <para>Below the box for the barcode there may be options for you to
22617 override the default due date for the item.</para>
22621 <para>This option will only appear if you have set the <link
22622 linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
22623 to allow staff to override the due date</para>
22627 <para>At the bottom of the page there is a summary of the patron's
22628 current checked out items along with the due date (and time if the
22629 item is an hourly loan), items checked out today will appear at the
22633 <para>If the checked out time is listed as 00:00 then the item is a
22634 daily loan item. The due time for daily checkouts will show 23:59
22635 which is the last minute of the day.</para>
22639 <screeninfo>Patron's checkout summary</screeninfo>
22643 <imagedata fileref="images/circ/checkoutsummary.png"/>
22648 <para>Also at the bottom of the page is the list of items the patron
22652 <screeninfo>Holds summary on check out screen</screeninfo>
22656 <imagedata fileref="images/circ/holdssummary.png"/>
22661 <para>From the holds list you can suspend or resume patrons holds
22662 using the options at the bottom of the list if you have the <link
22663 linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
22664 set to 'allow.'</para>
22667 <para>If you have your <link
22668 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
22669 preference set to "Don't allow" then you will not have the option to
22670 put an end date on the hold suspension</para>
22673 <para>If there are notes on the patron record these will appear to the
22674 right of the checkout box</para>
22677 <screeninfo>Patron notes on check out screen</screeninfo>
22681 <imagedata fileref="images/circ/patronnotes.png"/>
22686 <para>If the patron has a hold waiting at the library that too will
22687 appear to the right of the check out box making it easy for the
22688 circulation librarian to see that there is another item to give the
22692 <screeninfo>Hold waiting message on check out screen</screeninfo>
22696 <imagedata fileref="images/circ/holdwaiting.png"/>
22701 <section id="printcircreceipt">
22702 <title>Printing Receipts</title>
22704 <para>Once you have checked out all of the items for the patron you
22705 can print them a receipt by choosing one of two methods.</para>
22707 <para>If you have the <link
22708 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
22709 preference set to 'open a print quick slip window' you can simply
22710 hit enter on your keyboard or scan a blank piece of paper with your
22711 barcode scanner. The idea being that you're "checking out" a blank
22712 barcode which triggers Koha to print the 'Quick slip.'</para>
22714 <para>You can also click the Print button at the top of the screen
22715 and choose 'Print slip' or 'Print quick slip'.</para>
22718 <screeninfo>Print receipt to slip printer</screeninfo>
22722 <imagedata fileref="images/circ/printslip.png"/>
22727 <para>If you choose 'Print slip' it will print all of the items the
22728 patron has checked out, including those they checked out at an
22729 earlier date. Choosing 'Print quick slip' will print only the items
22730 that were checked out today.</para>
22732 <para>What prints on the slips can be customized by altering the
22733 slip templates under the <link linkend="notices">Notices &
22734 Slips</link> tool.</para>
22737 <section id="clearpatroninfo">
22738 <title>Clear Patron Information</title>
22740 <para>When you're done checking an item out if you have the <link
22741 linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
22742 preference set to 'Show' you can clear the current patron by
22743 clicking the X in the top right of the patron's info to remove the
22744 current patron from the screen and start over.</para>
22747 <screeninfo>Clear Screen Button</screeninfo>
22751 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
22756 <para>If you have the <link
22757 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
22758 preference set to 'clear the screen' then you simply need to hit
22759 enter or scan a blank barcode and the screen will be cleared of the
22760 current patron.</para>
22764 <section id="checkoutmsg">
22765 <title>Check Out Messages</title>
22767 <para>If you check out an item that has multiple pieces and you have
22768 cataloged that information in subfield 3 of the item record (in
22769 MARC21) a message will pop up when you check out that item telling you
22770 how many pieces should be there.</para>
22773 <screeninfo>Materials in the checked out item</screeninfo>
22777 <imagedata fileref="images/circ/materialspecified.png"/>
22782 <para>There are times when Koha will prevent the librarian from being
22783 able to check out items to a patron. When this happens a warning will
22784 appear notifying the librarian of why the patron cannot check items
22789 <para>Patron owes too much in fines</para>
22792 <screeninfo>Patron owes too much in fines</screeninfo>
22796 <imagedata fileref="images/circ/fineswarning.png"/>
22803 <para>You can set the amount at which patron checkouts are
22804 blocked with the <link
22805 linkend="noissuescharge">noissuescharge</link> system
22812 <para>Patron has been barred from the library</para>
22815 <screeninfo>Patron account barred</screeninfo>
22819 <imagedata fileref="images/circ/debarwarning.png"/>
22826 <para>This can be set by the librarian editing a patron record
22827 and adding a <link linkend="patronflags">flag</link> or by the
22828 <link linkend="noticetriggers">Overdue/Notice Status
22829 Triggers</link></para>
22835 <para>Patron needs to confirm their address</para>
22838 <screeninfo>Patron's address warning</screeninfo>
22842 <imagedata fileref="images/circ/addresswarning.png"/>
22849 <para>This can be set by the librarian editing a patron record
22850 and adding a <link linkend="patronflags">flag</link></para>
22856 <para>Patrons has lost their library card</para>
22859 <screeninfo>Lost patron card warning</screeninfo>
22863 <imagedata fileref="images/circ/lostcardwarning.png"/>
22870 <para>This can be set by the librarian editing a patron record
22871 and adding a <link linkend="patronflags">flag</link></para>
22878 <section id="checkoutwarn">
22879 <title>Check Out Warnings</title>
22881 <para>Sometimes checkouts will trigger warning messages that will
22882 appear in a yellow box above the check out field. These warnings need
22883 to be acknowledged before you will be able to continue checking items
22888 <para>Patron has outstanding fines</para>
22891 <screeninfo>Patron has a debt</screeninfo>
22895 <imagedata fileref="images/circ/warnings/patrondebt.png"/>
22902 <para>Item on hold for someone else</para>
22905 <screeninfo>Item is on hold for someone else</screeninfo>
22909 <imagedata fileref="images/circ/warnings/onhold.png"/>
22916 <para>Item should be on the hold shelf waiting for someone
22920 <screeninfo>Item is on hold shelf waiting for someone
22925 <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
22932 <para>Item already checked out to this patron</para>
22935 <screeninfo>Item is currently checked out to this
22936 patron</screeninfo>
22940 <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
22947 <para>Item checked out to another patron</para>
22950 <screeninfo>Item checked out to another patron</screeninfo>
22954 <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
22961 <para>Item not for loan</para>
22964 <screeninfo>Item is not normally for loan</screeninfo>
22968 <imagedata fileref="images/circ/warnings/notforloan.png"/>
22975 <para>Patron has too many things checked out</para>
22978 <screeninfo>Too many checkouts</screeninfo>
22982 <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
22989 <para>Item cannot be renewed</para>
22992 <screeninfo>No more renewals</screeninfo>
22996 <imagedata fileref="images/circ/warnings/norenewals.png"/>
23003 <para>This can be overridden with the <link
23004 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
23005 system preference</para>
23011 <para>Barcode not found</para>
23014 <screeninfo>Barcode not found</screeninfo>
23018 <imagedata fileref="images/circ/barcodefastadd.png"/>
23025 <para>Learn more about <link linkend="fastaddcat">fast
23026 cataloging</link> later in this manual.</para>
23034 <section id="circrenew">
23035 <title>Renewing</title>
23037 <para>Checked out items can be renewed (checked out for another period
23038 of time) based on your <link linkend="circfinerules">circulation
23039 rules</link> and <link linkend="RenewalPeriodBase">renewal
23040 preferences</link>. If you allow it, patrons can renew their own items
23041 via the OPAC, but sometimes you'll need to help them by renewing their
23042 items via the staff client. To renew items checked out to a patron,
23043 visit their details page or checkout page and review their checkout
23044 summary at the bottom.</para>
23047 <screeninfo>Circulation Summary</screeninfo>
23051 <imagedata fileref="images/circ/circsummary.png"/>
23056 <para>In the Renew column you will see how many times each item has been
23057 renewed and a checkbox to renew the item for the patron. Check the boxed
23058 of the items you would like to renew and click the 'Renew or Return
23059 checked items' button, or to renew all items checked out to the patron
23060 simply click the 'Renew all' button.</para>
23063 <screeninfo>Renew buttons</screeninfo>
23067 <imagedata fileref="images/circ/renewbutton.png"/>
23072 <para>Sometimes renewals will be blocked based on your circulation
23073 rules, to override this block you must have your <link
23074 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
23075 preference set to 'Allow'. If you allow renewal limit overrides, you
23076 will see a checkbox at the bottom left of the circulation summary. Check
23077 that box and then choose the items you would like to renew.</para>
23080 <screeninfo>Override renewal limit</screeninfo>
23084 <imagedata fileref="images/circ/overriderenew.png"/>
23089 <para>Checking that box will add checkboxes in the renew column above
23090 where before the item was not renewable.</para>
23093 <section id="checkingin">
23094 <title>Check In (Returning)</title>
23096 <para>Checking in items can be performed from various different
23101 <para>The check in box on the top of the main staff client</para>
23104 <screeninfo>Check out box on main Koha Staff Client
23109 <imagedata fileref="images/circ/checkinmain.png"/>
23116 <para>The check in option on the quick search bar on the Circulation
23118 <screeninfo>Check in tab on quick search bar</screeninfo>
23122 <imagedata fileref="images/circ/checkinquickbox.png"/>
23125 </screenshot></para>
23129 <para>The check in link on the patron's checkout summary (and on the
23130 checkout summary page)</para>
23133 <screeninfo>Patron checkout summary includes 'Check In'
23138 <imagedata fileref="images/circ/checkinlink.png"/>
23145 <para>The Check in page under the Circulation menu</para>
23148 <screeninfo>Check in link on Circulation Module</screeninfo>
23152 <imagedata fileref="images/circ/checkincirc.png"/>
23159 <section id="checkitemin">
23160 <title>Checking Items In</title>
23162 <para>To check an item in scan the barcode for the item into the box
23163 provided. A summary of all items checked in will appear below the
23167 <screeninfo>Check In Summary</screeninfo>
23171 <imagedata fileref="images/circ/checkin.png"/>
23176 <para>If you are checking items in that were put in the dropbox while
23177 the library was closed you can check the 'Dropbox mode' box before
23178 scanning items. This will effectively roll back the returned date to
23179 the last date the library was open.</para>
23183 <para>This requires that you have your closings added to the <link
23184 linkend="calholidays">Holidays & Calendar Tool </link></para>
23188 <para>You can also choose to forgive all overdue charges for items you
23189 are checking in by checking the 'Forgive overdue charges' box before
23190 scanning items.</para>
23193 <section id="checkinmsg">
23194 <title>Check In Messages</title>
23196 <para>There are several messages that can appear when checking items
23201 <para>If you are checking an item in at a library other than the
23202 home branch, a message will appear asking you to transfer the book
23203 to the home library</para>
23206 <screeninfo>Check in Transfer Message</screeninfo>
23210 <imagedata fileref="images/circ/checkintransfer.png"/>
23217 <para>After this item is checked in the status of the item
23218 will be changed in the catalog to 'in transit'</para>
23221 <screeninfo>In Transit Status</screeninfo>
23225 <imagedata fileref="images/circ/transferstatus.png"/>
23232 <para>To mark an item as back at the home branch, check the
23233 item in at the home branch</para>
23236 <screeninfo>Check In Transferred Item</screeninfo>
23240 <imagedata fileref="images/circ/transfercheckin.png"/>
23247 <para>A message will appear tell you that the item is not
23248 checked out, but the status will now say available in the
23249 catalog. This step is necessary to mark items as received
23250 by the home branch.</para>
23258 <para>If you are checking in an item that should have multiple
23259 parts or pieces a message will appear warning you about the number
23260 of pieces you should have in your hand</para>
23263 <screeninfo>Materials Specified</screeninfo>
23267 <imagedata fileref="images/circ/materialspecified.png"/>
23274 <para>If you're checking an item in that has a hold on it, you
23275 will be prompted to confirm the hold</para>
23278 <screeninfo>Hold Found Check In Message</screeninfo>
23282 <imagedata fileref="images/circ/holdfound.png"/>
23289 <para>Clicking the Confirm hold button will mark the item as
23290 waiting for pickup from the library</para>
23293 <screeninfo>Hold waiting at the library</screeninfo>
23297 <imagedata fileref="images/circ/waitingstatus.png"/>
23304 <para>Clicking the Print Slip and Confirm button will mark the
23305 item as waiting for pickup at the library and present the
23306 library with a receipt to print and place on the book with the
23307 patron's information</para>
23311 <para>Ignoring the hold will leave the item on hold, but leave
23312 its status as Available (it will not cancel the hold)</para>
23318 <para>If you're checking in an item that has a hold on it at
23319 another branch you will be prompted to confirm and transfer the
23323 <screeninfo>Hold found for another branch</screeninfo>
23327 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
23334 <para>Clicking the Confirm hold and Transfer button will mark
23335 the item as in transit to the library where the hold was
23339 <screeninfo>In transit hold status</screeninfo>
23343 <imagedata fileref="images/circ/intransithold.png"/>
23350 <para>Clicking the Print Slip, Transfer and Confirm button
23351 will mark the item as in transit to the library where the hold
23352 was placed and present the library with a receipt to print and
23353 place on the book with the patron's information</para>
23357 <para>Ignoring the hold will leave the item on hold, but leave
23358 its status as Available (it will not cancel the hold)</para>
23364 <para>If you have the system showing you fines at the time of
23366 linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
23367 see a message telling you about the fine and providing you a link
23368 to the payment page for that patron</para>
23371 <screeninfo>FineNotifyAtCheckin</screeninfo>
23375 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
23384 <section id="circmessages">
23385 <title>Circulation Messages</title>
23387 <para>Circulation messages are short messages that librarians can leave
23388 for their patrons or their colleagues that will appear at the time of
23389 circulation.</para>
23391 <section id="setcircmsg">
23392 <title>Setting up Messages</title>
23394 <para>Circulation messages are set up as <link
23395 linkend="authorizedvalues">Authorized Values</link>. To add or edit
23396 Circulation Messages you want to work with the <link
23397 linkend="bornotes">BOR_NOTES</link> value.</para>
23400 <screeninfo>BOR_NOTES Authorized Values</screeninfo>
23404 <imagedata fileref="images/circ/bor_notes.png"/>
23409 <para>The 'Description' field can hold a canned message that you would
23410 like to appear on the patron's record. <important>
23411 <para>The 'Description' field is limited to 80 characters, but the
23412 patron message field can hold more than that. Enter 80 characters
23413 in the 'Description' field and then type the rest on the patron
23415 </important></para>
23418 <section id="addcircmsg">
23419 <title>Adding a Message</title>
23421 <para>When on the patron's check out tab you will see a link to 'Add a
23422 new message' to the right of the check out box.</para>
23425 <screeninfo>Circulation Message in Staff Client</screeninfo>
23429 <imagedata fileref="images/circ/staffmessages.png"/>
23434 <para>When you click 'Add a new message' you will be asked to choose
23435 if the message is for the librarians or the patron and the message you
23436 would like to leave.</para>
23439 <screeninfo>Leave a Circulation Message</screeninfo>
23443 <imagedata fileref="images/circ/leavecircmsg.png"/>
23449 <para>A message for the patron will also show to the library
23454 <section id="viewcircmsg">
23455 <title>Viewing Messages</title>
23457 <para>Circulation messages meant for the staff and/or the patron will
23458 appear on the patron's checkout screen to the right of the checkout
23459 box. Messages in bold and red are meant for the library staff only,
23460 whereas messages in regular italics font are meant for the patron and
23461 the librarian.</para>
23464 <screeninfo>Circulation Message in Staff Client</screeninfo>
23468 <imagedata fileref="images/circ/staffmessages.png"/>
23473 <para>Circulation messages meant for the patron will also appear when
23474 they log into the OPAC.</para>
23477 <screeninfo>Circulation Message in OPAC</screeninfo>
23481 <imagedata fileref="images/circ/opacmsg.png"/>
23488 <section id="holds">
23489 <title>Holds</title>
23493 <section id="holdsinstaff">
23494 <title>Placing Holds in Staff Client</title>
23496 <para>There are several ways to place holds from the staff client. The
23497 most obvious is using the 'Place Hold' button at the top of any
23498 bibliographic record.</para>
23501 <screeninfo>Place Hold Button on Bib Record</screeninfo>
23505 <imagedata fileref="images/circ/placeholdbib.png"/>
23510 <para>You can also click the smaller 'Place Hold' link found at the
23511 top of your catalog search results, or the 'Holds' link found below
23512 each result.</para>
23515 <screeninfo>Hold options on search results</screeninfo>
23519 <imagedata fileref="images/circ/placeholdsearch.png"/>
23524 <para>You will be asked to search for a patron by barcode or any part
23525 of their name to start the hold process.</para>
23528 <screeninfo>Find Patron For Hold</screeninfo>
23532 <imagedata fileref="images/circ/placeholdfindpatron.png"/>
23537 <para>If you'd like to search for the patron first and then the bib
23538 record for the hold, you can open the patron record and click on the
23539 'Search to Hold' button at the top of the patron record.</para>
23542 <screeninfo>Search to Hold on Patron Record</screeninfo>
23546 <imagedata fileref="images/circ/searchtohold.png"/>
23551 <para>After clicking the button you will be brought to the catalog
23552 search page where you can find the book(s) you want to place a hold
23553 on. Under each title on the results you'll see an option to 'Hold for
23554 Patron Name.'</para>
23557 <screeninfo>Hold for Patron links on Search Results</screeninfo>
23561 <imagedata fileref="images/circ/holdresults.png"/>
23566 <para>If you want to place a hold on multiple items, simply check the
23567 boxes to the left of them and click the arrow to the right of the
23568 'Place Hold' button.</para>
23571 <screeninfo>Hold Multiple Items for Patron</screeninfo>
23575 <imagedata fileref="images/circ/holdmultiresults.png"/>
23580 <para>Depending on how many items you choose to place a hold on at
23581 once you will see a different place hold form. If you are placing a
23582 hold on one bibliographic record you will see a list of all of the
23583 items you can place a hold on.</para>
23586 <screeninfo>Place Hold Form</screeninfo>
23590 <imagedata fileref="images/circ/placeholdsingle.png"/>
23597 <para>Enter any notes that might apply to this hold</para>
23601 <para>Choose the library where the patron will pick up the
23606 <para>If the patron wants the hold to start on a date other than
23607 today, enter that in the 'Hold starts on date' field</para>
23611 <para>This option will only appear if the <link
23612 linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
23613 system preference is set to 'Allow'</para>
23619 <para>If the patron has specified that they don't want the item
23620 after a certain date, or if you have limits on hold lengths, you
23621 can enter an expiration date for the hold in the 'Hold expires on
23626 <para>To have expired holds canceled automatically you will
23627 need to have the <link linkend="expiredholdscron">Expired
23628 Holds</link> cron job set to run on a regular basis.</para>
23634 <para>Next choose if you want to place a hold on the next
23635 available item or a specific item by clicking the radio button
23636 next to an individual item.</para>
23640 <para>If you're placing a hold on multiple items you will be presented
23641 with the next available option for all titles. If no items are
23642 available for hold it will say so on the confirmation screen.</para>
23645 <screeninfo>Place multiple items on hold</screeninfo>
23649 <imagedata fileref="images/circ/placeholdmultiple.png"/>
23654 <para>Once your hold is placed, if you'd like to have Koha forget that
23655 you used the 'Search to Hold' function, you can choose to have Koha
23656 'forget' the patron's name by clicking the arrow to the right of the
23657 'Place Hold' button on the search results and choosing the 'Forget'
23661 <screeninfo>Forget Search to Hold Option</screeninfo>
23665 <imagedata fileref="images/circ/forgethold.png"/>
23671 <section id="manageholds">
23672 <title>Managing Holds</title>
23674 <para>Holds can be altered and canceled from the Holds tab found on
23675 the left of the bibliographic record.</para>
23678 <screeninfo>Bibliographic Record Tabs</screeninfo>
23682 <imagedata fileref="images/circ/holdtab.png"/>
23687 <para>From the list of holds you can change the order of the holds,
23688 the pickup location, suspend and/or cancel the hold.</para>
23691 <screeninfo>Lists of Holds</screeninfo>
23695 <imagedata fileref="images/circ/holdslist.png"/>
23701 <para>If you have your <link
23702 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
23703 preference set to "Don't allow" then you will not have the option to
23704 put an end date on the hold suspension</para>
23708 <para>Depending on how you have your <link
23709 linkend="HidePatronName">HidePatronName</link> system preference set
23710 the list may show card numbers instead of names in the Patron column
23711 like in the image above.</para>
23714 <para>To rearrange or delete holds, simply make a selection from the
23715 'Priority' pull down or click the arrows to the right of the priority
23719 <screeninfo>Hold Priority Menu</screeninfo>
23723 <imagedata fileref="images/circ/holdpriority.png"/>
23728 <para>To delete or cancel a hold, choose 'del' from the menu or click
23729 the red 'X' to the right of the hold line.</para>
23731 <para>If you use the priority pull down to rearrange or delete holds
23732 you will need to click the 'Update hold(s)' button to save your
23735 <para>Clicking the down arrow to the right of the hold will stick the
23736 hold at the bottom of the list even if more requests are made.</para>
23738 <para>For example, your library has home-bound patrons that are
23739 allowed to keep books out for months at a time. It would not be fair
23740 to other patrons if a home-bound patron were able to check out a brand
23741 new book and keep it for months. For this reason, the home-bound
23742 patron's hold request would stay at the bottom of the queue until
23743 everyone else who wanted to read that book has already done so.</para>
23746 <screeninfo>Lowest Priority & Delete Options for
23751 <imagedata fileref="images/circ/lowestpriority.png"/>
23756 <para>If a patron asks to have their hold suspended and you have the
23757 <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
23758 system preference set to 'allow' you can do so by clicking the Suspend
23759 button to far right. If the patron gives you a date for the items to
23760 become unsuspended you can enter that in the date box and click the
23761 'Update hold(s)' button to save your changes.</para>
23764 <screeninfo>Hold suspension column</screeninfo>
23768 <imagedata fileref="images/circ/suspendholds.png"/>
23776 <section id="receiveholds">
23777 <title>Receiving Holds</title>
23779 <para>When items that are on hold are checked in or out the system
23780 will remind the circulation librarian that the item is on hold and
23781 offer them options for managing the hold.</para>
23783 <para>When you check in an item that has a hold on it the system will
23784 ask you to either confirm and transfer the item</para>
23787 <screeninfo>Confirm Hold & Transfer</screeninfo>
23791 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
23796 <para>or just confirm the hold</para>
23799 <screeninfo>Confirm Hold</screeninfo>
23803 <imagedata fileref="images/circ/holdconfirm.png"/>
23808 <para>Clicking the Confirm button will mark the item as on hold for
23809 the patron. If the item needs to be transferred the item will also be
23810 marked as in transit to the proper branch. Clicking 'Ignore' will
23811 retain the hold, but allow you to check the item out to another
23812 patron. Choosing to confirm and print will present you with a
23813 printable page that you can slip inside the book with the necessary
23814 hold and/or transfer information.</para>
23816 <para>Once confirmed the hold will show on the patron record and on
23817 the checkout screen under the 'Hold' tab.</para>
23820 <screeninfo>Hold on Patron Record</screeninfo>
23824 <imagedata fileref="images/circ/holdpatronrec.png"/>
23829 <para>The item record will also show that the item is on hold.</para>
23832 <screeninfo>Hold on Item Record</screeninfo>
23836 <imagedata fileref="images/circ/holditem.png"/>
23841 <para>In some cases a patron may come in to pick up a hold for their
23842 partner (or someone else in their household). In this case you want to
23843 make sure that the hold is cancelled when you check the item out to
23844 someone else. When trying to check out an item that is already waiting
23845 for someone else you will be presented with a warning message.</para>
23848 <screeninfo>Hold waiting for someone else</screeninfo>
23852 <imagedata fileref="images/circ/holdwaitingwarn.png"/>
23857 <para>From here you can check the item out to the patron at the desk
23858 and cancel the hold for the patron.</para>
23862 <section id="transfers">
23863 <title>Transfers</title>
23865 <para>If you work in a multi-branch system you can transfer items from
23866 one library to another by using the Transfer tool. To transfer an
23871 <para>Click 'Transfer' on the Circulation page</para>
23874 <screeninfo>Transfer Tool</screeninfo>
23878 <imagedata fileref="images/circ/transfer.png"/>
23885 <para>Enter the library you would like to transfer the item
23890 <para>Scan or type the barcode on the item you would like to
23897 <para>Click 'Submit'</para>
23900 <screeninfo>Transfer Summary</screeninfo>
23904 <imagedata fileref="images/circ/itemtransferred.png"/>
23911 <para>The item will now say that it is in transit</para>
23914 <screeninfo>Item in Transit</screeninfo>
23918 <imagedata fileref="images/circ/itemintransit.png"/>
23925 <para>When the item arrives at the other branch the librarian must
23926 check the item in to acknowledge that it is no longer in
23931 <para>The item will not be permanently moved to the new
23935 <screeninfo>Item record</screeninfo>
23939 <imagedata fileref="images/circ/itemlocations.png"/>
23946 <para>The item shows the same 'Home Library' but has updated the
23947 'Current Location' to note where it resides at this time</para>
23954 <section id="setlibrary">
23955 <title>Set Library</title>
23957 <para>By default you will enter the staff client as if you are at your
23958 home library. This library will appear in the top right of the Staff
23962 <screeninfo>My Library</screeninfo>
23966 <imagedata fileref="images/circ/mylibrary.png"/>
23971 <para>This is the library that all circulation transactions will take
23972 place at. If you are at another library (or on a bookmobile) you will
23973 want to set your library before you start circulating items. To do this
23974 you can click 'Set' at the top right or on the Circulation page.</para>
23977 <screeninfo>Set Library Form</screeninfo>
23981 <imagedata fileref="images/circ/setlibrary.png"/>
23986 <para>Once you have saved your changes you new library will appear in
23987 the top right.</para>
23990 <section id="fastaddcat">
23991 <title>Fast Add Cataloging</title>
23993 <para>Sometimes circulation librarians need to quickly add a record to
23994 the system for an item they are about to check out. This is called 'Fast
23995 Add.' To allow circulation librarians access to the Fast Add Cataloging
23996 tool, simply make sure they have the <link
23997 linkend="fastaddpermissions">fast_cataloging</link> permissions. There
23998 are two ways to add titles via fast add. If you know that you're about
23999 to check out an item that isn't in you catalog you can go to the
24000 Circulation module and click 'Fast cataloging.'</para>
24003 <screeninfo>Circulation Menu</screeninfo>
24007 <imagedata fileref="images/circ/circmenu.png"/>
24012 <para>The cataloging interface will open up with the short cataloging
24016 <screeninfo>Fast Add Framework</screeninfo>
24020 <imagedata fileref="images/circ/fastadd.png"/>
24025 <para>After adding your cataloging data you will be asked to enter item
24026 data. Enter the items barcode, collection code, etc and save the item
24027 before checking it out.</para>
24029 <para>The other way to fast catalog is from the checkout screen. When
24030 you enter a barcode at checkout that Koha can't find, it will prompt you
24031 to use fast cataloging to add the item to Koha and check it out.</para>
24034 <screeninfo>Barcode not found</screeninfo>
24038 <imagedata fileref="images/circ/barcodefastadd.png"/>
24043 <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
24044 form where you can enter the title information</para>
24047 <screeninfo>Fast cataloging</screeninfo>
24051 <imagedata fileref="images/circ/fastaddbarcode.png"/>
24056 <para>After clicking 'Save' you will be brought to the item record where
24057 the barcode will already be filled in with the barcode you're trying to
24061 <screeninfo>Fast cataloging item record</screeninfo>
24065 <imagedata fileref="images/circ/fastadditem.png"/>
24070 <para>After clicking the 'Add item' button the item will automatically
24071 be checked out the patron you were trying to check the book out to
24075 <screeninfo>Checked out item</screeninfo>
24079 <imagedata fileref="images/circ/fastaddcheckedout.png"/>
24085 <section id="circreports">
24086 <title>Circulation Reports</title>
24090 <section id="holdsqueue">
24091 <title>Holds Queue</title>
24093 <para>This report will show you all of the holds at your
24097 <screeninfo>Sample Holds Queue</screeninfo>
24101 <imagedata fileref="images/circ/holdsqueue.png"/>
24106 <para>To generate this report, you must have the <link
24107 linkend="buildholdscron">Build Holds Queue cron job</link> running.
24108 This cron job is a script that should be run periodically if your
24109 library system allows borrowers to place on-shelf holds. This script
24110 decides which library should be responsible for fulfilling a given
24111 hold request.</para>
24113 <para>It's behavior is controlled by the system preferences <link
24114 linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link
24115 linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
24117 <para>If you do not want all of your libraries to participate in the
24118 on-shelf holds fulfillment process, you should list the the libraries
24119 that *do* participate in the process here by inputting all the
24120 participating library's branchcodes, separated by commas ( e.g.
24121 "MPL,CPL,SPL,BML" etc. ).</para>
24123 <para>By default, the holds queue will be generated such that the
24124 system will first attempt to hold fulfillment using items already at
24125 the pickup library if possible. If there are no items available at the
24126 pickup library to fill a hold, build_holds_queue.pl will then use the
24127 list of libraries defined in StaticHoldsQueueWeight. If
24128 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
24129 script will assign fulfillment requests in the order the branches are
24130 placed in the StaticHoldsQueueWeight system preference.</para>
24132 <para>For example, if your system has three libraries, of varying
24133 sizes ( small, medium and large ) and you want the burden of holds
24134 fulfillment to be on larger libraries before smaller libraries, you
24135 would want StaticHoldsQueueWeight to look something like
24136 "LRG,MED,SML".</para>
24138 <para>If you want the burden of holds fulfillment to be spread out
24139 equally throughout your library system, simply enable
24140 RandomizeHoldsQueueWeight. When this system preference is enabled, the
24141 order in which libraries will be requested to fulfill an on-shelf hold
24142 will be randomized each time the list is regenerated.</para>
24144 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
24145 time. Doing so will cause the build_holds_queue script to ignore
24146 RandomizeHoldsQueueWeight, causing the script to request hold
24147 fulfillment not randomly, but by alphabetical order.</para>
24150 <section id="holdspull">
24151 <title>Holds to pull</title>
24153 <para>This report will show you all of the items that have holds on
24154 them that are available at the library for pulling. If the items are
24155 available at multiple branches then all branches with that item
24156 available will see the hold to pull until one library triggers the
24160 <screeninfo>Holds to Pull</screeninfo>
24164 <imagedata fileref="images/circ/holdstopull.png"/>
24169 <para>You can limit the results you see by using the Refine box on the
24170 left side of the page:</para>
24173 <screeninfo>Refine Holds to Pull Report</screeninfo>
24177 <imagedata fileref="images/circ/refineholdstopull.png"/>
24183 <section id="holdspickup">
24184 <title>Holds awaiting pickup</title>
24186 <para>This report will show all of the holds that are waiting for
24187 patrons to pick them up.</para>
24190 <screeninfo>Holds Awaiting Pickup</screeninfo>
24194 <imagedata fileref="images/circ/holdspickup.png"/>
24199 <para>Items that have been on the hold shelf longer than you normally
24200 allow (based on the <link
24201 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
24202 preference value) will appear on the 'Holds Over' tab, they will not
24203 automatically be cancelled unless you have set the <link
24204 linkend="expiredholdscron">cron job</link> to do that for you, but you
24205 can cancel all holds using the button at the top of the list.</para>
24208 <screeninfo>Items waiting on the hold shelf too long</screeninfo>
24212 <imagedata fileref="images/circ/holdspickupover.png"/>
24218 <section id="holdratios">
24219 <title>Hold ratios</title>
24221 <para>Hold ratios help with collection development. Using this report
24222 you will be able to see how many of your patrons have holds on items
24223 and whether you should buy more. By default it will be set to the
24224 library needing 3 items per hold that has been placed. The report will
24225 tell you how many additional items need to be purchased to meet this
24229 <screeninfo>Hold Ratios</screeninfo>
24233 <imagedata fileref="images/circ/holdratio.png"/>
24239 <section id="transferstoreceive">
24240 <title>Transfers to receive</title>
24242 <para>This report will list all of the items that Koha thinks are in
24243 transit to your library.</para>
24246 <screeninfo>Transfers to Receive</screeninfo>
24250 <imagedata fileref="images/circ/transitreceive.png"/>
24255 <para>If your transfers are late in arriving at your library you will
24256 see a message stating how late your items are.</para>
24259 <screeninfo>Late transfers include warning messages</screeninfo>
24263 <imagedata fileref="images/circ/transferlate.png"/>
24269 <para>An item is considered late based on the number of days you
24270 have entered in the <link
24271 linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
24272 system preference.</para>
24276 <section id="overduesreport">
24277 <title>Overdues</title>
24280 <para>For libraries with a large patron base, this report may take a
24281 significant amount of time to run.</para>
24285 <para>Large libraries can choose to filter the report before it runs
24286 by setting the <link
24287 linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
24288 system preference to 'Require'.</para>
24291 <para>This report will list all items that are overdue at your
24295 <screeninfo>Overdues List</screeninfo>
24299 <imagedata fileref="images/circ/overdues.png"/>
24304 <para>The report can be filtered using the menu options found on the
24305 left of the report.</para>
24308 <section id="overduesfines">
24309 <title>Overdues with fines</title>
24311 <para>This report will show you any overdues at your library that have
24312 accrued fines on them.</para>
24315 <screeninfo>Overdues with fines</screeninfo>
24319 <imagedata fileref="images/circ/overduewfines.png"/>
24324 <para>If you would like to limit the report you can use the pull down
24325 menu at the top to limit to a specific shelving location at your
24326 branch. To see overdues with fines at other branches you will have to
24327 <link linkend="setlibrary">change your branch</link> or log in at that
24329 <para>If you do not charge fines and/or don't have the <link
24330 linkend="finescronjob">fines cron job</link> running you will see
24331 no data on this report.</para>
24332 </important></para>
24336 <section id="trackinhouse">
24337 <title>Tracking In house Use</title>
24339 <para>Many libraries track the use of items within the library. This can
24340 be done in Koha one of two ways. The first is to create one or more
24341 <link linkend="addstatspatron">Statistical Patrons</link>. When
24342 collecting items that have been used within the library, you will want
24343 to check them out to your statistical patron:</para>
24346 <screeninfo>Check Out Items to Stats Patron</screeninfo>
24350 <imagedata fileref="images/circ/checkoutinhouse.png"/>
24355 <para>Instead of marking the item as 'checked out' the system will
24356 record that the item was used in house:</para>
24359 <screeninfo>Local Use Recorded</screeninfo>
24363 <imagedata fileref="images/circ/localuserecorded.png"/>
24368 <para>Repeat these steps for all items that have been used within the
24369 library to keep accurate statistics for item use.</para>
24371 <para>The other way to record local use of items is to set your <link
24372 linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
24373 preference to 'Record.' Then whenever you check an item in that is not
24374 checked out and not on hold a local use will be recorded.</para>
24377 <screeninfo>Local Use Recorded</screeninfo>
24381 <imagedata fileref="images/circ/localusecheckin.png"/>
24387 <para>If you have <link
24388 linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
24389 'Record' you can still use your statistical patrons to record local
24390 use as well.</para>
24394 <section id="processinglocations">
24395 <title>In Processing / Book Cart Locations</title>
24397 <para>Koha allows for handling temporary locations like the processing
24398 center and/or book carts throughout the library. For this feature to
24399 work you must first make sure you have <link
24400 linkend="authorizedvalues">authorized values</link> set in the <link
24401 linkend="shelvelocvals">LOC</link> category for PROC (Processing Center)
24402 and CART (Book Cart).</para>
24405 <screeninfo>CART & PROC values in LOC</screeninfo>
24409 <imagedata fileref="images/circ/LOCvalues.png"/>
24414 <para>Next you need to set the <link
24415 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
24416 preference to PROC. This will set the new items to the Processing Center
24417 as their default location.</para>
24419 <para>Create items with their desired final shelving location.</para>
24423 <para>These newly cataloged items will be temporarily set to the
24424 PROC location and will display with whatever description PROC has.
24425 The original location code entered at item creation is stored in the
24426 new items column 'permanent_location', for future use. Items will
24427 stay in the PROC location until they are checked in. To have those
24428 items then move to the shelving cart:</para>
24432 <para>Turn on the <link
24433 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
24434 system preference</para>
24438 <para>Check in those newly-created items and they will be moved
24439 to the location code of CART and display with whatever
24440 description CART has.</para>
24444 <para>A <link linkend="proccartcron">cron job</link> runs at
24445 specified intervals to age items from CART to the permanent
24446 shelving location. (For example, an hourly cron entry of
24447 cart_to_shelf.pl --hours 3 where --hours is the amount of time
24448 an item should spend on the cart before aging to its permanent
24455 linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
24456 system preference is turned on, any newly checked-in item
24457 is also automatically put into the shelving cart, to be
24458 covered by the same script run.</para>
24464 <para>Checkins with confirmed holds will not go into the
24465 shelving cart. If items on the shelving cart are checked
24466 out, the cart location will be cleared.</para>
24476 <section id="selfcheckout">
24477 <title>Self Checkout</title>
24479 <para>Koha comes with a very basic self checkout module. To enable this
24480 module you need to set the <link
24481 linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
24482 'Enable.' To use this module you have to log in as a <link
24483 linkend="addstaffpatron">staff member</link> with <link
24484 linkend="patronpermissions">circulation permissions</link>.</para>
24487 <para>Create a <link linkend="addstaffpatron">staff patron</link>
24488 specifically for this action so that you don't leave a real staff
24489 client logged into a computer all day</para>
24492 <para>There is no link to the Self Checkout module, but a simple
24493 addition to the <link linkend="intranetuserjs">intranetuserjs</link>
24494 system preference can add one.</para>
24496 <programlisting>$(document).ready(function(){ $("#login
24497 #submit").parent().after("<p><a
24498 href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
24499 target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
24502 <para>The code above has line breaks added to make it more readable,
24503 please be sure to enter the above as one line in when putting it in
24504 the system preference.</para>
24507 <para>The link will then appear at the bottom of the log in page:</para>
24510 <screeninfo>Self Checkout Link on Staff Login</screeninfo>
24514 <imagedata fileref="images/circ/selfcheckoutlink.png"/>
24519 <para>You can also access this module by going to :
24520 http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
24522 <para>When on the self checkout page depending on your value in the
24523 <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
24524 preference you will be asked to enter you cardnumber</para>
24527 <screeninfo>Self Checkout Patron Card Number</screeninfo>
24531 <imagedata fileref="images/circ/selfcheckout.png"/>
24536 <para>or your username and password:</para>
24539 <screeninfo>Shelf checkout by login</screeninfo>
24543 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
24548 <para>Once you're logged in to the self check module you will be asked
24549 to scan the items you are checking out</para>
24552 <screeninfo>Self Checkout</screeninfo>
24556 <imagedata fileref="images/circ/selfcheckoutuser.png"/>
24561 <para>As you scan items they will appear below the barcode box</para>
24564 <screeninfo>Self Checkout Summary</screeninfo>
24568 <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
24573 <para>When you are finished scanning items it is important to click the
24574 'Click here if done' button to log the patron out and prepare for the
24575 next patron.</para>
24577 <para>When attempting to check items out there are some instances where
24578 error messages will appear and the patron will be directed to the
24579 librarian. This will happen even if you are allowing overrides on
24580 circulation functions. Only a librarian can override a circulation block
24581 and so patrons must go to the librarian for help in these
24585 <screeninfo>Self Checkout Error Message</screeninfo>
24589 <imagedata fileref="images/circ/selfcheckoutfines.png"/>
24595 <section id="offlinecirc">
24596 <title>Offline Circulation Utility</title>
24598 <section id="firefoxofflinecirc">
24601 <firstname>Franois</firstname>
24603 <surname>Charbonnier</surname>
24607 <orgname>BibLibre</orgname>
24610 <othercredit role="copyeditor">
24611 <firstname>Nicole C.</firstname>
24613 <surname>Engard</surname>
24615 <contrib>Changed content where necessary.</contrib>
24618 <pubdate>2012</pubdate>
24621 <title>Firefox Plugin</title>
24623 <para>There is an offline circulation tool that you can add to your
24624 Firefox browser as a plugin/addon. To do so, just go to <ulink
24625 url="https://addons.mozilla.org/en/firefox/addon/koct/">https://addons.mozilla.org/en/firefox/addon/koct/</ulink>
24626 page and click on the "install now" button. You may have to confirm
24627 the installation, just click on "install now" and then restart Firefox
24628 to complete the installation.</para>
24630 <para>Once you have installed the plugin and restarted Firefox, you
24631 will see the Koha logo in the add-on bar at the bottom right of
24635 <screeninfo>Koha Icon on Add-on Bar</screeninfo>
24639 <imagedata fileref="images/circ/koctstatusbar.png"/>
24644 <para>A click on the logo will open the tool in its own window.</para>
24647 <screeninfo>Koha Offline Circ Tool</screeninfo>
24651 <imagedata fileref="images/circ/koct.png"/>
24656 <para>The plugin consists of four tabs:</para>
24660 <para>The Check Out tab is where you check out items</para>
24664 <para>The Check In tab is where you check in items</para>
24668 <para>The Log tab keeps track of every transaction done while in
24669 offline mode</para>
24673 <para>The log will keep information until you empty it. Each
24674 time you open the plugin and it contains data in the log it
24675 will warn you</para>
24678 <screeninfo>Koha Offline Circ Warning</screeninfo>
24682 <imagedata fileref="images/circ/koctwarn.png"/>
24687 <para>If you'd like to clear the log, check the 'I want to
24688 delete rows' box before hitting the 'OK' button. Otherwise
24689 clicking 'OK' will keep the items in the log and let you
24690 continue working with the tool.</para>
24696 <para>The Param tab is to set up the plugin</para>
24700 <para>The first thing you want to do then is to set up the plugin. Go
24701 to the Param tab to set up the plugin</para>
24704 <screeninfo>Koha Offline CIrc Params</screeninfo>
24708 <imagedata fileref="images/circ/koctparam.png"/>
24713 <para>Answer the 4 questions presented:</para>
24717 <para>Server = the URL of the librarian interface</para>
24721 <para>Branch Code = the code for the branch where you are
24726 <para>Username = your staff account login</para>
24730 <para>Password = your staff account password</para>
24735 <para>To save the settings, you will have to close the plugin
24736 window and re-open it by clicking again on the Koha logo in the
24739 <para>You can create a staff account dedicated to the offline
24740 circulation. So that, no matter who is at the circulation desk,
24741 they can all use the same login. Along those lines, you can use a
24742 group login that you already have in place for circulation as
24744 </tip>Once you have everything set up you can start checking items
24747 <para>Checking out:</para>
24750 <screeninfo>Koha Offline Circulation Check Out</screeninfo>
24754 <imagedata fileref="images/circ/koct.png"/>
24761 <para>Go to the Check Out tab</para>
24765 <para>Scan the patron barcode</para>
24769 <para>Scan the item barcode</para>
24773 <para>Click 'Save'</para>
24777 <para>Checking in:</para>
24780 <screeninfo>Koha Offline Circulation Check In</screeninfo>
24784 <imagedata fileref="images/circ/koctcheckin.png"/>
24791 <para>Go to the Check In tab</para>
24795 <para>Scan the item barcode</para>
24799 <para>Click Save</para>
24803 <para>Each time, you check out or check in an item, a new transaction
24804 is recorded in the local plugin database and you will see, at the
24805 bottom of the plugin how many transactions has been made during the
24806 offline circulation. For example, "10 Row(s) Added" means you did 10
24807 transactions.</para>
24810 <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
24814 <imagedata fileref="images/circ/koctcount.png"/>
24819 <para>Then, if you want an overview of every transaction, go to the
24820 Log tab. This tab will show you the transactions in the plugin
24824 <screeninfo>Koha Offline Circulation Log</screeninfo>
24828 <imagedata fileref="images/circ/koctlog.png"/>
24834 <para>The status will be "Local." as long as you are offline and
24835 don't process the transactions into Koha.</para>
24836 </tip>When your Internet connection comes back up you will want to
24837 get these transactions in to Koha. Before processing these
24838 transactions you should be aware of a few issues.</para>
24840 <para>Because you are not connected to your Koha database when using
24841 this plugin holds will need additional processing. If an item you
24842 check in while offline has a hold, the hold is kept on the item.
24843 Since, you can't confirm holds found during the processing of every
24844 check in, the holds stay on the item and will need to be managed
24845 later. If you only checked in a few items you can just keep a record
24846 of them all. If you checked in a lot of items you can use the Holds
24847 Queue once it rebuilds to see what holds made it to the shelf
24848 erroneously.</para>
24850 <para>Similarly, if an patron card was expired, the offline
24851 circulation tool won't know about it, so the checkout will be recorded
24852 regardless of the patron's account being blocked normally.</para>
24854 <para>You have two options for adding this data to Koha</para>
24858 <para>Commit to Koha</para>
24862 <para>If you checked in/out on more than one computer at the
24863 same time, what you want is to process every transaction
24864 consistently. Let's say for instance that one patron checked a
24865 book out on one computer and then checked the same book in on
24866 another computer. To be consistent, you need to record the
24867 check out first and then the check in. Not the opposite! To do
24868 so, you need to group every transaction in one place, sort
24869 them all and then, process everything. So, you need to use the
24870 "Commit to Koha" option from every plugin/computer you worked
24871 with. This way, the log will go to Koha and be accessible from
24872 the Offline Circulation page.</para>
24875 <screeninfo>Circulation Menu</screeninfo>
24879 <imagedata fileref="images/circ/offlinecirclink.png"/>
24886 <para><emphasis>Get there:</emphasis> Circulation > Offline
24887 Circulation (Firefox add-on)</para>
24890 <screeninfo>Offline Circulation</screeninfo>
24894 <imagedata fileref="images/circ/offlinecirclog.png"/>
24901 <para>Once all of the logs from all of the circulation
24902 computers are loaded you will be able to check them all or
24903 select just those you want to process into Koha.</para>
24907 <para>Click on the Process button and Koha will record every
24908 sorted transaction one by one. For each transaction, the
24909 status will change to:</para>
24913 <para>"Success." if the transaction was processed
24918 <para>"Borrower not found." if the borrower card number is
24923 <para>"Item not found." if the item barcode is
24928 <para>"Item not issued." if you checked in an available
24935 <para>Once finished you will have a summary of all of your
24936 transactions</para>
24939 <screeninfo>Offline Circulation Summary</screeninfo>
24943 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
24952 <para>Apply directly</para>
24956 <para>If you performed all of the circulation actions on one
24957 computer then everything is sorted already so you can choose
24958 to "Apply directly"</para>
24962 <para>The status column will be updated to let you know if the
24963 transactions were applied</para>
24967 <para>"Success." if the transaction was processed
24972 <para>"Borrower not found." if the borrower card number is
24977 <para>"Item not found." if the item barcode is
24982 <para>"Item not issued." if you checked in an available
24989 <para>Once you're finished you can review all of the items
24990 right in the Log tab</para>
24993 <screeninfo>Koha Offline Circulation Apply
24994 Directly</screeninfo>
24998 <imagedata fileref="images/circ/koctdirectly.png"/>
25007 <para>Once you are done you can clear the log by clicking Clear. If
25008 you don't you will be warned the next time you open the Offline
25009 Circulation tool.</para>
25012 <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
25016 <imagedata fileref="images/circ/koctwarn.png"/>
25022 <section id="windowsofflinecirc">
25023 <title>Offline Circ Tool for Windows</title>
25025 <para>The Offline Circulation Utility can be downloaded at: <ulink
25026 url="http://millruntech.com/koha/koha-offline-circulation">http://millruntech.com/koha/koha-offline-circulation</ulink></para>
25029 <section id="uploadofflinecirc">
25030 <title>Upload Offline Circ File</title>
25032 <para>The <link linkend="windowsofflinecirc">offline circulation tool
25033 for Windows</link> will generate a KOC file that you can upload into
25034 Koha once your system comes back up.</para>
25036 <para>On the Circulation menu click 'Offline Circulation File (.koc)
25040 <screeninfo>Circulation menu</screeninfo>
25044 <imagedata fileref="images/circ/offlinecirclink.png"/>
25049 <para>Browse your computer for the *.koc file</para>
25052 <screeninfo>Upload KOC File</screeninfo>
25056 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
25061 <para>Once the file is uploaded, click the process the file</para>
25064 <screeninfo>Process offline circulation file</screeninfo>
25068 <imagedata fileref="images/circ/processoffline.png"/>
25073 <para>When this is complete you'll see the summary of actions from
25074 when you were offline (including any errors).</para>
25077 <screeninfo>Summary of offline actions</screeninfo>
25081 <imagedata fileref="images/circ/offlinesummary.png"/>
25089 <chapter id="cataloging">
25090 <title>Cataloging</title>
25092 <para>Before you start cataloging in Koha you're going to want to do some
25093 basic setup. Refer to the <link linkend="implementation">Implementation
25094 Checklist</link> for a full list of these things. Most importantly you're
25095 going to want to make sure that your <link
25096 linkend="marcbibframeworks">Frameworks</link> are all defined the way you
25097 want. Once in the cataloging module you will not be able to add or remove
25098 fields and subfields so your frameworks must be ready before you start
25103 <para><emphasis>Get there:</emphasis> More > Cataloging</para>
25107 <section id="catbibs">
25108 <title>Bibliographic Records</title>
25110 <para>In Koha the bibliographic record contains the main information
25111 related to the material. This includes things like the title, author,
25112 ISBN, etc. This information is stored in Koha in Marc (different flavors
25113 of Marc are supported in Koha). Once this information is saved, <link
25114 linkend="catitems">items or holdings</link> can be attached.</para>
25116 <section id="addbibrec">
25117 <title>Adding Records</title>
25119 <para>Records can be added to Koha via original or copy cataloging. If
25120 you would like to catalog a record using a blank template</para>
25124 <para>Click 'New Record'</para>
25127 <screeninfo>New Record Menu</screeninfo>
25131 <imagedata fileref="images/cataloging/newfromframework.png"/>
25138 <para>Choose the framework you would like to base your record
25145 <para>If you want to catalog a record based on an existing record at
25146 another library</para>
25150 <para>Click 'z39.50 Search'</para>
25153 <screeninfo>Z39.50 Search</screeninfo>
25157 <imagedata fileref="images/cataloging/zsearch.png"/>
25164 <para>Search for the item you would like to catalog</para>
25169 <para>If no results are found, try searching for fewer
25170 fields, not all Z39.50 targets can search all of the
25171 fields above.</para>
25178 <para>Search targets can be altered by using the <link
25179 linkend="z3950admin">Z39.50 Admin</link> area.</para>
25183 <para>From the results you can view the MARC or Card view for
25184 the records or choose to Import them into Koha</para>
25187 <screeninfo>Z39.50 Search Results</screeninfo>
25191 <imagedata fileref="images/cataloging/zsearchresults.png"/>
25198 <para>In addition to the Import link to the right of each
25199 title, you can click on the title you're interested in and
25200 a menu will pop up with links to preview the record and
25204 <screeninfo>Import Link Popup on Z39.50 Search
25205 Results</screeninfo>
25209 <imagedata fileref="images/cataloging/importz39.png"/>
25216 <para>If you don't find the title you need in your Z39.50
25217 search results you can click the 'Try Another Search'
25218 button at the bottom left of your results</para>
25221 <screeninfo>Try another search</screeninfo>
25225 <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
25236 <para>Once you've opened a blank framework or imported a record via
25237 Z39.50 you will be presented with the form to continue
25241 <screeninfo>Add MARC Record</screeninfo>
25245 <imagedata fileref="images/cataloging/addmarc.png"/>
25252 <para>To expand a collapsed tag click on the tag
25257 <para>To get help from the Library of Congress on a Marc tag click
25258 the question mark (?) to the right of each field number</para>
25262 <para>If you feel that this clutters the screen you can hide
25263 the question marks by unchecking the box next to the 'Show
25264 MARC tag documentation links' note at the top right of the
25268 <screeninfo>Show MARC tag documentation links
25269 checkbox</screeninfo>
25273 <imagedata fileref="images/cataloging/marcdoclinks.png"/>
25282 <para>Sometimes fields may not be editable due to the value in
25284 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
25285 system preference. If you have this preference set to not allow
25286 catalogers to type in fields controlled by authorities you may see
25287 a lock symbol to the left of the field.</para>
25290 <screeninfo>Authority fields locked against editing</screeninfo>
25294 <imagedata fileref="images/cataloging/lockedauthority.png"/>
25301 <para>If this icon appears you must click the icon to the
25302 right of the field to search for an existing authority.</para>
25305 <screeninfo>Search for authority</screeninfo>
25309 <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
25316 <para>From the results list click 'Choose authority' to bring
25317 that into your catalog record</para>
25320 <screeninfo>Authority search results</screeninfo>
25324 <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
25333 <para>To duplicate a field click on the 'repeat this tag' icon to
25334 the right of the tag</para>
25337 <screeninfo>Duplicate a Field</screeninfo>
25341 <imagedata fileref="images/cataloging/dupfield.png"/>
25348 <para>To move subfields in to the right order, click the up
25349 arrow to the left of the field</para>
25353 <para>To duplicate a subfield click on the clone icon (to
25354 remove a copied field, click the delete clone icon) to the
25355 right of the field</para>
25358 <screeninfo>Clone Subfield</screeninfo>
25362 <imagedata fileref="images/cataloging/clonesubfield.png"/>
25369 <para>To remove a subfield (if there is more than one of the
25370 same type), click the - (minus sign) to the right of the
25377 <para>To use a plugin click on the icon to the right of the
25381 <screeninfo>Leader Builder Plugin</screeninfo>
25385 <imagedata fileref="images/cataloging/leaderbuilder.png"/>
25392 <para>Some fixed fields have editors that will change based on
25393 the material type you're cataloging (for example the 006 and
25394 the 008 fields)</para>
25397 <screeninfo>008 Plugin</screeninfo>
25401 <imagedata fileref="images/cataloging/008plugin.png"/>
25410 <para>Once you've finished, click the 'Save' button at the top and
25411 choose whether you want to save and view the bib record you have
25412 created or continue on to add/edit items attached to the
25416 <screeninfo>Record save options</screeninfo>
25420 <imagedata fileref="images/cataloging/savecataloging.png"/>
25427 <para>If you are about to add a duplicate record to the system
25428 you will be warned before saving</para>
25431 <screeninfo>Duplicate Record Warning</screeninfo>
25435 <imagedata fileref="images/cataloging/duprecordwarn.png"/>
25445 <section id="cataloganalytics">
25446 <title>Adding Analytic Records</title>
25448 <para>Libraries sometimes make journal articles and articles within
25449 monographs and serials accessible to library patrons through analytics
25450 cataloging. Analytics cataloging creates separate bibliographic
25451 records for these articles, chapters, sections, etc. found within a
25452 larger resource such as a book, an article within a journal, newspaper
25453 or serial. In analytics cataloging, although a separate bib record is
25454 created for the title, it is not physically separated from the host
25455 item. Learn more about Analytics in Chapter 13 of AACR2.</para>
25457 <para>If you would like to catalog analytic records in Koha you first
25458 need to update the <link
25459 linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
25460 preference to 'Display.'</para>
25462 <para>After cataloging your analytic record (see <link
25463 linkend="addbibrec">Adding Records</link> for more on creating
25464 records) click 'Edit' from the normal view and choose to 'Link to Host
25468 <screeninfo>Link to Host Item</screeninfo>
25472 <imagedata fileref="images/cataloging/analyticslink.png"/>
25477 <para>This will prompt you to enter the barcode for the item this
25478 record should be linked to.</para>
25481 <screeninfo>Barcode for Analytic Linking</screeninfo>
25485 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
25490 <para>After entering the item's barcode and clicking 'Select' you will
25491 receive a confirmation message.</para>
25494 <screeninfo>Analytic Link Success</screeninfo>
25498 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
25503 <para>The record will now have the 773 field filled in properly to
25504 complete the link.</para>
25507 <screeninfo>773</screeninfo>
25511 <imagedata fileref="images/cataloging/analytics773.png"/>
25516 <para>If you have linked an analytic record incorrectly you can remove
25517 that link by editing the item on the analytic record (not the host
25518 record). To do this, go to the analytic record and click the 'Edit'
25519 button and choose to 'Edit items'. To the left of each item you will
25520 see two options.</para>
25523 <screeninfo>Edit Analytic Item Record</screeninfo>
25527 <imagedata fileref="images/cataloging/analyticdelink.png"/>
25534 <para>Clicking 'Edit in Host' will allow you to edit the item on
25535 the host record.</para>
25539 <para>Clicking 'Delink' will remove the 773 field and the link
25540 between the analytic and the host.</para>
25544 <para>To view all of the items tied to the host record, do a search
25545 for the record, click the Analytics tab on the left and the analytics
25546 tied to each barcode will be shown under the "Used in" column.</para>
25549 <screeninfo>Analytics Tab</screeninfo>
25553 <imagedata fileref="images/cataloging/analyticstab.png"/>
25559 <para>It is also possible to create analytic records from this
25560 screen by clicking on "Create Analytics"</para>
25563 <para>You can also see the analytics attached to this record by
25564 clicking the 'Show Analytic' link towards the top of the record in the
25565 normal view.</para>
25568 <screeninfo>Show Analytics on Bib Record</screeninfo>
25572 <imagedata fileref="images/cataloging/anayticbib.png"/>
25578 <section id="editbibrec">
25579 <title>Editing Records</title>
25581 <para>To edit a record you can click 'Edit Biblio' from the search
25582 results on the cataloging page</para>
25585 <screeninfo>Edit Biblio Option on Search Results</screeninfo>
25589 <imagedata fileref="images/cataloging/catalogsearch.png"/>
25594 <para>or by clicking the Edit button on the Bibliographic Record and
25595 choosing 'Edit Record'</para>
25598 <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
25602 <imagedata fileref="images/cataloging/editrecord.png"/>
25607 <para>The record will open in the MARC editor</para>
25610 <screeninfo>Editing MARC Record</screeninfo>
25614 <imagedata fileref="images/cataloging/editingrecord.png"/>
25619 <para>The alternative is to search via Z39.50 to overlay your record
25620 with a fuller record found at another library. You can do this by
25621 choosing 'Replace Record via Z39.50' from the Edit menu.</para>
25624 <screeninfo>Replace via Z39.50</screeninfo>
25628 <imagedata fileref="images/cataloging/replaceviaz39.png"/>
25633 <para>Once you choose that you will be brought to a Z39.50 search
25634 window to search other libraries for the record in question.</para>
25636 <para>Once you have made your edits (via either method) you can click
25637 'Save' at the top left of the editor.</para>
25639 <para>You can also use the edit menu to add your own custom cover
25640 image if you have either <link
25641 linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
25642 <link linkend="LocalCoverImages">LocalCoverImages</link> set to
25643 'Display' by choosing 'Upload Image' from the menu.</para>
25646 <screeninfo>Upload Image</screeninfo>
25650 <imagedata fileref="images/cataloging/uploadimage.png"/>
25655 <para>Choosing to 'Upload Image' will take you to the <link
25656 linkend="uploadlocalimages">Upload Local Cover Image
25657 Tool</link>.</para>
25660 <section id="dupbibrec">
25661 <title>Duplicating Records</title>
25663 <para>Sometimes a copy of the record you need to catalog can't be
25664 found via Z39.50. In these cases you can create a duplicate of similar
25665 record and edit the necessary pieces to create a new record. To
25666 duplicate an existing record click 'Edit as New (Duplicate)' from the
25667 Edit menu on the Bibliographic Record</para>
25670 <screeninfo>Edit as New (Duplicate) Bibliographic
25671 Record</screeninfo>
25675 <imagedata fileref="images/cataloging/createduplicate.png"/>
25680 <para>This will open a new MARC record with the fields filled in with
25681 the values from the original Bibliographic Record.</para>
25684 <screeninfo>New Duplicate Record</screeninfo>
25688 <imagedata fileref="images/cataloging/newduprecord.png"/>
25694 <section id="mergebibs">
25695 <title>Merging Records</title>
25697 <para>If you would like to merge together multiple records you can do
25698 that via the <link linkend="lists">Lists</link> tool. <link
25699 linkend="mergebibrecs">Learn more here</link>.</para>
25703 <section id="catitems">
25704 <title>Item Records</title>
25706 <para>In Koha each bibliographic record can have one or more items
25707 attached. These items are sometimes referred to as holdings. Each item
25708 includes information to the physical copy the library has.</para>
25710 <section id="addingitems">
25711 <title>Adding Items</title>
25713 <para>After saving a new bibliographic record, you will be redirected
25714 to a blank item record so that you can attach an item to the
25715 bibliographic record. You can also click 'Add/Edit Items' from the
25716 cataloging search results</para>
25719 <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
25723 <imagedata fileref="images/cataloging/catalogsearch.png"/>
25728 <para>or you can add new item at any time by clicking 'New' on the
25729 bibliographic record and choosing 'New Item'</para>
25732 <screeninfo>New Item Button</screeninfo>
25736 <imagedata fileref="images/cataloging/newitem.png"/>
25741 <para>The item edit form will appear:</para>
25744 <screeninfo>Add item form</screeninfo>
25748 <imagedata fileref="images/cataloging/additem.png"/>
25753 <para>At the very least, if you plan on circulating the item, the
25754 following fields should be entered for new items:</para>
25758 <para>2 - Source of classification</para>
25762 <para>a - Permanent location</para>
25766 <para>b - Current location</para>
25770 <para>o - Full call number</para>
25774 <para>p - Barcode</para>
25778 <para>v - Cost, replacement price</para>
25782 <para>This value will be charged to patrons when you mark an
25783 item they have checked out as 'Lost'</para>
25789 <para>y - Koha item type</para>
25793 <para>To make sure that these values are filled in you can mark them
25794 as mandatory in the <link linkend="marcbibframeworks">framework</link>
25795 you're using and then they will appear in red with a 'required' label.
25796 The item will not save until the required fields are filled in.</para>
25799 <screeninfo>Required Item Subfield</screeninfo>
25803 <imagedata fileref="images/cataloging/requireditemfields.png"/>
25811 <para>To make item subfields required in a framework you'll want
25812 to edit the 952 field in the <link
25813 linkend="marcbibframeworks">framework editor</link>.</para>
25818 <para>Below the add form there are 3 buttons for adding the
25822 <screeninfo>Add Item Buttons</screeninfo>
25826 <imagedata fileref="images/cataloging/additembuttons.png"/>
25833 <para>Add Item will add just the one item</para>
25837 <para>Add & Duplicate will add the item and fill in a new form
25838 with the same values for your to alter</para>
25842 <para>Add Multiple Copies will ask how many copies and will then
25843 add that number of copies adding +1 to the barcode so each barcode
25848 <para>Your added items will appear above the add form once
25852 <screeninfo>Items</screeninfo>
25856 <imagedata fileref="images/cataloging/items.png"/>
25861 <para>Your items will also appear below the bibliographic details on
25862 the bib record display.</para>
25865 <screeninfo>List of Items on the Bib Record</screeninfo>
25869 <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
25874 <para>If you have <link
25875 linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
25876 set to 'Display' then there will also be a link to print a quick spine
25877 label next to each item.</para>
25880 <screeninfo>List of Items on the Bib Record with a Print Label
25885 <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
25891 <section id="editingitems">
25892 <title>Editing Items</title>
25894 <para>Items can be edited in several ways.</para>
25898 <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
25902 <screeninfo>Edit Items Menu Option</screeninfo>
25906 <imagedata fileref="images/cataloging/edititem.png"/>
25913 <para>Clicking 'Edit Items' beside the item on the 'Items'
25917 <screeninfo>Items Tab</screeninfo>
25921 <imagedata fileref="images/cataloging/itemstab.png"/>
25928 <para>The edit menu is also where items can be deleted from:</para>
25931 <screeninfo>Edit and Delete links for Items</screeninfo>
25935 <imagedata fileref="images/cataloging/edititemlink.png"/>
25940 <section id="itemquickedit">
25941 <title>Quick Item Status Updates</title>
25943 <para>Often circulation staff need to change the status of an item
25944 to Lost or Damaged. This doesn't require you to edit the entire item
25945 record. Instead clicking on the item barcode on the checkout summary
25946 or checkin history will bring you to an item summary. You can also
25947 get to the item summary by clicking on the Items tab to the left of
25948 the bib detail page.</para>
25951 <screeninfo>Item Edit</screeninfo>
25955 <imagedata fileref="images/cataloging/quickitemedit.png"/>
25960 <para>From this view you can mark an item lost by choosing a lost
25961 status from the pull down and clicking the 'Set Status'
25965 <screeninfo>Edit Lost Status</screeninfo>
25969 <imagedata fileref="images/cataloging/editloststatus.png"/>
25974 <para>You can also mark an item as damaged by choosing a damaged
25975 status from the pull down and clicking the 'Set Status'
25979 <screeninfo>Edit Damaged Status</screeninfo>
25983 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
25990 <section id="iteminfo">
25991 <title>Item Information</title>
25993 <para>To the left of every bibliographic record there is a tab to view
25997 <screeninfo>Items Tab</screeninfo>
26001 <imagedata fileref="images/cataloging/itemstab-long.png"/>
26006 <para>Clicking that tab will give you basic information about the
26007 items. If you ordered the item via the acquisitions module then the
26008 History section will include information about the order.</para>
26011 <screeninfo>History with order info</screeninfo>
26015 <imagedata fileref="images/cataloging/itemorderinfo.png"/>
26020 <para>If the Order or Accession date is linked, clicking it will bring
26021 you to the acquisitions information for that item.</para>
26024 <section id="moveitemrec">
26025 <title>Moving Items</title>
26027 <para>Items can be moved from one bibliographic record to another
26028 using the Attach Item option</para>
26031 <screeninfo>Attach Item Option</screeninfo>
26035 <imagedata fileref="images/cataloging/attachitem.png"/>
26040 <para>Visit the bibliographic record you want to attach the item to
26041 and choose 'Attach Item' from the 'Edit' menu.</para>
26044 <screeninfo>Attach Item Form</screeninfo>
26048 <imagedata fileref="images/cataloging/attachitemform.png"/>
26053 <para>Simply enter the barcode for the item you want to move and click
26056 <para>If you want to move all items to a new record creating only one
26057 bibliographic record you can use the <link
26058 linkend="mergebibrecs">Merge Records tool</link> instead.</para>
26061 <section id="deleteitems">
26062 <title>Deleting Items</title>
26064 <para>There are many ways to delete item records. If you only need to
26065 delete one item you can do this by opening up the detail page for the
26066 bib record and clicking the 'Edit' button at the top. From there you
26067 can choose to 'Edit items'.</para>
26070 <screeninfo>'Edit Items' menu option</screeninfo>
26074 <imagedata fileref="images/cataloging/edititemstodelete.png"/>
26079 <para>You will be presented with a list of items and next to each one
26080 will be a link labeled 'Delete'. Click that link and if the item is
26081 not checked out it will delete that item.</para>
26084 <screeninfo>Delete link on the left</screeninfo>
26088 <imagedata fileref="images/cataloging/deleteitemlink.png"/>
26093 <para>If you know that all of the items attached to your record are
26094 not currently checked out you can use the 'Delete all items' option
26095 under the 'Edit menu' and it will remove all items from the
26098 <para>Finally you can use the <link linkend="batchdeleteitems">batch
26099 delete tool</link> to delete a batch of items.</para>
26102 <section id="itemcirchistory">
26103 <title>Item Specific Circulation History</title>
26105 <para>Each bibliographic record keeps a circulation history (with or
26106 without the patron information depending on your settings), but each
26107 item also has its own circulation history page. To see this, click on
26108 the 'Items' tab to the left of the record you are viewing.</para>
26111 <screeninfo>Items tab</screeninfo>
26115 <imagedata fileref="images/cataloging/itemstab-long.png"/>
26120 <para>Below the 'History' heading is a link to 'View item's checkout
26121 history,' clicking that will open up the item's history which will
26122 look slightly different from the bibliographic record's history
26126 <screeninfo>Item Specific Circulation History</screeninfo>
26130 <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
26137 <section id="catauthorities">
26138 <title>Authorities</title>
26140 <para>Authority records are a way of controlling fields in your MARC
26141 records. Using authority records will provide you with control over
26142 subject headings, personal names and places.</para>
26144 <section id="addauthorities">
26145 <title>Adding Authorities</title>
26147 <para>To add a new authority record, choose the authority type from
26148 the 'New Authority' button.</para>
26151 <screeninfo>New Authority Record Options</screeninfo>
26155 <imagedata fileref="images/cataloging/newauthtypes.png"/>
26160 <para>The form that appears will allow you to enter all of the
26161 necessary details regarding your authority record.</para>
26164 <screeninfo>New Authority Record</screeninfo>
26168 <imagedata fileref="images/cataloging/newauthrec.png"/>
26173 <para>To expand collapsed values simply click on the title and the
26174 subfields will appear.</para>
26177 <section id="searchauthorities">
26178 <title>Searching Authorities</title>
26180 <para>From the authorities page you can search for existing terms and
26181 the bibliographic records they are attached to.</para>
26184 <screeninfo>Authority Search</screeninfo>
26188 <imagedata fileref="images/cataloging/authoritysearch.png"/>
26193 <para>From the results you will see the authority record, how many
26194 bibliographic records it is attached to, and a delete link (if there
26195 are not bibliographic records attached).</para>
26198 <screeninfo>Authority Search Results</screeninfo>
26202 <imagedata fileref="images/cataloging/authorityresults.png"/>
26207 <para>Clicking on the authority record summary will open the full
26208 record and the option to edit the record.</para>
26211 <screeninfo>Authority Record</screeninfo>
26215 <imagedata fileref="images/cataloging/authrecord.png"/>
26221 <section id="editauthorities">
26222 <title>Editing Authorities</title>
26224 <para>Authorities can be edited by clicking on the authority summary
26225 from the search results and then clicking the 'Edit' button above the
26229 <screeninfo>Edit Authority Record</screeninfo>
26233 <imagedata fileref="images/cataloging/editauthority.png"/>
26238 <para>Once you've made the necessary edits, simply click 'Save' and if
26239 you have the <link linkend="dontmerge">dontmerge</link> system
26240 preference set to 'Do' the next time the <link
26241 linkend="mergeauthcron">merge_authorities.pl cronjob</link> runs it
26242 will update all of the bib records that use that authority.</para>
26244 <para>To delete an authority record you first must make sure it's not
26245 linked to any bibliographic records. If it is not used by any
26246 bibliographic records a 'Delete' link will appear to the right of the
26247 record on the search results and as a button that appears after
26248 clicking on the summary of the authority record.</para>
26252 <section id="catguides">
26253 <title>Cataloging Guides</title>
26257 <section id="bibcatcheatsheet">
26260 <firstname>Jared</firstname>
26262 <surname>Camins-Esakov</surname>
26266 <orgname>American Numismatic Society</orgname>
26269 <othercredit role="copyeditor">
26270 <firstname>Nicole C.</firstname>
26272 <surname>Engard</surname>
26274 <contrib>Changed content where necessary.</contrib>
26277 <pubdate>2010</pubdate>
26280 <title>Bibliographic Record Cataloging Cheat Sheet</title>
26282 <table cellpadding="4" cellspacing="4" frame="all">
26283 <title>Cataloging Guide</title>
26285 <tgroup align="left" cols="4" colsep="1" rowsep="1">
26288 <entry><para>Tag</para></entry>
26290 <entry><para>Label</para></entry>
26292 <entry><para>Description</para></entry>
26294 <entry><para>Instructions</para></entry>
26300 <entry><para>000</para></entry>
26302 <entry><para>LEADER</para></entry>
26304 <entry><para>Describes the record(i.e. surrogate) -- is it a
26305 record for a monograph? A serial?</para></entry>
26307 <entry><para>Click in this field to fill it in. Then set
26308 "Bibliographic level" to 'a' for articles or 's' for serials.
26309 Otherwise, leave everything as is.</para></entry>
26313 <entry><para>001</para></entry>
26315 <entry><para>CONTROL NUMBER</para></entry>
26317 <entry><para>Accession number.</para></entry>
26319 <entry><para>Enter the accession number written inside the
26320 item here. For articles and items which do not have accession
26321 numbers, leave blank.</para></entry>
26325 <entry><para>003</para></entry>
26327 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
26329 <entry><para>Your MARC Organizational Code</para></entry>
26331 <entry><para>Click in this field to fill it in (will auto fill
26332 if you have your <link
26333 linkend="MARCOrgCode">MARCOrgCode</link> preference
26334 set).</para></entry>
26338 <entry><para>005</para></entry>
26340 <entry><para>D & T LATEST TRANSACTION</para></entry>
26342 <entry><para>Current date and time.</para></entry>
26344 <entry><para>Click in this field to fill it in.</para></entry>
26348 <entry><para>008</para></entry>
26350 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
26352 <entry><para>Field containing computer-readable
26353 representations of a number of things.</para></entry>
26355 <entry><para>Generally you will only use 's' (single) or 'm'
26356 (multiple) options for position 06- use the former when the
26357 item was published in a single year, the latter when it was
26358 published over the course of several. If there is a single
26359 date, only enter a date in the first date field (positions
26360 07-10). Enter the three-digit country code in positions 15-17,
26361 being sure to add spaces if the country code is fewer than
26362 three characters long. If there is an index, note that fact in
26363 position 31. Enter the three-letter language code in positions
26364 35-37.</para></entry>
26368 <entry><para>010</para></entry>
26370 <entry><para>LCCN</para></entry>
26372 <entry><para>A number assigned by the Library of Congress to
26373 uniquely identify the work.</para></entry>
26375 <entry><para>Check on the copyright page of the book (if it
26376 was published in the US) or the LC catalog for this number. If
26377 you can't find it, don't worry about it.</para></entry>
26381 <entry><para>020</para></entry>
26383 <entry><para>ISBN</para></entry>
26385 <entry><para>Unique number used by publishers to identify
26386 books.</para></entry>
26388 <entry><para>If this number isn't listed on the book, there
26389 probably isn't one.</para></entry>
26393 <entry><para>022</para></entry>
26395 <entry><para>ISSN</para></entry>
26397 <entry><para>Unique number used by publishers to identify
26398 serials.</para></entry>
26400 <entry><para>If this number isn't listed on the book, there
26401 probably isn't one.</para></entry>
26405 <entry><para>033</para></entry>
26407 <entry><para>DATE/TIME OF EVENT</para></entry>
26409 <entry><para>Used for auction dates. Required for auction
26410 catalogs.</para></entry>
26412 <entry><para>For auctions that took place on only one day,
26413 enter the date of the auction in the format YYYYMMDD in the
26414 subfield 'a' and a '0' in the first indicator. For auctions
26415 that took place over two consecutive days or any number of
26416 non-consecutive days, create a subfield 'a' for each day with
26417 the date in the format YYYYMMDD, and put a '1' in the first
26418 indicator. For auctions that took place over more than two
26419 consecutive days, create a subfield 'a' (in format YYYYMMDD)
26420 for the first day and a subfield 'a' (also in format YYYYMMDD)
26421 for the last day, and put a '2' in the first
26422 indicator.</para></entry>
26426 <entry><para>040</para></entry>
26428 <entry><para>CATALOGING SOURCE</para></entry>
26430 <entry><para>Identifies which libraries created and modified
26431 the record.</para></entry>
26433 <entry><para>For imported records, add a subfield 'd' with
26434 your OCLC code as the value. For new records, make sure that
26435 the subfield 'c' with your OCLC code as the
26436 value.</para></entry>
26440 <entry><para>041</para></entry>
26442 <entry><para>LANGUAGE CODE</para></entry>
26444 <entry><para>Identifies all the languages used in an item,
26445 when two or more languages are present.</para></entry>
26447 <entry><para>For significant portions of a text in a given
26448 language, there should be a subfield 'a' with that language
26449 code. If there are only summaries or abstracts in a specific
26450 language, create a subfield 'b' with that language
26451 code.</para></entry>
26455 <entry><para>100</para></entry>
26457 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
26459 <entry><para>Authorized form of the main author's
26460 name</para></entry>
26462 <entry><para>See Authorized headings sheet and AACR2. The
26463 first indicator should generally be a '1', to indicate that
26464 the entry is surname first. If the name consists only of a
26465 forename, however, the first indicator should be
26466 '0'.</para></entry>
26470 <entry><para>110</para></entry>
26472 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
26474 <entry><para>Authorized form of the name of the main corporate
26475 author. Required for auction catalogs.</para></entry>
26477 <entry><para>Auction catalogs should use a 110 field rather
26478 than a 100 field. See Authorized headings sheet and AACR2. Set
26479 the first indicator to '2'.</para></entry>
26483 <entry><para>111</para></entry>
26485 <entry><para>MAIN ENTRY--MEETING</para></entry>
26487 <entry><para>Authorized form of the name of a meeting which
26488 acted as a main offer (e.g. conference
26489 proceedings)</para></entry>
26491 <entry><para>See Authorized headings sheet and AACR2. Set the
26492 first indicator to '2'.</para></entry>
26496 <entry><para>245</para></entry>
26498 <entry><para>TITLE STATEMENT</para></entry>
26500 <entry><para>Transcription of the title statement from the
26501 title page (or chief source of information)</para></entry>
26503 <entry><para>Enter the title in subfield 'a', the subtitle in
26504 subfield 'b', and the statement of responsibility in subfield
26505 'c'. If you are creating a record for a single volume or part
26506 of a multi-part item, you should put the part number in
26507 subfield 'n' and the part title in subfield 'p.' For auction
26508 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
26509 in square brackets in subfield 'f'. See ISBD punctuation
26510 sheet. Set the first indicator to '0' if there is no author,
26511 otherwise set it to '1'. Set the second indicator to the
26512 number of non-filing characters (i.e. characters in an initial
26513 articles plus the space... for "The " set the second indicator
26514 to '4').</para></entry>
26518 <entry><para>246</para></entry>
26520 <entry><para>VARYING FORM OF TITLE</para></entry>
26522 <entry><para>Alternate form of title for searching and filing
26523 purposes</para></entry>
26525 <entry><para>If the patron might look for the work under a
26526 different title, enter it here. Do not include initial
26527 articles. The first indicator should be '3', unless the title
26528 is merely a variant spelling, in which case the first
26529 indicator should be '1'.</para></entry>
26533 <entry><para>250</para></entry>
26535 <entry><para>EDITION STATEMENT</para></entry>
26537 <entry><para>Transcription of the edition statement from the
26538 title page (or chief source of information)</para></entry>
26540 <entry><para>Transcribe the edition statement exactly as it
26541 appears on the title-page. You may abbreviate if the edition
26542 statement is very long.</para></entry>
26546 <entry><para>260</para></entry>
26548 <entry><para>PUBLICATION (IMPRINT)</para></entry>
26550 <entry><para>Publication information.</para></entry>
26552 <entry><para>Put the location of publication in subfield 'a',
26553 the publisher in subfield 'b', and the year (or probable year)
26554 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
26558 <entry><para>300</para></entry>
26560 <entry><para>PHYSICAL DESCRIPTION</para></entry>
26562 <entry><para>Physical description</para></entry>
26564 <entry><para>Enter the pagination statement in subfield 'a', a
26565 brief description of "special" contents such as illustrations
26566 or maps in subfield 'b' (see AACR2), and the size of the item
26567 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
26571 <entry><para>490</para></entry>
26573 <entry><para>SERIES STATEMENT</para></entry>
26575 <entry><para>Shows the series statement exactly as it appears
26576 on the item.</para></entry>
26578 <entry><para>Transcribe the series statement into subfield 'a'
26579 with the volume number in subfield 'v'. See ISBD punctuation
26580 sheet. Set the first indicator to '1' if you are using an 830.
26581 As a general rule, you should do so.</para></entry>
26585 <entry><para>500</para></entry>
26587 <entry><para>GENERAL NOTE</para></entry>
26589 <entry><para>Notes that don't fit anywhere
26590 else.</para></entry>
26592 <entry><para>Enter notes as full sentences, with a separate
26593 500 field for each distinct topic.</para></entry>
26597 <entry><para>501</para></entry>
26599 <entry><para>WITH NOTE</para></entry>
26601 <entry><para>Notes whether the work is bound with the works
26602 described by other records.</para></entry>
26604 <entry><para>Put description of relationship in subfield
26605 'a'.</para></entry>
26609 <entry><para>504</para></entry>
26611 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
26613 <entry><para>Indicates whether the work includes a
26614 bibliography.</para></entry>
26616 <entry><para>If the work includes a bibliography and index,
26617 put the text "Includes bibliographical references (p. XXX-XXX)
26618 and index." in subfield 'a'. If the work does not include an
26619 index, remove that part of the sentence. If the references are
26620 scattered throughout the work and not gathered into a distinct
26621 sentence, remove the parenthetical statement.</para></entry>
26625 <entry><para>505</para></entry>
26627 <entry><para>FORMATTED CONTENTS</para></entry>
26629 <entry><para>List of contents in a standard format.
26630 Unformatted contents can be listed in a 500 (General Note)
26631 field.</para></entry>
26633 <entry><para>See ISBD punctuation sheet. Set the first
26634 indicator to '0'. If you are separately coding authors and
26635 titles, set the second indicator to '0'. Otherwise, leave the
26636 second indicator blank.</para></entry>
26640 <entry><para>518</para></entry>
26642 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
26644 <entry><para>Used for auction dates.</para></entry>
26646 <entry><para>For auction catalogs, enter the date of the
26647 auction in the format 'January 2, 1984' in the subfield
26652 <entry><para>520</para></entry>
26654 <entry><para>SUMMARY, ETC.</para></entry>
26656 <entry><para>A brief summary or abstract of the book or
26657 article.</para></entry>
26659 <entry><para>In general you do not need to write a summary. A
26660 summary might be called for, however, with items that cannot
26661 be easily reviewed by a patron, such as books with highly
26662 acidic paper or CD-ROMs.</para></entry>
26666 <entry><para>546</para></entry>
26668 <entry><para>LANGUAGE NOTE</para></entry>
26670 <entry><para>Note describing the languages used in the
26671 work</para></entry>
26673 <entry><para>Only needed for works in multiple languages. See
26674 ISBD punctuation sheet.</para></entry>
26678 <entry><para>561</para></entry>
26680 <entry><para>PROVENANCE INFORMATION</para></entry>
26682 <entry><para>Describes the previous ownership of the
26683 item.</para></entry>
26685 <entry><para>Used only for rare books.</para></entry>
26689 <entry><para>563</para></entry>
26691 <entry><para>BINDING INFORMATION</para></entry>
26693 <entry><para>Describes the binding of the item.</para></entry>
26695 <entry><para>Used only for rare books.</para></entry>
26699 <entry><para>590</para></entry>
26701 <entry><para>LOCAL NOTE</para></entry>
26703 <entry><para>Local notes. Required for auction
26704 catalogs.</para></entry>
26706 <entry><para>Used for auction catalogs to indicate what types
26707 of coins are sold in the auction- Roman, Greek,
26708 etc.</para></entry>
26712 <entry><para>600</para></entry>
26714 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
26716 <entry><para>Authorized form of personal names for people
26717 discussed in the work</para></entry>
26719 <entry><para>See Authorized headings sheet and AACR2. The
26720 first indicator should generally be a '1', to indicate that
26721 the entry is surname first. If the name consists only of a
26722 forename, however, the first indicator should be '0'. If you
26723 found the name in the LC authority file, set the second
26724 indicator to '0'. Otherwise set the second indicator to
26725 '4'.</para></entry>
26729 <entry><para>610</para></entry>
26731 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
26733 <entry><para>Authorized form of corporate names for
26734 organizations discussed in the work</para></entry>
26736 <entry><para>See Authorized headings sheet and AACR2. Set the
26737 first indicator to '2'. If you found the name in the LC
26738 authority file, set the second indicator to '0'. Otherwise set
26739 the second indicator to '4'.</para></entry>
26743 <entry><para>611</para></entry>
26745 <entry><para>SUBJECT ADDED--MEETING</para></entry>
26747 <entry><para>Authorized form of meeting names for meetings
26748 discussed in the work</para></entry>
26750 <entry><para>See Authorized headings sheet and AACR2. Set the
26751 first indicator to '2'. If you found the name in the LC
26752 authority file, set the second indicator to '0'. Otherwise set
26753 the second indicator to '4'.</para></entry>
26757 <entry><para>630</para></entry>
26759 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
26761 <entry><para>Authorized form of titles for other works
26762 discussed in the work</para></entry>
26764 <entry><para>See Authorized headings sheet and AACR2. Set the
26765 first indicator to the number of non-filing characters (i.e.
26766 characters in an initial articles plus the space... for "The "
26767 set the first indicator to '4'). If you found the name in the
26768 LC authority file, set the second indicator to '0'. Otherwise
26769 set the second indicator to '4'.</para></entry>
26773 <entry><para>650</para></entry>
26775 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
26777 <entry><para>Library of Congress Subject Heading terms
26778 describing the subject of the work</para></entry>
26780 <entry><para>See Authorized headings sheet and AACR2. If you
26781 found the name in the LC authority file, set the second
26782 indicator to '0'. Otherwise set the second indicator to
26783 '4'.</para></entry>
26787 <entry><para>651</para></entry>
26789 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
26791 <entry><para>Library of Congress Subject Heading geographical
26792 terms describing the subject of the work</para></entry>
26794 <entry><para>See Authorized headings sheet and AACR2. If you
26795 found the name in the LC authority file, set the second
26796 indicator to '0'. Otherwise set the second indicator to
26797 '4'.</para></entry>
26801 <entry><para>655</para></entry>
26803 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
26805 <entry><para>Describes what an item is as opposed to what the
26806 item is about.</para></entry>
26808 <entry><para>Generally used only for auction catalogs, which
26809 should have the genre heading "Auction catalogs." (make sure
26810 to find the authorized heading!) If you found the name in the
26811 LC authority file, set the second indicator to '0'. If you are
26812 using a term from a specific thesaurus, set the second
26813 indicator to '7' and put the code for the thesaurus in
26814 subfield '2'. Otherwise set the second indicator to
26815 '4'.</para></entry>
26819 <entry><para>690</para></entry>
26821 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
26823 <entry><para>Used for headings from any custom subject
26824 authority file.</para></entry>
26826 <entry><para>If there is no appropriate LCSH term, you can use
26827 a 690 with subject headings you find on other items in the
26828 catalog.</para></entry>
26832 <entry><para>691</para></entry>
26834 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
26836 <entry><para>Used for headings from any custom subject
26837 authority file.</para></entry>
26839 <entry><para>If there is no appropriate LCSH term, you can use
26840 a 691 with subject headings you find on other items in the
26841 catalog.</para></entry>
26845 <entry><para>700</para></entry>
26847 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
26849 <entry><para>Used for second authors and other persons related
26850 to the production of the work.</para></entry>
26852 <entry><para>See Authorized headings sheet and AACR2. The
26853 first indicator should generally be a '1', to indicate that
26854 the entry is surname first. If the name consists only of a
26855 forename, however, the first indicator should be
26856 '0'.</para></entry>
26860 <entry><para>710</para></entry>
26862 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
26864 <entry><para>Used for corporate bodies related to the
26865 production of the work (e.g. publishers).</para></entry>
26867 <entry><para>See Authorized headings sheet and AACR2. Set the
26868 first indicator to '2'.</para></entry>
26872 <entry><para>711</para></entry>
26874 <entry><para>ADDED ENTRY--MEETING</para></entry>
26876 <entry><para>Used for meetings related to the production of
26877 the work (e.g. symposia that contributed to the
26878 work).</para></entry>
26880 <entry><para>See Authorized headings sheet and AACR2. Set the
26881 first indicator to '2'.</para></entry>
26885 <entry><para>730</para></entry>
26887 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
26889 <entry><para>Used for uniform titles related to the production
26890 of the work (e.g. a work that inspired the present
26891 work)</para></entry>
26893 <entry><para>See Authorized headings sheet and AACR2. Set the
26894 first indicator to the number of non-filing characters (i.e.
26895 characters in an initial articles plus the space... for "The "
26896 set the first indicator to '4').</para></entry>
26900 <entry><para>773</para></entry>
26902 <entry><para>HOST ITEM ENTRY</para></entry>
26904 <entry><para>Describes the larger bibliographic unit that
26905 contains the work (e.g. book or journal containing the article
26906 being described in the current record)</para></entry>
26908 <entry><para>If the host publication is author main entry,
26909 enter the authorized form of the author's name in subfield
26910 'a'. Put the title in subfield 't'. If the host publication is
26911 an independent work, put publication information in subfield
26912 'd'. When available, ISSN and ISBN should always be used in,
26913 in subfields 'x' and 'z' respectively. Relationship
26914 information (e.g. volume number, page number, etc.) goes in
26915 subfield 'g'. Subfield 'q' contains an encoded representation
26916 of the location of the item: volume, issue, and section
26917 numbers are separated by colons, and the first page is entered
26918 following a '<' at the end of the subfield. See ISBD
26919 punctuation sheet. Set the first indicator to '0'. If you want
26920 the label "In:" to be generated, leave the second indicator
26921 blank. If you want something else displayed before the 773
26922 text, set the second indicator to '8' and add a subfield 'i'
26923 with the label you want at the beginning of the field (e.g.
26924 "$iOffprint from:").</para></entry>
26928 <entry><para>830</para></entry>
26930 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
26932 <entry><para>Authorized form of the series name transcribed in
26933 the 490 field. Often this will just be the same as the
26934 490.</para></entry>
26936 <entry><para>See Authorized headings sheet and AACR2. Set the
26937 second indicator to the number of non-filing characters (i.e.
26938 characters in an initial articles plus the space... for "The "
26939 set the second indicator to '4').</para></entry>
26943 <entry><para>852</para></entry>
26945 <entry><para>LOCATION/CALL NUMBER</para></entry>
26947 <entry><para>Provides the section name for pre-barcode books,
26948 pamphlets, and some articles and serials.</para></entry>
26950 <entry><para>Do not put anything in this field if you are
26951 cataloging a volume which gets only one record and a barcode.
26952 If the item does not get a barcode, or you are currently
26953 creating a record for an article in a volume, put the section
26954 in subfield 'a' (see ANS cataloging documentation), and the
26955 call number in subfield 'i'. Set the first indicator to
26956 '8'.</para></entry>
26960 <entry><para>856</para></entry>
26962 <entry><para>ELECTRONIC ACCESS</para></entry>
26964 <entry><para>Links to material available
26965 online.</para></entry>
26967 <entry><para>Put the URL of any electronic copies or
26968 summaries, etc. in subfield 'u' and a link title in subfield
26969 'y'. Set the first indicator to '4'.</para></entry>
26973 <entry><para>942</para></entry>
26975 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
26977 <entry><para>Used for Koha-specific data.</para></entry>
26979 <entry><para>Set the subfield 'c' to the appropriate item
26980 type.</para></entry>
26987 <section id="itemcatguide">
26988 <title>Item/Holdings Record Cataloging Guide</title>
26990 <para>This table represents the default embedded holdings data in Koha
26991 3.4. This information can be used for migration or importing data
26994 <table cellpadding="4" cellspacing="4" frame="all">
26995 <title>Koha Embedded Holdings Data</title>
26997 <tgroup align="left" cols="4" colsep="1" rowsep="1">
26998 <colspec colname="tag" colnum="1"/>
27000 <colspec colname="data" colnum="2"/>
27002 <colspec colname="desc" colnum="3"/>
27004 <colspec colname="note" colnum="4"/>
27008 <entry><para>MARC21 Tag/subfield</para></entry>
27010 <entry><para>Data Element</para></entry>
27012 <entry><para>Description</para></entry>
27014 <entry><para>Notes</para></entry>
27020 <entry><para>952$0</para></entry>
27022 <entry><para>Withdrawn status</para></entry>
27024 <entry><para>Default values: </para><itemizedlist>
27026 <para>0 = Not withdrawn</para>
27030 <para>1 = Withdrawn</para>
27032 </itemizedlist></entry>
27034 <entry><para>Coded value, matching <link
27035 linkend="authorizedvalues">Authorized Value</link> category
27036 ('WITHDRAWN' in default installation)</para></entry>
27040 <entry><para>952$1</para></entry>
27042 <entry><para>Lost status</para></entry>
27044 <entry><para>Default values:</para><itemizedlist>
27046 <para>0 = Available</para>
27050 <para>1 = Lost</para>
27054 <para>2 = Long Overdue (Lost)</para>
27058 <para>3 = Lost and Paid For</para>
27062 <para>4 = Missing in Inventory</para>
27066 <para>5 = Missing in Hold Queue</para>
27068 </itemizedlist></entry>
27070 <entry><para>It's possible to configure OPAC so that lost
27071 items don't display with the <link
27072 linkend="hidelostitems">hidelostitems</link> system
27073 preference. </para><para>Coded value, matching <link
27074 linkend="authorizedvalues">Authorized Value</link> category
27075 ('LOST' in default installation)</para></entry>
27079 <entry><para>952$2</para></entry>
27081 <entry><para>Classification</para></entry>
27083 <entry><para>Classification scheme that defines filing rules
27084 used for sorting call numbers.</para></entry>
27086 <entry><para>A choice of <link
27087 linkend="classificationsources">classification sources</link>
27088 as they are defined in administration. If no classification
27089 scheme is entered, the system will use the value entered in
27091 linkend="DefaultClassificationSource">DefaultClassificationSource</link>
27092 preference.</para></entry>
27096 <entry><para>952$3</para></entry>
27098 <entry><para>Materials specified</para></entry>
27100 <entry><para>Specific issues of serials or multi-part
27101 items.</para></entry>
27103 <entry><para>Displayed when items are checked out and in to
27104 tell the staff how many pieces the item has. Copy/volume data
27105 is stored in 952$h and $t for display in Normal
27106 views.</para></entry>
27110 <entry><para>952$4</para></entry>
27112 <entry><para>Damaged status</para></entry>
27114 <entry><para>Default values: </para><itemizedlist>
27116 <para>0 = Not damaged</para>
27120 <para>1 = Damaged</para>
27122 </itemizedlist></entry>
27124 <entry><para>Coded value, matching <link
27125 linkend="authorizedvalues">Authorized Value</link> category
27126 ('DAMAGE' in default installation)</para></entry>
27130 <entry><para>952$5</para></entry>
27132 <entry><para>Use restrictions</para></entry>
27134 <entry><para>Default values:</para><itemizedlist>
27136 <para>0 = No use restrictions</para>
27140 <para>1 = Restricted Access</para>
27142 </itemizedlist></entry>
27144 <entry><para>Coded value, matching <link
27145 linkend="authorizedvalues">Authorized Value</link> category
27146 ('RESTRICT' in default installation). This value has no effect
27147 on circulation.</para></entry>
27151 <entry><para>952$7</para></entry>
27153 <entry><para>Not for loan</para></entry>
27155 <entry><para>Default values:</para><itemizedlist>
27157 <para>-1 = Ordered</para>
27161 <para>0 = Available for loans</para>
27165 <para>1 = Not for Loan</para>
27169 <para>2 = Staff Collection</para>
27171 </itemizedlist></entry>
27173 <entry><para>Coded value, matching <link
27174 linkend="authorizedvalues">Authorized Value</link> category
27175 ('NOT_LOAN' in default installation). Negative number values
27176 can still be placed on hold.</para></entry>
27180 <entry><para>952$8</para></entry>
27182 <entry><para>Collection code</para></entry>
27184 <entry><para>Coded value</para></entry>
27186 <entry><para>Coded value, matching <link
27187 linkend="authorizedvalues">Authorized Value</link> category
27188 ('CCODE' in default installation)</para></entry>
27192 <entry><para>952$9</para></entry>
27194 <entry><para>Item number</para></entry>
27196 <entry><para>System-generated item number.</para></entry>
27198 <entry><para>Does not display in the item
27199 record.</para></entry>
27203 <entry><para>952$a</para></entry>
27205 <entry><para>Owning Library **</para></entry>
27207 <entry><para>Branch code</para></entry>
27209 <entry><para><emphasis role="bold">Required</emphasis>. Code
27210 must be defined in <link linkend="libsgroups">Libraries,
27211 Branches and Groups</link></para></entry>
27215 <entry><para>952$b</para></entry>
27217 <entry><para>Holding library ** (usually the same as 952$a
27220 <entry><para>Branch code</para></entry>
27222 <entry><para><emphasis role="bold">Required</emphasis>. Code
27223 must be defined in <link linkend="libsgroups">Libraries,
27224 Branches and Groups</link></para></entry>
27228 <entry><para>952$c</para></entry>
27230 <entry><para>Shelving location code</para></entry>
27232 <entry><para/></entry>
27234 <entry><para>Coded value, matching <link
27235 linkend="authorizedvalues">Authorized Value</link> category
27236 ('LOC' in default installation)</para></entry>
27240 <entry><para>952$d</para></entry>
27242 <entry><para>Date acquired</para></entry>
27244 <entry><para>YYYY-MM-DD</para></entry>
27246 <entry><para>Date formats in the 952 subfields are required to
27247 be in the system internal format for data loading and
27248 subsequent item editing: YYYY-MM-DD</para></entry>
27252 <entry><para>952$e</para></entry>
27254 <entry><para>Source of acquisition</para></entry>
27256 <entry><para>Coded value or vendor string</para></entry>
27258 <entry><para>Filled in automatically with the Koha assigned
27259 vendor id by Acquisitions when an item is
27260 received.</para></entry>
27264 <entry><para>952$g</para></entry>
27266 <entry><para>Purchase price</para></entry>
27268 <entry><para>Decimal number, no currency symbol (ex.
27269 10.00)</para></entry>
27271 <entry><para>Filled in automatically by Acquisitions when an
27272 item is received.</para></entry>
27276 <entry><para>952$h</para></entry>
27278 <entry><para>Serial enumeration</para></entry>
27280 <entry><para/></entry>
27282 <entry><para>Filled in automatically by Serials if the issue
27283 is received there.</para></entry>
27287 <entry><para>952$o</para></entry>
27289 <entry><para>Koha full call number</para></entry>
27291 <entry><para/></entry>
27293 <entry><para>Can be filled in automatically based on the <link
27294 linkend="itemcallnumber">itemcallnumber</link> system
27295 preference.</para></entry>
27299 <entry><para>952$p</para></entry>
27301 <entry><para>Barcode *</para></entry>
27303 <entry><para>Max 20 characters</para></entry>
27305 <entry><para/></entry>
27309 <entry><para>952$t</para></entry>
27311 <entry><para>Copy number</para></entry>
27313 <entry><para>Max 32 characters</para></entry>
27315 <entry><para/></entry>
27319 <entry><para>952$v</para></entry>
27321 <entry><para>Replacement price</para></entry>
27323 <entry><para>Decimal number, no currency symbol (ex.
27324 10.00)</para></entry>
27326 <entry><para>Filled in automatically by Acquisitions when an
27327 item is received.</para></entry>
27331 <entry><para>952$w</para></entry>
27333 <entry><para>Price effective from</para></entry>
27335 <entry><para>YYYY-MM-DD</para></entry>
27337 <entry>Date formats in the 952 subfields are required to be in
27338 the system internal format for data loading and subsequent
27339 item editing: YYYY-MM-DD. Filled in automatically by
27340 Acquisitions when an item is received.</entry>
27344 <entry><para>952$y</para></entry>
27346 <entry><para>Koha item type **</para></entry>
27348 <entry><para>Coded value, required field for
27349 circulation</para></entry>
27351 <entry><para><emphasis role="bold">Required</emphasis>. Coded
27352 value, must be defined in <link linkend="itemtypeadmin">Item
27353 types</link></para></entry>
27357 <entry><para>952$z</para></entry>
27359 <entry><para>Public note</para></entry>
27361 <entry><para/></entry>
27363 <entry><para/></entry>
27369 <para>* - required for circulation</para>
27371 <para>** - required by Koha</para>
27374 <section id="onorderitemholds">
27376 <corpauthor>VOKAL</corpauthor>
27379 <firstname>Nicole C.</firstname>
27381 <surname>Engard</surname>
27384 <pubdate>2010</pubdate>
27386 <bibliosource><ulink
27387 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>
27390 <title>Handling On Order Items and Holds</title>
27392 <para>If you tend to import your MARC records when you have ordered
27393 the book (as opposed to when you receive the books), and allow patrons
27394 to place holds on those books, you may need to add item records to the
27395 *.mrc file before importing.</para>
27397 <para>The easiest way to import your latest order is to first run your
27398 records through <ulink
27399 url="http://people.oregonstate.edu/~reeset/marcedit/html/index.php">MARCEdit</ulink>.
27400 Download your MARC records, saving them to your desktop or some other
27401 location you use/will remember. If you have MARCEdit already installed
27402 you should simply have to double click on your MARC records, and they
27403 will automatically open in MARCEdit.<important>
27404 <para>This tutorial was written with MARCEdit version
27405 5.2.3769.41641 on Windows XP, instructions may be different if
27406 your version or operating system is different.</para>
27407 </important></para>
27411 <para>Your original file will automatically be in the input;
27412 ensure MarcBreaker is chosen, and then click "Execute"</para>
27415 <screeninfo>MarcBreaker</screeninfo>
27419 <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
27426 <para>You will be presented with a summary of the records
27427 processed at the bottom of the screen</para>
27430 <screeninfo>MarcBreaker Summary</screeninfo>
27434 <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
27441 <para>Click 'Edit Records' to continue on to adding item
27446 <para>Your screen will be replaced with a larger screen containing
27447 the MARC records</para>
27450 <screeninfo>MARC file for editing</screeninfo>
27454 <imagedata fileref="images/appendix-onorder/editrecords.png"/>
27461 <para>Click on Tools > Add/Edit Field</para>
27464 <screeninfo>Add/Delete Field</screeninfo>
27468 <imagedata fileref="images/appendix-onorder/addfield.png"/>
27475 <para>Enter in the Koha specific item info</para>
27478 <screeninfo>Add 942 Field</screeninfo>
27482 <imagedata fileref="images/appendix-onorder/add942.png"/>
27489 <para>In the Field box, type 942</para>
27493 <para>In the Field Data box, type \\$c and the item type code
27494 (\\$cBOOK in this example)</para>
27498 <para>Check the 'Insert last' option</para>
27502 <para>Click 'Add Field'</para>
27508 <para>Enter in the item record data</para>
27511 <screeninfo>Add 952 Field</screeninfo>
27515 <imagedata fileref="images/appendix-onorder/add952.png"/>
27522 <para>In the Field box, type 952</para>
27526 <para>In the Field Data box, type
27527 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
27531 <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
27535 <para>In a default install of Koha -1 is the value for
27536 the Ordered status</para>
27542 <para>You may want to look at other subfields you would
27543 like data in -- for example, changing the collection code
27544 to put all the items in the same collection (8),
27545 automatically fill in the acquisition date (d), or put in
27546 a public note (z).</para>
27550 <para>Be sure you use the $ to separate subfields; adding
27551 each subfield on a separate line will cause that many
27552 items to be imported with your MARC record (in the example
27553 above, four items, each with one of those subfields
27558 <para>Make sure you look at the Administration >
27559 Authorized Values in Koha to put the correct code into the
27566 <para>Check the 'Insert last' option</para>
27570 <para>Click 'Add Field'</para>
27576 <para>Close the field editor window</para>
27580 <para>Click on File > Compile into MARC</para>
27583 <screeninfo>Compile into MARC</screeninfo>
27587 <imagedata fileref="images/appendix-onorder/compile.png"/>
27594 <para>Choose where to save your file</para>
27598 <para>Now you want to go into your Koha system and follow the
27599 instructions for <link linkend="stagemarc">importing MARC
27600 records</link>.</para>
27602 <para>Once the item has come in, you will need to go to the item
27603 record and individually change the item to have the correct barcode,
27604 and manually change the status from Ordered to the blank line in the
27605 Not for Loan field.</para>
27608 <para>If you purchase your cataloged item records, you may want to
27609 request your vendor put in the information you need into the MARC
27610 records for you; that way, you could import the edited-by-the-vendor
27611 file, overwriting the current record, automatically replacing the
27612 data with what you need.</para>
27618 <chapter id="serials">
27619 <title>Serials</title>
27621 <para>Serials actions can be accessed by going to the More menu at the top
27622 of your screen and choosing Serials or by clicking Serials on the main
27623 Koha staff client page. The Serials module in Koha is used for keeping
27624 track of journals, newspapers and other items that come on a regular
27625 schedule. As with all modules, make sure you go through the related <link
27626 linkend="impserials">Implementation Checklist</link> before using the
27627 Serials module.</para>
27631 <para><emphasis>Get there:</emphasis> More > Serials</para>
27635 <section id="newsubscription">
27636 <title>Add a subscription</title>
27638 <para>Subscriptions can be added by clicking the 'New' button on any
27639 bibliographic record</para>
27642 <screeninfo>New Subscription Button</screeninfo>
27646 <imagedata fileref="images/serials/newsubfrombib.png"/>
27651 <para>Or by visiting the Serials module and clicking 'New
27652 Subscription'</para>
27655 <screeninfo>New Subscription Button</screeninfo>
27659 <imagedata fileref="images/serials/newsubbutton.png"/>
27664 <para>If you are entering a new subscription from the Serials module you
27665 will be presented with a blank form (if creating new from a
27666 bibliographic record the form will include the bib info).</para>
27669 <screeninfo>Add a new Subscription Form</screeninfo>
27673 <imagedata fileref="images/serials/addsub.png"/>
27680 <para>'Librarian' field will show the logged in librarian's
27685 <para>'Vendor' can be found by either searching vendors entered via
27686 the <link linkend="acqmodule">Acquisitions module</link> or entering
27687 the vendor ID number</para>
27691 <para>Vendor information is not required</para>
27695 <para>In order to claim missing and late issues you need to
27696 enter vendor information</para>
27699 <screeninfo>Vendor Missing Warning</screeninfo>
27703 <imagedata fileref="images/serials/vendorwarning.png"/>
27712 <para>'Biblio' is the MARC record you'd like to link this
27713 subscription to</para>
27717 <para>This can be done by searching for an existing record by
27718 clicking on the 'Search for Biblio' link below the boxes or by
27719 entering the bib number for a record in the first box. Only if
27720 you search with the field between the parenthesis.</para>
27726 <para>Next you can choose whether a new item is created when
27727 receiving an issue</para>
27731 <para>'Location' is for the shelving location</para>
27735 <para>'Call Number' is for your item's call number prefix</para>
27739 <para>'Library' is the branch that owns this subscription.</para>
27743 <para>If more than one library subscribes to this serial you
27744 will need to create a subscription for each library</para>
27748 <para>This can be done easily by using the 'Edit as New
27749 (Duplicate)' option found on the subscription information page
27750 and changing only the 'Library' field</para>
27753 <screeninfo>New Duplicate Subscription</screeninfo>
27757 <imagedata fileref="images/serials/newasdup.png"/>
27766 <para>The 'Grace Period' is the number of days before an issue is
27767 automatically moved from 'expected' status to 'waiting' and how many
27768 days before an issue is automatically moved from 'waiting' status to
27773 <para>Use the 'Public Note' for any notes you would like to appear
27774 in the OPAC for the patrons</para>
27778 <para>'Nonpublic Note' should be used for notes that are only
27779 visible to the librarians via the staff client</para>
27783 <para>To set up a routing list for serials, choose 'Routing List'
27784 from the 'Patron notification' field.</para>
27788 <para>For this option to appear you need to make sure that you
27789 have a Routing List notice set up in the <link
27790 linkend="notices">Notices Tool</link></para>
27794 <para>Learn more about <link linkend="routinglist">Routing
27795 Lists</link> later in this manual</para>
27801 <para>The Staff and OPAC Display options allow you to control how
27802 many issues appear by default on bibliographic records in the Staff
27803 Client and the OPAC</para>
27807 <para>If no values are entered in these fields, they will use
27809 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
27811 linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
27812 system preference values</para>
27818 <para>In 'First issue publication date' you want to enter the date
27819 of the issue you have in your hand, the date from which the
27820 prediction pattern will start</para>
27824 <para>There are several pre-defined options for the 'Frequency' of
27829 <para>Without periodicy: some very specific (usually high level
27830 science journals) don't have a true periodicity. When you
27831 subscribe to the title, you subscribe for 6 issues, which can
27832 arrive in 1 year... or 2... There is no regularity or known
27837 <para>Unknown select this if none of the other choices are
27842 <para>Irregular: The journal is not "regular" but has a
27843 periodicity. You know that it comes out on January, then in
27844 October and December, it is irregular, but you know when it's
27845 going to arrive.</para>
27849 <para>2/day: Twice daily</para>
27853 <para>1/day: Daily</para>
27857 <para>3/week: Three times a week</para>
27861 <para>1/week: Weekly</para>
27865 <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
27869 <para>1/ 3 weeks: Tri-weekly</para>
27873 <para>1/month: Monthly</para>
27877 <para>1/ 2 months (6/year): Bi-monthly</para>
27881 <para>1/ 3 months (1/quarter): Quarterly</para>
27885 <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
27886 Summer, Autumn, Winter, Spring)</para>
27890 <para>2/year: Half yearly</para>
27894 <para>1/year: Annual</para>
27898 <para>1/ 2 years: Bi-annual</para>
27904 <para>Checking the 'Manual history' box will allow you to enter
27905 serials outside the prediction pattern.</para>
27909 <para>'Numbering pattern' will help you determine how the numbers
27910 are printed for each issue</para>
27914 <para>Start with the numbering on the issue you have in hand,
27915 the numbering that matches the date you entered in the 'First
27916 issue publication' field</para>
27920 <para>If you have chosen any 'Numbering Format' other than
27921 'Number' in the 'Rollover at' field, enter the last issue number
27922 before the volume number changes</para>
27926 <para>If you chose the 'Number' Numbering Format you will
27927 see 'issues expected' in which you will enter the total
27928 number of issues you expect to receive.</para>
27931 <screeninfo>Number as Numbering Pattern</screeninfo>
27935 <imagedata fileref="images/serials/numberonly.png"/>
27944 <para>You can choose to create your own numbering pattern by
27945 choosing 'None of the above' and clicking the 'Show/Hide
27946 Advanced Pattern' button at the bottom of the form</para>
27952 <para>'Subscription start date' is the date at which the
27953 subscription begins. This is used for setting up renewal
27958 <para>'Subscription length' is the number of issues or months in the
27959 subscription. This is also used for setting up renewal alerts</para>
27963 <para>'Subscription end date' should only be entered for
27964 subscriptions that have ended (if you're entering in a backlog of
27969 <para>The 'Numbering formula' is editable to match the way you'd
27970 like your numbering to print on the item record and subscription
27971 information pages</para>
27975 <para>Click 'Save Subscription' to save the information you have
27976 entered. <link linkend="sampleserialsapp">Find sample serial examples in
27977 the appendix</link>.</para>
27980 <section id="receiveissues">
27981 <title>Receive Issues</title>
27983 <para>Issues can be marked as received from several locations. To find a
27984 subscription, use the search box at the top of the Serials page to
27985 search for the serial you'd like to receive issues for:</para>
27988 <screeninfo>Subscription Search</screeninfo>
27992 <imagedata fileref="images/serials/subsearch.png"/>
27997 <para>From the search results you can click the 'Serial Receive' link or
27998 you can click on the subscription title and then click the 'Receive'
28002 <screeninfo>Subscription Buttons</screeninfo>
28006 <imagedata fileref="images/serials/subbuttons.png"/>
28011 <para>The final way to receive serials is from the 'Serial Collection'
28012 page. To the left of the Subscription summary page there is a menu with
28013 a link to 'Serial Collection'</para>
28016 <screeninfo>Serial Subscription Menu</screeninfo>
28020 <imagedata fileref="images/serials/serialcolllink.png"/>
28025 <para>From the page that opens up you can click 'Edit Serial' with the
28026 issue you want to receive checked.</para>
28029 <screeninfo>Edit Issues</screeninfo>
28033 <imagedata fileref="images/serials/editissue.png"/>
28038 <para>All three of these options will open up the issue receive
28042 <screeninfo>Receive Serials</screeninfo>
28046 <imagedata fileref="images/serials/receiveissue.png"/>
28053 <para>Choose 'Arrived' from the status pull down to mark a serial as
28058 <para>If you have decided to have an item record created for each
28059 issue an <link linkend="addingitems">item add form</link> will
28064 <para>If your issue has a supplemental issue with it, fill in the
28065 Supplemental Issue information.</para>
28069 <para>If you have decided to have an item record created for each
28070 issue an <link linkend="addingitems">item add form</link> will
28071 appear for your supplement and for the issue itself</para>
28075 <para>Once you have entered your info you can click 'Save'</para>
28079 <para>If you are receiving multiple issues at once, or have marked an
28080 issue as 'Late' or 'Missing' there you can click the 'Generate Next'
28081 button below the list of issues.</para>
28084 <screeninfo>Generate Next Button</screeninfo>
28088 <imagedata fileref="images/serials/editissue.png"/>
28093 <para>Clicking this button will generate the next issue for you and mark
28094 the previously expected issue as 'Late' automatically. You can then
28095 check the 'Edit' box to the right of each issue and edit the status on
28096 multiple issues at once.</para>
28099 <section id="routinglist">
28100 <title>Create a Routing List</title>
28102 <para>A routing list is a list of people who receive the serial before
28103 it goes to the shelf. When setting up your serial subscription you want
28104 to be sure to pick 'Routing List' from the 'Patron Notification' pull
28108 <screeninfo>Patron Notification Option</screeninfo>
28112 <imagedata fileref="images/serials/serialnotification.png"/>
28117 <para>When on the subscription page you will see a link to the left that
28118 reads 'Create Routing List' or 'Edit Routing List'</para>
28121 <screeninfo>Subscription Routing List Link</screeninfo>
28125 <imagedata fileref="images/serials/createroutinglink.png"/>
28130 <para>Clicking that link will bring you to the menu to add a new routing
28134 <screeninfo>Routing List Creation</screeninfo>
28138 <imagedata fileref="images/serials/createroutinglist.png"/>
28143 <para>From here you want to click 'Add recipients' in order to add
28144 people to the routing list. In the menu that appears you can filter
28145 patrons by part of their name, their library and/or patron
28149 <screeninfo>Add Members to Routing List</screeninfo>
28153 <imagedata fileref="images/serials/addtorouting.png"/>
28158 <para>Clicking 'Add' to the right of each name will add them to the
28159 routing list. When you have chosen all of the people for the list, click
28160 the 'Close' link to be redirected to the routing list.</para>
28163 <screeninfo>Routing List</screeninfo>
28167 <imagedata fileref="images/serials/editroutinglist.png"/>
28172 <para>If the list looks the way you expect it to, then click 'Save'.
28173 Next you will be brought to a preview of the routing list. To print the
28174 list click 'Save and preview routing slip.' This will open a printable
28175 version of the list.</para>
28178 <screeninfo>Preview Routing List</screeninfo>
28182 <imagedata fileref="images/serials/previewroutinglist.png"/>
28188 linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
28189 on then patrons listed in the routing list will automatically be added
28190 to the holds list for the issue.</para>
28193 <section id="serialsubinstaff">
28194 <title>Subscriptions in Staff Client</title>
28196 <para>Subscription information will appear on bibliographic records
28197 under the 'Subscriptions' tab</para>
28200 <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
28204 <imagedata fileref="images/serials/subinfoonbib.png"/>
28209 <para>Clicking the 'Subscription Details' link will take you to the
28210 Subscription summary page in the staff client.</para>
28213 <screeninfo>Subscription Detail</screeninfo>
28217 <imagedata fileref="images/serials/subscriptiondetail.png"/>
28223 <section id="serialsubinopac">
28224 <title>Subscriptions in OPAC</title>
28226 <para>When viewing the subscription in the OPAC there will be several
28229 <para>Like in the staff client, there will be a Subscriptions tab on the
28230 bibliographic record.</para>
28233 <screeninfo>Subscriptions Tab in OPAC</screeninfo>
28237 <imagedata fileref="images/serials/subopac.png"/>
28242 <para>Under this tab will appear the number of issues you chose when
28243 setting up the subscription or in your <link
28244 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
28245 system preference. Clicking the 'More details' link will provide you
28246 with additional information about the serial history. You can set the
28247 default view of a serial in the OPAC with the <link
28248 linkend="SubscriptionHistory">SubscriptionHistory</link> system
28251 <para>There are two views, compact and full. The compact serial
28252 subscription will show basic information regarding the
28253 subscription</para>
28256 <screeninfo>Compact Serial View</screeninfo>
28260 <imagedata fileref="images/serials/compactopac.png"/>
28265 <para>From this compact display patrons can subscribe to routing lists
28266 by clicking the subscribe link that appears below subscriptions that
28267 offer a routing list.</para>
28270 <screeninfo>Subscribe link in the OPAC</screeninfo>
28274 <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
28279 <para>Whereas the full view shows extensive details, broken out by year,
28280 regarding the subscription</para>
28283 <screeninfo>Full Serial View</screeninfo>
28287 <imagedata fileref="images/serials/fullopac.png"/>
28293 <section id="serialclaims">
28294 <title>Claim Late Serials</title>
28296 <para>Koha can send email messages to your serial vendors if you have
28297 late issues. To the left of the main serials page there is a link to
28301 <screeninfo>Link to Claims on Serials Menu</screeninfo>
28305 <imagedata fileref="images/serials/serialclaimmenu.png"/>
28310 <para>The links to claims also appears to the left of the subscription
28314 <screeninfo>Link to Claims on the Serials Menu</screeninfo>
28318 <imagedata fileref="images/serials/serialclaimmenu1.png"/>
28323 <para>If you don't have a claim notice defined yet you will see a
28324 warning message that you need to first define a notice.</para>
28327 <screeninfo>Missing Claims Notice Warning</screeninfo>
28331 <imagedata fileref="images/serials/noserialclaim.png"/>
28336 <para>Clicking 'Claims' will open a report that will ask you to choose
28337 from your various serial vendors to generate claims for late
28341 <screeninfo>Serial Claims</screeninfo>
28345 <imagedata fileref="images/serials/serialclaims.png"/>
28350 <para>From the list of late issues you can choose which ones you want to
28351 send a claim email to by clicking the checkbox to the left of late
28352 issue, choosing the notice template to use and clicking the 'Send
28353 notification' button.</para>
28356 <section id="serialexpiration">
28357 <title>Check Serial Expiration</title>
28359 <para>When adding serials you enter a subscription length, using the
28360 check expiration tool you can see when your subscriptions are about to
28361 expire. To use the tool click the link to 'Check expiration' on the
28362 serials menu.</para>
28365 <screeninfo>Check Serial Expiration</screeninfo>
28369 <imagedata fileref="images/serials/serialexpiresearch.png"/>
28374 <para>In the form that appears you need to enter at least a date to
28377 <para>In your results you will see all subscriptions that will expire
28378 before the date you entered. From there you can choose to view the
28379 subscription further or renew it in one click.</para>
28382 <screeninfo>Serial Expiration Search Results</screeninfo>
28386 <imagedata fileref="images/serials/serialexpire.png"/>
28392 <section id="serialrenew">
28393 <title>Renewing Serials</title>
28395 <para>If your serial subscription has expired you won't be able to
28396 receive issues. To renew your subscription you can click the 'Renew'
28397 button at the top of your subscription detail page.</para>
28400 <screeninfo>Renew option on subscription detail</screeninfo>
28404 <imagedata fileref="images/serials/renewsubscription.png"/>
28409 <para>Another option is to click the 'Renew' link to the right of the
28410 subscription on the Serial Collection page.</para>
28413 <screeninfo>Renew option on serial collection</screeninfo>
28417 <imagedata fileref="images/serials/collectionrenew.png"/>
28422 <para>Once you click the 'Renew' link or button you will be presenting
28423 with renewal options.</para>
28426 <screeninfo>Subscription renewal form</screeninfo>
28430 <imagedata fileref="images/serials/serialrenew.png"/>
28437 <para>The start date should be the date your subscription period
28442 <para>For the subscription length you'll want to fill in one of the
28443 three fields presented: Number of num (issues), Number of months or
28444 Number of weeks.</para>
28448 <para>Finally enter any notes you might have about this
28455 <chapter id="acqmodule">
28456 <title>Acquisitions</title>
28458 <para>The Koha Acquisitions module provides a way for the library to
28459 record orders placed with vendors and manage purchase budgets.</para>
28463 <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
28467 <section id="acqsetup">
28468 <title>Setup</title>
28470 <para>Before using the Acquisitions Module you will want to make sure
28471 that you have completed all of the set up.</para>
28473 <para>First, set your <link linkend="acqprefs">Acquisitions System
28474 Preferences</link> and <link linkend="acqadmin">Acquisitions
28475 Administration</link> to match your library's workflow.</para>
28477 <para>On the main acquisitions page you will see your library's funds
28481 <screeninfo>Acquisitions Funds Summary</screeninfo>
28485 <imagedata fileref="images/acquisitions/acqfunds.png"/>
28491 <para>If the total line is confusing for the funds you have set up
28492 you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
28494 <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
28498 <para>To see all active funds you can click the checkbox next to 'Show
28499 all' below the funds table.</para>
28501 <para>To see a history of all orders in a fund you can click on the
28502 linked amount and it will run a search for you.</para>
28505 <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
28509 <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
28514 <para>Learn more in the <link linkend="fundtracking">Budget/Fund
28515 Tracking</link> section of this manual.</para>
28518 <section id="acqvendors">
28519 <title>Vendors</title>
28521 <para>Before any orders can be places you must first enter at least one
28524 <section id="addacqvendor">
28525 <title>Add a Vendor</title>
28527 <para>To add a vendor click the 'New Vendor' button on the
28528 Acquisitions page</para>
28531 <screeninfo>New Vendor Button on Acquisitions</screeninfo>
28535 <imagedata fileref="images/acquisitions/newvendbutton.png"/>
28540 <para>The vendor add form is broken into three pieces</para>
28544 <para>The first section is for basic information about the
28548 <screeninfo>Basic Vendor Information</screeninfo>
28552 <imagedata fileref="images/acquisitions/newvendor1.png"/>
28559 <para>Of these fields, only the Vendor name is required, the
28560 rest of the information should be added to help with
28561 generating claim letters and invoices</para>
28567 <para>The second section is for information regarding your contact
28568 at the Vendor's office</para>
28571 <screeninfo>Vendor Contact Details</screeninfo>
28575 <imagedata fileref="images/acquisitions/newvendor2.png"/>
28582 <para>None of these fields are required, they should only be
28583 entered if you want to keep track of your contact's
28584 information within Koha</para>
28590 <para>The final section is for billing information</para>
28593 <screeninfo>Vendor Ordering/Billing Information</screeninfo>
28597 <imagedata fileref="images/acquisitions/newvendor3.png"/>
28604 <para>To be able to order from a vendor you must make them
28609 <para>For List Prices and Invoice Prices choose the
28614 <para>Currencies are assigned in the <link
28615 linkend="currexchangeadmin">Currencies & Exchange
28616 Rates</link> admin area</para>
28622 <para>If your library is charged tax mark your Tax Number as
28627 <para>Note if you list prices and/or invoice prices include
28632 <para>If the vendor offers a consistent blank discount, enter
28633 that in the 'Discount' field</para>
28637 <para>You can enter item specific discounts when placing
28644 <para>Enter your tax rate if your library is charged taxes on
28649 <para>If you know about how long it usually takes orders to
28650 arrive from this vendor you can enter a delivery time. This
28651 will allow Koha to estimate when orders will arrive at your
28652 library on the late orders report.</para>
28656 <para>Notes are for internal use</para>
28663 <section id="editacqvendor">
28664 <title>View/Edit a Vendor</title>
28666 <para>To view a vendor's information page you must search for the
28667 vendor from the Acquisitions home page. Your search can be for any
28668 part of the Vendor's name:</para>
28671 <screeninfo>Vendor Search Results</screeninfo>
28675 <imagedata fileref="images/acquisitions/vendorsearch.png"/>
28680 <para>From the results, click on the name of the vendor you want to
28681 view or edit</para>
28684 <screeninfo>Vendor Information Page</screeninfo>
28688 <imagedata fileref="images/acquisitions/vendorpage.png"/>
28693 <para>To make changes to the vendor, simply click the 'Edit'
28696 <para>If the vendor has no baskets attached to it then a 'Delete'
28697 button will also be visible and the vendor can be deleted.</para>
28700 <screeninfo>Delete Vendor Button</screeninfo>
28704 <imagedata fileref="images/acquisitions/deletevendor.png"/>
28710 <section id="vendorcontracts">
28711 <title>Vendor Contracts</title>
28713 <para>You can define contracts (with a start and end date) and attach
28714 it to a vendor. This is used so that at the end of the year you can
28715 see how much you spent on a specific contract with a vendor. In some
28716 places, contracts are set up with a minimum and maximum yearly
28719 <section id="addvendorcontract">
28720 <title>Add a Contract</title>
28722 <para>At the top of a vendor search results page with only result or
28723 at the top of a vendor information page you will see a 'New
28724 Contract' button.</para>
28727 <screeninfo>New Contract Button</screeninfo>
28731 <imagedata fileref="images/acquisitions/newcontract.png"/>
28736 <para>The contract form will ask for some very basic information
28737 about the contract</para>
28740 <screeninfo>New Contract Form</screeninfo>
28744 <imagedata fileref="images/acquisitions/newcontractform.png"/>
28750 <para>You will not be able to enter a contract retrospectively,
28751 the end date must not be before today's date.</para>
28754 <para>Once the contract is saved it will appear below the vendor
28755 information.</para>
28758 <screeninfo>Vendor with contracts</screeninfo>
28762 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
28767 <para>It will also be an option when creating a basket</para>
28770 <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
28774 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
28782 <section id="managesuggest">
28783 <title>Managing Suggestions</title>
28785 <para>Depending on your settings in the <link
28786 linkend="suggestionspref">suggestion</link> system preference, patrons
28787 may be able to make purchase suggestions via the OPAC. When a suggestion
28788 is waiting for library review, it will appear on the Acquisitions home
28789 page under the vendor search.</para>
28792 <screeninfo>Pending suggestions on Acquisitions</screeninfo>
28796 <imagedata fileref="images/acquisitions/suggestonacq.png"/>
28801 <para>It will also appear on the main staff dashboard under the module
28805 <screeninfo>Pending suggestions on main page</screeninfo>
28809 <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
28814 <para>Clicking 'Manage suggestions' will take you to the suggestion
28815 management tool. If there are no pending suggestions you can access the
28816 suggestion management tool by clicking the 'Manage suggestions' link on
28817 the menu on the left of the Acquisitions page.</para>
28820 <screeninfo>Suggestion Management</screeninfo>
28824 <imagedata fileref="images/acquisitions/suggestmanage.png"/>
28829 <para>Your suggestions will be sorted into several tabs: Accepted,
28830 Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
28831 suggestion will show the name of the librarian who managed the
28832 suggestion and the reason they gave for accepting or rejecting it (found
28833 under 'Status').</para>
28835 <para>For libraries with lots of suggestions, there are filters on the
28836 left hand side of the Manage Suggestions page to assist in limiting the
28837 number of titles displayed on the screen.</para>
28840 <screeninfo>Suggestion Filtering</screeninfo>
28844 <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
28849 <para>Clicking on the blue headings will expand the filtering options
28850 and clicking '[clear]' will clear all filters and show all
28852 <para>The suggestions page will automatically be limited to
28853 suggestions for your library. To see information for all (or any
28854 other) libraries click on the 'Acquisition information' filter and
28855 change the library.</para>
28858 <screeninfo>Branch filter</screeninfo>
28862 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
28868 <para>When reviewing 'Pending' suggestions you can choose to check the
28869 box next to the item(s) you want to approve/reject and then choose the
28870 status and reason for your selection. You can also choose to completely
28871 delete the suggestion by checking the 'Delete selected' box.</para>
28874 <screeninfo>Pending Suggestions</screeninfo>
28878 <imagedata fileref="images/acquisitions/suggestpending.png"/>
28883 <para>Another option for libraries with long lists of suggestions is to
28884 approve or reject suggestions one by one by clicking on the title of the
28885 suggestion to open a summary of the suggestion, including information if
28886 the item was purchased.</para>
28889 <screeninfo>Suggestion Information</screeninfo>
28893 <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
28898 <para>Clicking 'edit' to the right of the suggested title will open a
28899 suggestion editing page.</para>
28902 <screeninfo>Edit Purchase Suggestion</screeninfo>
28906 <imagedata fileref="images/acquisitions/editsuggestion.png"/>
28911 <para>From this form you can make edits to the suggestion (adding more
28912 details or updating incorrect information provided by the patron). You
28913 can also choose to accept or reject the suggestion on an individual
28918 <para>Choosing to mark a request as 'Pending' will move the request
28919 back to the 'Pending' tab.</para>
28923 <para>Reasons for accepting and rejecting suggestions are defined by the
28924 <link linkend="suggestauthorized">SUGGEST</link> authorized
28928 <screeninfo>Reasons for approving or rejecting
28929 suggestions</screeninfo>
28933 <imagedata fileref="images/acquisitions/suggestreasons.png"/>
28938 <para>If you choose 'Others...' as your reason you will be prompted to
28939 enter your reason in a text box. Clicking 'Cancel' to the right of the
28940 box will bring back the pull down menu with authorized reasons.</para>
28943 <screeninfo>Enter reason for 'Others...'</screeninfo>
28947 <imagedata fileref="images/acquisitions/suggestothers.png"/>
28952 <para>Once you have clicked 'Submit' the suggestion will be moved to the
28953 matching tab. The status will also be updated on the patron's account in
28954 the OPAC and an <link linkend="notices">email notice</link> will be sent
28955 to the patron using the template that matches the status you have
28959 <screeninfo>Purchase suggestions in the OPAC</screeninfo>
28963 <imagedata fileref="images/acquisitions/mysuggestions.png"/>
28969 <section id="placingacqorder">
28970 <title>Placing Orders</title>
28972 <para>To place an order you must first search for the vendor or
28973 bookseller you want to send the order to.</para>
28975 <section id="createacqbasket">
28976 <title>Create a basket</title>
28978 <para>To create a basket you must first search for the vendor you're
28979 ordering from:</para>
28982 <screeninfo>New Basket / Add Basket Options</screeninfo>
28986 <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
28991 <para>Next to the vendor name you will see a 'New Basket'
28995 <screeninfo>Add Basket Form</screeninfo>
28999 <imagedata fileref="images/acquisitions/addbasket.png"/>
29004 <para>When adding a basket you want to give it a name that will help
29005 you identify it later. The notes fields are optional and can contain
29006 any type of information.</para>
29008 <para>If you have <link linkend="addvendorcontract">added
29009 contracts</link> to the vendor you're ordering from, you will also
29010 have an option to choose which contract you're ordering these items
29014 <screeninfo>Basket with contract options</screeninfo>
29018 <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
29023 <para>When finished, click 'Save'</para>
29026 <screeninfo>New Empty Basket</screeninfo>
29030 <imagedata fileref="images/acquisitions/basket.png"/>
29035 <para>Once your basket is created you are presented with several
29036 options for adding items to the order.</para>
29040 <para>If you are ordering another copy of an existing item, you
29041 can simply search for the record in your system</para>
29044 <screeninfo>Search for existing records</screeninfo>
29048 <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
29055 <para>From the results, simply click 'Order' to be brought to
29056 the order form</para>
29059 <screeninfo>Order form</screeninfo>
29063 <imagedata fileref="images/acquisitions/existingitemorder.png"/>
29070 <para>All of the details associated with the item will
29071 already be listed under 'Catalog details'</para>
29079 <para>If you allow patrons to make purchase suggestions (learn
29080 more in the <link linkend="managesuggest">Managing
29081 Suggestions</link> section of this manual) then you can place
29082 orders from those suggestions</para>
29085 <screeninfo>Approved Suggestions to Order From</screeninfo>
29089 <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
29096 <para>From the results, click 'Order' next to the item you
29097 want to order and you will be presented with the order form
29098 including a link to the suggestion</para>
29101 <screeninfo>Order from a Suggestion</screeninfo>
29105 <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
29112 <para>From this form you can make changes to the Catalog
29113 Details if necessary</para>
29117 <para>When the item appears in your basket it will include
29118 a link to the suggestion</para>
29121 <screeninfo>Suggestion Link in basket</screeninfo>
29125 <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
29136 <para>To order from a record that can't be found anywhere else,
29137 choose the 'From a new (empty) record'</para>
29140 <screeninfo>Order a new record</screeninfo>
29144 <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
29151 <para>You will be presented with an empty form to fill in all
29152 of the necessary details about the item you are
29159 <para>If you want to search other libraries for an item to
29160 purchase you can use the 'From an external source' option which
29161 will allow you to order from a MARC record found via a Z39.50
29165 <screeninfo>Search for record to add</screeninfo>
29169 <imagedata fileref="images/acquisitions/orderz39.png"/>
29176 <para>From the results click the Order link next to the item
29177 you want to purchase</para>
29180 <screeninfo>Search Results to Order From</screeninfo>
29184 <imagedata fileref="images/acquisitions/orderz39results.png"/>
29191 <para>If the item you're ordering from an external source
29192 looks like it might be a duplicate, Koha will warn you and
29193 give you options on how to proceed</para>
29196 <screeninfo>Duplicate order warning</screeninfo>
29200 <imagedata fileref="images/acquisitions/dupwarning.png"/>
29207 <para>From the warning you can choose to just order
29208 another copy on the existing bib record, create a new bib
29209 record, or cancel your order of this item.</para>
29215 <para>In the order form that pops up you will not be able to
29216 edit the catalog details</para>
29219 <screeninfo>New order from Z39.50 Search</screeninfo>
29223 <imagedata fileref="images/acquisitions/orderz39form.png"/>
29232 <para>The final option for ordering is to order from a staged
29233 record (<link linkend="stagemarc">learn more about staging
29234 records</link>)</para>
29237 <screeninfo>Staged Files to Order From</screeninfo>
29241 <imagedata fileref="images/acquisitions/stagedfiles.png"/>
29248 <para>From the list of files you are presented with, choose
29249 the 'Add orders' link</para>
29252 <screeninfo>Records in the staged file</screeninfo>
29256 <imagedata fileref="images/acquisitions/stagedrecords.png"/>
29263 <para>From the list of records, click 'Add order' next to
29264 the item you want to add to your order</para>
29267 <screeninfo>New order from Staged Record</screeninfo>
29271 <imagedata fileref="images/acquisitions/stagedorder.png"/>
29278 <para>From the order form you will not be able to edit
29279 the catalog details.</para>
29285 <para>The other option is to import all records from the
29286 staged file by scrolling below the list of records in the
29287 staged file and filling in the item information.</para>
29290 <screeninfo>Import All</screeninfo>
29294 <imagedata fileref="images/acquisitions/importallstaged.png"/>
29301 <para>If you choose this option the Koha will look in
29302 the 020$c and grab the pricing information from that
29303 field and put that on each order line.</para>
29313 <para>After bringing in the bib information, if your <link
29314 linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
29315 to add an item when ordering you will enter the item info next. You
29316 need to fill out at least one item record and then click the 'Add'
29317 button at the bottom left of the item form.</para>
29320 <screeninfo>Item order</screeninfo>
29324 <imagedata fileref="images/acquisitions/itemonorder.png"/>
29329 <para>After clicking add the item will appear above the form and then
29330 you can enter your next item the same way (if ordering more than one
29334 <screeninfo>Item ordered</screeninfo>
29338 <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
29343 <para>Once you have entered the info about the item you need to enter
29344 the Accounting information.</para>
29347 <screeninfo>Accounting Details</screeninfo>
29351 <imagedata fileref="images/acquisitions/accounting.png"/>
29358 <para>Quantity is populated by the number of items you've added to
29359 the order above</para>
29363 <para>The list of funds is populated by the <link
29364 linkend="funds">funds</link> you have assigned in the <link
29365 linkend="acqadmin">Acquisitions Administration</link> area</para>
29369 <para>The currency pull down will have the <link
29370 linkend="currexchangeadmin">currencies</link> you set up in the
29371 <link linkend="acqadmin">Acquisitions Administration</link>
29376 <para>The vendor price will be used to calculate the rest of the
29377 amount fields below</para>
29381 <para>If the price is uncertain, check the uncertain price
29386 <para>A basket with at least one uncertain price can't be
29393 <para>If you added Planning Values when <link
29394 linkend="addbudgetfund">creating the Fund</link> those values will
29395 appear in the two planning value fields</para>
29399 <para>Once an item is added to the basket you will be presented with a
29400 basket summary</para>
29403 <screeninfo>Basket with item info</screeninfo>
29407 <imagedata fileref="images/acquisitions/finalbasket.png"/>
29412 <para>From here you can edit or remove the items you have
29417 <para>Choosing to 'Delete the order' will just delete the order
29418 line, but leave the record in the catalog</para>
29422 <para>Choosing to 'Delete order and catalog record' remove both
29423 the order line and the record in the catalog</para>
29427 <para>The catalog record cannot always be deleted, you might
29428 see notes as to why</para>
29431 <screeninfo>Can't delete order line</screeninfo>
29435 <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
29444 <para>Also on the summary page you have the option to edit the
29445 information you entered about the basket by clicking the 'Edit basket
29446 header information' button, deleting the basket altogether by clicking
29447 the 'Delete this basket' button, or exporting your basket as a CSV
29448 file by clicking the 'Export this basket as CSV' button.</para>
29451 <screeninfo>Basket Buttons</screeninfo>
29455 <imagedata fileref="images/acquisitions/basketbuttons.png"/>
29460 <para>Once you're sure your basket is complete you can click 'Close
29461 this basket' button to indicate that this basket is complete and has
29462 been sent to the vendor. If you have your <link
29463 linkend="BasketConfirmations">BasketConfirmations</link> preference
29464 set to show a confirmation you will be asked if you're sure about
29465 closing the basket.</para>
29468 <screeninfo>Basket Closure Confirmation</screeninfo>
29472 <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
29477 <para>When closing the basket you can choose to add the basket to a
29478 group for easy printing and retrieval. If you check the box to 'Attach
29479 this basket to a new basket group' you will be brought to the group
29480 list where you can print a PDF of the order.</para>
29483 <screeninfo>Closed Baskets</screeninfo>
29487 <imagedata fileref="images/acquisitions/basketgroup.png"/>
29493 <para>A basket with at least one items marked as 'uncertain price'
29494 will not be able to be closed</para>
29497 <screeninfo>A basket with items where the price is
29498 uncertain</screeninfo>
29502 <imagedata fileref="images/acquisitions/basketuncertain.png"/>
29506 </important></para>
29508 <para>Clicking the 'Uncertain Prices' button will pull up a list of
29509 items that you have marked as uncertain for this vendor. From that
29510 list you can quickly edit the items by entering new prices and
29514 <screeninfo>Uncertain Prices</screeninfo>
29518 <imagedata fileref="images/acquisitions/uncertainprices.png"/>
29524 <para>The Uncertain Prices page is independent of the basket, it is
29525 linked to the vendor, so you will see all items on order for this
29526 vendor with uncertain prices.</para>
29532 <section id="acqbasketgroup">
29533 <title>Create a basket group</title>
29535 <para>A basket group is simply a group of baskets. In some libraries,
29536 you have several staff members that create baskets, and, at the end of
29537 a period of time, someone then groups them together to send to the
29538 vendor in bulk. That said, it is possible to have one basket in a
29539 basket group if that's the workflow used in your library.</para>
29542 <section id="printacqbasket">
29543 <title>Printing baskets</title>
29545 <para>When you are finished adding items to your basket you want to
29546 click 'Close this Basket'</para>
29549 <screeninfo>Close Basket</screeninfo>
29553 <imagedata fileref="images/acquisitions/closebasket.png"/>
29558 <para>You will be asked if you want to create a purchase order at this
29562 <screeninfo>Create Purchase Order</screeninfo>
29566 <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
29571 <para>Your completed order will be listed on the Basket Grouping page
29572 for the printing or further modification.</para>
29575 <screeninfo>Basket Grouping</screeninfo>
29579 <imagedata fileref="images/acquisitions/grouping.png"/>
29584 <para>Clicking 'Print' below your order will generate a PDF for
29585 printing. The PDF will have all of your library information followed
29586 by the items in your order.</para>
29589 <screeninfo>Order found on PDF</screeninfo>
29593 <imagedata fileref="images/acquisitions/pdforder.png"/>
29600 <section id="receiveacqorder">
29601 <title>Receiving Orders</title>
29603 <para>Orders can be received from the vendor information page</para>
29606 <screeninfo>Receive from Vendor Information</screeninfo>
29610 <imagedata fileref="images/acquisitions/receivefromvendor.png"/>
29615 <para>or the vendor search results page</para>
29618 <screeninfo>Vendor Search Results</screeninfo>
29622 <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
29627 <para>After clicking 'Receive shipment' you will be asked to enter a
29628 vendor invoice number and a shipment received date.</para>
29631 <screeninfo>Receive Shipment</screeninfo>
29635 <imagedata fileref="images/acquisitions/receive.png"/>
29640 <para>The receive page will list all items still on order with the
29641 vendor regardless of the basket the item is from.</para>
29644 <screeninfo>Receipt Summary</screeninfo>
29648 <imagedata fileref="images/acquisitions/receiptsummary.png"/>
29653 <para>To receive a specific item, click the 'Receive' link to the right
29654 of the item.</para>
29657 <screeninfo>Receive Item Form</screeninfo>
29661 <imagedata fileref="images/acquisitions/receiveitem.png"/>
29666 <para>From this form you can alter the cost information. You can also
29667 choose to mark only part of the order as received if the vendor didn't
29668 send your entire order by entering in the 'Quantity received'. The
29669 values you enter in the 'Replacement cost' and 'Actual cost' will
29670 automatically populate the item record by filling in subfield v (Cost,
29671 replacement price) and subfield g (Cost, normal purchase price) on the
29672 item record after saving.</para>
29675 <screeninfo>Item record after receipt</screeninfo>
29679 <imagedata fileref="images/acquisitions/receiveditem.png"/>
29684 <para>Once you have made any changes necessary, click 'Save' to mark the
29685 item as received.</para>
29688 <screeninfo>Already Received Items</screeninfo>
29692 <imagedata fileref="images/acquisitions/received.png"/>
29697 <para>When you're finished receiving items you can navigate away from
29698 this page or click the 'Finish receiving' button at the bottom of the
29701 <para>You will also see that the item is received and/or cancelled if
29702 you view the basket.</para>
29705 <screeninfo>One item marked (rcvd) in basket</screeninfo>
29709 <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
29715 <section id="acqclaims">
29716 <title>Claims & Late Orders</title>
29718 <para>If you have entered in an email address for the vendors in your
29719 system you can send them claim emails when an order is late. Before you
29720 can send claims you will need to set up an <link
29721 linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
29723 <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
29724 page you will be presented with a series of filter options on the left
29725 hand side. These filters will be applied only closed baskets.</para>
29728 <screeninfo>Acquisitions Late Order Filters</screeninfo>
29732 <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
29738 <para>The vendor pull down only shows vendors with closed baskets that
29742 <para>Once you filter your orders to show you the things you consider to
29743 be late you will be presented with a list of these items.</para>
29746 <screeninfo>Late Orders</screeninfo>
29750 <imagedata fileref="images/acquisitions/lateorders.png"/>
29755 <para>To the right of each late title you will be see a checkbox. Check
29756 off the ones you want a claim letter sent to and click 'Claim Order' at
29757 the bottom right of the list. This will automatically send an email to
29758 the vendor at the email address you have on file.<note>
29759 <para>The Estimated Delivery Date is based on the Delivery time
29760 value entered on the vendor record.</para>
29763 <para>If you would rather use a different acquisition claim letter
29764 (other than the default) you can <link linkend="addnotices">create that
29765 in the notices module</link> and choose it from the menu above the list
29766 of late items.</para>
29769 <screeninfo>Choose a Claim Letter</screeninfo>
29773 <imagedata fileref="images/acquisitions/claimletter.png"/>
29779 <section id="acqsearch">
29780 <title>Acquisition Searches</title>
29782 <para>At the top of the various Acquisition pages there is a quick
29783 search box where you can perform either a Vendor Search or an Order
29787 <screeninfo>Acquisition Searches</screeninfo>
29791 <imagedata fileref="images/acquisitions/acqsearches.png"/>
29796 <para>In the Vendor Search you can enter any part of the vendor name to
29797 get results.</para>
29800 <screeninfo>Vendor Search Results</screeninfo>
29804 <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
29809 <para>Using the Orders Search you can search for items that have been
29810 ordered with or without the vendor.</para>
29813 <screeninfo>Order Search Box</screeninfo>
29817 <imagedata fileref="images/acquisitions/ordersearch.png"/>
29822 <para>You can enter info in one or both fields and you can enter any
29823 part of the title and/or vendor name.</para>
29826 <screeninfo>Order Search Results</screeninfo>
29830 <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
29835 <para>Clicking the plus sign to the right of the Vendor search box will
29836 expand the search and allow you to search for additional fields.</para>
29839 <screeninfo>Expanded Orders Search</screeninfo>
29843 <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
29848 <para>Clicking Advanced Search to the right of the search button will
29849 give you all of the order search options available.</para>
29852 <screeninfo>Full Order Search</screeninfo>
29856 <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
29862 <section id="fundtracking">
29863 <title>Budget/Fund Tracking</title>
29865 <para>On the main acquisitions page there will be a table on the right
29866 showing you all of your active funds and a breakdown of what has been
29867 ordered or spent against them.</para>
29870 <screeninfo>Fund Table</screeninfo>
29874 <imagedata fileref="images/acquisitions/budgettable.png"/>
29879 <para>Clicking on the linked amounts under spent or ordered will show
29880 you a summary of the titles ordered on that budget.</para>
29883 <screeninfo>Titles Spent</screeninfo>
29887 <imagedata fileref="images/acquisitions/spent.png"/>
29894 <chapter id="stafflists">
29895 <title>Lists & Cart</title>
29897 <para>Lists are a way to save a collection of content on a specific topic
29898 or for a specific purpose. The Cart is a session specific storage
29903 <para><emphasis>Get there:</emphasis> More > Lists</para>
29907 <section id="lists">
29908 <title>Lists</title>
29912 <section id="createlist">
29913 <title>Create a List</title>
29915 <para>A list can be created by visiting the Lists page and clicking
29919 <screeninfo>New List Button</screeninfo>
29923 <imagedata fileref="images/lists/newlistbutton.png"/>
29928 <para>The new list form offers several options for creating your
29932 <screeninfo>New List Form</screeninfo>
29936 <imagedata fileref="images/lists/newlistform.png"/>
29943 <para>The name is what will appear on the list of Lists</para>
29947 <para>You can also choose how to sort the list</para>
29951 <para>Finally there are three types of lists you can choose
29956 <para>A Private List is managed by you and can be seen only by
29961 <para>A Public List can be seen by everybody, but managed only
29968 <para>A list can also be created from the catalog search
29972 <screeninfo>New list from catalog search</screeninfo>
29976 <imagedata fileref="images/lists/newlistsearch.png"/>
29983 <para>Check the box to the left of the titles you want to add to
29984 the new list</para>
29988 <para>Choose [New List] from the 'Add to:' pull down menu</para>
29991 <screeninfo>New List from Search Results</screeninfo>
29995 <imagedata fileref="images/lists/newlistfromsearch.png"/>
30002 <para>Name the list and choose what type of list this
30007 <para>A Private List is managed by you and can be seen
30012 <para>A Public List can be seen by everybody, but managed
30021 <para>Once the list is saved it will accessible from the Lists page
30022 and from the 'Add to' menu at the top of the search results.</para>
30025 <section id="addtolist">
30026 <title>Add to a List</title>
30028 <para>To add titles to an existing list click on the list name from
30029 the page of lists</para>
30032 <screeninfo>List of Lists</screeninfo>
30036 <imagedata fileref="images/lists/listslist.png"/>
30041 <para>From the List page you can add titles by scanning barcodes into
30042 the box at the bottom of the page</para>
30045 <screeninfo>Content of a List</screeninfo>
30049 <imagedata fileref="images/lists/listcontents.png"/>
30054 <para>A title can also be added to a list by selecting titles on the
30055 search results page and choosing the list from the 'Add to'
30059 <screeninfo>Add to List</screeninfo>
30063 <imagedata fileref="images/lists/addtolist.png"/>
30069 <section id="viewlist">
30070 <title>Viewing Lists</title>
30072 <para>To see the contents of a list, visit the Lists page on the staff
30076 <screeninfo>List of Lists</screeninfo>
30080 <imagedata fileref="images/lists/listslist.png"/>
30085 <para>Clicking on the 'List Name' will show the contents of the
30089 <screeninfo>Content of a List</screeninfo>
30093 <imagedata fileref="images/lists/listcontents.png"/>
30099 <section id="mergebibrecs">
30100 <title>Merging Bibliographic Records Via Lists</title>
30102 <para>The easiest way to merge together duplicate bibliographic
30103 records is to add them to a list and use the Merge Tool from
30107 <screeninfo>List of Duplicate Records</screeninfo>
30111 <imagedata fileref="images/lists/listofdups.png"/>
30116 <para>From the list, check the two items you want to merge. If you
30117 choose more than or fewer than 2, you will be presented with an
30121 <screeninfo>Merge Items Error</screeninfo>
30125 <imagedata fileref="images/lists/merge2rec.png"/>
30130 <para>Once you have selected the records you want to merge, click the
30131 'Merge selected items' button. You will be asked which of the two
30132 records you would like to keep as your primary record and which will
30133 be deleted after the merge. If the records were created using
30134 different frameworks, Koha will also ask you what Framework you would
30135 like the newly merged record to use.</para>
30138 <screeninfo>Choose Primary Record for Merge</screeninfo>
30142 <imagedata fileref="images/lists/mergeprimary.png"/>
30147 <para>You will be presented with the MARC for both of the records
30148 (each accessible by tabs labeled with the bib numbers for those
30149 records). By default the entire first record will be selected, uncheck
30150 the fields you don't want in the final (destination) record and then
30151 move on to the second tab to choose which fields should be in the
30152 final (destination) record.</para>
30155 <screeninfo>Merging Records</screeninfo>
30159 <imagedata fileref="images/lists/mergerecs.png"/>
30164 <para>Should you try to add a field that is not repeatable two times
30165 (like choosing the 245 field from both record #1 and #2) you will be
30166 presented with an error</para>
30169 <screeninfo>Non-repeatable Error</screeninfo>
30173 <imagedata fileref="images/lists/nondupfield.png"/>
30178 <para>Once you have completed your selections click the 'merge'
30179 button. The primary record will now CONTAIN the data you chose for it
30180 as well as all of the items/holdings from both bib records, and the
30181 second record will be deleted.<important>
30182 <para>It is important to rebuild your zebra index immediately
30183 after merging records. If a search is performed for a record which
30184 has been deleted Koha will present the patrons with an error in
30186 </important></para>
30190 <section id="cart">
30191 <title>Cart</title>
30193 <para>The cart is a temporary holding place for items in the OPAC and/or
30194 staff client. The cart will be emptied once the session is ended (by
30195 closing the browser or logging out). The cart is best used for
30196 performing batch operations (holds, printing, emailing) or for getting a
30197 list of items to be printed or emailed to yourself or a patron.</para>
30199 <para>If you would like to enable the cart in the staff client, you need
30200 to set the <link linkend="intranetbookbag">intranetbookbag</link> system
30201 preference to 'Show.' To add things to the cart, search the catalog and
30202 select the items you would like added to your cart and choose 'Cart'
30203 from the 'Add to' menu</para>
30206 <screeninfo>Add to Cart</screeninfo>
30210 <imagedata fileref="images/lists/addtocart.png"/>
30215 <para>A confirmation will appear below the cart button at the top of the
30216 staff client</para>
30219 <screeninfo>Items added to Cart</screeninfo>
30223 <imagedata fileref="images/lists/itemsaddedcart.png"/>
30228 <para>Clicking on the Cart icon will provide you with the contents of
30232 <screeninfo>Cart Contents</screeninfo>
30236 <imagedata fileref="images/lists/cart.png"/>
30243 <para>From this list of items you can perform several actions</para>
30247 <para>'Send' will send the list to the email address you
30252 <para>'Download' will allow you to download the cart using one of 3
30253 default formats or your <link linkend="csvprofiles">CSV
30254 Profiles</link></para>
30258 <para>'Print' will present you with a printable version of the
30263 <para>'Empty and Close' will empty the list and close the
30268 <para>'Hide Window' will close the window</para>
30274 <chapter id="reports">
30275 <title>Reports</title>
30277 <para>Reports in Koha are a way to gather data. Reports are used to
30278 generate statistics, member lists, shelving lists, or any list of data in
30279 your database.</para>
30283 <para><emphasis>Get there:</emphasis> More > Reports</para>
30287 <section id="customreports">
30288 <title>Custom Reports</title>
30290 <para>Koha's data is stored in a MySQL database which means that
30291 librarians can generate nearly any report they would like by either
30292 using the <link linkend="quidedreportwizard">Guided Reports
30293 Wizard</link> or writing their own <link linkend="reportfromsql">SQL
30294 query</link>.</para>
30296 <section id="customreport">
30297 <title>Add Custom Report</title>
30301 <section id="quidedreportwizard">
30302 <title>Guided Report Wizard</title>
30304 <para>The guided report wizard will walk you through a six step
30305 process to generate a report.</para>
30307 <para>Step 1: Choose the module you want to report on. This will
30308 determine what tables and fields are available for you to
30312 <screeninfo>Chose Module for Report</screeninfo>
30316 <imagedata fileref="images/reports/report1.png"/>
30321 <para>Step 2: Choose a report type. For now, Tabular is the only
30322 option available.</para>
30325 <screeninfo>Report Type</screeninfo>
30329 <imagedata fileref="images/reports/report2.png"/>
30334 <para>Step 3: Choose the fields you want in your report. You can
30335 select multiple fields and add them all at once by using CTRL+Click
30336 on each item you want to add before clicking the Add button.</para>
30339 <screeninfo>Select database fields to query</screeninfo>
30343 <imagedata fileref="images/reports/report3.png"/>
30348 <para>Step 4: Choose any limits you might want to apply to your
30349 report (such as item types or branches). If you don't want to apply
30350 any limits, simply click Next instead of making an option.</para>
30353 <screeninfo>Choose limits</screeninfo>
30357 <imagedata fileref="images/reports/report4.png"/>
30362 <para>Step 5: Perform math functions. If you don't want to do any
30363 calculations, simply click Next instead of making an option.</para>
30366 <screeninfo>Choose math functions</screeninfo>
30370 <imagedata fileref="images/reports/report5.png"/>
30375 <para>Step 6: Choose data order. If you want the data to print out
30376 in the order it's found in the database, simply click Finish.</para>
30379 <screeninfo>Choose ordering</screeninfo>
30383 <imagedata fileref="images/reports/report6.png"/>
30388 <para>When you are finished you will be presented with the SQL
30389 generated by the report wizard. From here you can choose to save the
30390 report by clicking 'Save' or copy the SQL and make edits to it by
30394 <screeninfo>Custom Report Confirmation</screeninfo>
30398 <imagedata fileref="images/reports/reportconfirm.png"/>
30403 <para>If you choose to save the report you will be asked to name
30404 your report and enter any notes regarding it.</para>
30407 <screeninfo>Save custom report</screeninfo>
30411 <imagedata fileref="images/reports/reportsave.png"/>
30416 <para>Once your report is saved it will appear on the 'Use Saved'
30417 page with all other saved reports.</para>
30420 <screeninfo>Saved Reports list</screeninfo>
30424 <imagedata fileref="images/reports/savedreports.png"/>
30429 <para>From here you can make edits, run the report, or schedule a
30430 time to have the report run. To find the report you created you can
30431 sort by any of the columns by clicking the on the column header
30432 (creation date is the best bet for finding the report you just
30433 added). You can also filter your results using the filter menu on
30437 <section id="reportfromsql">
30438 <title>Report from SQL</title>
30440 <para>In addition to the report wizard, you have the option to write
30441 your own queries using SQL. To find reports written by other Koha
30442 users, visit the Koha Wiki: <ulink
30443 url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink>.
30444 You can also find your database structure in
30445 /installer/data/mysql/kohastructure.sql or online at: <ulink
30446 url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
30448 <para>To add your query, click the link to 'Create from SQL' on the
30449 main reports module or the New button at the top of the Saved
30450 Reports page.</para>
30453 <screeninfo>New SQL Report</screeninfo>
30457 <imagedata fileref="images/reports/newsql.png"/>
30462 <para>Fill in the form presented</para>
30465 <screeninfo>Create Report from SQL</screeninfo>
30469 <imagedata fileref="images/reports/reportfromsql.png"/>
30476 <para>The name is what will appear on the Saved Reports page to
30477 help you identify the report later. It will also be searchable
30478 using the filters found the left of the Saved Reports
30483 <para>Notes will also appear on the Saved Reports page, this can
30484 be used to provide more details about the report or tips on how
30485 to enter values when it runs</para>
30489 <para>The type should always be 'Tabular' at this time since the
30490 other formats have not been implemented</para>
30494 <para>In the SQL box you will type or paste the SQL for the
30499 <para>If you feel that your report might be too resource
30500 intensive you might want to consider using runtime parameters to
30501 your query. Runtime parameters basically make a filter appear
30502 before the report is run to save your system resources.</para>
30504 <para>There is a specific syntax that Koha will understand as
30505 'ask for values when running the report'. The syntax is
30506 <<Question to ask|authorized_value>>.</para>
30510 <para>The << and >> are just delimiters. You
30511 must put << at the beginning and >> at the end
30512 of your parameter</para>
30516 <para>The 'Question to ask' will be displayed on the left of
30517 the string to enter.</para>
30521 <para>The authorized_value can be omitted if not applicable.
30522 If it contains an authorized value category, or branches or
30523 itemtype or categorycode, a list with the Koha authorized
30524 values will be displayed instead of a free field Note that
30525 you can have more than one parameter in a given SQL Note
30526 that entering nothing at run time won't probably work as you
30527 expect. It will be considered as "value empty" not as
30528 "ignore this parameter". For example entering nothing for :
30529 "title=<<Enter title>>" will display results
30530 with title='' (no title). If you want to have to have
30531 something not mandatory, use "title like <<Enter
30532 title>>" and enter a % at run time instead of
30537 <para>Examples:</para>
30541 <para>SELECT surname,firstname FROM borrowers WHERE
30542 branchcode=<<Enter patrons library|branches>>
30543 AND surname like <<Enter filter for patron surname (%
30544 if none)>></para>
30548 <para>SELECT * FROM items WHERE homebranch = <<Pick
30549 your branch|branches>> and barcode like
30550 <<Partial barcode value here>></para>
30555 <para>To generate a date picker calendar to the right of the
30556 field when running a report you can use the 'date' keyword
30557 like this: <<Enter Date|date>></para>
30560 <screeninfo>Date Picker</screeninfo>
30564 <imagedata fileref="images/reports/datepicker.png"/>
30571 <para>You have to put "%" in a text box to 'leave it blank'.
30572 Otherwise, it literally looks for "" (empty string) as the
30573 value for the field.</para>
30577 <para>In addition to using any authorized value code to
30578 generate a dropdown, you can use the following values as
30579 well: Branches (branches), Item Types (itemtypes) and Patron
30580 Categories (categorycode). For example a branch pull down
30581 would be generated like this
30582 <<Branch|branches>></para>
30585 <screeninfo>Branch pull down</screeninfo>
30589 <imagedata fileref="images/reports/branchpulldown.png"/>
30593 </important></para>
30598 <para>There is a limit of 10,000 records put on SQL statements
30599 entered in Koha. To get around this you want to add 'LIMIT 100000'
30600 to the end of your SQL statement (or any other number above
30604 <para>Once everything is entered click the 'Save Report' button and
30605 you'll be presented with options to run it. Once a report is saved
30606 you do not have to recreate it you can simply find it on the Saved
30607 Reports page and <link linkend="runcustomreport">run</link> or <link
30608 linkend="editcustomreports">edit</link> it.</para>
30612 <section id="editcustomreports">
30613 <title>Edit Custom Reports</title>
30615 <para>Every report can be edited from the reports lists. To see the
30616 list of reports already stored in Koha, click 'Use Saved.'</para>
30619 <screeninfo>Saved Reports</screeninfo>
30623 <imagedata fileref="images/reports/savedreports.png"/>
30628 <para>To find the report you'd like to edit you can sort by any of the
30629 columns by clicking the on the column header. You can also filter your
30630 results using the filter menu on the left.</para>
30632 <para>From this list you can edit any custom report by clicking 'Edit
30636 <screeninfo>Edit SQL Form</screeninfo>
30640 <imagedata fileref="images/reports/editreport.png"/>
30646 <section id="runcustomreport">
30647 <title>Running Custom Reports</title>
30649 <para>Once custom reports are saved to Koha, you can run them by going
30650 to the Saved Reports page and clicking the Run link to the right of
30654 <screeninfo>Run Report</screeninfo>
30658 <imagedata fileref="images/reports/runreport.png"/>
30663 <para>When you report runs you will either be asked for some
30667 <screeninfo>Enter report parameters</screeninfo>
30671 <imagedata fileref="images/reports/reportparameters.png"/>
30676 <para>or you will see the results right away</para>
30679 <screeninfo>Report results</screeninfo>
30683 <imagedata fileref="images/reports/reportresults.png"/>
30688 <para>From the results you can choose to rerun the report by clicking
30689 'Run report' at the top, edit the report by clicking the 'Edit' button
30690 or starting over and creating a new report by using the 'New' button.
30691 You can also download your results by choosing a file type at the
30692 bottom of the results next to the 'Download the report' label and
30693 clicking 'Download.'<tip>
30694 <para>A Comma Separated Text file is a CSV file and it can be
30695 opened by any spreadsheet application.</para>
30700 <section id="statsreports">
30701 <title>Statistics Reports</title>
30703 <para>Statistic reports will show you counts and sums. These reports are
30704 all about numbers and statistics, for reports that return more detailed
30705 data, use the <link linkend="quidedreportwizard">Guided Report
30706 Wizard</link>. These reports are limited in what data they can look at,
30707 so it's often recommended to use <link linkend="customreports">custom
30708 reports</link> for official end of the year statistics.</para>
30710 <section id="acqstats">
30711 <title>Acquisitions Statistics</title>
30714 <para>These reports are limited in what data they can look at, so
30715 it's often recommended to use <link linkend="customreports">custom
30716 reports</link> for official end of the year statistics.</para>
30719 <para>Using the form provided, choose which value you would like to
30720 appear in the Column and which will appear in the Row.</para>
30723 <screeninfo>Acquisitions Statistics</screeninfo>
30727 <imagedata fileref="images/reports/acqform.png"/>
30732 <para>If you choose to output to the browser your results will print
30733 to the screen.</para>
30736 <screeninfo>Acquisitions Statistics Results</screeninfo>
30740 <imagedata fileref="images/reports/acqnumbers.png"/>
30745 <para>You can also choose to export to a file that you can manipulate
30746 to your needs.</para>
30748 <para>When generating your report, note that you get to choose between
30749 counting or summing the values.</para>
30752 <screeninfo>Acquisitions Stats Options</screeninfo>
30756 <imagedata fileref="images/reports/acqtotal.png"/>
30761 <para>Choosing amount will change your results to appear as the sum of
30762 the amounts spent.</para>
30765 <screeninfo>Acquisitions statistics with totals</screeninfo>
30769 <imagedata fileref="images/reports/acqamounts.png"/>
30775 <section id="patstats">
30776 <title>Patron Statistics</title>
30779 <para>These reports are limited in what data they can look at, so
30780 it's often recommended to use <link linkend="customreports">custom
30781 reports</link> for official end of the year statistics.</para>
30784 <para>Using the form provided, choose which value you would like to
30785 appear in the Column and which will appear in the Row.</para>
30788 <screeninfo>Patron Statistics Options</screeninfo>
30792 <imagedata fileref="images/reports/patronform.png"/>
30797 <para>If you choose to output to the browser your results will print
30798 to the screen.</para>
30801 <screeninfo>Patron Statistics Results</screeninfo>
30805 <imagedata fileref="images/reports/patronresults.png"/>
30810 <para>Based on your selections, you may see some query information
30811 above your results table. You can also choose to export to a file that
30812 you can manipulate to your needs.</para>
30815 <section id="catstats">
30816 <title>Catalog Statistics</title>
30819 <para>These reports are limited in what data they can look at, so
30820 it's often recommended to use <link linkend="customreports">custom
30821 reports</link> for official end of the year statistics.</para>
30824 <para>Using the form provided, choose which value you would like to
30825 appear in the Column and which will appear in the Row.</para>
30828 <screeninfo>Catalog Statistics Form</screeninfo>
30832 <imagedata fileref="images/reports/catalogform.png"/>
30837 <para>If you choose to output to the browser your results will print
30838 to the screen.</para>
30841 <screeninfo>Catalog Statistic Results</screeninfo>
30845 <imagedata fileref="images/reports/catalogresults.png"/>
30850 <para>You can also choose to export to a file that you can manipulate
30851 to your needs.</para>
30854 <section id="circstats">
30855 <title>Circulation 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>Circulation Statistics</screeninfo>
30871 <imagedata fileref="images/reports/circform.png"/>
30876 <para>If you choose to output to the browser your results will print
30877 to the screen.</para>
30880 <screeninfo>Circulation Statistic Results</screeninfo>
30884 <imagedata fileref="images/reports/circresults.png"/>
30889 <para>You can also choose to export to a file that you can manipulate
30890 to your needs.<tip>
30891 <para>To get a complete picture of your monthly or daily
30892 circulation, you can run the report twice, once for 'Type' of
30893 'Checkout' and again for 'Renewal.'</para>
30895 <para>This report uses 'Period,' or date, filtering that allows
30896 you to limit to a month by simply selecting the first day of the
30897 first month through the first day of the next month. For example,
30898 10/1 to 11/1 to find statistics for the month of October.</para>
30902 <para>To find daily statistics, set your date
30903 range.</br> Example: "I want circulation data starting
30904 with date XXX up to, but not including, date XXX."</para>
30908 <para>For a whole month, an example range would be: 11/01/2009
30909 to 12/01/2009</para>
30913 <para>For a whole year, an example range would be: 01/01/2009
30914 to 01/01/2010</para>
30918 <para>For a single day, an example would be: 11/15/2009 to
30919 11/16/2009 to find what circulated on the 15th</para>
30924 <section id="inhouseuse">
30925 <title>Tracking in house use</title>
30927 <para>Using the Circulation statistics reporting wizard you can run
30928 reports on in house usage of items simply by choosing 'Local Use'
30929 from the 'Type' pull down:</para>
30932 <screeninfo>In House Use Stats</screeninfo>
30936 <imagedata fileref="images/reports/inhouse.png"/>
30943 <section id="serialstats">
30944 <title>Serials Statistics</title>
30947 <para>These reports are limited in what data they can look at, so
30948 it's often recommended to use <link linkend="customreports">custom
30949 reports</link> for official end of the year statistics.</para>
30952 <para>Using the form provided, choose how you would like to list the
30953 serials in your system.</para>
30956 <screeninfo>Serials Statistics</screeninfo>
30960 <imagedata fileref="images/reports/serialsform.png"/>
30965 <para>If you choose to output to the browser your results will print
30966 to the screen.</para>
30969 <screeninfo>Serials Results</screeninfo>
30973 <imagedata fileref="images/reports/serialsresults.png"/>
30978 <para>You can also choose to export to a file that you can manipulate
30979 to your needs.</para>
30982 <section id="holdstats">
30983 <title>Holds Statistics</title>
30986 <para>These reports are limited in what data they can look at, so
30987 it's often recommended to use <link linkend="customreports">custom
30988 reports</link> for official end of the year statistics.</para>
30991 <para>Using the form provided you can see statistics for holds placed,
30992 filled, cancelled and more at your library. From the form choose what
30993 value you want to display in the column and what value to show in the
30994 row. You can also choose from the filters on the far right of the
30998 <screeninfo>Hold Statistics Form</screeninfo>
31002 <imagedata fileref="images/reports/holdstatsform.png"/>
31007 <para>If you choose to output to the browser your results will print
31008 to the screen.</para>
31011 <screeninfo>Hold Stats Results</screeninfo>
31015 <imagedata fileref="images/reports/holdstatsresults.png"/>
31020 <para>You can also choose to export to a file that you can manipulate
31021 to your needs.</para>
31024 <section id="mostcheckouts">
31025 <title>Patrons with the most checkouts</title>
31027 <para>This report will simply list the patrons who have the most
31031 <screeninfo>Patrons with the most checkouts form</screeninfo>
31035 <imagedata fileref="images/reports/topcheckoutsform.png"/>
31040 <para>If you choose to output to the browser your results will print
31041 to the screen.</para>
31044 <screeninfo>Top checkouts results</screeninfo>
31048 <imagedata fileref="images/reports/topcheckoutsresult.png"/>
31053 <para>You can also choose to export to a file that you can manipulate
31054 to your needs.</para>
31057 <section id="mostcirculated">
31058 <title>Most Circulated Items</title>
31060 <para>This report will simply list the items that have the been
31061 checked out the most.</para>
31064 <screeninfo>Most Circulation Items Form</screeninfo>
31068 <imagedata fileref="images/reports/topcircform.png"/>
31073 <para>If you choose to output to the browser your results will print
31074 to the screen.</para>
31077 <screeninfo>Top Circulation Items Results</screeninfo>
31081 <imagedata fileref="images/reports/topcircresults.png"/>
31086 <para>You can also choose to export to a file that you can manipulate
31087 to your needs.</para>
31090 <section id="patnocheckouts">
31091 <title>Patrons with no checkouts</title>
31093 <para>This report will list for you the patrons in your system who
31094 haven't checked any items out.</para>
31097 <screeninfo>Patrons with no Checkouts</screeninfo>
31101 <imagedata fileref="images/reports/patnocheckout.png"/>
31106 <para>If you choose to output to the browser your results will print
31107 to the screen.</para>
31110 <screeninfo>Results for Patrons with no Checkouts</screeninfo>
31114 <imagedata fileref="images/reports/patnocheckout-results.png"/>
31119 <para>You can also choose to export to a file that you can manipulate
31120 to your needs.</para>
31123 <section id="itemnocheckouts">
31124 <title>Items with no checkouts</title>
31126 <para>This report will list items in your collection that have never
31127 been checked out.</para>
31130 <screeninfo>Items with No Checkouts</screeninfo>
31134 <imagedata fileref="images/reports/nocheckoutsform.png"/>
31139 <para>If you choose to output to the browser your results will print
31140 to the screen.</para>
31143 <screeninfo>Items with no checkouts results</screeninfo>
31147 <imagedata fileref="images/reports/nocheckoutsresults.png"/>
31152 <para>You can also choose to export to a file that you can manipulate
31153 to your needs.</para>
31156 <section id="catbyitem">
31157 <title>Catalog by Item Type</title>
31159 <para>This report will list the total number of items of each item
31160 type per branch.</para>
31163 <screeninfo>Catalog by Item Type</screeninfo>
31167 <imagedata fileref="images/reports/itemtotals.png"/>
31172 <para>If you choose to output to the browser your results will print
31173 to the screen.</para>
31176 <screeninfo>Total of Items by Type and Branch</screeninfo>
31180 <imagedata fileref="images/reports/itemtotalsresults.png"/>
31185 <para>You can also choose to export to a file that you can manipulate
31186 to your needs.</para>
31189 <section id="lostreport">
31190 <title>Lost Items</title>
31192 <para>This report will allow you to generate a list of items that have
31193 been marked as Lost within the system</para>
31196 <screeninfo>Lost Items Report</screeninfo>
31200 <imagedata fileref="images/reports/lostitems.png"/>
31206 <section id="avloantime">
31207 <title>Average Loan Time</title>
31209 <para>This report will list the average time items are out on loan
31210 based on the criteria you enter:</para>
31213 <screeninfo>Average Checkout Period Form</screeninfo>
31217 <imagedata fileref="images/reports/averloanform.png"/>
31222 <para>If you choose to output to the browser your results will print
31223 to the screen.</para>
31226 <screeninfo>Average Checkout Period Results</screeninfo>
31230 <imagedata fileref="images/reports/avercheckout.png"/>
31235 <para>You can also choose to export to a file that you can manipulate
31236 to your needs.</para>
31240 <section id="reportdic">
31241 <title>Report Dictionary</title>
31243 <para>The report dictionary is a way to pre-define common filters you'd
31244 like to apply to your reports. This is a good way to add in filters that
31245 the report wizard doesn't include by default. To add a new definition,
31246 or filter, click 'New Definition' on the Reports Dictionary page and
31247 follow the 4 step process.</para>
31249 <para>Step 1: Name the definition and provide a description if
31253 <screeninfo>Create a Definition</screeninfo>
31257 <imagedata fileref="images/reports/dict1.png"/>
31262 <para>Step 2: Choose the module that the will be queried.</para>
31265 <screeninfo>Select Koha Module</screeninfo>
31269 <imagedata fileref="images/reports/dict2.png"/>
31274 <para>Step 3: Choose columns to query from the tables presented.</para>
31277 <screeninfo>Choose columns</screeninfo>
31281 <imagedata fileref="images/reports/dict3.png"/>
31286 <para>Step 4: Choose the value(s) from the field(s). These will be
31287 automatically populated with options available in your database.</para>
31290 <screeninfo>Choose fields and values</screeninfo>
31294 <imagedata fileref="images/reports/dict4.png"/>
31299 <para>Confirm your selections to save the definition.</para>
31302 <screeninfo>Confirm Definition</screeninfo>
31306 <imagedata fileref="images/reports/dictconfirm.png"/>
31311 <para>Your definitions will all appear on the Reports Dictionary
31315 <screeninfo>Reports Dictionary Listing</screeninfo>
31319 <imagedata fileref="images/reports/dictlist.png"/>
31324 <para>Then when generating reports on the module you created the value
31325 for you will see an option to limit by the definition at the bottom of
31326 the usual filters.</para>
31329 <screeninfo>Dictionary Limit Option</screeninfo>
31333 <imagedata fileref="images/reports/dictionarylimit.png"/>
31340 <chapter id="opac">
31341 <title>OPAC</title>
31343 <para>This chapter assumes that you have the following preferences set as
31349 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
31355 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
31360 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
31365 <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
31369 <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
31374 <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
31379 <para><link linkend="reviewson">reviewson</link> = Allow</para>
31383 <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
31387 <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
31392 <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
31397 <para><link linkend="OPACAmazonEnabled">OPACAmazonEnabled</link> =
31403 linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
31408 <para><link linkend="XISBN">XISBN</link> = Use</para>
31412 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
31413 = Default set of links</para>
31417 <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
31418 = Don't show</para>
31422 <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
31428 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
31433 <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
31438 <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
31443 <para>If your system preferences are set differently your displays may
31446 <section id="opacsearchresults">
31447 <title>Search Results</title>
31449 <para>To search the OPAC you can either choose to enter your search
31450 words in the box at the top of the OPAC or click on the 'Advanced
31451 Search' link to perform a more detailed search.</para>
31454 <screeninfo>OPAC Search Box</screeninfo>
31458 <imagedata fileref="images/opac/searchbox.png"/>
31463 <para>For more on searching check the '<link
31464 linkend="searching">Searching</link>' chapter in this manual.</para>
31466 <section id="opacresultsoverview">
31467 <title>Results Overview</title>
31469 <para>After performing a search the number of results found for your
31470 search will appear above the results</para>
31473 <screeninfo>Total Results</screeninfo>
31477 <imagedata fileref="images/opac/totalresults-rss.png"/>
31482 <para>By default your search results will be sorted based on your
31483 <link linkend="opacdefaultsort">OPACdefaultSortField and
31484 OPACdefaultSortOrder</link> system preference values. To change this
31485 you can choose another sorting method from the pull down on the
31489 <screeninfo>Results Sorting Options</screeninfo>
31493 <imagedata fileref="images/opac/sortingresults.png"/>
31498 <para>Under each title on your results list a series of values from
31499 your leader will appear. It is important to note that this has nothing
31500 to do with the item types or collection codes you have applied to your
31501 records, this data is all pulled from your leader.</para>
31504 <screeninfo>Leader Visualization</screeninfo>
31508 <imagedata fileref="images/opac/leader.png"/>
31513 <para>Below each title you will see the availability for the items
31514 attached to the record. Note that even if you filtered on one library
31515 location all locations that hold the item will appear on the search
31519 <screeninfo>Holdings Information</screeninfo>
31523 <imagedata fileref="images/opac/holdings-results.png"/>
31528 <para>If you have turned on <link linkend="enhancedcontent">Enhanced
31529 Content</link> preferences you may have book jackets on your search
31533 <screeninfo>Book Jacket on Results</screeninfo>
31537 <imagedata fileref="images/opac/coverresults.png"/>
31543 <section id="opacfilter">
31544 <title>Filters</title>
31546 <para>To filter your results click on the links below the 'Refine Your
31547 Search' menu on the left of your screen</para>
31550 <screeninfo>Refine Your Results</screeninfo>
31554 <imagedata fileref="images/opac/refineresults.png"/>
31560 <section id="searchrss">
31561 <title>Search RSS Feeds</title>
31563 <para>You will be able to subscribe to your search results as an RSS
31564 feed by clicking the RSS icon in your address bar or next to the
31565 number of results. To learn more about what RSS feeds are check out
31566 <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
31567 video</ulink>.</para>
31570 <screeninfo>RSS Feed Icon</screeninfo>
31574 <imagedata fileref="images/opac/totalresults-rss.png"/>
31579 <para>Subscribing to search results as RSS feeds will allow you to see
31580 when a new item is added to the catalog in your area of
31585 <section id="opacbibrec">
31586 <title>Bibliographic Record</title>
31588 <para>When you click on a title from the search results, you're brought
31589 to the bibliographic detail of the record. This page is broken down in
31590 several different areas.</para>
31592 <para>At the top of your screen will be the title and the GMD:</para>
31595 <screeninfo>Title</screeninfo>
31599 <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
31604 <para>Below the title the authors will be listed. These come from your
31605 1xx and 7xx fields:</para>
31608 <screeninfo>Author Display</screeninfo>
31612 <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
31617 <para>If you have your <link
31618 linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
31619 set to 'show' you will see a material type that is determined by values
31620 in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
31621 Item Types</link> Appendix).</para>
31624 <screeninfo>XSLT Item Type</screeninfo>
31628 <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
31633 <para>Next you'll see the description of the record you're
31637 <screeninfo>Basic Details</screeninfo>
31641 <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
31646 <para>Following that information you'll find the subject headings which
31647 can be clicked to search for other titles on similar topics</para>
31650 <screeninfo>Bibliographic Subjects</screeninfo>
31654 <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
31659 <para>If your record has a table of contents or summary it will appear
31660 next to the 'Summary' or 'Table of Contents' label</para>
31663 <screeninfo>Summary</screeninfo>
31667 <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
31672 <para>If your record has data in the 856 fields you'll see the links to
31673 the right of the 'Online Resources' label</para>
31676 <screeninfo>Online Resources</screeninfo>
31680 <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
31685 <para>If the title you're viewing is in a public list then you'll see a
31686 list of those to the right of the 'List(s) this item appears in' label
31687 and if it has tags they will appear below the 'Tags from this library'
31691 <screeninfo>Tags</screeninfo>
31695 <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
31700 <para>In the tabs below the details you will find your holdings
31708 <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
31713 <para>Any notes (5xx fields) that have been cataloged will appear under
31714 'Title Notes'</para>
31717 <screeninfo>Title notes</screeninfo>
31721 <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
31726 <para>If you're allowing comments they will appear in the next
31730 <screeninfo>Comments</screeninfo>
31734 <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
31739 <para>And finally if you have enabled FRBR and you have other editions
31740 of the title in your collection you will see the 'Editions' tab.</para>
31743 <screeninfo>Editions</screeninfo>
31747 <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
31752 <para>To the right of the details you'll find a series of boxes. The
31753 first box is a list of buttons to help navigate the search results. From
31754 there you can see the next or previous result from your search or return
31755 to the results.</para>
31758 <screeninfo>Search Options</screeninfo>
31762 <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
31767 <para>Clicking Browse Results at the top of the right column will open
31768 up your search results on the detail page</para>
31771 <screeninfo>Search Results</screeninfo>
31775 <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
31780 <para>Below the search buttons you'll find the links to place a hold,
31781 print the record, save the record to your lists, or add it to your
31785 <screeninfo>More options</screeninfo>
31789 <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
31794 <para>Clicking 'More Searches' will show the list of libraries you
31795 entered in your <link
31796 linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
31800 <screeninfo>More Searches</screeninfo>
31804 <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
31809 <para>Under the 'Save Record' label you will find a series of file
31810 formats you can save the record as. This list can be customized by
31811 altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
31812 system preference.</para>
31815 <screeninfo>Save Record</screeninfo>
31819 <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
31824 <para>If at any time you want to change the view from the 'Normal' view
31825 to see the Marc or the ISBD you can click the tabs across the top of the
31829 <screeninfo>Record Views</screeninfo>
31833 <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
31839 <section id="opaclistscart">
31840 <title>Lists & Cart</title>
31842 <para>A cart is a temporary holding place for records you're interested
31843 in finding during this session. That means that once you log out of the
31844 OPAC or close the browser you lose the items in your cart. A list is a
31845 more permanent location for saving items. To learn more about lists,
31846 check the <link linkend="stafflists">Lists in the Staff Client</link>
31847 chapter of this manual.</para>
31849 <section id="opaclists">
31850 <title>Lists</title>
31852 <para>Patrons can manage their own private lists by visiting the 'my
31853 lists' section of their account.</para>
31856 <screeninfo>Lists Management</screeninfo>
31860 <imagedata fileref="images/opac/nolists.png"/>
31865 <section id="opacaddlists">
31866 <title>Creating Lists</title>
31868 <para>Lists can also be created by choosing the 'New List' option in
31869 the 'Add to' menu on the search results</para>
31872 <screeninfo>Add to New List</screeninfo>
31876 <imagedata fileref="images/opac/addtonewlist.png"/>
31881 <para>To create a list the patron simply needs to click the 'New
31882 List' link and populate the form that appears</para>
31885 <screeninfo>Create a new list</screeninfo>
31889 <imagedata fileref="images/opac/newlist.png"/>
31894 <para>The only field required is the 'List Name,' but the patron can
31895 also choose how they want the list sorted and if the list is public
31896 or private.<important>
31897 <para>If you aren't allowing patrons to create public lists with
31899 linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
31900 preference then patrons will only be able to create private
31902 </important></para>
31905 <section id="opacaddtolists">
31906 <title>Adding titles to Lists</title>
31908 <para>Titles can be added to lists from the search results and/or
31909 from the bibliographic record. On the search results options to add
31910 items to the list appear below each result and across the top of the
31911 results page</para>
31914 <screeninfo>Add to Lists from Results</screeninfo>
31918 <imagedata fileref="images/opac/addtolistcart.png"/>
31923 <para>To add a single title to a list, click the 'Save to Lists'
31924 option and then choose the list you'd like to add the title to. To
31925 add multiple titles to a list check the boxes on the left of the
31926 titles you want to add and then choose the list you want to add the
31927 titles to from the 'Add too' pull down at the top of the
31931 <section id="listscontent">
31932 <title>Viewing Lists Contents</title>
31934 <para>To view the contents of a list, click on the list name under
31935 the Lists button.</para>
31938 <screeninfo>Lists</screeninfo>
31942 <imagedata fileref="images/opac/chooselist.png"/>
31947 <para>The contents of the list will look similar to your search
31948 results pages except that there will be different menu options
31949 across the top of the list.</para>
31952 <screeninfo>List View</screeninfo>
31956 <imagedata fileref="images/opac/listview.png"/>
31961 <para>Using the menu options above the list you can place multiple
31962 items on hold, download the list contents, email the list or print
31963 the list out.</para>
31967 <para>To place a hold on one or more list items check the box to
31968 the left of the item and click the 'Place Hold' link at the
31973 <para>To download the list contents click the 'Download List'
31974 link and choose the format you'd like to download the list
31980 <para>iso2079 is MARC format</para>
31987 <para>To email the list contents to someone, click the 'Send
31988 List' link and enter in your email details in the form that pops
31992 <screeninfo>Email List Contents</screeninfo>
31996 <imagedata fileref="images/opac/emailist.png"/>
32003 <para>To print the contents of your list out click the 'Print
32009 <section id="opacmanagelists">
32010 <title>Managing Lists</title>
32012 <para>Once the list is saved patrons can begin adding items to it.
32013 From the 'my lists' tab on the patron record the patron can edit and
32014 delete the lists they have created by clicking the appropriate link
32015 to the right of the list name.</para>
32018 <screeninfo>My Lists</screeninfo>
32022 <imagedata fileref="images/opac/mylists.png"/>
32027 <para>To edit the list's title or sorting patrons click the 'Edit'
32028 link to the right of the list description.</para>
32031 <screeninfo>Editing List</screeninfo>
32035 <imagedata fileref="images/opac/editlist.png"/>
32040 <para>When clicking 'Delete' next to a list you will be asked to
32041 confirm that you want to delete the list.</para>
32044 <screeninfo>Delete list confirmation</screeninfo>
32048 <imagedata fileref="images/opac/deletelist.png"/>
32053 <para>The list will not be deleted until the 'Confirm' button is
32054 clicked to the right of the list you'd like to delete.</para>
32060 <section id="opaccart">
32061 <title>Cart</title>
32065 <section id="opacaddtocart">
32066 <title>Adding titles to the Cart</title>
32068 <para>Titles can be added to the cart from the search results and/or
32069 from the bibliographic record. On the search results options to add
32070 items to the cart appear below each result and across the top of the
32071 results page</para>
32074 <screeninfo>Add to Cart on Search Results</screeninfo>
32078 <imagedata fileref="images/opac/addtolistcart.png"/>
32083 <para>Clicking the 'Add to Cart' button will add the one title to
32084 your cart. To add multiple titles at once, check the box to the left
32085 of each result and then choose 'Cart' from the 'Add to' pull down at
32086 the top of the screen. Once titles are added to the cart you will be
32087 presented with a confirmation</para>
32090 <screeninfo>Items added to Cart</screeninfo>
32094 <imagedata fileref="images/opac/addedtocart.png"/>
32100 <section id="manageopaccart">
32101 <title>Managing the Cart</title>
32103 <para>Once you have titles in your cart you can manage the contents
32104 by clicking on the 'Cart' button usually found at the top of the
32105 screen to the right of the search box. Your cart will open in a new
32109 <screeninfo>Contents of your cart</screeninfo>
32113 <imagedata fileref="images/opac/cartcontents.png"/>
32118 <para>From this window you are presented with several options.
32119 Across the top of the cart are several buttons.</para>
32121 <para>First is the 'More details' button. Clicking this will show
32122 you additional information about the titles in your cart (ISBNs,
32123 Subjects, Publisher Info, Notes and more).</para>
32125 <para>Next is the option to send the contents of your cart to an
32126 email address. This is handy if you want to send the resources you
32127 found at the library to your home email account to refer to later or
32128 to send to a patron researching a specific topic. Clicking this link
32129 will open up a new window that asks for the email address and
32130 message to send.</para>
32133 <screeninfo>Email Cart</screeninfo>
32137 <imagedata fileref="images/opac/emailcart.png"/>
32142 <para>In addition to sending your cart you can download the contents
32143 of your cart in several pre-defined formats or using a <link
32144 linkend="csvprofiles">CSV Profile</link> that you defined in the
32145 Tools module.</para>
32148 <screeninfo>Download Cart</screeninfo>
32152 <imagedata fileref="images/opac/downloadcart.png"/>
32157 <para>Finally you can print out the contents of your cart by
32158 choosing the 'Print' link.</para>
32160 <para>In addition to the various different ways to save the contents
32161 of your cart, there are ways to add value to the data in your cart.
32162 By selecting one or more titles from the cart you can add them to a
32163 list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
32164 tag them (click 'Tag'). All of these operations follow the same
32165 procedure as they do when performing them in the OPAC.</para>
32170 <section id="opacplacehold">
32171 <title>Placing Holds</title>
32173 <para>Patrons can place holds on items via the OPAC if they're logged in
32174 and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
32175 preference set to 'Allow'. If the item can be placed on hold the option
32176 to place it on hold will appear in several different places.</para>
32180 <para>When viewing a list or search results page you'll see the
32181 option to place hold on multiple items by checking the boxes to the
32182 left of the results and clicking 'Place Hold' at the top</para>
32185 <screeninfo>Place Hold from Results</screeninfo>
32189 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
32196 <para>When viewing a list or search results page you'll see the
32197 option to place the item on hold below the basic information about
32201 <screeninfo>Place Hold</screeninfo>
32205 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
32212 <para>When viewing an individual title you'll see the option to
32213 place a hold in the box on the right side of the screen</para>
32216 <screeninfo>Place Hold</screeninfo>
32220 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
32227 <para>No matter which of the above links you click to place your hold
32228 you'll be brought to the same hold screen.</para>
32231 <screeninfo>Place Hold Form</screeninfo>
32235 <imagedata fileref="images/opac/opacplacehold.png"/>
32242 <para>Check the box to the left of the items you'd like to place on
32247 <para>The title includes a link back to the detail page for the
32252 <para>The priority shows where in the holds queue this hold will
32257 <para>If allowed by your <link
32258 linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link>
32259 preference, the 'Hold Starts on Date' column will show. This field
32260 allows the patron to have their hold start on a future date.</para>
32264 <para>By default holds placed in the system remain until canceled,
32265 but if the patron fills in a 'Hold Not Needed After' date then the
32266 hold has an expiration date.</para>
32271 <para>Expired holds are removed by the <link
32272 linkend="expiredholdscron">Expired Holds Cron Job</link>, this
32273 is not an automatic process and must be set up by your system
32274 administrator</para>
32281 <para>If allowed by your <link
32282 linkend="OPACItemHolds">OPACItemHolds</link> preference the patron
32283 will be allowed to choose whether to place the hold on the next
32284 available copy or a specific copy</para>
32287 <screeninfo>Specific Copy Hold</screeninfo>
32291 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
32298 <para>If allowed by your <link
32299 linkend="OPACAllowUserToChooseBranch">OPACAllowUserToChooseBranch</link>
32300 preference the patron can choose where they'd like to pick up their
32305 <para>After clicking the Place Hold button the patron will be brought to
32306 their account page where they'll see all of the items they have on
32310 <section id="opacenhancedcontent">
32311 <title>Enhanced Content</title>
32315 <section id="opactagging">
32316 <title>Tagging</title>
32318 <para>Depending on your settings for the <link
32319 linkend="TagsEnabled">TagsEnabled</link>, <link
32320 linkend="TagsInputOnList">TagsInputOnList</link> and <link
32321 linkend="TagsInputOnDetail">TagsInputOnDetail</link> preferences you
32322 may be able to add tags to bibliographic records from the search
32323 results and/or bibliographic records. If you are allowing patrons to
32324 add tags from the search results screen you will see an input box
32325 below each result and a 'Tag' option at the top of the screen.</para>
32328 <screeninfo>Tagging Options on Results</screeninfo>
32332 <imagedata fileref="images/opac/tags-results.png"/>
32337 <para>To add a tag to one item, type the tabs (separated by commas) in
32338 the 'New tag' box and click 'Add'. You will be presented with a
32339 confirmation of your tags being added.</para>
32342 <screeninfo>Tags Added on Results</screeninfo>
32346 <imagedata fileref="images/opac/tagsadded-results.png"/>
32351 <para>From the results you can also tag items in bulk by clicking the
32352 checkboxes on the left and then clicking the 'Tag' button at the top.
32353 After clicking the button it will change into an input box for you to
32354 add tags to all of the items you have selected.</para>
32357 <screeninfo>Add Tags to Multiple Items</screeninfo>
32361 <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
32367 <section id="opaccomments">
32368 <title>Comments</title>
32370 <para>Patrons can leave comments in the OPAC if you have the <link
32371 linkend="reviewson">reviewson</link> preference set to allow this.
32372 Each bibliographic record has a comments tab below the bibliographic
32373 information.</para>
32376 <screeninfo>Comments Tab</screeninfo>
32380 <imagedata fileref="images/opac/commentstab.png"/>
32385 <para>If the patron is logged in they will see a link to add a comment
32386 to the item. Clicking this link will open a pop up window with a box
32387 for their comments.</para>
32390 <screeninfo>Add a Comment</screeninfo>
32394 <imagedata fileref="images/opac/addcomment.png"/>
32399 <para>Once the comment has been typed and the 'Submit' button clicked,
32400 the patron will see their comment as pending and other patrons will
32401 simply see that there are no comments on the item.</para>
32404 <screeninfo>Pending Comment</screeninfo>
32408 <imagedata fileref="images/opac/commentpending.png"/>
32413 <para>Once the comment is approved the patron will see the number of
32414 comments on the 'Comments' tab and the comment highlighted in yellow
32415 as their comment.</para>
32418 <screeninfo>Your Comments</screeninfo>
32422 <imagedata fileref="images/opac/yourcomment.png"/>
32427 <para>Other patrons will see the comment with the name of the patron
32428 who left the comment (unless you have set the <link
32429 linkend="ShowReviewer">ShowReviewer</link> preference to not show
32430 patron names).</para>
32433 <screeninfo>Comment by other patron</screeninfo>
32437 <imagedata fileref="images/opac/commentby.png"/>
32442 <para>If you'd like to link to a page of recent comments added to your
32443 catalog you simply need to add a link to
32444 http://YOURCATALOG/cgi-bin/koha/opac-showreviews.pl to anywhere on
32448 <screeninfo>Recent Comments List</screeninfo>
32452 <imagedata fileref="images/opac/recentcomments.png"/>
32458 <section id="zotero">
32459 <title>Zotero</title>
32461 <para>Zotero is a Firefox add on that allows for the saving and
32462 generating of a bibliography. Learn more about and download Zotero at
32463 <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
32465 <para>When on the search results in the Koha OPAC, if you have Zotero
32466 installed, you will see a folder icon in the address bar to the right
32467 of the URL. Clicking that folder will open up a list of titles on the
32468 page for you to pick from to add to Zotero.</para>
32471 <screeninfo>Zotero pop up</screeninfo>
32475 <imagedata fileref="images/opac/zoteroaddressbar.png"/>
32480 <para>Select the titles you want to add to Zotero and then click the
32481 'OK' button. This will add the title to Zotero. You can see the title
32482 by opening your Zotero library.</para>
32485 <screeninfo>Title in the Zotero Library</screeninfo>
32489 <imagedata fileref="images/opac/zoterotitle.png"/>
32495 <section id="customrss">
32496 <title>Custom RSS Feeds</title>
32498 <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
32499 any SQL query (for example a new acquisitions RSS feed). rss.pl is run
32500 on the command line to produce an RSS XML document.</para>
32502 <para>The output should be placed in a directory accessible to the
32503 OPAC (or staff) web interface so that users can download the RSS
32506 <para>An example of usage can be found at: misc/cronjobs/rss.pl
32507 lastAcquired.conf</para>
32509 <para>Normally rss.pl should be run periodically (e.g., daily) to keep
32510 the feed up-to-date.</para>
32512 <para>The configuration file (e.g., lastAcquired.conf) lists</para>
32516 <para>name of the template file to use</para>
32520 <para>path of output file</para>
32524 <para>SQL query</para>
32528 <para>rss.pl runs the SQL query, then feeds the output of the query
32529 through the template to produce the output file.</para>
32532 <para>To use custom RSS feeds you need to turn on the cron
32534 </important></para>
32538 <section id="opacmyaccount">
32539 <title>My Account</title>
32541 <para>From the OPAC patrons can log in and access their account if you
32542 have set the <link linkend="opacuserlogin">opacuserlogin</link>
32543 preference to 'Allow'. Once logged in patrons are brought to their
32544 account summary. If you would like to get to your account in the OPAC,
32545 you can click on your name in the top right of any page in the
32548 <section id="opacmysummary">
32549 <title>My Summary</title>
32552 <screeninfo>My Summary</screeninfo>
32556 <imagedata fileref="images/opac/myaccount.png"/>
32561 <para>From the 'my summary' tab, patrons will see all of the items
32562 they have checked out with the overdue items highlighted in red. If
32563 you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
32564 set to 'Allow' then your patrons will be able to renew their books
32565 right from the OPAC. If you have HTML entered in the <link
32566 linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
32567 you will see that to the right of the 'Fines' column.</para>
32570 <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
32574 <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
32579 <para>If your patrons would like to see the items barcodes on their
32580 list of checked out items you can set up a <link
32581 linkend="patronattributetypes">patron attribute</link> with the value
32582 of SHOW_BCODE and <link linkend="authorizedvalues">authorized
32583 value</link> of YES_NO.</para>
32586 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
32590 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
32595 <para>Then on the <link linkend="editpatrons">patron's record set the
32596 value</link> for SHOW_BCODE to yes.</para>
32599 <screeninfo>Setting value for SHOW_BCODE on patron
32600 record</screeninfo>
32604 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
32609 <para>This will add a column to the check out summary in the OPAC that
32610 shows the patrons the barcodes of the items they have checked
32614 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
32618 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
32623 <para>Clicking on the 'Overdue' tab will show only the items that are
32627 <screeninfo>Overdue Items</screeninfo>
32631 <imagedata fileref="images/opac/myoverdues.png"/>
32636 <para>The 'Fines' tab will show just a total of what the patron owes.
32637 Clicking on the total will take them to the 'my fines' tab where they
32638 will see a complete breakdown of their fines and bills. If you don't
32639 charge fines at your library you can turn the display of these tabs
32640 off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
32641 preference to 'Don't Allow.'</para>
32644 <screeninfo>Patron Fines</screeninfo>
32648 <imagedata fileref="images/opac/myfines.png"/>
32653 <para>Finally, clicking on the 'Holds' tab will show the patron the
32654 status of all of the items they have on hold. Items that are ready for
32655 pickup will be highlighted in yellow.</para>
32658 <screeninfo>Patron holds status</screeninfo>
32662 <imagedata fileref="images/opac/myholds.png"/>
32667 <para>Patrons can cancel their own holds if they are not in transit or
32668 already waiting for them. They can also suspend all of their holds
32669 (depending on the value of your <link
32670 linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference)
32671 indefinitely or until a specific date if they choose by filling in the
32672 suspend options at the bottom of the page.</para>
32675 <para>If you have your <link
32676 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
32677 preference set to "Don't allow" then you will not have the option to
32678 put an end date on the hold suspension</para>
32682 <section id="opacmyaccount-flags">
32683 <title>Patron Flags</title>
32685 <para>If you have <link linkend="patronflags">flagged your patron's
32686 account</link> they may see one of the following error messages at the
32687 top of their account.</para>
32691 <para>Card marked as lost</para>
32694 <screeninfo>Library card lost</screeninfo>
32698 <imagedata fileref="images/opac/nocard.png"/>
32705 <para>Patron address in question</para>
32708 <screeninfo>Patron address in question</screeninfo>
32712 <imagedata fileref="images/opac/noaddress.png"/>
32720 <para>this error message will not include a link to the
32721 update form if you have <link
32722 linkend="OPACPatronDetails">OPACPatronDetails</link> set to
32723 'Don't allow'</para>
32730 <para>Patron marked restricted</para>
32733 <screeninfo>Patron restricted</screeninfo>
32737 <imagedata fileref="images/opac/debarred.png"/>
32745 <section id="opacmyfines">
32746 <title>My Fines</title>
32748 <para>If your library charges fines the next tab on the left is 'my
32749 fines.' Opening this tab will show the patron an entire history of
32750 their accounting at the library.</para>
32753 <screeninfo>Library Fines & Charges</screeninfo>
32757 <imagedata fileref="images/opac/mybilling.png"/>
32763 <section id="opacmydetails">
32764 <title>My Details</title>
32766 <para>If you have your <link
32767 linkend="OPACPatronDetails">OPACPatronDetails</link> preference set to
32768 'Allow', your patrons will see a form filled in with their contacting
32769 information by clicking on the 'my personal details' tab.</para>
32772 <screeninfo>Patron's personal details</screeninfo>
32776 <imagedata fileref="images/opac/myprofile.png"/>
32781 <para>Patrons can edit their details in this form and click 'Submit
32782 Changes' to have their edits sent to the library for review before
32783 their record is updated. The email with the changes is sent to the
32784 library administration email address and lines that the patron changed
32785 will start with the field name in all caps.</para>
32788 linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set
32789 to 'Don't allow' then patrons will simply see their details in plain
32793 <screeninfo>Patron's personal details with no edits</screeninfo>
32797 <imagedata fileref="images/opac/myprofile-noedit.png"/>
32803 <section id="opacmytags">
32804 <title>My Tags</title>
32806 <para>If your library has <link
32807 linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
32808 next tab on the left will be 'my tags.' This tab will show patrons all
32809 of the tags in the system as a cloud and then all of the tags they
32810 have applied in a list format. From here patrons have the ability to
32811 remove tags that they have added if they want.</para>
32814 <screeninfo>Patron's tags</screeninfo>
32818 <imagedata fileref="images/opac/mytags.png"/>
32824 <section id="opacmypassword">
32825 <title>Change My Password</title>
32827 <para>Next, if you have <link
32828 linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
32829 the next tab will be 'change my password,' where patrons can change
32830 their password for logging into the OPAC. Patrons will be presented
32831 with a standard form asking them to enter their old password and then
32832 their new password twice.</para>
32835 <screeninfo>Change my password</screeninfo>
32839 <imagedata fileref="images/opac/mypassword.png"/>
32845 <section id="opacmysearchistory">
32846 <title>My Search History</title>
32848 <para>If you have your <link
32849 linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
32850 preference set to 'Allow' then your patrons can access their search
32851 history via the 'my search history' tab.</para>
32854 <screeninfo>my search history tab</screeninfo>
32858 <imagedata fileref="images/opac/mysearchhistory.png"/>
32863 <para>The search history is a record of all searches run by the
32864 patron. Clicking on any of the search phrases will re-run the search
32865 for the patron. The search history can be deleted by the patron at any
32866 time by clicking the 'Delete your search history' link found at the
32867 top of this tab or by clicking the little red 'x' next to the 'Search
32868 history' link at the top right of the OPAC.</para>
32871 <screeninfo>Search history link at the top right of the
32876 <imagedata fileref="images/opac/searchistory.png"/>
32882 <section id="opacmyhistory">
32883 <title>My Reading History</title>
32885 <para>Depending on your library's setting for <link
32886 linkend="opacreadinghistory">opacreadinghistory</link> your patrons
32887 may see the 'my reading history' tab next. This will show the patron
32888 their entire reading history unless they have asked the library to not
32889 keep that information via the 'my privacy' tab which will appear if
32890 you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
32891 set to 'Allow.'</para>
32894 <screeninfo>Patron reading history</screeninfo>
32898 <imagedata fileref="images/opac/myhistory.png"/>
32904 <section id="opacmyprivacy">
32905 <title>My Privacy</title>
32907 <para>The 'my privacy' tab will appear if you have both the <link
32908 linkend="opacreadinghistory">opacreadinghistory</link> and the <link
32909 linkend="OPACPrivacy">OPACPrivacy</link> preferences set to 'Allow.'
32910 This tab will allow the patrons to decide how the library keeps their
32911 circulation history data.</para>
32914 <screeninfo>my privacy tab</screeninfo>
32918 <imagedata fileref="images/opac/myprivacy.png"/>
32923 <para>The patron can choose from three options:</para>
32927 <para>Forever: keep my reading history without limit. This is the
32928 option for users who want to keep track of what they are
32933 <para>Default: keep my reading history according to local laws.
32934 This is the default option : the library will keep your reading
32935 history for the duration permitted by local laws.</para>
32939 <para>Never: Delete my reading history immediately. This will
32940 delete all record of the item that was checked-out upon
32945 <para>Depending on the patron's suggestions the contents of the '<link
32946 linkend="opacmyhistory">my reading history</link>' tab and the '<link
32947 linkend="circhistory">Circulation History</link>' tab in the staff
32948 client may change.</para>
32950 <para>Regardless of the patron's choice they can delete their reading
32951 history in bulk at any time by clicking the 'Immediate deletion'
32955 <screeninfo>Delete Circulation History</screeninfo>
32959 <imagedata fileref="images/opac/deletecirchistory.png"/>
32964 <para>Clicking this button will not delete items that are currently
32965 checked out, but will clear the patron's past reading history.</para>
32968 <section id="opacmysuggestions">
32969 <title>My Purchase Suggestions</title>
32971 <para>If your library allows patrons to make purchase suggestions the
32972 next tab will show all suggestions that the patron made to the library
32973 and their statuses. To disable this tab and the suggestion
32974 functionality set the <link
32975 linkend="suggestionspref">suggestion</link> preference to 'Don't
32979 <screeninfo>Patron purchase suggestions</screeninfo>
32983 <imagedata fileref="images/opac/mysuggestions.png"/>
32989 <section id="opacmymsgs">
32990 <title>My Messaging</title>
32992 <para>If your library has the <link
32993 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
32994 preference set to 'Allow' then your patrons will be able to choose
32995 which messages they receive from the library (with the exception of
32996 overdue notices which the library controls).</para>
32999 <screeninfo>Patron messaging preferences</screeninfo>
33003 <imagedata fileref="images/opac/mymessages.png"/>
33008 <para>If you also allow SMS messages with the <link
33009 linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
33010 an additional column to receive these messages as SMS (or text
33011 messages) and a field for a cell (or SMS) number.</para>
33014 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
33018 <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
33024 <section id="opacmylists">
33025 <title>My Lists</title>
33027 <para>Finally, if your library has the <link
33028 linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
33029 last tab will by 'my lists.' From here your patrons can review public
33030 lists and create or edit their own private lists.</para>
33033 <screeninfo>Patron lists</screeninfo>
33037 <imagedata fileref="images/opac/mylists.png"/>
33044 <section id="purchasesuggest">
33045 <title>Purchase Suggestions</title>
33047 <para>If your library has the <link
33048 linkend="suggestionspref">suggestion</link> preference set to 'Allow'
33049 then patrons will have the option to make purchase suggestions in
33050 several areas in the OPAC.</para>
33052 <para>There will be a link at the top of your OPAC under the search
33056 <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
33060 <imagedata fileref="images/opac/suggestfromsearch.png"/>
33065 <para>There will be a link when the patron finds nothing for their
33069 <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
33073 <imagedata fileref="images/opac/suggestfromnoresults.png"/>
33078 <para>And there will be a link on the patron's <link
33079 linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
33082 <screeninfo>Purchase Suggestion from My Purchase Suggestions
33087 <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
33092 <para>Clicking any one of these links will open the purchase suggestion
33096 <screeninfo>New Purchase Suggestion</screeninfo>
33100 <imagedata fileref="images/opac/newsuggestion.png"/>
33107 <para>From the form on the 'Title' is required by the
33112 <para>If you would like the 'Reason for suggestion' menu shown in
33113 the screenshot above to appear on your suggestions list you need to
33114 add an <link linkend="authorizedvalues">authorized value</link>
33115 category titled 'OPAC_SUG' and include reasons as values in that
33120 <para>If you would like the patron to be able to choose which branch
33121 they are making a suggestion for you need to set the <link
33122 linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
33123 preference to 'Allow'</para>
33127 <para>Once the form is submitted the data will be saved to the <link
33128 linkend="managesuggest">Acquisitions</link> module for the librarians to
33133 <chapter id="searching">
33134 <title>Searching</title>
33138 <section id="searchprefixes">
33139 <title>Advanced Search Prefixes</title>
33141 <para>The following prefixes can be added to search terms in the keyword
33142 search box to limit items returned</para>
33146 <para>ti: title search</para>
33150 <para>ex. ti:hamlet</para>
33156 <para>su: subject search</para>
33160 <para>ex. su:cooking</para>
33166 <para>pb: publisher search</para>
33170 <para>ex. pb:penguin</para>
33176 <para>au: author search</para>
33180 <para>ex. au:rowling</para>
33186 <para>su-geo: geographic subjects</para>
33190 <para>ex. su-geo:wales and kw:description and kw:travel</para>
33196 <para>bc: barcode</para>
33200 <para>ex. bc:502326000912</para>
33206 <para>lex: lexile</para>
33210 <para>levels lex:510</para>
33219 <section id="searchguide">
33222 <firstname>Becky</firstname>
33224 <surname>Bell</surname>
33227 <orgname>WALDO</orgname>
33231 <pubdate>October 2008</pubdate>
33233 <othercredit role="copyeditor">
33234 <firstname>Nicole C.</firstname>
33236 <surname>Engard</surname>
33238 <contrib>Fixed typos, changed content where necessary and added new
33239 screenshots.</contrib>
33243 <title>Guide to Searching</title>
33245 <para>This brief guide will explain a chart that shows a sample of how a
33246 MARC21 database can be configured, as well as a brief introductory
33247 searching guide. The indexing fields described in this document relate
33248 to the bibliographic data and does not address authority database
33251 <section id="searchguide-indexing">
33252 <title>Indexing and Searching Description</title>
33254 <para>Koha's databases are indexed by the Zebra open-source software.
33255 The overview to the documentation describes Zebra as:</para>
33258 <para>"...Zebra is a high-performance, general-purpose structured
33259 text indexing and retrieval engine. It reads records in a variety of
33260 input formats (eg. email, XML, MARC) and provides access to them
33261 through a powerful combination of Boolean search expressions and
33262 relevance-ranked free-text queries.</para>
33264 <para>Zebra supports large databases (tens of millions of records,
33265 tens of gigabytes of data). It allows safe, incremental database
33266 updates on live systems. Because Zebra supports the
33267 industry-standard information retrieval protocol, Z39.50, you can
33268 search Zebra databases using an enormous variety of programs and
33269 toolkits, both commercial and free, which understands this
33270 protocol..." Zebra - User's Guide and Reference, p. 1, <ulink
33271 url="http://www.indexdata.dk/zebra/doc/zebra.pdf">http://www.indexdata.dk/zebra/doc/zebra.pdf</ulink></para>
33274 <para>This brief guide will explain a chart that shows a sample of how
33275 a MARC21 database can be configured, as well as a brief introductory
33276 searching guide. The indexing fields described in this document relate
33277 to the bibliographic data and does not address authority database
33281 <para>The indexing described in this document is the set used by
33282 SouthEastern University. Your local indexing may vary.</para>
33286 <section id="searchguide-indexconfig">
33287 <title>Indexing Configuration</title>
33289 <para>There are three configuration files that Koha uses while
33292 <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
33293 contains the Z39.50 bib-1 attribute list, plus the Koha local use
33294 attributes for Biblio Indexes, Items Index, and Fixed Fields and other
33295 special indexes. The Z39.50 Bib-1 profile is made up of several
33296 different types of attributes: Use, Relation, Position, Structure,
33297 Truncation, and Completeness. The bib-1 'Use' attribute is represented
33298 on the chart; the other attributes are used primarily when doing
33299 searches. While there are over 150+ use attributes that could be used
33300 to define your indexing set, it's unlikely that you will choose to use
33301 them all. The attributes you elect to use are those that become the
33302 indexing rules for your database. The other five attribute sets define
33303 the various ways that a search can be further defined, and will not
33304 specifically be addressed in this document. For a complete list of the
33305 standard Bib-1 attributes, go to <ulink
33306 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
33308 <para>The second file
33309 (etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs) contains
33310 the abstract syntax which maps the MARC21 tags to the set of Use
33311 Attributes you choose to use. The rules established in this file
33312 provides a passable Bath level 0 and 1 service, which includes author,
33313 title, subject, keyword and exact services such as standard
33314 identifiers (LCCN, ISBN, ISSN, etc.)</para>
33316 <para>The third file (etc/zebradb/ccl.properties) is the Common
33317 Command Language (CCL) field mappings. This file combines the bib-1
33318 attribute set file and the abstract file and adds the qualifiers,
33319 usually known as index names. The qualifiers, or indexes, for this
33320 database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
33321 su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
33322 mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
33324 <para>The Koha Indexing Chart summarizes the contents of all three of
33325 these files in a more readable format. The first two columns labeled
33326 Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes
33327 file. The third column labeled MARC tags indexed is where you find
33328 which MARC tags are mapped to an attribute. The fourth column labeled
33329 Qualifiers identifies the search abbreviations used in the internal
33330 CCL query. The following description provides a definition for the
33331 word 'qualifiers'.</para>
33333 <para><emphasis>Qualifiers are used to direct the search to a
33334 particular searchable index, such as title (ti) and author indexes
33335 (au). The CCL standard itself doesn't specify a particular set of
33336 qualifiers, but it does suggest a few shorthand notations. You can
33337 customize the CCL parser to support a particular set of qualifiers to
33338 reflect the current target profile. Traditionally, a qualifier would
33339 map to a particular use-attribute within the BIB-1attribute set. It is
33340 also possible to set other attributes, such as the structure
33341 attribute.</emphasis></para>
33343 <para>In the MARC tags indexed column, there are some conventions used
33344 that have specific meanings. They are:</para>
33348 <para>A three digit tag (100) means that all subfields in the tag
33349 can be used in a search query. So, if you enter a search for
33350 'Jackson' as an author, you will retrieve records where Jackson
33351 could be the last name or the first name.</para>
33355 <para>A three digit tag that has a '$' followed by a letter
33356 (600$a) means that a search query will only search the 'a'
33361 <para>A three digit tag that is followed by a ':' and a letter
33362 (240:w) means that a search query can be further qualified. The
33363 letter following the ':' identifies how to conduct the search. The
33364 most common values you'll see are 'w' (word), 'p' (phrase), 's'
33365 (sort), and 'n' (numeric).</para>
33369 <para>The contents of the MARC tags, subfields, and/or fixed field
33370 elements that are listed in this chart are all indexed. You'll see
33371 that every attribute line is not mapped to a specific qualifier
33372 (index)-LC card number, line 9 is one example. However, every indexed
33373 word (a string of characters preceded and succeeded by a space) can be
33374 searched using a keyword (kw) search. So, although an LC card number
33375 specific index doesn't exist, you can still search by the LCCN since
33376 tag 010 is assigned to the LC-card-number attribute. To verify this,
33377 enter 72180055 in the persistent search box. You should retrieve The
33378 gods themselves, by Isaac Asimov.</para>
33380 <para>Examples of fixed field elements indexing can be seen on the
33381 chart between Attribute 8822 and Attribute 8703. These attributes are
33382 most commonly used for limiting. The fixed field attributes currently
33383 represent the BK codes. Other format codes, if needed, could be
33387 <section id="searchguide-basics">
33388 <title>Basic Searching</title>
33390 <para>The search box that library staff and library patrons will see
33391 most often is the persistent search box at the top of the page. Koha
33392 interprets the searches as keyword searches.</para>
33395 <screeninfo>Koha search box</screeninfo>
33399 <imagedata fileref="images/searching/searchbox.png"/>
33404 <para>To start a search, you enter a word or multiple words in the
33405 search box. When a single word is entered, a keyword search is
33406 performed. You can check this out by typing one word into the form and
33407 note the number of results located. Then, repeat the search with a
33408 minor change. In front of the search word, type 'kw=' followed by the
33409 same search term. The results will be identical.</para>
33411 <para>When you have more than one word in the search box, Koha will
33412 still do a keyword search, but a bit differently. Each word will be
33413 searched on its own, then the Boolean connector 'and' will narrow your
33414 search to those items with all words contained in matching
33417 <para>Suppose you want to find material about how libraries are using
33418 mashups. You'll select the major words and enter them into the
33419 persistent search box.</para>
33422 <screeninfo>Keyword Search</screeninfo>
33426 <imagedata fileref="images/searching/searchterms.png"/>
33431 <para>The response to this search is:</para>
33434 <screeninfo>Results</screeninfo>
33438 <imagedata fileref="images/searching/resultssummary.png"/>
33443 <para>The order of the words does not affect the retrieval results, so
33444 you could also enter the search as "mashups library". The response to
33445 this search is results</para>
33448 <screeninfo>Results</screeninfo>
33452 <imagedata fileref="images/searching/resultssummary2.png"/>
33457 <para>Too many words in the search box will find very few matches, as
33458 the following example illustrates:</para>
33461 <screeninfo>No results found</screeninfo>
33465 <imagedata fileref="images/searching/noresults.png"/>
33471 <section id="searchguide-advanced">
33472 <title>Advanced Searching</title>
33474 <para>When you can't find the most appropriate material with a general
33475 search, you can move to the Advanced Search page by clicking on the
33476 Search option on the persistent toolbar.</para>
33479 <screeninfo>Koha Menu</screeninfo>
33483 <imagedata fileref="images/searching/menubar.png"/>
33488 <para>The Advanced Search page offers many ways to limit the results
33489 of your search. You can search using the Boolean operators AND, OR,
33490 and NOT; limit by item type; limit by year and language; limit by
33491 subtypes audience, content, format, or additional content types; by
33492 location and by availability.</para>
33494 <para>The first limiting section on the Advanced Search page provides
33495 a quick and simple way to use the Boolean operators in your search.
33496 Note that this display depends on a system preference setting. This
33497 option can be found on the Administration > System Preferences >
33498 Searching page. The option called <link
33499 linkend="expandedSearchOption">expandedSearchOption</link> must be set
33500 to 'show' to see the following display.</para>
33503 <screeninfo>Advanced Search Options</screeninfo>
33507 <imagedata fileref="images/searching/searchoptions.png"/>
33512 <para>In this section you can choose among the many indexes by
33513 clicking on the arrow in the first box. The blank box that follows is
33514 where you enter your first search term or terms. On the second line,
33515 you can choose the Boolean operator you want to use in your search.
33516 The options are 'and', 'or', and 'not'. Then, you would again choose
33517 the index to search, followed by the second term or terms. If you have
33518 more concepts you want to include in your search, you can click the
33519 [+] to add another line for your search.</para>
33521 <para>A sample search is shown next, followed by its results:</para>
33524 <screeninfo>Advanced Search</screeninfo>
33528 <imagedata fileref="images/searching/advsearch.png"/>
33534 <screeninfo>Results from Advanced Search</screeninfo>
33538 <imagedata fileref="images/searching/numresults.png"/>
33543 <para>When you use the Boolean operators to broaden or narrow a
33544 search, remember the action of each operator. The 'and' operator
33545 narrows the results you'll retrieve because the search will retrieve
33546 the records that include all your search terms. The 'or' operator
33547 expands the results because the search will look for occurrences of
33548 all of your search terms. The 'not' operator excludes records with the
33549 term that follows the operator.</para>
33551 <para>Note: If you leave this <link
33552 linkend="expandedSearchOption">expandedSearchOption</link> set to
33553 'don't show', this is the display you will see:</para>
33556 <screeninfo>Fewer Search Options</screeninfo>
33560 <imagedata fileref="images/searching/feweropts.png"/>
33565 <para>The Advanced Search page then shows the multiple kinds of limits
33566 that can be applied to your search results. Either check a box or
33567 select from the drop down menus to narrow your search. You will type
33568 the year, year range, or a 'greater than (>)' or 'less than (<)'
33572 <screeninfo>Other Advanced Search Options</screeninfo>
33576 <imagedata fileref="images/searching/advoptions.png"/>
33581 <para>Finally, you can choose how the results will be sorted. The
33582 pre-defined sort options are in the final area of the Advanced Search
33586 <screeninfo>Sort Results By</screeninfo>
33590 <imagedata fileref="images/searching/advsortby.png"/>
33595 <para>The default sort is by relevance, although you can choose to
33596 sort by author, by title, by call number, by dates, or by popularity.
33597 If you would prefer a different default sort, you can set <link
33598 linkend="defaultSortField">defaultSortField</link> to one of the other
33599 choices in Administration > System Preferences >
33603 <section id="searchguide-ccl">
33604 <title>Common Command Language Searching</title>
33606 <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
33607 internal search protocol. Searches initiated in the graphical
33608 interface use this protocol as well, although the searcher doesn't
33609 know which indexes, operators and limiters are available and being
33610 used to conduct their search. The searcher can use the Advanced Search
33611 when more precise results set are desired and where the search indexes
33612 are somewhat known. However, some library users and many library staff
33613 prefer using a command based structure. This part of the document will
33614 present and explain the use of the Koha command based structure. The
33615 indexes, operators, and limiters used are identical to those used in
33616 the graphical interface.</para>
33618 <section id="searchguide-indexes">
33619 <title>Indexes</title>
33621 <para>The CCL standard itself doesn't specify a particular set of
33622 qualifiers (indexes), but it does suggest a few short-hand notations
33623 such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
33624 it's possible to customize that set by adding needed indexes based
33625 on local requirements. A qualifier (index) maps to a particular
33626 use-attribute within the Z39.50 BIB-1 attribute set. The complete
33627 Z39.50 Bib-1 Attribute can be viewed at <ulink
33628 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
33630 <para>The standard Koha set of indexes is a fairly common example of
33631 MARC21 indexing rules. The indexes that are defined in Koha are
33632 indexes typically used by other integrated library systems. The
33633 defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
33635 <table cellpadding="4" cellspacing="4" frame="all">
33636 <title>Attributes</title>
33638 <tgroup align="left" cols="2" colsep="1" rowsep="1">
33641 <entry>Bib-1 Attribute</entry>
33643 <entry>Qualifier (index)</entry>
33649 <entry>Personal-name</entry>
33655 <entry>Corporate-name</entry>
33661 <entry>Conference-name</entry>
33667 <entry>Title</entry>
33673 <entry>Title-series</entry>
33679 <entry>Title-uniform</entry>
33685 <entry>ISBN</entry>
33691 <entry>ISSN</entry>
33697 <entry>Local number</entry>
33703 <entry>Local-classification</entry>
33705 <entry>lcn and callnum</entry>
33709 <entry>Subject</entry>
33711 <entry>su, su-to, su-geo, su-ut</entry>
33715 <entry>Pubdate</entry>
33717 <entry>yr,pubdate</entry>
33721 <entry>Date-of-Acquisition</entry>
33723 <entry>acqdate</entry>
33727 <entry>Language</entry>
33733 <entry>Place-of-publication</entry>
33739 <entry>Abstract</entry>
33745 <entry>Notes</entry>
33751 <entry>Record-type</entry>
33753 <entry>rtype, mc-rtype, mus</entry>
33757 <entry>Author</entry>
33759 <entry>au, aut</entry>
33763 <entry>Subject-person-name</entry>
33765 <entry>su-na</entry>
33769 <entry>Any (keyword)</entry>
33775 <entry>Publisher</entry>
33781 <entry>Content-type</entry>
33783 <entry>ctype</entry>
33787 <entry>Koha-Auth-Number</entry>
33793 <entry>Author-personal-bibliography</entry>
33799 <entry>Author-in-order</entry>
33807 <para>Refer to the Koha Indexing Chart for the MARC21 tags mapped to
33808 each Bib-1 Attribute and index combination.</para>
33810 <section id="search-audexamp">
33811 <title>Audience Examples</title>
33815 <para>aud:a Easy</para>
33819 <para>aud:cc Juvenile</para>
33823 <para>aud:d Young adult</para>
33827 <para>aud:e Adult</para>
33832 <section id="search-contentsexamp">
33833 <title>Contents Examples</title>
33837 <para>fic:1 Fiction</para>
33841 <para>fic:0 Non Fiction</para>
33845 <para>bio:b Biography</para>
33849 <para>mus:j Musical recording</para>
33853 <para>mus:I Non musical record</para>
33859 <section id="searchguide-syntax">
33860 <title>Search Syntax</title>
33862 <para>In the persistent search box, single words generally retrieve
33863 large sets. To narrow a search, you can use multiple words. Koha
33864 automatically uses the 'and' Boolean operator to create a set of
33865 records matching your input. When you want to narrow the search to
33866 an author or a title or a subject or some other specific field or
33867 use a Boolean operator, there isn't an obvious way to accomplish
33868 that specificity. The library user can, of course, go to the
33869 Advanced Search page; however, if you know how to construct a CCL
33870 search, you can achieve more specificity while using the persistent
33871 search box on any page.</para>
33873 <para>There is a specific order to the CCL search syntax. Although
33874 it can be used for simple searches, it is an especially effective
33875 way to perform complex searches, as it affords you a great deal of
33876 control over your search results. To construct a CCL search, first
33877 enter a desired index code, then an equal sign, followed by your
33878 search word(s). Following are examples of simple CCL
33883 <para>ti=principles of accounting</para>
33887 <para>au=brown joseph</para>
33891 <para>su=poetry</para>
33895 <para>su-na=Shakespeare</para>
33899 <para>kw=marlin</para>
33903 <para>You can refine your search by combining search terms with
33904 Boolean operators 'and', 'or', or 'not'. Following are examples of
33905 searches using Boolean operators.</para>
33909 <para>ti=principles of accounting and au=brown joseph</para>
33913 <para>su=poetry not su-na=Shakespeare</para>
33917 <para>kw=communication and su=debate</para>
33921 <para>You can also choose to search for things that start with a
33922 character or series of characters</para>
33926 <para>ti,first-in-subfield=C (will show you all titles that
33927 start with the letter 'C')</para>
33931 <para>Other string location searches can be performed with the
33932 following keywords:</para>
33936 <para>rtrn : right truncation</para>
33940 <para>ltrn : left truncation</para>
33944 <para>lrtrn : left and right truncation</para>
33948 <para>st-date : type date</para>
33952 <para>st-numeric : type number (integer)</para>
33956 <para>ext : exact search on whole subfield (does not work with
33961 <para>phr : search on expression anywhere in the subfield</para>
33965 <para>startswithnt : subfield starts with</para>
33969 <para>Using specific indexes and Boolean operators are not the only
33970 way a search can be refined. You can also refine your search as a
33971 phrase when looking for a title, author, or subject. The syntax for
33972 this search is <emphasis>index,phr=search words</emphasis>.</para>
33974 <para>To illustrate the results of various search types, a search
33975 was done for the words 'supreme court'. The results illustrate that
33976 the search index and the word order make a difference in search
33977 results. Only the results count and the search itself is in these
33978 examples. The search executed will always be between the single
33982 <screeninfo>Sample Search 1</screeninfo>
33986 <imagedata fileref="images/searching/ex1.png"/>
33992 <screeninfo>Sample Search 2</screeninfo>
33996 <imagedata fileref="images/searching/ex2.png"/>
34002 <screeninfo>Sample Search 3</screeninfo>
34006 <imagedata fileref="images/searching/ex3.png"/>
34012 <screeninfo>Sample Search 4</screeninfo>
34016 <imagedata fileref="images/searching/ex4.png"/>
34022 <screeninfo>Sample Search 5</screeninfo>
34026 <imagedata fileref="images/searching/ex5.png"/>
34032 <screeninfo>Sample Search 6</screeninfo>
34036 <imagedata fileref="images/searching/ex6.png"/>
34042 <screeninfo>Sample Search 7</screeninfo>
34046 <imagedata fileref="images/searching/ex7.png"/>
34052 <screeninfo>Sample Search 8</screeninfo>
34056 <imagedata fileref="images/searching/ex8.png"/>
34062 <screeninfo>Sample Search 9</screeninfo>
34066 <imagedata fileref="images/searching/ex9.png"/>
34071 <para>You can also choose to use limiters in your search query. Some
34072 common limiters include dates, languages, record types, and item
34073 types. In the Advance Search, you can either click a box or key in
34074 data to limit your search. You can also apply the same limits with
34075 CCL by using the syntax in the following examples. In all</para>
34077 <para><emphasis>By Date: su=supreme court and
34078 yr,st-numeric=>2000</emphasis></para>
34081 <screeninfo>Sample Search 10</screeninfo>
34085 <imagedata fileref="images/searching/ex10.png"/>
34090 <para>When you limit by date, you can use the '>' (greater than),
34091 '<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
34094 <para><emphasis>By Item Type: su=nursing and
34095 itype:BK</emphasis></para>
34098 <screeninfo>Sample Search 11</screeninfo>
34102 <imagedata fileref="images/searching/ex11.png"/>
34107 <para>Each library will have a different set of item types defined
34108 in their circulation configuration. When you set up item types, you
34109 define a code and a name for each one. The name will appear on the
34110 Advance Search page. The code you assigned is used as a CCL search
34111 limit, formatted as 'itype:x', where 'x' is the assigned code. The
34112 initial set of item types in Koha will usually be edited to reflect
34113 your collections, so your item type limiters may be different than
34114 the initial ones. The initial item type limiters follow.</para>
34118 <para>itype:BKS Books, Booklets, Workbooks</para>
34122 <para>itype:SR Audio Cassettes, CDs</para>
34126 <para>itype:IR Binders</para>
34130 <para>itype:CF CD-ROMs, DVD-ROMs, General Online
34135 <para>itype:VR DVDs, VHS</para>
34139 <para>itype:KT Kit</para>
34143 <para>itype:AR Models</para>
34147 <para>itype:SER Serials</para>
34151 <para><emphasis>By format: su=supreme court not
34152 l-format:sr</emphasis></para>
34155 <screeninfo>Sample Search 12</screeninfo>
34159 <imagedata fileref="images/searching/ex12.png"/>
34164 <para>The format limiters are derived from a combination of LDR, 006
34165 and 007 positions. The formats that are currently defined are the
34170 <para>l-format:ta Regular print</para>
34174 <para>l-format:tb Large print</para>
34178 <para>l-format:fk Braille</para>
34182 <para>l-format:sd CD audio</para>
34186 <para>l-format:ss Cassette recording</para>
34190 <para>l-format:vf VHS tape</para>
34194 <para>l-format:vd DVD video</para>
34198 <para>l-format:co CD software</para>
34202 <para>l-format:cr Website</para>
34206 <para><emphasis>By content type: su=supreme court not
34207 ctype:l</emphasis></para>
34210 <screeninfo>Sample Search 13</screeninfo>
34214 <imagedata fileref="images/searching/ex13.png"/>
34219 <para>The content types are taken from the 008 MARC tag, positions
34222 <para>There are two other limiter types that are not described in
34223 this document. They are: Audience and Content. The only difference
34224 in the syntax of the CCL is the actual limiter. They are reproduced
34225 here just in case you would like to use these limiters.</para>
34230 <section id="kohasearchindexes">
34231 <title>Koha Search Indexes</title>
34233 <para>By default, not all fields are indexed in the Zebra search engine,
34234 but many are. Below are the MARC21 fields that are indexed in
34237 <table cellpadding="4" cellspacing="4" frame="all">
34238 <title>Indexes</title>
34240 <tgroup align="left" cols="2" colsep="1" rowsep="1">
34243 <entry><para>Field</para></entry>
34245 <entry><para>Description</para></entry>
34251 <entry><para>001</para></entry>
34253 <entry><para>Control-number</para></entry>
34257 <entry><para>005</para></entry>
34259 <entry><para>Date/time-last-modified</para></entry>
34263 <entry><para>007</para></entry>
34265 <entry><para>Microform-generation:n:range(data,11,1),
34266 Material-type,ff7-00:w:range(data,0,1),
34267 ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
34268 ff7-01-02:w:range(data,0,2)</para></entry>
34272 <entry><para>008</para></entry>
34274 <entry><para>date-entered-on-file:n:range(data,0,5),
34275 date-entered-on-file:s:range(data,0,5),
34276 pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
34277 pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
34278 pl:w:range(data,15,3), ta:w:range(data,22,1),
34279 ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
34280 lf:w:range(data,33,1), bio:w:range(data,34,1),
34281 ln:n:range(data,35,3), ctype:w:range(data,24,4),
34282 Record-source:w:range(data,39,0)</para></entry>
34286 <entry><para>010</para></entry>
34288 <entry><para>LC-card-number, Identifier-standard</para></entry>
34292 <entry><para>011</para></entry>
34294 <entry><para>LC-card-number, Identifier-standard</para></entry>
34298 <entry><para>015</para></entry>
34300 <entry><para>BNB-card-number, BGF-number, Number-db,
34301 Number-natl-biblio, Identifier-standard</para></entry>
34305 <entry><para>017</para></entry>
34307 <entry><para>Number-legal-deposit,
34308 Identifier-standard</para></entry>
34312 <entry><para>018</para></entry>
34314 <entry><para>Identifier-standard</para></entry>
34318 <entry><para>020$a</para></entry>
34320 <entry><para>ISBN:w, Identifier-standard:w</para></entry>
34324 <entry><para>020</para></entry>
34326 <entry><para>Identifier-standard</para></entry>
34330 <entry><para>022$a</para></entry>
34332 <entry><para>ISSN:w, Identifier-standard:w</para></entry>
34336 <entry><para>022</para></entry>
34338 <entry><para>Identifier-standard</para></entry>
34342 <entry><para>023</para></entry>
34344 <entry><para>Identifier-standard</para></entry>
34348 <entry><para>024$a</para></entry>
34350 <entry><para>Identifier-other</para></entry>
34354 <entry><para>024</para></entry>
34356 <entry><para>Identifier-standard</para></entry>
34360 <entry><para>025</para></entry>
34362 <entry><para>Identifier-standard</para></entry>
34366 <entry><para>027</para></entry>
34368 <entry><para>Report-number, Identifier-standard</para></entry>
34372 <entry><para>028</para></entry>
34374 <entry><para>Number-music-publisher,
34375 Identifier-standard</para></entry>
34379 <entry><para>030</para></entry>
34381 <entry><para>CODEN, Identifier-standard</para></entry>
34385 <entry><para>034</para></entry>
34387 <entry><para>Map-scale</para></entry>
34391 <entry><para>037</para></entry>
34393 <entry><para>Identifier-standard, Stock-number</para></entry>
34397 <entry><para>040</para></entry>
34399 <entry><para>Code-institution, Record-source</para></entry>
34403 <entry><para>041</para></entry>
34405 <entry><para>ln</para></entry>
34409 <entry><para>043</para></entry>
34411 <entry><para>Code-geographic</para></entry>
34415 <entry><para>050$b</para></entry>
34417 <entry><para>LC-call-number:w, LC-call-number:p,
34418 LC-call-number:s</para></entry>
34422 <entry><para>050</para></entry>
34424 <entry><para>LC-call-number:w, LC-call-number:p,
34425 LC-call-number:s</para></entry>
34429 <entry><para>052</para></entry>
34431 <entry><para>Geographic-class</para></entry>
34435 <entry><para>060</para></entry>
34437 <entry><para>NLM-call-number</para></entry>
34441 <entry><para>070</para></entry>
34443 <entry><para>NAL-call-number</para></entry>
34447 <entry><para>080</para></entry>
34449 <entry><para>UDC-classification</para></entry>
34453 <entry><para>082</para></entry>
34455 <entry><para>Dewey-classification:w,
34456 Dewey-classification:s</para></entry>
34460 <entry><para>086</para></entry>
34462 <entry><para>Number-govt-pub</para></entry>
34466 <entry><para>100$9</para></entry>
34468 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
34472 <entry><para>100$a</para></entry>
34474 <entry><para>Author,Author:p, Author:s, Editor,
34475 Author-personal-bibliography, Author-personal-bibliography:p,
34476 Author-personal-bibliography:s</para></entry>
34480 <entry><para>100</para></entry>
34482 <entry><para>Author, Author-title, Author-name-personal, Name,
34483 Name-and-title, Personal-name</para></entry>
34487 <entry><para>110$9</para></entry>
34489 <entry><para>Koha-Auth-Number</para></entry>
34493 <entry><para>110</para></entry>
34495 <entry><para>Author, Author-title, Author-name-corporate, Name,
34496 Name-and-title, Corporate-name</para></entry>
34500 <entry><para>111$9</para></entry>
34502 <entry><para>Koha-Auth-Number</para></entry>
34506 <entry><para>111</para></entry>
34508 <entry><para>Author, Author-title, Author-name-corporate, Name,
34509 Name-and-title, Conference-name</para></entry>
34513 <entry><para>130$n</para></entry>
34515 <entry><para>Thematic-number</para></entry>
34519 <entry><para>130$r</para></entry>
34521 <entry><para>Music-key</para></entry>
34525 <entry><para>130$9</para></entry>
34527 <entry><para>Koha-Auth-Number</para></entry>
34531 <entry><para>130</para></entry>
34533 <entry><para>Title, Title-uniform</para></entry>
34537 <entry><para>210</para></entry>
34539 <entry><para>Title, Title-abbreviated</para></entry>
34543 <entry><para>211</para></entry>
34545 <entry><para>Title, Title-abbreviated</para></entry>
34549 <entry><para>212</para></entry>
34551 <entry><para>Title, Title-other-variant</para></entry>
34555 <entry><para>214</para></entry>
34557 <entry><para>Title, Title-expanded</para></entry>
34561 <entry><para>222</para></entry>
34563 <entry><para>Title, Title-key</para></entry>
34567 <entry><para>240$r</para></entry>
34569 <entry><para>Music-key</para></entry>
34573 <entry><para>240$n</para></entry>
34575 <entry><para>Thematic-number</para></entry>
34579 <entry><para>240</para></entry>
34581 <entry><para>Title:w, Title:p, Title-uniform</para></entry>
34585 <entry><para>243$n</para></entry>
34587 <entry><para>Thematic-number</para></entry>
34591 <entry><para>243$r</para></entry>
34593 <entry><para>Music-key</para></entry>
34597 <entry><para>243</para></entry>
34599 <entry><para>Title:w, Title:p, Title-collective</para></entry>
34603 <entry><para>245$a</para></entry>
34605 <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
34606 Title:w, Title:p, Title:s</para></entry>
34610 <entry><para>245$c</para></entry>
34612 <entry><para>Author, Author-in-order:w, Author-in-order:p,
34613 Author-in-order:s</para></entry>
34617 <entry><para>245$9</para></entry>
34619 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
34623 <entry><para>245</para></entry>
34625 <entry><para>Title:w, Title:p</para></entry>
34629 <entry><para>246</para></entry>
34631 <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
34632 Title-former</para></entry>
34636 <entry><para>247</para></entry>
34638 <entry><para>Title, Title:p, Title-former, Title-other-variant,
34639 Related-periodical</para></entry>
34643 <entry><para>260$a</para></entry>
34645 <entry><para>pl:w, pl:p</para></entry>
34649 <entry><para>260$b</para></entry>
34651 <entry><para>Publisher:w, Publisher:p</para></entry>
34655 <entry><para>260$c</para></entry>
34657 <entry><para>copydate, copydate:s</para></entry>
34661 <entry><para>260</para></entry>
34663 <entry><para>pl</para></entry>
34667 <entry><para>300</para></entry>
34669 <entry><para>Extent:w, Extent:p</para></entry>
34673 <entry><para>400$a</para></entry>
34675 <entry><para>Name-and-title</para></entry>
34679 <entry><para>400$t</para></entry>
34681 <entry><para>Author-title, Name-and-title, Title,
34682 Title-series</para></entry>
34686 <entry><para>400$9</para></entry>
34688 <entry><para>Koha-Auth-Number</para></entry>
34692 <entry><para>400</para></entry>
34694 <entry><para>Author, Author-name-personal, Name,
34695 Personal-name</para></entry>
34699 <entry><para>410</para></entry>
34701 <entry><para>Author, Corporate-name</para></entry>
34705 <entry><para>410$a</para></entry>
34707 <entry><para>Name-and-title</para></entry>
34711 <entry><para>410$t</para></entry>
34713 <entry><para>Author-title, Title, Title-series</para></entry>
34717 <entry><para>410$9</para></entry>
34719 <entry><para>Koha-Auth-Number</para></entry>
34723 <entry><para>410</para></entry>
34725 <entry><para>Author-name-corporate, Name</para></entry>
34729 <entry><para>411</para></entry>
34731 <entry><para>Author, Conference-name</para></entry>
34735 <entry><para>411$a</para></entry>
34737 <entry><para>Name-and-title</para></entry>
34741 <entry><para>411$t</para></entry>
34743 <entry><para>Author-title, Title-series</para></entry>
34747 <entry><para>411</para></entry>
34749 <entry><para>Author-name-corporate, Name</para></entry>
34753 <entry><para>440$a</para></entry>
34755 <entry><para>Title-series:w, Title-series:p</para></entry>
34759 <entry><para>440$9</para></entry>
34761 <entry><para>Koha-Auth-Number</para></entry>
34765 <entry><para>440</para></entry>
34767 <entry><para>Title-series:w, Title-series:p, Title,
34768 Title-series</para></entry>
34772 <entry><para>490$a</para></entry>
34774 <entry><para>Title-series:w, Title-series:p</para></entry>
34778 <entry><para>490</para></entry>
34780 <entry><para>Title, Title-series</para></entry>
34784 <entry><para>490$9</para></entry>
34786 <entry><para>Koha-Auth-Number</para></entry>
34790 <entry><para>500</para></entry>
34792 <entry><para>Note:w, Note:p</para></entry>
34796 <entry><para>502</para></entry>
34798 <entry><para>Material-type</para></entry>
34802 <entry><para>505$r</para></entry>
34804 <entry><para>Author</para></entry>
34808 <entry><para>505$t</para></entry>
34810 <entry><para>Title</para></entry>
34814 <entry><para>505</para></entry>
34816 <entry><para>Note:w, Note:p</para></entry>
34820 <entry><para>510</para></entry>
34822 <entry><para>Indexed-by</para></entry>
34826 <entry><para>520</para></entry>
34828 <entry><para>Abstract:w, Abstract:p</para></entry>
34832 <entry><para>521$a</para></entry>
34834 <entry><para>lex:n</para></entry>
34838 <entry><para>526$c</para></entry>
34840 <entry><para>arl, arl:n</para></entry>
34844 <entry><para>526$d</para></entry>
34846 <entry><para>arp, arp:n</para></entry>
34850 <entry><para>590</para></entry>
34852 <entry><para>Note:w, Note:p</para></entry>
34856 <entry><para>600$a</para></entry>
34858 <entry><para>Name-and-title, Name, Personal-name,
34859 Subject-name-personal, Subject</para></entry>
34863 <entry><para>600$t</para></entry>
34865 <entry><para>Name-and-title, Title, Subject</para></entry>
34869 <entry><para>600$9</para></entry>
34871 <entry><para>Koha-Auth-Number</para></entry>
34875 <entry><para>600</para></entry>
34877 <entry><para>Name, Personal-name, Subject-name-personal,
34878 Subject</para></entry>
34882 <entry><para>610$a</para></entry>
34884 <entry><para>Name-and-title</para></entry>
34888 <entry><para>610$t</para></entry>
34890 <entry><para>Name-and-title, Title</para></entry>
34894 <entry><para>610$9</para></entry>
34896 <entry><para>Koha-Auth-Number</para></entry>
34900 <entry><para>610</para></entry>
34902 <entry><para>Name, Subject, Corporate-name</para></entry>
34906 <entry><para>611</para></entry>
34908 <entry><para>Conference-name</para></entry>
34912 <entry><para>611$a</para></entry>
34914 <entry><para>Name-and-title</para></entry>
34918 <entry><para>611$t</para></entry>
34920 <entry><para>Name-and-title, Title</para></entry>
34924 <entry><para>611$9</para></entry>
34926 <entry><para>Koha-Auth-Number</para></entry>
34930 <entry><para>611</para></entry>
34932 <entry><para>Name, Subject</para></entry>
34936 <entry><para>630$n</para></entry>
34938 <entry><para>Thematic-number</para></entry>
34942 <entry><para>630$r</para></entry>
34944 <entry><para>Music-key</para></entry>
34948 <entry><para>630$9</para></entry>
34950 <entry><para>Koha-Auth-Number</para></entry>
34954 <entry><para>630</para></entry>
34956 <entry><para>Subject</para></entry>
34960 <entry><para>650$9</para></entry>
34962 <entry><para>Koha-Auth-Number</para></entry>
34966 <entry><para>650</para></entry>
34968 <entry><para>Subject, Subject:p</para></entry>
34972 <entry><para>651$9</para></entry>
34974 <entry><para>Koha-Auth-Number</para></entry>
34978 <entry><para>651</para></entry>
34980 <entry><para>Name-geographic, Subject,Subject:p</para></entry>
34984 <entry><para>652$9</para></entry>
34986 <entry><para>Koha-Auth-Number</para></entry>
34990 <entry><para>653$9</para></entry>
34992 <entry><para>Koha-Auth-Number</para></entry>
34996 <entry><para>653</para></entry>
34998 <entry><para>Subject, Subject:p</para></entry>
35002 <entry><para>654$9</para></entry>
35004 <entry><para>Koha-Auth-Number</para></entry>
35008 <entry><para>654</para></entry>
35010 <entry><para>Subject</para></entry>
35014 <entry><para>655$9</para></entry>
35016 <entry><para>Koha-Auth-Number</para></entry>
35020 <entry><para>655</para></entry>
35022 <entry><para>Subject</para></entry>
35026 <entry><para>656$9</para></entry>
35028 <entry><para>Koha-Auth-Number</para></entry>
35032 <entry><para>656</para></entry>
35034 <entry><para>Subject</para></entry>
35038 <entry><para>657$9</para></entry>
35040 <entry><para>Koha-Auth-Number</para></entry>
35044 <entry><para>657</para></entry>
35046 <entry><para>Subject</para></entry>
35050 <entry><para>690$9</para></entry>
35052 <entry><para>Koha-Auth-Number</para></entry>
35056 <entry><para>690</para></entry>
35058 <entry><para>Subject, Subject:p</para></entry>
35062 <entry><para>700$9</para></entry>
35064 <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
35068 <entry><para>700$a</para></entry>
35070 <entry><para>Author, Author:p</para></entry>
35074 <entry><para>700$n</para></entry>
35076 <entry><para>Thematic-number</para></entry>
35080 <entry><para>700$r</para></entry>
35082 <entry><para>Music-key</para></entry>
35086 <entry><para>700$t</para></entry>
35088 <entry><para>Author-title, Name-and-title, Title,
35089 Title-uniform</para></entry>
35093 <entry><para>700</para></entry>
35095 <entry><para>Author, Author-name-corporate,
35096 Author-name-personal, Name, Editor, Personal-name</para></entry>
35100 <entry><para>710</para></entry>
35102 <entry><para>Author, Corporate-name</para></entry>
35106 <entry><para>710$t</para></entry>
35108 <entry><para>Author-title, Name-and-title, Title,
35109 Title-uniform</para></entry>
35113 <entry><para>710$a</para></entry>
35115 <entry><para>Name-and-title</para></entry>
35119 <entry><para>710$9</para></entry>
35121 <entry><para>Koha-Auth-Number</para></entry>
35125 <entry><para>710</para></entry>
35127 <entry><para>Author, Name</para></entry>
35131 <entry><para>711$a</para></entry>
35133 <entry><para>Name-and-title</para></entry>
35137 <entry><para>711$t</para></entry>
35139 <entry><para>Author-title, Title, Title-uniform</para></entry>
35143 <entry><para>711$9</para></entry>
35145 <entry><para>Koha-Auth-Number</para></entry>
35149 <entry><para>711</para></entry>
35151 <entry><para>Author-name-corporate, Name,
35152 Conference-name</para></entry>
35156 <entry><para>730$n</para></entry>
35158 <entry><para>Thematic-number</para></entry>
35162 <entry><para>730$r</para></entry>
35164 <entry><para>Music-key</para></entry>
35168 <entry><para>730$9</para></entry>
35170 <entry><para>Koha-Auth-Number</para></entry>
35174 <entry><para>730</para></entry>
35176 <entry><para>Title, Title-uniform</para></entry>
35180 <entry><para>740</para></entry>
35182 <entry><para>Title, Title-other-variant</para></entry>
35186 <entry><para>773$t</para></entry>
35188 <entry><para>Host-item</para></entry>
35192 <entry><para>780$t</para></entry>
35194 <entry><para>Title</para></entry>
35198 <entry><para>780</para></entry>
35200 <entry><para>Title, Title-former,
35201 Related-periodical</para></entry>
35205 <entry><para>785</para></entry>
35207 <entry><para>Related-periodical</para></entry>
35211 <entry><para>800$a</para></entry>
35213 <entry><para>Name-and-title</para></entry>
35217 <entry><para>800$t</para></entry>
35219 <entry><para>Author-title, Name-and-title, Title,
35220 Title-series</para></entry>
35224 <entry><para>800$9</para></entry>
35226 <entry><para>Koha-Auth-Number</para></entry>
35230 <entry><para>800</para></entry>
35232 <entry><para>Author, Author-name-personal, Name,
35233 Personal-name</para></entry>
35237 <entry><para>810$a</para></entry>
35239 <entry><para>Name-and-title</para></entry>
35243 <entry><para>810$t</para></entry>
35245 <entry><para>Author-title, Name-and-title, Title,
35246 Title-series</para></entry>
35250 <entry><para>810$9</para></entry>
35252 <entry><para>Koha-Auth-Number</para></entry>
35256 <entry><para>810</para></entry>
35258 <entry><para>Author, Corporate-name, Author-name-corporate,
35259 Name</para></entry>
35263 <entry><para>811$a</para></entry>
35265 <entry><para>Name-and-title</para></entry>
35269 <entry><para>811$9</para></entry>
35271 <entry><para>Koha-Auth-Number</para></entry>
35275 <entry><para>811$t</para></entry>
35277 <entry><para>Author-title, Name-and-title, Title,
35278 Title-series</para></entry>
35282 <entry><para>811</para></entry>
35284 <entry><para>Author, Author-name-corporate, Name,
35285 Conference-name</para></entry>
35289 <entry><para>830$9</para></entry>
35291 <entry><para>Koha-Auth-Number</para></entry>
35295 <entry><para>830</para></entry>
35297 <entry><para>Title, Title-series</para></entry>
35301 <entry><para>840</para></entry>
35303 <entry><para>Title, Title-series</para></entry>
35307 <entry><para>999$c</para></entry>
35309 <entry><para>Local-Number:n, Local-Number:w,
35310 Local-Number:s</para></entry>
35314 <entry><para>999$d</para></entry>
35316 <entry><para>biblioitemnumber:n, biblioitemnumber:w,
35317 biblioitemnumber:s</para></entry>
35321 <entry><para>942$0</para></entry>
35323 <entry><para>totalissues:n, totalissues:s</para></entry>
35327 <entry><para>942$2</para></entry>
35329 <entry><para>cn-bib-source</para></entry>
35333 <entry><para>942$6</para></entry>
35335 <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
35339 <entry><para>942$c</para></entry>
35341 <entry><para>itemtype:w</para></entry>
35345 <entry><para>942$n</para></entry>
35347 <entry><para>Suppress:w, Suppress:n</para></entry>
35351 <entry><para>942$h</para></entry>
35353 <entry><para>cn-class</para></entry>
35357 <entry><para>942$i</para></entry>
35359 <entry><para>cn-item</para></entry>
35363 <entry><para>942$k</para></entry>
35365 <entry><para>cn-prefix</para></entry>
35369 <entry><para>942$m</para></entry>
35371 <entry><para>cn-suffix</para></entry>
35375 <entry><para>952$0</para></entry>
35377 <entry><para>withdrawn:n, withdrawn:w</para></entry>
35381 <entry><para>952$1</para></entry>
35383 <entry><para>lost, lost:n</para></entry>
35387 <entry><para>952$2</para></entry>
35389 <entry><para>classification-source</para></entry>
35393 <entry><para>952$3</para></entry>
35395 <entry><para>materials-specified</para></entry>
35399 <entry><para>952$4</para></entry>
35401 <entry><para>damaged:n, damaged:w</para></entry>
35405 <entry><para>952$5</para></entry>
35407 <entry><para>restricted:n, restricted:w</para></entry>
35411 <entry><para>952$6</para></entry>
35413 <entry><para>cn-sort:n, cn-sort:s</para></entry>
35417 <entry><para>952$7</para></entry>
35419 <entry><para>notforloan:n, notforloan:w</para></entry>
35423 <entry><para>952$8</para></entry>
35425 <entry><para>ccode</para></entry>
35429 <entry><para>952$9</para></entry>
35431 <entry><para>itemnumber:n, itemnumber:s</para></entry>
35435 <entry><para>952$a</para></entry>
35437 <entry><para>homebranch</para></entry>
35441 <entry><para>952$b</para></entry>
35443 <entry><para>holdingbranch</para></entry>
35447 <entry><para>952$c</para></entry>
35449 <entry><para>location</para></entry>
35453 <entry><para>952$d</para></entry>
35455 <entry><para>Date-of-acquisition, Date-of-acquisition:d,
35456 Date-of-acquisition:s</para></entry>
35460 <entry><para>952$e</para></entry>
35462 <entry><para>acqsource</para></entry>
35466 <entry><para>952$f</para></entry>
35468 <entry><para>coded-location-qualifier</para></entry>
35472 <entry><para>952$g</para></entry>
35474 <entry><para>price</para></entry>
35478 <entry><para>952$j</para></entry>
35480 <entry><para>stack:n, stack:w</para></entry>
35484 <entry><para>952$l</para></entry>
35486 <entry><para>issues:n, issues:w, issues:s</para></entry>
35490 <entry><para>952$m</para></entry>
35492 <entry><para>renewals:n, renewals:w</para></entry>
35496 <entry><para>952$n</para></entry>
35498 <entry><para>reserves:n, reserves:w</para></entry>
35502 <entry><para>952$o</para></entry>
35504 <entry><para>Local-classification:w, Local-classification:p,
35505 Local-classification:s</para></entry>
35509 <entry><para>952$p</para></entry>
35511 <entry><para>barcode, barcode:n</para></entry>
35515 <entry><para>952$q</para></entry>
35517 <entry><para>onloan:n, onloan:w</para></entry>
35521 <entry><para>952$r</para></entry>
35523 <entry><para>datelastseen</para></entry>
35527 <entry><para>952$s</para></entry>
35529 <entry><para>datelastborrowed</para></entry>
35533 <entry><para>952$t</para></entry>
35535 <entry><para>copynumber</para></entry>
35539 <entry><para>952$u</para></entry>
35541 <entry><para>uri:u</para></entry>
35545 <entry><para>952$v</para></entry>
35547 <entry><para>replacementprice</para></entry>
35551 <entry><para>952$w</para></entry>
35553 <entry><para>replacementpricedate</para></entry>
35557 <entry><para>952$y</para></entry>
35559 <entry><para>itype:w</para></entry>
35563 <entry><para>952$z</para></entry>
35565 <entry><para>Note:w, Note:p</para></entry>
35573 <chapter id="aboutkoha">
35574 <title>About Koha</title>
35576 <para>The 'About Koha' area will give you important server information as
35577 well as general information about Koha.</para>
35581 <para><emphasis>Get there:</emphasis> More > About Koha</para>
35585 <section id="aboutserver">
35586 <title>Server Information</title>
35588 <para>Under the 'Server Information' tab you will find information about
35589 the Koha version and the machine you have installed Koha on. This
35590 information is very important for debugging problems. When reporting
35591 issues to your support provider or to the various other support avenues
35592 (mailing lists, chat room, etc), it's always good to give the
35593 information from this screen.</para>
35596 <screeninfo>Server Information on Koha</screeninfo>
35600 <imagedata fileref="images/about/aboutserver.png"/>
35606 <section id="aboutserverperl">
35607 <title>Perl Modules</title>
35609 <para>In order to take advantage of all of the functionalities of Koha,
35610 you will need to keep your Perl modules up to date. The 'Perl Modules'
35611 tab will show you all of the modules required by Koha, the version you
35612 have installed and whether you need to upgrade certain modules.</para>
35615 <screeninfo>Perl Modules</screeninfo>
35619 <imagedata fileref="images/about/aboutperlmodules.png"/>
35624 <para>Items listed in bold are required by Koha, items highlighed in red
35625 are missing completely and items highlighted in yellow simply need to be
35630 <chapter id="implementation">
35631 <title>Implementation Checklist</title>
35633 <para>The following guide will walk you through the areas of Koha you need
35634 to look at in order to prepare to start using the system.</para>
35636 <section id="imp-migration">
35637 <title>Data Migration</title>
35639 <para>Before you can start using Koha you'll need to have some data.
35640 This can be done by entering it all by hand, but most people already
35641 have their data in electronic format of some sort and just need to
35642 reformat it a bit for importing into Koha.</para>
35646 <para>Create a list of libraries and enter their info and codes into
35647 <link linkend="libsgroups">Libraries & Groups</link></para>
35651 <para>Define your list of <link linkend="itemtypeadmin">Item
35652 Types</link></para>
35656 <para>Define you patron categories and enter the categories and
35657 their codes into <link linkend="patcats">Patron
35658 Categories</link></para>
35662 <para>Enter any additional patron information fields you use in your
35663 library in the <link linkend="patronattributetypes">Patron
35664 Attributes</link></para>
35668 <para>Requires that you first set the <link
35669 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
35670 system preference if you have custom fields</para>
35676 <para>Define all of your <link linkend="authorizedvalues">Authorized
35677 Values</link></para>
35681 <para><link linkend="ccode">Collection codes</link></para>
35685 <para><link linkend="shelvelocvals">Shelving
35686 locations</link></para>
35690 <para>Item statuses (<link linkend="lost">lost</link>, <link
35691 linkend="notforloan">not for loan</link>, <link
35692 linkend="restricted">use restrictions</link>)</para>
35696 <para>Plus any others that are needed in your library</para>
35702 <para>Optionally define <link linkend="citytowns">City/Postal
35703 Code</link> combos and <link linkend="roadtypes">Road Types</link>
35704 for patron entry</para>
35708 <para><link linkend="kohamarcmapping">Map your bibliographic
35709 data</link> from your legacy system to Koha fields and migrate
35710 (remembering to use the collection, shelving, item type and library
35711 codes you entered in the above setting areas)</para>
35715 <para><link linkend="patronimport">Map your patron data</link> from
35716 your legacy system to the Koha fields and migrate (remembering to
35717 use the patron and library codes you defined above)</para>
35721 <para>Test your migrated data to be sure that everything is as you
35722 expect it to be, some things to test include:</para>
35726 <para>Check some of your titles with diacritics and make sure
35727 that they migrated properly.</para>
35731 <para>Check titles in a series and make sure that series
35732 information migrated properly.</para>
35736 <para>Make sure that your patrons have their contact information
35737 in the right fields.</para>
35741 <para>If your serials data was migrated search for these records
35742 in the catalog and confirm that they look right.</para>
35746 <para>If your serials data was migrated search for these records
35747 in the serials module and confirm that they look right.</para>
35751 <para>Check marc records to verify a variety of items are
35752 cataloged correctly</para>
35756 <para>Check cataloging process to see if all necessary fields
35757 are available</para>
35761 <para>If fines are migrated, check to see that they are applied
35766 <para>If holds are migrated, check to see they are accurate in
35767 catalog and patron record</para>
35774 <section id="impadmin">
35775 <title>Admin Configuration</title>
35777 <para>Most of these preferences won't need to be changed to use your
35778 Koha system, but there are a few that you might want to
35783 <para>If your library uses CAS Authentication, you'll want to set
35784 the various <link linkend="casauthentication">CAS system
35785 preferences</link></para>
35789 <para>Administration System Preferences</para>
35794 linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
35795 This is the email address that will be used by the system in
35796 'from' lines and to send errors to if there is no email set for
35801 <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
35802 Decide if you want to show item type icons in the staff client
35807 <para><link linkend="delimiter">delimiter</link> : This value
35808 will be put in between fields when exporting data from
35813 <para><link linkend="virtualshelves">virtualshelves</link> :
35814 Decide if you want the staff and/or patrons to use lists in
35819 <para><link linkend="insecure">insecure</link> : If your system
35820 is behind a local firewall, you can set it to no require log in
35821 for the staff client</para>
35825 <para><link linkend="AutoLocation">AutoLocation</link> : Require
35826 staff to log in to the staff client from a specific IP
35832 linkend="IndependantBranches">IndependantBranches</link> :
35833 Prevent librarians from editing content that belongs to other
35840 <para>Go through the <link linkend="logs">Log System
35841 Preferences</link> and decide which actions you want to keep track
35842 of in the logs</para>
35847 <section id="implocal">
35848 <title>Localization Configuration</title>
35850 <para>Koha is used worldwide and so you need to make sure you set your
35851 localization preferences so that options throughout Koha appear properly
35852 for your location/language.</para>
35856 <para>Localization/Internationalization System Preferences</para>
35860 <para><link linkend="dateformat">dateformat</link> : Decide how
35861 dates are displayed throughout Koha</para>
35866 linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
35867 Decide if patrons can choose what language the OPAC appears
35872 <para><link linkend="opaclanguages">opaclanguages</link> :
35873 Decide which languages the patrons can choose from</para>
35879 <para><link linkend="languagepref">language</link> : Decide
35880 which languages appear in the staff client</para>
35885 linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
35886 Define your first day of the week</para>
35893 <section id="impcirc">
35894 <title>Circulation Configuration</title>
35896 <para>Before you start circulating your collection you'll need to set up
35897 your rules and preferences for circulation.</para>
35901 <para>Define you <link linkend="circfinerules">Circulation/Fine
35902 rules</link></para>
35906 <para>Enter the <link linkend="calholidays">days your library is
35907 closed</link> for fines and due date calculations</para>
35911 <para>Circulation System Preferences</para>
35915 <para><link linkend="CircControl">CircControl</link> : Define
35916 whether circ rules are based on item's location, patron's
35917 location or transaction location</para>
35921 <para><link linkend="useDaysMode">useDaysMode</link> : Define
35922 how due dates are calculated</para>
35926 <para><link linkend="finesCalendar">finesCalendar</link> :
35927 Define how fines are calculated (for every late date or only for
35928 days the library is open)</para>
35932 <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> :
35933 Decide if staff are allowed to override due dates on
35939 linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
35940 Decide if items are sent back to the owning branch when checked
35946 linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
35947 : Decide how items checked out today display on the patron
35953 linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
35954 : Decide how items checked out prior to today display on the
35955 patron record</para>
35959 <para><link linkend="noissuescharge">noissuescharge</link> :
35960 Define the maximum amount a patron can owe before checkouts are
35966 linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
35967 if patrons need to return items before their accounts
35972 <para><link linkend="AllowOnShelfHolds">AllowOnShelfHolds</link>
35973 : Decide if patrons can place holds on items that are marked as
35974 being available</para>
35979 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
35980 : Decide if you want the staff to be able to override the
35981 setting for the above at checkout</para>
35988 linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
35989 : Decide if patrons can place holds on items that are marked as
35995 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
35996 : Decide if you want the staff to be able to override the
35997 setting for the above at checkout</para>
36003 <para><link linkend="maxreserves">maxreserves</link> : Decide
36004 how many items a patron can have on hold at once</para>
36009 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
36010 : Decide if you want the staff to be able to override the
36011 setting for the above at checkout</para>
36017 <para><link linkend="maxoutstanding">maxoutstanding</link> :
36018 Define the maximum amount a patron can owe before holds are
36024 linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
36025 : Decide if you want the staff to be able to override the
36026 setting for the above at checkout</para>
36033 linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
36034 Define the number of days before a hold expires</para>
36038 <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
36039 : Decide if you want to use the built in web-based self-checkout
36045 linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
36046 Decide if the self-checkout system requires login</para>
36051 linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
36052 : Decide if you want patron images to show on the self
36053 checkout screen</para>
36060 linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
36061 : Decide if you want the staff to be able to checkout items
36062 marked as ‘not for loan'</para>
36067 linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
36068 : Decide if you want staff to override the limit put on
36073 <para><link linkend="AllowFineOverride">AllowFineOverride</link>
36074 : Decide if you want staff to be able to override fine
36079 <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
36080 : Decide what date renewals are based on</para>
36084 <para><link linkend="finesMode">finesMode</link> : Switch to
36085 ‘Calculate and Charge' before go live if you charge
36090 <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
36091 If you want to receive a copy of every overdue notice sent out,
36092 enter your email address here</para>
36097 linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
36098 : Decide if you want an email every time a hold is placed</para>
36103 linkend="ReservesControlBranch">ReservesControlBranch</link> :
36104 Decide which branch's hold rules are considered first</para>
36108 <para><link linkend="soundon">soundon</link> : Decide if you
36109 want to have sounds on for circulation actions</para>
36114 linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
36115 : If you have a large amount of overdues, you might want to turn
36116 this preference on so as to allow you to filter before results
36122 linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
36123 : If you have a lot of staff members sharing one circ computer
36124 you might want to enable this so that staff can clear the screen
36125 in between checkouts to protect patron's privacy</para>
36130 linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
36131 Decide how you want Koha to react if you scan in a blank barcode
36132 on the checkout screen</para>
36137 linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
36138 and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
36139 : Decide if you want patrons and/or staff to be able to suspend
36145 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
36146 : If you allow holds to be suspended decide if you want them
36147 to automatically resume on the date entered by the staff
36148 and/or patron</para>
36156 <para>Customize your <link linkend="notices">Notices &
36157 Slips</link></para>
36161 <para>Define your <link linkend="noticetriggers">Overdue Notice
36162 Triggers</link></para>
36166 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36170 <para>Populate <link linkend="buildholdscron">your holds
36171 queue</link> (every 1-4 hours)</para>
36175 <para>Decide <link linkend="expiredholdscron">when holds
36176 expire</link> (daily)</para>
36180 <para><link linkend="finescronjob">Calculate fines due</link>
36185 <para>Fines on hourly loans will calculate when you check
36186 the items in</para>
36192 <para><link linkend="longoverduecron">Mark long overdue items as
36193 lost</link> (daily)</para>
36197 <para>Decide when the system <link linkend="msgqueuecron">sends
36198 out messages</link> (1-4 hours)</para>
36202 <para>Decide when the system <link
36203 linkend="overduenoticecron">queues overdue notices</link>
36208 <para>Set up <link linkend="printholdcron">hold notices that
36209 didn't send for printing</link> (daily after overdues and
36210 message queue)</para>
36214 <para>Decide when the system <link
36215 linkend="advnoticecron">queues the advanced notice of items
36216 due</link> (daily)</para>
36220 <para>Find holds that need to be <link
36221 linkend="unsuspendholdcron">resumed and remove suspension</link>
36229 <section id="imppratrons">
36230 <title>Patron Configuration</title>
36232 <para>You have already imported patron data from your old system, but
36233 there are plenty of options available to you regarding patrons and their
36238 <para>Enter your <link linkend="addstaffpatron">staff members as
36239 patrons</link></para>
36243 <para>Define <link linkend="patronpermissions">staff members
36244 access permissions</link></para>
36250 <para>Patron System Preferences</para>
36254 <para><link linkend="AddPatronLists">AddPatronLists</link> :
36255 Decide how patron categories appear when creating a new
36260 <para><link linkend="autoMemberNum">autoMemberNum</link> :
36261 Decide if the patrons barcodes are auto-generated or if you
36262 enter them yourself</para>
36266 <para><link linkend="MaxFine">MaxFine</link> : Determine the
36267 maximum amount that people can owe in fines</para>
36272 linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
36273 : Decide when to warn staff that the patron account is about to
36279 linkend="intranetreadinghistory">intranetreadinghistory</link> :
36280 Decide if the staff can see the patron's reading/checkout
36286 linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
36287 List fields that you want to appear as mandatory on the patron
36288 add/edit form</para>
36292 <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
36293 Add or change the titles for your patrons</para>
36298 linkend="borrowerRelationship">borrowerRelationship</link> : Add
36299 or change borrower relationships (child to adult and
36300 professional to organization)</para>
36305 linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
36306 : Determine if the patrons get an email confirming the creation
36307 of their account</para>
36312 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
36313 : Decide if patrons can choose from a series of notices (other
36314 than overdues)</para>
36318 <para><link linkend="patronimages">patronimages</link> : Decide
36319 if you want to save patron images in your system</para>
36324 linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
36325 : Decide if you want to enable custom patron fields</para>
36329 <para><link linkend="minPasswordLength">minPasswordLength</link>
36330 : Enter the minimum number of characters you want passwords to
36336 linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
36337 Decide what fields your library doesn't need to see on the
36338 patron entry form</para>
36345 <section id="impcatalog">
36346 <title>Cataloging Configuration</title>
36348 <para>Before you start cataloging in Koha you'll want to set up your
36349 preferences and other rules.</para>
36353 <para>Define your cataloging templates aka <link
36354 linkend="marcbibframeworks">MARC Bibliographic
36355 Frameworks</link></para>
36359 <para>Run the <link linkend="marcbibframeworkstest">MARC
36360 Bibliographic Framework Test</link> to be sure your changes are
36367 <para>Define any <link linkend="authorizedvalues">authorized
36368 values</link> you might want to use in cataloging</para>
36372 <para>Set up <link linkend="classificationsources">custom
36373 classification sources</link> (if you use something other than the
36378 <para>Set up <link linkend="recordmatchingrules">MARC matching
36379 rules</link> for importing records from mrc files or z39.50</para>
36383 <para>Set up <link linkend="keywordmapping">Koha to Keyword
36384 mapping</link> for deciding how to display marc fields to the screen
36385 (still in beta - only one field)</para>
36389 <para>Set up the <link linkend="z3950admin">z39.50 targets</link>
36390 you want to search for cataloging (and acquisitions)</para>
36394 <para>Cataloging System Preferences</para>
36398 <para><link linkend="URLLinkText">URLLinkText</link> : Enter
36399 text to display when 856 fields do not have pre-defined
36404 <para><link linkend="hide_marc">hide_marc</link> : If you are
36405 unfamiliar with MARC you can have the MARC fields number
36410 <para><link linkend="LabelMARCView">LabelMARCView</link> :
36411 Choose how you want duplicate fields to appear on the
36417 linkend="DefaultClassificationSource">DefaultClassificationSource</link>
36418 : Choose which classification source is the default in your
36424 linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
36425 if you need labels to appear on your MARC editor</para>
36429 <para><link linkend="marcflavour">marcflavour</link> : Choose
36430 your MARC format</para>
36434 <para><link linkend="itemcallnumber">itemcallnumber</link> :
36435 Enter which field and subfields to look into for the call
36440 <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
36441 your MARC Organizational Code (not the same as your OCLC
36446 <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
36447 Koha generates item barcodes for you</para>
36451 <para><link linkend="OpacSuppression">OpacSuppression</link> :
36452 Decide if you want to hide items marked as suppressed from the
36453 OPAC search results</para>
36459 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36463 <para>Decide when the system <link linkend="checkurlcron">checks
36464 URLs in catalog records</link> to see if they are still
36472 <section id="impauthorities">
36473 <title>Authorities Configuration</title>
36475 <para>Koha has the ability to keep track of your authority records and
36476 how they're linked to your bibliographic records. Before using
36477 authorities you should configure several preferences.</para>
36481 <para>Set <link linkend="authoritiesadmin">Authority
36482 Frameworks</link> aka templates</para>
36486 <para>Authority System Preferences</para>
36491 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
36492 Decide if Koha creates authorities when cataloging</para>
36496 <para><link linkend="dontmerge">dontmerge</link> : Decide if
36497 updates to authorities trigger updates to the bibliographic
36498 records that link to them</para>
36503 linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
36504 Decide when authorities are created</para>
36508 <para><link linkend="LinkerModule">LinkerModule</link> : Decide
36509 which match the authority linker should use</para>
36513 <para><link linkend="LinkerOptions">LinkerOptions</link> :
36514 Decide if you want authority linking to be broader or more
36520 linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
36521 Decide if you want to enable authority linking while
36528 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36532 <para>Choose when the system looks for authorities updates to
36533 <link linkend="mergeauthcron">merge changes into bibliographic
36534 records</link></para>
36541 <section id="impsearching">
36542 <title>Searching Configuration</title>
36544 <para>There are several system preferences related to searching, it is
36545 not always recommended to make too many changes to these preferences
36546 since they are set to get you the most relevant results. If you would
36547 like to change the default way that Koha handles searching, view the
36548 <link linkend="searchingprefs">Searching system preferences</link>
36553 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36557 <para>Decide how often your <link
36558 linkend="rebuildsearchcron">system rebuilds the search
36559 index</link> (4-10 min)</para>
36565 <para>Searching System Preferences</para>
36570 linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> :
36571 Decide which authorized value fields you want patrons and staff
36572 to be able to limit their advanced searches by</para>
36577 linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
36578 : Decide how you want Koha to handle subject searches in the
36584 linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
36585 : Decide how you want Koha to handle subject searches in the
36591 linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
36592 : Decide how you want Koha to handle subject searches in the
36599 <para><link linkend="displayFacetCount">displayFacetCount</link>
36600 : Decide whether to show facet counts on search results</para>
36607 <section id="impopac">
36608 <title>OPAC Configuration</title>
36610 <para>There are a lot of ways you can customize your OPAC in
36615 <para>Decide how you want your OPAC to look & what content you
36616 want on the main page</para>
36620 <para>Create a library branded stylesheet using CSS</para>
36625 <para>Do not edit the default CSS files, instead create a new
36626 one, that way the system can always fall back on the original
36634 <para>Create a custom XSLT stylesheet to change the way search
36635 results and bib records appear in the OPAC</para>
36639 <para>OPAC System preferences</para>
36643 <para><link linkend="opacuserlogin">opacuserlogin</link> :
36644 Decide if you want to allow patrons to login to the OPAC to
36645 access customized functionality (searching will be allowed
36646 without logging in)</para>
36650 <para><link linkend="RequestOnOpac">RequestOnOpac</link> :
36651 Decide if patrons can place holds via the OPAC</para>
36655 <para><link linkend="OPACItemHolds">OPACItemHolds</link> :
36656 Decide if patrons can place holds on specific items (instead
36657 of just the next available item)</para>
36662 linkend="OpacPasswordChange">OpacPasswordChange</link> :
36663 Decide if patrons can change their password (don't allow
36664 this if you're using LDAP)</para>
36669 linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> :
36670 Decide if patrons can renew their checked out items via the
36676 linkend="opacreadinghistory">opacreadinghistory</link> :
36677 Decide if patrons can view their reading/checkout history
36678 via the OPAC</para>
36682 <para><link linkend="reviewson">reviewson</link> : Decide if
36683 you want to allow patrons to comment on bib records via the
36688 <para><link linkend="OpacStarRatings">OpacStarRatings</link>
36689 : Decide if patrons can leave star ratings</para>
36693 <para><link linkend="virtualshelves">virtualshelves</link> :
36694 Decide if you want patrons to be able to create Lists</para>
36699 linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
36700 : If patrons can create lists then decide if they are
36701 allowed to create public lists</para>
36705 <para><link linkend="suggestionspref">suggestion</link> :
36706 Decide if you want patrons to be able to submit purchase
36712 linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
36713 : Decide if you want patrons to be able to see purchase
36714 suggestions made by other patrons</para>
36720 <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
36721 patrons can save items into their cart</para>
36725 <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
36726 Decide if you want non logged in users to be able to make
36727 purchase suggestions</para>
36732 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> :
36733 Decide if you want to use the XSLT stylesheets on the OPAC
36734 search results</para>
36739 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> :
36740 Decide if you want to use the XSLT stylesheets on the bib
36741 records in the OPAC</para>
36745 <para><link linkend="LibraryName">LibraryName</link> : Enter
36746 your library name for display in the <title> tag and on
36747 the top of the OPAC</para>
36751 <para><link linkend="opacsmallimage">opacsmallimage</link> :
36752 Choose a logo to replace the Koha logo</para>
36756 <para><link linkend="opaccredits">opaccredits</link> : Enter
36757 HTML to appear at the bottom of every page in the OPAC</para>
36761 <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
36762 : Enter HTML that will appear in the center of the main OPAC
36767 <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
36768 will appear to the left on the main OPAC page</para>
36772 <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
36773 HTML that will appear below OpacNav</para>
36777 <para><link linkend="opacheader">opacheader</link> : Enter the
36778 HTML that will appear above the search box on the OPAC</para>
36783 linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
36784 the HTML that will appear when no results are found</para>
36789 linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
36790 the HTML that will appear below the facets on your search
36795 <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
36796 : Enter the HTML that will appear in the far right of the
36797 circulation summary in the OPAC</para>
36801 <para>Customize your stylesheets:</para>
36805 <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
36806 any additional fields you want to define styles for</para>
36811 linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
36812 Point to a CSS file on your Koha server</para>
36816 <para><link linkend="opacstylesheet">opacstylesheet</link> :
36817 If you have a custom CSS enter the link to that file</para>
36822 linkend="opaccolorstylesheet">opaccolorstylesheet</link> :
36823 Point to a CSS file on your Koha server</para>
36830 linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
36831 Decide if you want search terms to be highlighted on the search
36836 <para><link linkend="hidelostitems">hidelostitems</link> :
36837 Decide if you want to show patrons items you have marked as
36842 <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
36843 : Decide what view is the default for bib records on the
36848 <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> :
36849 Decide if you want to enable the shelf browse
36850 functionality</para>
36855 linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
36856 Decide if URLs clicked in the OPAC are opened in a new
36862 linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
36863 you have a multi-branch system decide if you want patrons to
36864 search their library first</para>
36868 <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
36869 Decide if you want patrons to be able to search your authority
36874 <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if
36875 you want patrons to browse your authority file</para>
36880 linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
36881 Choose which libraries you want patrons to be able to re-run
36882 their search in</para>
36887 linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
36888 : If you're a multi-branch system you can add a pull down to the
36889 search bar for patrons to search which library to search</para>
36894 linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
36895 : Decide if you want the system to keep a search history</para>
36901 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
36905 <para>If you have the <link
36906 linkend="OpacBrowser">OpacBrowser</link> preference set decide
36907 <link linkend="authbrowsercron">when you want the contents to
36908 rebuild</link></para>
36912 <para>If you have <link linkend="customrss">custom RSS
36913 feeds</link>, decide when you want the <link
36914 linkend="customrssfeedcron">feed to be populated</link></para>
36920 <section id="editableopac">
36921 <title>Editable OPAC Regions</title>
36923 <para>Using the OPAC system preferences you can customize various
36924 regions, the following graphics will define what preferences update
36925 each regions.</para>
36928 <screeninfo>OPAC Editable Regions</screeninfo>
36932 <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
36937 <para>An example of a way to customize the page is included as
36941 <screeninfo>Customized Koha OPAC</screeninfo>
36945 <imagedata fileref="images/appendix-opac/opaccustomregions-customized.jpg"/>
36952 <section id="impenhanced">
36953 <title>Enhanced Content Configuration</title>
36955 <para>Koha allows you to pull in content from outside sources to enhance
36956 your bib records. All of this content can be toggled on and off using
36957 the enhanced content system preferences.</para>
36961 <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
36965 <para>If you would like to have your OPAC and/or staff client
36966 show an 'Editions' tab on the bib record, you want to enable one
36967 or the other FRBR preferences and then either one or both of the
36968 ISBN services (XISBN and ThingISBN).</para>
36974 <para><link linkend="amazonprefs">Amazon</link> : This service is
36975 free and just requires that you visit <ulink
36976 url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
36981 <para>Using the Amazon preferences you can choose to show
36982 different types of content from Amazon. Before choosing which
36983 types of content you would like to display you will need to
36984 enable Amazon content for the staff client and/or the
36992 linkend="Babelthequeprefs">Babelthèque</link></para>
36996 <para>This is a pay service. Contact Babelthèque to learn
36997 how to enable this content in the OPAC.</para>
37003 <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
37007 <para>This is a pay service from Baker & Taylor. Contact
37008 Baker & Taylor for the information to enter into these
37009 preferences.</para>
37015 <para><link linkend="googleprefs">Google</link></para>
37019 <para>This service is free and does not require registration,
37020 simply enable GoogleJackets and you're set to go.</para>
37026 <para><link linkend="librarythingprefs">LibraryThing</link></para>
37030 <para>With the exception of ThingISBN, you will need to contact
37031 LibraryThing for the information to enter into these
37036 <para>Enabling ThingISBN will help to populate the editions tab
37037 on the bib record display if you have enabled FRBR.</para>
37043 <para><link linkend="novelistselect">Novelist</link></para>
37047 <para>This is a pay service from Ebsco. Contact Ebsco for the
37048 information to enter into these preferences</para>
37054 <para><link linkend="oclcprefs">OCLC</link></para>
37058 <para>XISBN is used to populate the editions tab on the bib
37059 record display if you have enabled FRBR. This service is free
37060 for up to 999 queries a day.</para>
37066 <para><link linkend="Syndeticsprefs">Syndetics</link></para>
37070 <para>This is a pay service from Syndetics to add content for
37071 your bib records. Contact Syndetics for the information to enter
37072 into these preferences.</para>
37078 <para><link linkend="taggingprefs">Tagging</link></para>
37082 <para>Choose whether or not you want to allow patrons to add
37083 tags to records in Koha.</para>
37090 <section id="impacq">
37091 <title>Acquisitions Configuration</title>
37093 <para>When using acquisitions in Koha you first need to define some
37098 <para>Set up your <link linkend="budgetplanning">funds &
37099 budgets</link></para>
37103 <para>Choose your <link linkend="currexchangeadmin">default
37104 currency</link> and enter others if you order from multiple
37109 <para>Enter in your <link linkend="acqvendors">vendor
37110 information</link></para>
37114 <para>Create an <link linkend="marcbibframeworks">Framework with the
37115 code ACQ</link> (if you're going to enter item records at the time
37116 of ordering or receiving)</para>
37120 <para>Acquisitions System preferences</para>
37124 <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
37125 Decide if an item record is created during acquisition</para>
37129 <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
37130 Decide how you want monetary amounts to display</para>
37134 <para><link linkend="gist">gist</link> : Enter your sales tax
37135 (if you are billed for tax)</para>
37139 <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
37140 Decide what format you want your print orders to use</para>
37147 <section id="impserials">
37148 <title>Serials Configuration</title>
37150 <para>When you use serials there are a few options you can set before
37155 <para>Serials System Preferences</para>
37160 linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
37161 : Decide if you want renewing serials to add a suggestion for
37162 easy purchasing</para>
37166 <para><link linkend="RoutingSerials">RoutingSerials</link> :
37167 Decide if you want to route serials around your library</para>
37172 linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
37173 Decide if holds are placed on serials when there is a routing
37174 list in place</para>
37180 <para>Cataloging System Preferences</para>
37185 linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
37186 : Decide how many of the most recent issues to display in the
37187 staff client</para>
37192 linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
37193 : Decide how many of the most recent issues to display in the
37199 linkend="SubscriptionHistory">SubscriptionHistory</link> :
37200 Decide how you want the subscription information to display in
37208 <section id="impgolive">
37209 <title>Planning for Go-Live</title>
37211 <para>Once you have all of your settings ready, you need to prepare for
37212 making your system live:</para>
37216 <para>Decide if you need training by an outside service or if your
37217 staff can do the training themselves.</para>
37221 <para>Make sure that there is time for your staff to play with your
37222 test system and get comfortable with it</para>
37226 <para>If this is a migration, work with your previous company to
37227 extract data right before you go live</para>
37231 <para>Come up with URLs for your new Koha OPAC & Staff
37236 <para>Make sure that if you're hosting your own system you have a
37243 <chapter id="sopac">
37244 <title>SOPAC2 Installation</title>
37246 <section id="sopac2">
37249 <firstname>Jean-André</firstname>
37251 <surname>Santoni</surname>
37254 <orgname>BibLibre</orgname>
37258 <pubdate>August 2009</pubdate>
37260 <othercredit role="translator">
37261 <firstname>Nicole C.</firstname>
37263 <surname>Engard</surname>
37265 <contrib>Translation</contrib>
37269 <title>SOPAC2 Introduction</title>
37272 <para>The following documentation was translated using Google
37273 Translate from French to English and may have some language
37278 <section id="sopacintro">
37279 <title>Introduction</title>
37281 <para>This is an installation guide and the connector SOPAC2 Koha. It
37282 has been tested on Debian Lenny and Ubuntu Jaunty, with 6.12 and Koha
37283 Drupal 3.0.x It does not cover the installation of Koha and Drupal, but
37284 SOPAC, its dependencies and the connector.</para>
37287 <section id="sopacinstall">
37288 <title>Installation of Locum and Insurge</title>
37290 <para>Locum and Insurge are the two libraries used primarily by SOPAC.
37291 They serve as a layer of abstraction to the data. Insurge manages the
37292 social aspect (tags, reviews, ratings), while Locum manages the
37293 connection to the ILS via the connector. Both libraries use a different
37294 database from that of Drupal.</para>
37296 <section id="sopacdepend">
37297 <title>Dependencies</title>
37299 <para>There are no packages for Debian MDB2 yet, you can install it
37302 <programlisting># apt-get install php-pear
37303 # pear install MDB2
37304 # pear install MDB2#mysql</programlisting>
37307 <section id="sopacdownload">
37308 <title>Download</title>
37310 <para>Download the Locum and Insurge libraries from SVN:</para>
37312 <programlisting># cd /usr/local/lib
37313 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
37314 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
37317 <section id="sopaccreatedb">
37318 <title>Creation of the Database</title>
37320 <programlisting>$ mysql -u root
37321 mysql> create database scas;
37322 mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
37323 mysql> flush privileges;
37324 mysql> exit</programlisting>
37327 <section id="sopacdsn">
37328 <title>Sync DSN</title>
37330 <para>This file will provide the connection information to a DB
37333 <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
37335 <para>It should contain:</para>
37337 <programlisting><?php
37338 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
37341 <section id="sopacinstallinsurge">
37342 <title>Installation of Insurge</title>
37344 <para>If you customize the name of the database, consider editing the
37347 <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
37349 <para>Import Insurge:</para>
37351 <programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
37353 <para>Configure Insurge:</para>
37355 <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
37357 <para>The variables in insurge.ini are empty. The default values are
37358 too long and cause MySQL errors.</para>
37360 <para>Here is a sample of insurge.ini</para>
37362 <programlisting>; This is the Locum configuration file
37363 ; General configuration options for your installation of Insurge.
37365 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
37366 ; This is where you configure your repository membership information.
37368 ; parent_server is the server name of the repository parent server you have been
37370 ; group_id = The group ID you have been given by your repository admin.
37371 ; These configuration points are OPTIONAL and are only necessary if you are
37372 ; participating in a repository relationship.
37376 group_key = ""</programlisting>
37379 <section id="sopacinstallocum">
37380 <title>Installation of Locum</title>
37382 <para>The same procedure applies to Locum</para>
37384 <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
37385 # mysql < /usr/local/lib/locum/sql/scas_locum.sql
37386 # nano /usr/local/lib/locum/sql/locum_init.sql
37387 # mysql < /usr/local/lib/locum/sql/locum_init.sql
37388 # nano /usr/local/lib/locum/config/locum.ini
37389 # mkdir /usr/local/var
37390 # mkdir /usr/local/var/log</programlisting>
37392 <para>Configure the DSN:</para>
37394 <programlisting>[locum_config]
37395 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
37397 <para>And the coordinates of your Koha installation:</para>
37399 <programlisting>[ils_config]
37401 ils_version = "30x"
37402 ils_server = "localhost"
37403 ils_harvest_port = "80"</programlisting>
37405 <para>The rest depends on your configuration of Koha.</para>
37409 <section id="sopackoha">
37410 <title>Installation of Koha Connector</title>
37412 <para>Enter the connector Koha from SVN:</para>
37414 <programlisting># cd /usr/local/lib/locum/connectors/
37415 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
37418 <section id="sopacharvest">
37419 <title>Harvest Records</title>
37421 <para>Now that the connector is in place, we will be able to launch
37422 harvest.php, a tool that will reap Locum DB Koha and fill the
37425 <para>Start by configuring harvest.php:</para>
37427 <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
37429 <para>Here are the variables you must change:</para>
37431 <programlisting>$first_record = 1;
37432 $last_record = 30;</programlisting>
37434 <para>These are the minimum and maximum biblionumbers from your Koha
37437 <para>Then start the harvest:</para>
37439 <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
37440 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
37443 <section id="sopacphinx">
37444 <title>Installation of Sphinx</title>
37446 <para>Sphinx is the indexer for the database used by Locum and
37449 <section id="sphinxdepend">
37450 <title>Dependencies</title>
37452 <para>There is no Debian package for Sphinx so you'll have to compile
37453 the source directly:</para>
37455 <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
37458 <section id="sphinxdownload">
37459 <title>Download and Compile</title>
37461 <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
37462 $ tar zxvf sphinx-0.9.8.tar.gz
37464 $ ./configure --prefix=/usr/local/sphinx
37467 # mkdir /usr/local/sphinx
37468 # mkdir /usr/local/sphinx/lib
37469 # cp api/sphinxapi.php /usr/local/sphinx/lib/
37470 $ rm -R sphinx-0.9.8*</programlisting>
37473 <section id="sphinxuser">
37474 <title>Creation of User and Group</title>
37476 <para>Creating a Sphinx user and change the owner:</para>
37478 <programlisting># adduser sphinx
37480 # usermod -G sphinx sphinx
37481 # mkdir /usr/local/sphinx/var/run
37482 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
37485 <section id="demonsphinx">
37486 <title>The demon Sphinx</title>
37488 <para>Download:</para>
37490 <programlisting># cd /etc/init.d
37491 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
37492 # chmod +x /etc/init.d/sphinx</programlisting>
37494 <para>Add Sphinx in the service at boot:</para>
37496 <programlisting># update-rc.d sphinx defaults</programlisting>
37499 <section id="sphinxconfig">
37500 <title>Configuration</title>
37502 <para>Copy the configuration file supplied with the source of Sphinx
37503 before the change:</para>
37505 <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
37506 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
37507 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
37508 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
37510 <para>And if you personalize the name of the BDD:</para>
37512 <programlisting># sed 's/scas/Ma_BDD/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
37515 <section id="sphinxindexing">
37516 <title>Indexing documents</title>
37518 <para>Indexing is necessary if you want to use the search features of
37521 <para>You must first complete the Insurge table index</para>
37523 <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
37524 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
37526 <para>Then start indexing Sphinx</para>
37528 <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
37530 <para>Finally, we must start the demon:</para>
37532 <programlisting># /etc/init.d/sphinx start</programlisting>
37534 <para>When the demon is already en route, you can update the index
37537 <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
37541 <section id="installsopac">
37542 <title>Installation of SOPAC2</title>
37544 <para>Now to the SOPAC software itself:</para>
37546 <section id="downloadsopac">
37547 <title>Download</title>
37549 <para>Download from SVN:</para>
37551 <programlisting>$ cd /chemin/vers/drupal/sites/all/
37554 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
37557 <section id="sopacinstallation">
37558 <title>Installation</title>
37560 <para>Going in the administration of Drupal to activate the module.
37561 Enable also the dependencies:</para>
37565 <para>Profile</para>
37569 <para>PHP Filter</para>
37577 <para>The Drupal menu should now list these entries.</para>
37580 <section id="configsopac">
37581 <title>Configuration</title>
37583 <para>Then go into the settings of SOPAC.</para>
37587 <para>Configure the paths to the Locum and Insurge
37592 <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
37593 with content like:</para>
37597 <programlisting><?php
37598 print sopac_search_form('both');
37599 print theme('pages_catalog');</programlisting>
37603 <para>Check the Input Format "PHP Code"</para>
37607 <para>Check Move to front page</para>
37611 <para>In URL path settings, set the SOPAC URL prefix you have
37616 <para>Go to the root of Drupal, a search form will appear.</para>
37618 <para>Thinking to empty the cache of Drupal when something does not
37621 <para>Drupal offers a few blocks, not configured by default. Must
37622 specify on which page they should appear.</para>
37627 <chapter id="cronjobsch">
37628 <title>Cron Jobs</title>
37632 <section id="cronjobs">
37633 <title>Cron Jobs</title>
37635 <para>The locations below assume a dev install which puts the crons in
37636 misc/, if you have a standard install you may want to look in bin/ for
37637 these files if you cannot find them in misc/</para>
37639 <section id="searchcron">
37640 <title>Search</title>
37644 <section id="rebuildsearchcron">
37645 <title>Rebuild Index</title>
37647 <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
37649 <para>Does: Updates Zebra indexes with recently changed data.</para>
37651 <para>Required by: Zebra</para>
37653 <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
37654 depending on performance needs</para>
37658 <section id="circcron">
37659 <title>Circulation</title>
37661 <section id="buildholdscron">
37662 <title>Holds Queue</title>
37664 <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
37666 <para>Does: Updates holds queue report</para>
37668 <para>Required by: <link linkend="holdsqueue">Holds Queue
37669 Report</link></para>
37671 <para>Frequency suggestion: every 1-4 hours</para>
37673 <para>Description:</para>
37677 <para>A script that should be run periodically if your library
37678 system allows borrowers to place on-shelf holds. This script
37679 decides which library should be responsible for fulfilling a
37680 given hold request.</para>
37682 <para>It's behavior is controlled by the system preferences
37683 <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
37685 linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
37687 <para>If you do not want all of your libraries to participate in
37688 the on-shelf holds fulfillment process, you should list the the
37689 libraries that *do* participate in the process here by inputting
37690 all the participating library's branchcodes, separated by commas
37691 ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
37693 <para>By default, the holds queue will be generated such that
37694 the system will first attempt to hold fulfillment using items
37695 already at the pickup library if possible. If there are no items
37696 available at the pickup library to fill a hold,
37697 build_holds_queue.pl will then use the list of libraries defined
37698 in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
37699 disabled ( which it is by default ), the script will assign
37700 fulfillment requests in the order the branches are placed in the
37701 StaticHoldsQueueWeight system preference.</para>
37703 <para>For example, if your system has three libraries, of
37704 varying sizes ( small, medium and large ) and you want the
37705 burden of holds fulfillment to be on larger libraries before
37706 smaller libraries, you would want StaticHoldsQueueWeight to look
37707 something like "LRG,MED,SML".</para>
37709 <para>If you want the burden of holds fulfillment to be spread
37710 out equally throughout your library system, simply enable
37711 RandomizeHoldsQueueWeight. When this system preference is
37712 enabled, the order in which libraries will be requested to
37713 fulfill an on-shelf hold will be randomized each time the list
37714 is regenerated.</para>
37716 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
37717 this time. Doing so will cause the build_holds_queue script to
37718 ignore RandomizeHoldsQueueWeight, causing the script to request
37719 hold fulfillment not randomly, but by alphabetical order.</para>
37723 <section id="buildholdscronperl">
37724 <title>Perl Documentation</title>
37727 role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
37729 <para>my $biblionumber_aref =
37730 GetBibsWithPendingHoldRequests();</para>
37732 <para>Return an arrayref of the biblionumbers of all bibs that
37733 have one or more unfilled hold requests.</para>
37736 role="bold">GetPendingHoldRequestsForBib</emphasis></para>
37738 <para>my $requests =
37739 GetPendingHoldRequestsForBib($biblionumber);</para>
37741 <para>Returns an arrayref of hashrefs to pending, unfilled hold
37744 <para>the bib identified by $biblionumber. The following keys are
37745 present in each hashref:</para>
37749 <para>biblionumber</para>
37753 <para>borrowernumber</para>
37757 <para>itemnumber</para>
37761 <para>priority</para>
37765 <para>branchcode</para>
37769 <para>reservedate</para>
37773 <para>reservenotes</para>
37777 <para>borrowerbranch</para>
37781 <para>The arrayref is sorted in order of increasing
37785 role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
37787 <para>my $available_items =</para>
37789 <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
37791 <para>Returns an arrayref of items available to fill hold requests
37792 for the bib identified by $biblionumber. An item is available to
37795 <para>request if and only if:</para>
37799 <para>it is not on loan</para>
37803 <para>it is not withdrawn</para>
37807 <para>it is not marked notforloan</para>
37811 <para>it is not currently in transit</para>
37815 <para>it is not lost</para>
37819 <para>it is not sitting on the hold shelf</para>
37824 role="bold">MapItemsToHoldRequests</emphasis></para>
37826 <para>MapItemsToHoldRequests($hold_requests,
37827 $available_items);</para>
37830 role="bold">CreatePickListFromItemMap</emphasis></para>
37832 <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
37835 role="bold">_get_branches_to_pull_from</emphasis></para>
37837 <para>Query system preferences to get ordered list of branches to
37838 use to fill hold requests.</para>
37842 <section id="expiredholdscron">
37843 <title>Expired Holds</title>
37846 misc/cronjobs/holds/cancel_expired_holds.pl</para>
37848 <para>Does: By default, this cron job will only automatically cancel
37849 holds where the user has set an expiration date. If the library is
37851 linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
37853 linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
37854 preferences then this script will also cancel holds that have been
37855 sitting on the hold shelf for too long and will (if the library
37856 does) charge the patron for not picking up the hold.</para>
37858 <para>Frequency suggestion: daily</para>
37861 <section id="unsuspendholdcron">
37862 <title>Unsuspend Holds</title>
37865 misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
37867 <para>Does: This script checks to find holds that should no longer
37868 be suspended and removes the suspension if the <link
37869 linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
37870 preference is set to 'allow'. This puts the patron back in to the
37871 queue where they were when the hold was suspended.</para>
37873 <para>Frequency suggestion: daily</para>
37876 <section id="finescronjob">
37877 <title>Fines</title>
37879 <para>Script path: misc/cronjobs/fines.pl</para>
37881 <para>Required by: <link linkend="finesMode">finesMode</link> system
37884 <para>Frequency suggestion: nightly</para>
37887 <section id="longoverduecron">
37888 <title>Long Overdues</title>
37890 <para>Script path: misc/cronjobs/longoverdue.pl</para>
37892 <para>Does: allows one to specify delays for changing items to
37893 different lost statuses, and optionally charge for them.</para>
37895 <para>Frequency suggestion: nightly</para>
37897 <section id="longoverduecronperl">
37898 <title>Perl Documentation</title>
37900 <para><emphasis role="bold">NAME</emphasis></para>
37902 <para>longoverdue.pl cron script to set lost statuses on overdue
37903 materials. Execute without options for help.</para>
37908 <section id="noticescron">
37909 <title>Notices</title>
37913 <section id="msgqueuecron">
37914 <title>Message Queue</title>
37916 <para>Script path: misc/cronjobs/process_message_queue.pl</para>
37918 <para>Does: processes the message queue to send emails and SMS
37919 messages to users. sends outgoing emails to patrons.</para>
37921 <para>Frequency suggestion: 1-4 hours</para>
37924 <section id="advnoticecron">
37925 <title>Advanced Notice</title>
37927 <para>Script path: misc/cronjobs/advance_notices.pl</para>
37929 <para>Does: prepares "pre-due" notices and "item due" notices for
37930 patrons who request them prepares notices for patrons for items just
37931 due or coming due soon. requires <link
37932 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
37935 <para>Frequency suggestion: nightly</para>
37938 <para>This script does not actually send the notices. It queues
37939 them in the <link linkend="msgqueuecron">message queue</link> for
37943 <section id="advnoticecronperl">
37944 <title>Perl Documentation</title>
37946 <para><emphasis role="bold">NAME</emphasis></para>
37948 <para>advance_notices.pl - cron script to put item due reminders
37949 into message queue</para>
37951 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
37953 <para>./advance_notices.pl -c</para>
37955 <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
37957 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
37959 <para>This script prepares pre-due and item due reminders to be
37960 sent to patrons. It queues them in the message queue, which is
37961 processed by the process_message_queue.pl cronjob. The type and
37962 timing of the messages can be configured by the patrons in their
37963 "My Alerts" tab in the OPAC.</para>
37965 <para><emphasis role="bold">METHODS</emphasis></para>
37967 <para>parse_letter</para>
37971 <section id="overduenoticecron">
37972 <title>Overdue Notice</title>
37974 <para>Script path: misc/cronjobs/overdue_notices.pl</para>
37976 <para>Does: prepares messages to alert patrons of overdue messages
37977 (both via email and print)</para>
37979 <para>Frequency suggestion: nightly</para>
37982 <para>This script does not actually send the notices. It queues
37983 them in the <link linkend="msgqueuecron">message queue</link> for
37984 later or generates the HTML for later printing</para>
37987 <section id="overduenoticecronperl">
37988 <title>Perl Documentation</title>
37990 <para><emphasis role="bold">NAME</emphasis></para>
37992 <para>overdue_notices.pl - prepare messages to be sent to patrons
37993 for overdue items</para>
37995 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
37997 <para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
37998 -library <branchcode>...] [ -max <number of days> ] [
37999 -csv [ <filename> ] ] [-itemscontent <field list>
38002 <para>Options:</para>
38004 <para>-help brief help message</para>
38006 <para>-man full documentation</para>
38008 <para>-n No email will be sent</para>
38010 <para>-max <days> maximum days overdue to deal with</para>
38012 <para>-library <branchname> only deal with overdues from
38013 this library (repeatable : several libraries can be given)</para>
38015 <para>-csv <filename> populate CSV file</para>
38017 <para>-html <filename> Output html to file</para>
38019 <para>-itemscontent <list of fields> item information in
38022 <para>-borcat <categorycode> category code that must be
38025 <para>-borcatout <categorycode> category code that must be
38028 <para><emphasis role="bold">OPTIONS</emphasis></para>
38030 <para>-help Print a brief help message and exits.</para>
38032 <para>-man Prints the manual page and exits.</para>
38034 <para>-v Verbose. Without this flag set, only fatal errors are
38037 <para>-n Do not send any email. Overdue notices that would have
38038 been sent to the patrons or to the admin are printed to standard
38039 out. CSV data (if the -csv flag is set) is written to standard out
38040 or to any csv filename given.</para>
38042 <para>-max Items older than max days are assumed to be handled
38043 somewhere else, probably the longoverdues.pl script. They are
38044 therefore ignored by this program. No notices are sent for them,
38045 and they are not added to any CSV files. Defaults to 90 to match
38046 longoverdues.pl.</para>
38048 <para>-library</para>
38050 <para>select overdues for one specific library. Use the value in
38051 the branches.branchcode table. This option can be repeated in
38052 order to select overdues for a group of libraries.</para>
38054 <para>-csv Produces CSV data. if -n (no mail) flag is set, then
38055 this CSV data is sent to standard out or to a filename if
38056 provided. Otherwise, only overdues that could not be emailed are
38057 sent in CSV format to the admin.</para>
38059 <para>-itemscontent</para>
38061 <para>comma separated list of fields that get substituted into
38062 templates in places of the <<items.content>>
38063 placeholder. This defaults to
38064 issuedate,title,barcode,author</para>
38066 <para>Other possible values come from fields in the biblios,
38067 items, and issues tables.</para>
38069 <para>-borcat Repetable field, that permit to select only few of
38070 patrons categories.</para>
38072 <para>-borcatout</para>
38074 <para>Repetable field, permis to exclude some patrons
38077 <para>-t | --triggered</para>
38079 <para>This option causes a notice to be generated if and only if
38080 an item is overdue by the number of days defined in a notice
38083 <para>By default, a notice is sent each time the script runs,
38084 which is suitable for less frequent run cron script, but requires
38085 syncing notice triggers with the cron schedule to ensure proper
38086 behavior. Add the --triggered option for daily cron, at the risk
38087 of no notice being generated if the cron fails to run on
38090 <para>-list-all</para>
38092 <para>Default items.content lists only those items that fall in
38093 the range of the currently processing notice. Choose list-all to
38094 include all overdue items in the list (limited by -max
38097 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
38099 <para>This script is designed to alert patrons and administrators
38100 of overdue items.</para>
38102 <para>Configuration</para>
38104 <para>This script pays attention to the overdue notice
38105 configuration performed in the "Overdue notice/status triggers"
38106 section of the "Tools" area of the staff interface to Koha. There,
38107 you can choose which letter templates are sent out after a
38108 configurable number of days to patrons of each library. More
38109 information about the use of this section of Koha is available in
38110 the Koha manual.</para>
38112 <para>The templates used to craft the emails are defined in the
38113 "Tools: Notices" section of the staff interface to Koha.</para>
38115 <para>Outgoing emails</para>
38117 <para>Typically, messages are prepared for each patron with
38118 overdue items. Messages for whom there is no email address on file
38119 are collected and sent as attachments in a single email to each
38120 library administrator, or if that is not set, then to the email
38121 address in the "KohaAdminEmailAddress" system preference.</para>
38123 <para>These emails are staged in the outgoing message queue, as
38124 are messages produced by other features of Koha. This message
38125 queue must be processed regularly by the
38126 misc/cronjobs/process_message_queue.pl program.</para>
38128 <para>In the event that the "-n" flag is passed to this program,
38129 no emails are sent. Instead, messages are sent on standard output
38130 from this program. They may be redirected to a file if
38133 <para>Templates</para>
38135 <para>Templates can contain variables enclosed in double angle
38136 brackets like <<this>>. Those variables will be
38137 replaced with values specific to the overdue items or relevant
38138 patron. Available variables are:</para>
38140 <para><<bib>></para>
38142 <para>the name of the library</para>
38144 <para><<items.content>></para>
38146 <para>one line for each item, each line containing a tab separated
38147 list of title, author, barcode, issuedate</para>
38149 <para><<borrowers.*>></para>
38151 <para>any field from the borrowers table</para>
38153 <para><<branches.*>></para>
38155 <para>any field from the branches table</para>
38157 <para>CSV output</para>
38159 <para>The "-csv" command line option lets you specify a file to
38160 which overdues data should be output in CSV format.</para>
38162 <para>With the "-n" flag set, data about all overdues is written
38163 to the file. Without that flag, only information about overdues
38164 that were unable to be sent directly to the patrons will be
38165 written. In other words, this CSV file replaces the data that is
38166 typically sent to the administrator email address.</para>
38168 <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
38170 <para>"overdue_notices.pl" - In this most basic usage, with no
38171 command line arguments, all libraries are processed individually,
38172 and notices are prepared for all patrons with overdue items for
38173 whom we have email addresses. Messages for those patrons for whom
38174 we have no email address are sent in a single attachment to the
38175 library administrator's email address, or to the address in the
38176 KohaAdminEmailAddress system preference.</para>
38178 <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
38179 email and populates /tmp/overdues.csv with information about all
38180 overdue items.</para>
38182 <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
38183 of overdues in the last 2 weeks for the MAIN library.</para>
38185 <para><emphasis role="bold">SEE ALSO</emphasis></para>
38187 <para>The misc/cronjobs/advance_notices.pl program allows you to
38188 send messages to patrons in advance of their items becoming due,
38189 or to alert them of items that have just become due.</para>
38191 <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
38193 <para>These methods are internal to the operation of
38194 overdue_notices.pl.</para>
38196 <para>parse_letter</para>
38198 <para>parses the letter template, replacing the placeholders with
38199 data specific to this patron, biblio, or item</para>
38201 <para>named parameters:</para>
38203 <para>letter - required hashref</para>
38205 <para>borrowernumber - required integer</para>
38207 <para>substitute - optional hashref of other key/value pairs that
38208 should be substituted in the letter content</para>
38210 <para>returns the "letter" hashref, with the content updated to
38211 reflect the substituted keys and values.</para>
38213 <para>prepare_letter_for_printing</para>
38215 <para>returns a string of text appropriate for printing in the
38216 event that an overdue notice will not be sent to the patron's
38217 email address. Depending on the desired output format, this may be
38218 a CSV string, or a human-readable representation of the
38221 <para>required parameters:</para>
38223 <para>letter</para>
38225 <para>borrowernumber</para>
38227 <para>optional parameters:</para>
38229 <para>outputformat</para>
38233 <section id="printholdcron">
38234 <title>Print Hold Notices</title>
38236 <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
38238 <para>Does: looks through the message queue for hold notices that
38239 didn't go through because the patron didn't have an email address
38240 and generates a print notice</para>
38242 <para>Frequency suggestion: nightly</para>
38245 <section id="talkingtechcrons">
38246 <title>Talking Tech</title>
38248 <para>To learn more about setting up this third party product view
38249 the <link linkend="talkingtechappendix">Talking Tech
38250 Appendix</link>.</para>
38252 <section id="talkingtechsendcron">
38253 <title>Sending Notices File</title>
38256 misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
38258 <para>Does: Script to generate Spec C outbound notifications file
38259 for Talking Tech i-tiva phone notification system.</para>
38261 <para>Required by: <link
38262 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
38264 <para>Frequency suggestion: nightly</para>
38266 <section id="talkingsendcronperl">
38267 <title>Perl Documentation</title>
38269 <para><emphasis role="bold">USAGE</emphasis></para>
38271 <para>TalkingTech_itiva_outbound.pl</para>
38273 <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
38274 6 --output=/tmp/talkingtech/outbound.csv</para>
38276 <para>TalkingTech_itiva_outbound.pl --type=RESERVE
38277 --type=PREOVERDUE --lang=FR</para>
38279 <para>Script to generate Spec C outbound notifications file for
38280 Talking Tech i-tiva phone notification system.</para>
38282 <para>--help -h</para>
38284 <para>Prints this help</para>
38286 <para>-v Provide verbose log information.</para>
38288 <para>--output -o</para>
38290 <para>Destination for outbound notifications file (CSV format).
38291 If no value is specified, output is dumped to screen.</para>
38293 <para>--lang</para>
38295 <para>Sets the language for all outbound messages. Currently
38296 supported values are EN, FR and ES. If no value is specified, EN
38297 will be used by default.</para>
38299 <para>--type</para>
38301 <para>REQUIRED. Sets which messaging types are to be used. Can
38302 be given multiple times, to specify multiple types in a single
38303 output file. Currently supported values are RESERVE, PREOVERDUE
38304 and OVERDUE. If no value is given, this script will not produce
38305 any outbound notifications.</para>
38307 <para>--waiting-hold-day -w</para>
38309 <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
38310 has been set to waiting on which to call. Use switch as many
38311 times as desired. For example, passing "-w 0 -w 2 -w 6" will
38312 cause calls to be placed on the day the hold was set to waiting,
38313 2 days after the waiting date, and 6 days after. See example
38314 above. If this switch is not used with --type=RESERVE, calls
38315 will be placed every day until the waiting reserve is picked up
38316 or canceled.</para>
38318 <para>--library-code --code -c</para>
38320 <para>OPTIONAL The code of the source library of the message.
38321 The library code is used to group notices together for
38322 consortium purposes and apply library specific settings, such as
38323 prompts, to those notices. This field can be blank if all
38324 messages are from a single library.</para>
38328 <section id="talkingtechreceivecron">
38329 <title>Receiving Notices File</title>
38332 misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
38334 <para>Does: Script to process received Results files for Talking
38335 Tech i-tiva phone notification system.</para>
38337 <para>Required by: <link
38338 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
38340 <para>Frequency suggestion: nightly</para>
38342 <section id="talkingreceivecronperl">
38343 <title>Perl Documentation</title>
38345 <para><emphasis role="bold">USAGE</emphasis></para>
38347 <para>TalkingTech_itiva_inbound.pl</para>
38349 <para>TalkingTech_itiva_inbound.pl -v
38350 --input=/tmp/talkingtech/results.csv</para>
38352 <para>Script to process received Results files for Talking Tech
38353 i-tiva phone notification system.</para>
38355 <para>--help -h</para>
38357 <para>Prints this help</para>
38359 <para>-v Provide verbose log information.</para>
38361 <para>--input -i</para>
38363 <para>REQUIRED. Path to incoming results file.</para>
38369 <section id="proccartcron">
38370 <title>In Processing/Book Cart</title>
38372 <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
38374 <para>Does: Updates all items with a location of CART to the item's
38375 permanent location.</para>
38377 <para>Required by: <link
38378 linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
38380 linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
38381 & <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
38382 system preferences</para>
38384 <para>Frequency suggestion: hourly</para>
38386 <section id="proccartcronperl">
38387 <title>Perl Documentation</title>
38389 <para><emphasis role="bold">NAME</emphasis></para>
38391 <para>cart_to_shelf.pl cron script to set items with location of
38392 CART to original shelving location after X hours. Execute without
38393 options for help.</para>
38397 <section id="catalogcron">
38398 <title>Catalog</title>
38402 <section id="checkurlcron">
38403 <title>Check URLs</title>
38405 <para>Script path: misc/cronjobs/check-url.pl</para>
38407 <para>Does: checks URLs in 856$u field. Script output can now be
38408 formatted in CSV or HTML. The HTML version links directly to MARC
38409 biblio record editor.</para>
38411 <para>Frequency suggestion: monthly</para>
38413 <para>Learn more: <ulink
38414 url="http://wiki.koha-community.org/wiki/Check-url_enhancements">http://wiki.koha-community.org/wiki/Check-url_enhancements</ulink></para>
38416 <section id="checkurlcronperl">
38417 <title>Perl Documentation</title>
38419 <para><emphasis role="bold">NAME</emphasis></para>
38421 <para>C4::URL::Checker - base object for checking URL stored in
38424 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
38426 <programlisting>use C4::URL::Checker;
38428 my $checker = C4::URL::Checker->new( );
38429 $checker->{ host_default } = 'http://mylib.kohalibrary.com';
38430 my $checked_urls = $checker->check_biblio( 123 );
38431 foreach my $url ( @$checked_urls ) {
38432 print "url: ", $url->{ url A }, "\n",
38433 "is_success: ", $url->{ is_success }, "\n",
38434 "status: ", $url->{ status }, "\n";
38435 } </programlisting>
38437 <para><emphasis role="bold">FUNCTIONS</emphasis></para>
38441 <para>Create a URL Checker. The returned object can be used to set
38442 default host variable :</para>
38444 <programlisting>my $checker = C4::URL::Checker->new( );
38445 $checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
38447 <para>check_biblio</para>
38449 <para>Check all URL from a biblio record. Returns a pointer to an
38450 array containing all URLs with checking for each of them.</para>
38452 <programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
38454 <para>With 2 URLs, the returned array will look like that:</para>
38458 'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
38459 'is_success' => 1,
38460 'status' => 'ok'
38463 'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
38464 'is_success' => 0,
38465 'status' => '404 - Page not found'
38467 ], </programlisting>
38469 <para><emphasis role="bold">NAME</emphasis></para>
38471 <para>check-url.pl - Check URLs from 856$u field.</para>
38473 <para><emphasis role="bold">USAGE</emphasis></para>
38475 <para>check-url.pl [--verbose|--help]
38476 [--host=http://default.tld]</para>
38478 <para>Scan all URLs found in 856$u of bib records and display if
38479 resources are available or not.</para>
38481 <para><emphasis role="bold">PARAMETERS</emphasis></para>
38483 <para>--host=http://default.tld</para>
38485 <para>Server host used when URL doesn't have one, ie doesn't begin
38486 with 'http:'. For example, if --host=http://www.mylib.com, then
38487 when 856$u contains 'img/image.jpg', the url checked is:
38488 http://www.mylib.com/image.jpg'.</para>
38490 <para>--verbose|-v</para>
38492 <para>Outputs both successful and failed URLs.</para>
38494 <para>--html</para>
38496 <para>Formats output in HTML. The result can be redirected to a
38497 file accessible by http. This way, it's possible to link directly
38498 to biblio record in edit mode. With this parameter --host-pro is
38501 <para>--host-pro=http://koha-pro.tld</para>
38503 <para>Server host used to link to biblio record editing
38506 <para>--help|-h</para>
38508 <para>Print this help page.</para>
38512 <section id="mergeauthcron">
38513 <title>Merge Authorities</title>
38515 <para>Script path: misc/migration_tools/merge_authorities.pl</para>
38517 <para>Does: Updates biblio data with changes to authorities
38520 <para>Required by: <link linkend="dontmerge">dontmerge</link> system
38523 <para>Frequency suggestion: nightly</para>
38526 <section id="serialscron">
38527 <title>Serials Update</title>
38529 <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
38531 <para>Does: checks if there is a "late" issue on active
38532 subscriptions, and if there is, the script will set it as late, and
38533 add the next one as expected.</para>
38535 <para>Frequency suggestion: nightly</para>
38539 <section id="opaccrons">
38540 <title>OPAC</title>
38544 <section id="customrssfeedcron">
38545 <title>RSS Feeds</title>
38547 <para>Script path: misc/cronjobs/rss/rss.pl</para>
38549 <para>Does: Produces an RSS XML document for any SQL query (not used
38550 for search results RSS feed). <link linkend="customrss">Learn
38551 more</link>.</para>
38553 <para>Frequency suggestion: hourly</para>
38556 <section id="authbrowsercron">
38557 <title>Authorities Browser</title>
38559 <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
38561 <para>Does: Generate content for authorities browse in OPAC</para>
38563 <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link>
38564 system preference</para>
38567 <section id="keywordclouds">
38568 <title>Subject/Author Clouds</title>
38570 <para>Script path: misc/cronjobs/cloud-kw.pl</para>
38572 <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
38573 misc/cronjobs/cloud-sample.conf has a sample of how this script
38576 <para>Frequency: This is the type of script you can run once a month
38577 or so, the content generated isn't going to change very much over
38580 <section id="keywordcloudsperl">
38581 <title>Perl Documentation</title>
38583 <para><emphasis role="bold">NAME</emphasis></para>
38585 <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
38588 <para><emphasis role="bold">USAGE</emphasis></para>
38590 <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
38592 <para>Creates multiple HTML files containing keywords cloud with
38593 top terms sorted by their logarithmic weight. cloud.conf is a YAML
38594 configuration file driving cloud generation process.</para>
38596 <para><emphasis role="bold">PARAMETERS</emphasis></para>
38598 <para>--conf=configuration file</para>
38600 <para>Specify configuration file name</para>
38602 <para>--verbose|-v</para>
38604 <para>Enable script verbose mode.</para>
38606 <para>--help|-h</para>
38608 <para>Print this help page.</para>
38610 <para><emphasis role="bold">CONFIGURATION</emphasis></para>
38612 <para>Configuration file looks like that:</para>
38614 <para><programlisting> ---
38615 # Koha configuration file for a specific installation
38616 # If not present, defaults to KOHA_CONF
38617 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
38618 # Zebra index to scan
38620 # Koha index used to link found kewords with an opac search URL
38622 # Number of top keyword to use for the cloud
38624 # Include CSS style directives with the cloud
38625 # This could be used as a model and then CSS directives are
38626 # put in the appropriate CSS file directly.
38628 # HTML file where to output the cloud
38629 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
38631 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
38632 ZebraIndex: Subject
38636 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis
38637 role="bold">IMPROVEMENTS</emphasis></para>
38639 <para>Generated top terms have more informations than those
38640 outputted from the time being. Some parameters could be easily
38641 added to improve this script:</para>
38643 <para>WithCount</para>
38645 <para>In order to output terms with the number of occurrences they
38646 have been found in Koha Catalogue by Zebra.</para>
38648 <para>CloudLevels</para>
38650 <para>Number of levels in the cloud. Now 24 levels are
38653 <para>Weighting</para>
38655 <para>Weighting method used to distribute terms in the cloud. We
38656 could have two values: Logarithmic and Linear. Now it's
38657 Logarithmic by default.</para>
38661 <para>Now terms are outputted in the lexical order. They could be
38662 sorted by their weight.</para>
38667 <section id="systemcron">
38668 <title>System Administration</title>
38672 <section id="cleandbcron">
38673 <title>Clean up Database</title>
38675 <para>Script path: misc/cronjobs/cleanup_database.pl</para>
38677 <para>Does: Truncates the sessions table and cleans out old
38678 zebraqueue entries.</para>
38682 <section id="acqcrons">
38683 <title>Acquisitions</title>
38685 <section id="cleansuggcron">
38686 <title>Clean up old suggestions</title>
38688 <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
38690 <para>Does: Removes old (defined by you) suggestions from the
38691 suggestion management area.</para>
38695 <section id="deprecatedcrons">
38696 <title>Deprecated scripts</title>
38698 <para>These should not be run without modification:</para>
38700 <para>Script path: misc/cronjobs/update_items.pl</para>
38702 <para>Script path:misc/cronjobs/smsoverdues.pl</para>
38704 <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
38706 <para>Script path:misc/cronjobs/reservefix.pl</para>
38708 <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
38710 <para>Script path:misc/cronjobs/j2a.pl</para>
38715 <chapter id="webservices">
38716 <title>Web Services</title>
38720 <section id="OAI-PMHservice">
38721 <title>OAI-PMH</title>
38725 <section id="oaiconfsample">
38726 <title>Sample OAI Conf File</title>
38728 <para><programlisting> format:
38731 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
38732 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
38733 xsl_file: /usr/local/koha/xslt/vs.xsl
38735 metadataPrefix: marxml
38736 metadataNamespace: http://www.loc.gov/MARC21/slim
38737 http://www.loc.gov/standards/marcxml/schema/MARC21slim
38738 schema: http://www.loc.gov/MARC21/slim
38739 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
38741 metadataPrefix: oai_dc
38742 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
38743 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
38745 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
38751 <title>Using the SRU server</title>
38753 <section id="usingsru">
38756 <firstname>Nicolas</firstname>
38758 <surname>Morin</surname>
38761 <orgname>BibLibre</orgname>
38765 <pubdate>December 2009</pubdate>
38768 <title>Using the SRU server</title>
38770 <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
38771 information about the protocol itself can be found at <ulink
38772 url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
38773 The version implemented is version 1.1.</para>
38775 <section id="sru_explain">
38776 <title>Explain</title>
38778 <para>If you want to have information about the implementation of SRU
38779 on a given server, you should have access to the Explain file using a
38780 request to the server without any parameter. Like
38781 <http://myserver.com:9999/biblios/>. The response from the
38782 server is an XML file that should look like the following and will
38783 give you information about the default settings of the SRU
38787 <zs:explainResponse>
38788 <zs:version>1.1</zs:version>
38790 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
38791 <zs:recordPacking>xml</zs:recordPacking>
38792 <zs:recordData>
38793 <explain xml:base="zebradb/explain-biblios.xml">
38795 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
38797 <serverInfo protocol="SRW/SRU/Z39.50">
38798 <host>biblibre</host>
38799 <port>9999</port>
38800 <database>biblios</database>
38801 </serverInfo>
38802 <databaseInfo>
38803 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
38804 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
38806 <sru>http://biblibre:9999</sru>
38808 </databaseInfo>
38810 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
38811 <title>CQL Standard Set</title>
38813 <index search="true" scan="true" sort="false">
38814 <title lang="en">CQL Server Choice</title>
38816 <name set="cql">serverChoice</name>
38819 <attr type="1" set="bib1">text</attr>
38822 <index search="true" scan="true" sort="false">
38823 <title lang="en">CQL All</title>
38825 <name set="cql">all</name>
38828 <attr type="1" set="bib1">text</attr>
38831 <!-- Record ID index -->
38832 <index search="true" scan="true" sort="false">
38833 <title lang="en">Record ID</title>
38835 <name set="rec">id</name>
38838 <attr type="1" set="bib1">rec:id</attr>
38839 <attr type="4" set="bib1">3</attr>
38845 <section id="sru_search">
38846 <title>Search</title>
38849 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
38850 is composed of the following elements:</para>
38854 <para>base url of the SRU server :
38855 http://myserver.com:9999/biblios?</para>
38859 <para>search part with the 3 required parameters : version,
38860 operation and query. The parameters within the search part should
38861 be of the key=value form, and can be combined with the &
38866 <para>One can add optional parameters to the query, for instance
38867 maximumRecords indicating the maximum number of records to be returned
38869 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
38870 will only get the first 5 results results from the server.</para>
38873 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>
38874 gives more details about the search operations and in particular the
38875 list of optional parameters for searching.</para>
38877 <section id="sru_search_more_details">
38878 <title>More details about Search</title>
38880 <para>The "operation" key can take two values: scan or
38881 searchRetrieve.</para>
38883 <para>If operation=searchRetrieve, then the search key should be
38884 query. As in : operation=searchRetrieve&query=reefs</para>
38886 <para>If operation=scan, then the search key should be scanClause.
38887 As in : operation=scan&scanClause=reefs</para>
38889 <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
38890 that exist on your system. For instance you'll see that we have
38891 indexes for Subject and for Title: att 21 Subject and att 4 Title
38892 respectively.</para>
38894 <para>In the pqf.properties file located under
38895 etc/zebradb/pqf.properties I see that an access point already uses
38896 my Subject index (index.dc.subject = 1=21) while another uses my
38897 Title index (index.dc.title = 1=4) I know this is my Subject index
38898 because as I've seen just before in my bib1.att file, it's called
38899 with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
38900 my Subject index. And Title was called with 1=4 so index.dc.title =
38901 1=4 correctly points to my Title index. I can now construct my query
38902 just like I would in a search box, just preceding it with the
38903 "query" key: query=Subject=reefs and Title=coral searches "reefs" in
38904 the subject and "coral" in the title. The full url would be
38905 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
38906 and Title=coral If I want to limit the result set to just 5 records,
38908 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
38909 and Title=coral&maximumRecords=5</para>
38911 <para>I can also play with truncate, relations, etc. Those are also
38912 defined in my pqf.properties file. I can see for instance the
38913 position properties defined as:</para>
38916 position.first = 3=1 6=1
38918 position.any = 3=3 6=1
38919 # "any position in field"
38922 <para>So as an example if I want "coral" to be at the beginning of
38923 the title, I can do this query :
38924 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
38929 <section id="sru_retrieve">
38930 <title>Retrieve</title>
38932 <para>My search for
38933 http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
38934 reefs&maximumRecords=1 retrieves just on record. The response
38935 looks like this:</para>
38938 <zs:searchRetrieveResponse>
38939 <zs:version>1.1</zs:version>
38940 <zs:numberOfRecords>1</zs:numberOfRecords>
38943 <zs:recordPacking>xml</zs:recordPacking>
38944 <zs:recordData>
38945 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
38946 <leader> cam a22 4500</leader>
38947 <datafield tag="010" ind1=" " ind2=" ">
38948 <subfield code="a">2-603-01193-6</subfield>
38949 <subfield code="b">rel.</subfield>
38950 <subfield code="d">159 F</subfield>
38952 <datafield tag="020" ind1=" " ind2=" ">
38953 <subfield code="a">FR</subfield>
38954 <subfield code="b">00065351</subfield>
38956 <datafield tag="101" ind1="1" ind2=" ">
38957 <subfield code="c">ita</subfield>
38959 <datafield tag="105" ind1=" " ind2=" ">
38960 <subfield code="a">a z 00|y|</subfield>
38962 <datafield tag="106" ind1=" " ind2=" ">
38963 <subfield code="a">r</subfield>
38965 <datafield tag="100" ind1=" " ind2=" ">
38966 <subfield code="a">20091130 frey50 </subfield>
38968 <datafield tag="200" ind1="1" ind2=" ">
38969 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
38970 <subfield code="b">Texte imprimé</subfield>
38971 <subfield code="e">la faune sous-marine des coraux</subfield>
38972 <subfield code="f">A. et A. Ferrari</subfield>
38974 <datafield tag="210" ind1=" " ind2=" ">
38975 <subfield code="a">Lausanne</subfield>
38976 <subfield code="a">Paris</subfield>
38977 <subfield code="c">Delachaux et Niestlé</subfield>
38978 <subfield code="d">cop. 2000</subfield>
38979 <subfield code="e">impr. en Espagne</subfield>
38981 <datafield tag="215" ind1=" " ind2=" ">
38982 <subfield code="a">287 p.</subfield>
38983 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
38984 <subfield code="d">20 cm</subfield>
38988 <size>4725</size>
38989 <localnumber>2</localnumber>
38990 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
38993 </zs:recordData>
38994 <zs:recordPosition>1</zs:recordPosition>
38996 </zs:records>
38997 </zs:searchRetrieveResponse>
39004 <appendix id="sysprefdefaults">
39005 <title>System Preference Defaults</title>
39009 <section id="isbddefaults">
39010 <title>ISBD Defaults</title>
39014 <section id="isbddefault">
39015 <title>MARC Default</title>
39017 <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
39018 110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
39019 }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
39020 130t }|<br/><br/></para>
39022 <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
39023 245s }{ 245h }|</para>
39025 <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
39028 <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
39030 <para>#245||{ 245c }|</para>
39032 <para>#242||{ = 242c }|</para>
39034 <para>#250| - |{ 250a }{ 250b }|</para>
39036 <para>#254|, |{ 254a }|</para>
39038 <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
39041 <para>#256|, |{ 256a }|</para>
39043 <para>#257|, |{ 257a }|</para>
39045 <para>#258|, |{ 258a }{ 258b }|</para>
39047 <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
39049 <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
39052 <para>#306| - |{ 306a }|</para>
39054 <para>#307| - |{ 307a }{ 307b }|</para>
39056 <para>#310| - |{ 310a }{ 310b }|</para>
39058 <para>#321| - |{ 321a }{ 321b }|</para>
39060 <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
39061 }{ 340h }{ 340i }|</para>
39063 <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
39064 }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
39065 342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
39067 <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
39068 }{ 343h }{ 343i }|</para>
39070 <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
39072 <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
39073 }{ 352i }{ 352q }|</para>
39075 <para>#362| - |{ 362a }{ 351z }|</para>
39077 <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
39079 <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
39081 <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
39082 }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
39083 800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
39085 <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
39086 }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
39087 810s }{ 810t }{ 810u }{ 810v }|.</para>
39089 <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
39090 }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
39093 <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
39094 }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
39097 <para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
39099 <para>#501|<br/><br/>|{ 501a }|</para>
39101 <para>#502|<br/><br/>|{ 502a }|</para>
39103 <para>#504|<br/><br/>|{ 504a }|</para>
39105 <para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
39108 <para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
39109 506d }{ 506u }|</para>
39111 <para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
39113 <para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
39115 <para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
39118 <para>#511|<br/><br/>|{ 511a }|</para>
39120 <para>#513|<br/><br/>|{ 513a }{513b }|</para>
39122 <para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
39123 514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
39126 <para>#515|<br/><br/>|{ 515a }|</para>
39128 <para>#516|<br/><br/>|{ 516a }|</para>
39130 <para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
39132 <para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
39135 <para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
39137 <para>#522|<br/><br/>|{ 522a }|</para>
39139 <para>#524|<br/><br/>|{ 524a }|</para>
39141 <para>#525|<br/><br/>|{ 525a }|</para>
39143 <para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
39144 510d }{\n510x }|</para>
39146 <para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
39147 506d }{\n506u }|</para>
39149 <para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
39150 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
39152 <para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
39153 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
39156 <para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
39159 <para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
39162 <para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
39163 540d }{\n520u }|</para>
39165 <para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
39166 }{\n544d }{\n544e }{\n544n }|</para>
39168 <para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
39170 <para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
39172 <para>#547|<br/><br/>|{\n547a }|</para>
39174 <para>#550|<br/><br/>|{ 550a }|</para>
39176 <para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
39177 552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
39178 }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
39180 <para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
39181 555d }{ 555u }|</para>
39183 <para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
39185 <para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
39187 <para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
39188 565d }{ 565e }|</para>
39190 <para>#567|<br/><br/>|{ 567a }|</para>
39192 <para>#580|<br/><br/>|{ 580a }|</para>
39194 <para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
39196 <para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
39198 <para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
39200 <para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
39202 <para>#020|<br/><br/><label>ISBN: </label>|{
39203 020a }{ 020c }|</para>
39205 <para>#022|<br/><br/><label>ISSN: </label>|{
39208 <para>#222| = |{ 222a }{ 222b }|</para>
39210 <para>#210| = |{ 210a }{ 210b }|</para>
39212 <para>#024|<br/><br/><label>Standard No.:
39213 </label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
39215 <para>#027|<br/><br/><label>Standard Tech. Report.
39216 No.: </label>|{ 027a }|</para>
39218 <para>#028|<br/><br/><label>Publisher. No.:
39219 </label>|{ 028a }{ 028b }|</para>
39221 <para>#013|<br/><br/><label>Patent No.:
39222 </label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
39225 <para>#030|<br/><br/><label>CODEN: </label>|{
39228 <para>#037|<br/><br/><label>Source: </label>|{
39229 037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
39231 <para>#010|<br/><br/><label>LCCN: </label>|{
39234 <para>#015|<br/><br/><label>Nat. Bib. No.:
39235 </label>|{ 015a }{ 0152 }|</para>
39237 <para>#016|<br/><br/><label>Nat. Bib. Agency Control
39238 No.: </label>|{ 016a }{ 0162 }|</para>
39240 <para>#600|<br/><br/><label>Subjects--Personal
39241 Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
39242 }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
39243 }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
39244 }{--600x}{--600z}{--600y}{--600v}|</para>
39246 <para>#610|<br/><br/><label>Subjects--Corporate
39247 Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
39248 }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
39249 }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
39250 }{--610x}{--610z}{--610y}{--610v}|</para>
39252 <para>#611|<br/><br/><label>Subjects--Meeting Names:
39253 </label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
39254 }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
39255 611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
39257 <para>#630|<br/><br/><label>Subjects--Uniform
39258 Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
39259 }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
39260 630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
39262 <para>#648|<br/><br/><label>Subjects--Chronological
39263 Terms: </label>|{\n6483 }{\n648a
39264 }{--648x}{--648z}{--648y}{--648v}|</para>
39266 <para>#650|<br/><br/><label>Subjects--Topical Terms:
39267 </label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
39268 }{--650x}{--650z}{--650y}{--650v}|</para>
39270 <para>#651|<br/><br/><label>Subjects--Geographic
39271 Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
39272 }{--651x}{--651z}{--651y}{--651v}|</para>
39274 <para>#653|<br/><br/><label>Subjects--Index Terms:
39275 </label>|{ 653a }|</para>
39277 <para>#654|<br/><br/><label>Subjects--Facted Index
39278 Terms: </label>|{\n6543
39279 }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
39281 <para>#655|<br/><br/><label>Index Terms--Genre/Form:
39282 </label>|{\n6553 }{\n655a}{--655b}{--655x
39283 }{--655z}{--655y}{--655v}|</para>
39285 <para>#656|<br/><br/><label>Index Terms--Occupation:
39286 </label>|{\n6563
39287 }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
39289 <para>#657|<br/><br/><label>Index Terms--Function:
39290 </label>|{\n6573
39291 }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
39293 <para>#658|<br/><br/><label>Index Terms--Curriculum
39295 </label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
39297 <para>#050|<br/><br/><label>LC Class. No.:
39298 </label>|{ 050a }{ / 050b }|</para>
39300 <para>#082|<br/><br/><label>Dewey Class. No.:
39301 </label>|{ 082a }{ / 082b }|</para>
39303 <para>#080|<br/><br/><label>Universal Decimal Class.
39304 No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
39306 <para>#070|<br/><br/><label>National Agricultural
39307 Library Call No.: </label>|{ 070a }{ / 070b }|</para>
39309 <para>#060|<br/><br/><label>National Library of
39310 Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
39312 <para>#074|<br/><br/><label>GPO Item No.:
39313 </label>|{ 074a }|</para>
39315 <para>#086|<br/><br/><label>Gov. Doc. Class. No.:
39316 </label>|{ 086a }|</para>
39318 <para>#088|<br/><br/><label>Report. No.:
39319 </label>|{ 088a }|</para>
39322 <section id="unimarcdefault">
39323 <title>UNIMARC Default</title>
39325 <para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
39326 200i}|</h2></para>
39328 <para>#461|<label class="ipt">A part of : </label>|<a
39329 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
39330 461h} {v. 461v}{(461d)}<br/>|</para>
39332 <para>#200b|<label class="ipt">Material Designation :
39333 </label>| {200b }|<br/></para>
39335 <para>#101a|<label class="ipt">Language(s): </label>|<a
39336 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
39338 <para>#200f|<label class="ipt">Authors : </label>|<a
39339 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
39340 ; }</a>|<br/></para>
39342 <para>#200g|<label class="ipt">Co-authors : </label>|<a
39343 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
39344 ; }</a>|<br/></para>
39346 <para>#210a|<br/><label class="ipt">Place of pubblication
39347 : </label>|<a
39348 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
39350 <para>#210c|<label class="ipt">Publisher : </label>|<a
39351 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
39352 ; }</a>|<br/></para>
39354 <para>#210d|<label class="ipt">Date of pubblication :
39355 </label>|{ 210d}|<br/></para>
39357 <para>#215|<label class="ipt">Description :
39358 </label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
39360 <para>#225a|<label class="ipt">Series :</label>|<a
39361 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
39362 ;}</a> |</para>
39364 <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
39365 225v}|<br/></para>
39367 <para>#686|<label>Classification : </label>|{ 686a
39368 }|<br/></para>
39370 <para>#608|<label>Form, Genre : </label>|<a
39371 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
39372 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39373 title="Search on {608a}">{
39374 608a}</a>|<br/><br/></para>
39376 <para>#200||<label class="ipt">Subjects :
39377 </label><br/>|<ul></para>
39379 <para>#600|<label class="ipt">Person(s)
39380 </label><br/> |<li><a
39381 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
39382 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39383 title="Search on {600a}">{
39384 600a}</a></li>|<br/></para>
39386 <para>#601|<label class="ipt">Organisation(s)
39387 </label><br/>|<li><a
39388 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
39389 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39390 title="Search on {601a}">{
39391 601a}</a></li>|<br/></para>
39393 <para>#606|<label class="ipt">Term(s)
39394 </label><br/>|<li><a
39395 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
39396 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39397 title="Search on {606a}">{
39398 606a}</a></li>|<br/></para>
39400 <para>#607|<label class="ipt">Place(s)
39401 </label><br/>|<li><a
39402 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
39403 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39404 title="Search on {607a}">{
39405 607a}</a></li>|<br/></para>
39407 <para>#610|<label>Keywords</label><br/>|<li><a
39408 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
39409 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
39410 title="Search on {610a}">{ 610a}</a></li>|</para>
39412 <para>#200||</ul>|</para>
39414 <para>#856|<label class="ipt">Electronic resource :
39415 </label>|<a href="{856u}">click here</a> to go to
39416 the external resource<br/></para>
39418 <para>#010|<label class="ipt">ISBN : </label>|{010a
39419 ;}|<br/></para>
39421 <para>#011|<label class="ipt">ISSN : </label>|{011a
39422 ;}|<br/></para>
39424 <para>#200||<label class="ipt">Notes :
39425 </label>|<br/><ul></para>
39427 <para>#300||<li>{300a}</li>|</para>
39429 <para>#307||<li>{307a}</li>|</para>
39431 <para>#310||<li>{310a}</li>|</para>
39433 <para>#326||<li>{326a}</li>|</para>
39435 <para>#327||<li>{327a}</li>|</para>
39437 <para>#333|<li>Public : |{333a}</li>|</para>
39439 <para>#200||</ul>|</para>
39441 <para>#330||<label class="ipt">Abstract :
39442 </label>|<br/></para>
39444 <para>#330||{330a}|<br/></para>
39446 <para>#200||<br/><h2>Items</h2>|</para>
39448 <para>#200|<table>|<th>Call
39449 number</th><th>Copy
39450 note</th><th>Fonds</th><th>Genre
39451 detail</th><th>Circulation
39452 type</th><th>Barcode</th>|</para>
39454 <para>#995||<tr><td> {995k}</td><td>
39455 {995u}</td><td>
39456 {995y}</td><td>{995e} </td><td>
39457 {995o}</td><td>{995f}</td></tr>|</table></para>
39461 <section id="nozebradefault">
39462 <title>NoZebraIndexes Default</title>
39464 <para>'title' =>
39465 '130a,210a,222a,240a,243a,245a,245b,246a,246b,247a,247b,250a,250b,440a,830a',</para>
39467 <para>'author' =>
39468 '100a,100b,100c,100d,110a,111a,111b,111c,111d,245c,700a,710a,711a,800a,810a,811a',</para>
39470 <para>'isbn' => '020a',</para>
39472 <para>'issn' => '022a',</para>
39474 <para>'lccn' => '010a',</para>
39476 <para>'biblionumber' => '999c',</para>
39478 <para>'itemtype' => '942c',</para>
39480 <para>'publisher' => '260b',</para>
39482 <para>'date' => '260c',</para>
39484 <para>'note' => '500a,
39485 501a,504a,505a,508a,511a,518a,520a,521a,522a,524a,526a,530a,533a,538a,541a,546a,555a,556a,562a,563a,583a,585a,582a',</para>
39487 <para>'subject' =>
39488 '600*,610*,611*,630*,650*,651*,653*,654*,655*,662*,690*',</para>
39490 <para>'dewey' => '082',</para>
39492 <para>'bc' => '952p',</para>
39494 <para>'callnum' => '952o',</para>
39496 <para>'an' => '6009,6109,6119',</para>
39498 <para>'homebranch' => '952a,952c'</para>
39502 <appendix id="receiptprint">
39503 <title>Configuring Receipt Printers</title>
39505 <para>The following instructions are for specific receipt printers, but
39506 can probably be used to help with setup of other brands as well.</para>
39508 <section id="epsonprinters">
39510 <corpauthor>NEKLS</corpauthor>
39512 <pubdate>2008</pubdate>
39514 <bibliosource><ulink
39515 url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
39518 <title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
39522 <section id="epsonprintdriver">
39523 <title>In the Print Driver</title>
39525 <para>For these instructions, we are using version 5,0,3,0 of the
39526 Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
39527 Register at the <ulink
39528 url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
39529 Center website</ulink> to gain access to the drivers; go to Technical
39530 Resources, then choose the printer model from the Printers drop-down
39533 <para>Click Start > Printers and Faxes > Right click the receipt
39534 printer > Properties:</para>
39538 <para>Advanced Tab, click Printing Defaults button</para>
39542 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
39546 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
39547 Printable Width</para>
39551 <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
39552 window that appears. Fit to Printable Width should be
39553 automatically selected.</para>
39557 <para>OK your way out of there.</para>
39562 <section id="epsonfirefox">
39563 <title>In Firefox</title>
39565 <para>Under File > Page Setup:</para>
39569 <para>Shrink to fit page on Format & Options tab</para>
39573 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
39574 makes the receipts use all available space on the paper
39579 <para>Set all Headers/Footers to -blank-. This removes all of the
39580 gunk you might normally find on a print from Firefox, such as the
39581 URL, number of pages, etc.</para>
39585 <para>Click OK</para>
39589 <para>Set the default printer settings in Firefox so you don't see a
39590 "Print" dialog:</para>
39594 <para>Go to File > Print</para>
39598 <para>Set the Printer to the receipt printer.</para>
39602 <para>Click the Advanced (or Properties) button</para>
39606 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
39610 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
39611 Printable Width</para>
39615 <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
39616 window that appears. Fit to Printable Width should be
39617 automatically selected.</para>
39621 <para>OK your way out, go ahead and print whatever page you are
39626 <para>Type about:config, in the address bar. Click "I'll be
39627 careful, I promise!" on the warning message.</para>
39631 <para>Type, print.always in Filter.</para>
39635 <para>Look for print.always_print_silent.</para>
39639 <para>If the preference is there then set the value to
39646 <para>If the preference is not there (and it shouldn't be in most
39647 browsers) you have to add the preference.</para>
39651 <para>Right click the preference area and select New >
39656 <para>Type print.always_print_silent in the dialog box and set
39657 the value to True. This sets the print settings in Firefox to
39658 always use the same settings and print without showing a
39666 <para>Setting the print.always_print_silent setting in about:config
39667 DISABLES the ability to choose a printer in Firefox.</para>
39672 <section id="epson2">
39674 <corpauthor>NEKLS</corpauthor>
39676 <pubdate>2008</pubdate>
39678 <bibliosource><ulink
39679 url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
39682 <title>For Epson TM-T88II (2) Printers</title>
39684 <para>Register at the <ulink
39685 url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
39686 Center website</ulink> to gain access to the drivers; go to Technical
39687 Resources, then choose the printer model from the Printers drop-down
39690 <section id="epson2firefox">
39691 <title>In Firefox</title>
39693 <para>Under File > Page Setup:</para>
39697 <para>Shrink to fit page on Format & Options tab</para>
39701 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
39702 makes the receipts use all available space on the paper
39707 <para>Set all Headers/Footers to -blank-. This removes all of the
39708 gunk you might normally find on a print from Firefox, such as the
39709 URL, number of pages, etc.</para>
39713 <para>Click OK</para>
39717 <para>Set the default printer settings in Firefox so you don't see a
39718 "Print" dialog:</para>
39722 <para>Go to File > Print</para>
39726 <para>Set the Printer to the receipt printer.</para>
39730 <para>Print whatever page you are on.</para>
39734 <para>Type about:config, in the address bar. Click "I'll be
39735 careful, I promise!" on the warning message.</para>
39739 <para>Type, print.always in Filter.</para>
39743 <para>Look for, print.always_print_silent.</para>
39747 <para>If the preference is there then set the value to
39754 <para>If the preference is not there (and it shouldn't be in most
39755 browsers) you have to add the preference.</para>
39759 <para>Right click the preference area and select New >
39764 <para>Type, print.always_print_silent in the dialog box and
39765 set the value to True. This sets the print settings in Firefox
39766 to always use the same settings and print without showing a
39774 <para>Setting the print.always_print_silent setting in about:config
39775 DISABLES the ability to choose a printer in Firefox.</para>
39780 <section id="starprinter">
39782 <corpauthor>RHCL</corpauthor>
39785 <firstname>Nicole C.</firstname>
39787 <surname>Engard</surname>
39790 <pubdate>2010</pubdate>
39793 <title>For Star SP542 Printers</title>
39795 <section id="installstarprinter">
39796 <title>Installing the Printer</title>
39798 <para>While the following comments are based on the Star SP542 receipt
39799 printer, they probably apply to all printers in the SP5xx
39802 <para>The Star SP542 receipt printer works well with Koha and Firefox
39803 on Windows XP SP3. This printer, with either the parallel or USB
39804 interface, is fairly easy to install and configure. You will need the
39805 following executable file which is available from numerous places on
39806 the Internet:</para>
39808 <para>linemode_2k-xp_20030205.exe</para>
39810 <para>This executable actually does all of the installation; you will
39811 not need to use the Microsoft Windows "Add Printer" program. We
39812 recommend that when installing, the option for the software monitor
39813 not be selected; we have experienced significant pauses and delays in
39814 printing with it. Instead, simply choose to install the receipt
39815 printer without the monitor.</para>
39817 <para>Additionally, the install program may not put the printer on the
39818 correct port, especially if using the USB interface. This is easily
39819 corrected by going to "Start -> Printers and Faxes -> Properties
39820 for the SP542 printer -> Ports", then check the appropriate
39823 <para>A reboot may be required, even if not indicated by the
39824 installation software or the operating system.</para>
39828 <section id="firefoxreceipt">
39830 <corpauthor>VOKAL</corpauthor>
39833 <firstname>Nicole C.</firstname>
39835 <surname>Engard</surname>
39838 <pubdate>2010</pubdate>
39840 <bibliosource><ulink
39841 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>
39844 <title>Configuring Firefox to Print to Receipt Printer</title>
39848 <para>Open File > Page Setup</para>
39852 <para>Make all the headers and footers blank</para>
39856 <para>Set the margins to 0 (zero)</para>
39860 <para>In the address bar of Firefox, type about:config</para>
39864 <para>Search for print.always_print_silent and double click
39869 <para>Change it from false to true</para>
39873 <para>This lets you skip the Print pop up box that comes up, as
39874 well as skipping the step where you have to click OK,
39875 automatically printing the right sized slip.</para>
39881 <para>If print.always_print_silent does not come up</para>
39885 <para>Right click on a blank area of the preference
39890 <para>Select new > Boolean</para>
39894 <para>Enter "print.always_print_silent" as the name (without
39899 <para>Click OK</para>
39903 <para>Select true for the value</para>
39909 <para>You may also want to check what is listed for
39910 print.print_printer</para>
39914 <para>You may have to choose Generic/Text Only (or whatever your
39915 receipt printer might be named)</para>
39923 <appendix id="samplenotice">
39924 <title>Example Notice</title>
39926 <para>Nicole Engard</para>
39928 <para>410 Library Rd.</para>
39930 <para>Philadelphia, PA 19107</para>
39932 <para>Dear Nicole Engard (23529000035726),</para>
39934 <para>According to our records, at the time of this notice, you have items
39935 that are overdue. Please return or renew them as soon as possible to avoid
39936 increasing late fines.</para>
39938 <para>If you have registered a password with the library, you may use it
39939 with your library card number to renew online.</para>
39941 <para>If you believe you have returned the items below please call at and
39942 library staff will be happy to help resolve the issue.</para>
39944 <para>The following item(s) are currently overdue:</para>
39946 <para>07/08/2008 Creating drug-free schools and communities : 502326000054
39947 Fox, C. Lynn.</para>
39949 <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
39951 <para>Sincerely, Library Staff</para>
39954 <appendix id="sampleserialsapp">
39955 <title>Sample Serials</title>
39959 <section id="readersdigestsample">
39960 <title>Reader's Digest (0034-0375)</title>
39964 <para>Published 12 times a year (monthly)</para>
39968 <para>The Volume number changes every 6 months and the numbers
39969 continues on (requires an advanced pattern).</para>
39972 <screeninfo>Sample Reader's Digest Subscription</screeninfo>
39976 <imagedata fileref="images/serialssamples/readersserial.png"/>
39986 <section id="peoplesample">
39987 <title>People Weekly (1076-0091)</title>
39991 <para>Published weekly</para>
39995 <para>The website says "on Saturday except the first week of
39996 August, Thanksgiving week, the first and last weeks of the year"
39997 but this does not match the pattern for 2007 or 2008</para>
40003 <para>In the Jul-Dec there are 26 issues</para>
40007 <para>In the Jan-Jun there are 25 issues (no issue for the first
40008 week of January)</para>
40012 <para>Since the irregularity on the first # 26 does not skip a week,
40013 this would be set up as to roll over on issue 25. The 26th issue in the
40014 second half of the year would have to be received as a
40015 supplemental.</para>
40017 <para>The irregularity check will complain that 52 issues were expected,
40018 but 25 entered. The current irregularity check can only check that the
40019 first position of the numbering pattern matches the expected issue count
40020 of the periodicity. But we do need to trigger the rollover on the
40021 volume, so we need to define the last two weeks of the year as
40022 irregularities. So we receive 50 issues the first 50 weeks, then one
40023 supplemental issue in week 51, which we have to define the enumeration
40024 for, then the next predicted issue will be the following year's first
40028 <section id="hebrewserialsample">
40029 <title>עת-מול
40030 עיתון
40031 לתולדות ארץ
40032 ישראל ועם
40033 ישראל</title>
40035 <para>This journal is published with the following rules:</para>
40039 <para>6 issues a year (every 2 months)</para>
40043 <para>year changes every 6 issues</para>
40047 <para>we start in 2011</para>
40051 <para>the issue number goes up indefinitely</para>
40055 <para>starting from issue 215</para>
40059 <para>The planning would look like this:</para>
40062 <screeninfo>Sample for this Hebrew Journal</screeninfo>
40066 <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
40073 <appendix id="kohacms">
40074 <title>Using Koha as a Content Management System (CMS)</title>
40078 <section id="kohacmssetup">
40079 <title>Setup</title>
40081 <para>These are instructions for taking a default install of Koha 3.0
40082 and allowing it to function as a little content management system. This
40083 will allow a library to publish an arbitrary number of pages based on a
40084 template. This example uses the template for the main opac page, but you
40085 could just as well use any template you wish with a bit more editing.
40086 This may be appropriate if you have a small library, want to allow
40087 librarians to easily add pages, and do not want to support a complete
40092 <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
40093 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same
40098 <para>Edit pages.pl in an editor</para>
40102 <para>At approximately line 32 add:</para>
40104 <programlisting>my $cgi = new CGI;</programlisting>
40108 <para>At approximately line 36 change this code:</para>
40110 <programlisting>template_name =>
40111 "opac-main.tmpl",</programlisting>
40113 <para>To this code:</para>
40115 <programlisting>template_name => "pages.tmpl",</programlisting>
40119 <para>At approximately line 54 change this code:</para>
40121 <programlisting>$template->param(
40122 koha_news => $all_koha_news,
40123 koha_news_count => $koha_news_count
40124 ); </programlisting>
40126 <para>To this:</para>
40128 <programlisting>my $page = "page_" . $cgi->param("p");
40129 $template->param(
40130 koha_news => $all_koha_news,
40131 koha_news_count => $koha_news_count,
40132 local_page => "" .
40133 C4::Context->preference($page)
40134 ); </programlisting>
40139 /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/opac-main.tmpl
40141 /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tmpl</para>
40145 <para>At approximately line 38, change this:</para>
40147 <programlisting><!-- TMPL_IF NAME="OpacMainUserBlock"
40148 --><div id="opacmainuserblock" class="container"><!--
40149 TMPL_VAR NAME="OpacMainUserBlock" --></div><!-- /TMPL_IF
40150 --> </programlisting>
40152 <para>To this:</para>
40154 <programlisting><!-- TMPL_IF NAME="local_page" --><div
40155 id="opacmainuserblock" class="container"><!-- TMPL_VAR
40156 NAME="local_page" --></div><!-- /TMPL_IF
40157 --></programlisting>
40161 <para>In system preferences in the staff client, click the button
40162 for "New Preference" under "Local Use"</para>
40166 <para>Fill it out as so</para>
40170 <para>Explanation: test page for pages tiny cms</para>
40174 <para>Variable: page_test</para>
40178 <para>Value: Lorem ipsum</para>
40182 <para>Click the TextArea link (or enter "TextArea" into the
40183 input field below it)</para>
40187 <para>variable options (last field): 80|50</para>
40193 <para>In a browser go to
40194 http://youraddress/cgi-bin/koha/pages.pl?p=test The page should come
40195 up with the words "Lorem ipsum" in the main content area of the
40196 page. (replace "youraddress" with localhost, 127.0.0.1, or your
40197 domain name depending on how you have Apache set up.)</para>
40201 <para>To add more pages simply create a system preference where the
40202 title begins with "page_" followed by any arbitrary letters. You can
40203 add any markup you want as the value of the field. Reference the new
40204 page by changing the value of the "p" parameter in the URL.</para>
40208 <section id="kohacmstrouble">
40209 <title>Troubleshooting</title>
40211 <para>If you have problems check file permissions on pages.pl and
40212 pages.tmpl. They should have the same user and group as other Koha
40213 files like opac-main.pl.</para>
40216 <section id="kohacmsbonus">
40217 <title>Bonus Points</title>
40219 <para>Instead of using the address
40220 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
40221 http://youraddress/pages.pl?p=test Just open up
40222 /etc/koha/koha-httpd.conf and add the follow at about line
40223 13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
40225 <para>Then restart Apache.</para>
40229 <section id="kohacmsusage">
40230 <title>Usage</title>
40232 <para>After setting up Koha as a CMS you can create new pages following
40233 these instructions:</para>
40235 <section id="kohacmspages">
40236 <title>Adding Pages</title>
40238 <para>To add a new page you need to add a system preference under
40243 <para>Get there: More > Administration > Global System
40244 Preferences > Local Use</para>
40248 <para>Click 'New Preference'</para>
40252 <para>Enter in a description in the Explanation field</para>
40256 <para>Enter a value that starts with 'page_' in the Variable
40261 <para>Enter starting HTML in the Value field</para>
40264 <screeninfo>Add a new preference</screeninfo>
40268 <imagedata fileref="images/appendix-cms/newpreference.png"/>
40275 <para>Set the Variable Type to Textarea</para>
40279 <para>Set the Variable options to something like 20|20 for 20 rows
40280 and 20 columns</para>
40283 <screeninfo>Settings for the new preference</screeninfo>
40287 <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
40295 <section id="kohacmsview">
40296 <title>Viewing your page</title>
40298 <para>You can view your new page at
40299 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
40300 the part you entered after 'page_' in the Variable field.</para>
40303 <section id="kohacmsexpage">
40304 <title>Example</title>
40306 <para>This process can be used to create recommended reading lists
40307 within Koha. So once the code changes have been made per the
40308 instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
40309 instructions above to great a page for 'Recommended Reading
40313 <screeninfo>Create page by modifying a system
40314 preference</screeninfo>
40318 <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
40323 <para>Next we need to create pages for our various classes (or
40324 categories). To do this, return to the 'Adding a New Page' section and
40325 create a preference for the first class.</para>
40328 <screeninfo>Add a new sys pref for another page</screeninfo>
40332 <imagedata fileref="images/appendix-cms/class101-pref.png"/>
40337 <para>Next you'll want to link your first page to your new second
40338 page, go to the page_recommend preference and click 'Edit.' Now you
40339 want to edit the HTML to include a link to your newest page:</para>
40342 <screeninfo>Edit original preference to add new page</screeninfo>
40346 <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
40352 <section id="examplecms">
40353 <title>Live Examples</title>
40357 <para>The Crawford Library at Dallas Christian College is using
40358 this method for their recommended reading lists: <ulink
40359 url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
40366 <appendix id="resetkohadb">
40367 <title>Resetting the Koha Database</title>
40369 <para>These notes on how to reset the database for Koha 3 were derived
40370 from the following email thread: <ulink
40371 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>
40373 <para>Resetting the database may be useful if you install Koha with the
40374 sample data, and then wish to use real data without reinstalling the
40377 <section id="truncate">
40378 <title>Truncate Tables</title>
40380 <para>Use your preferred MySQL client to <ulink
40381 url="http://dev.mysql.com/doc/refman/5.0/en/truncate.html">truncate</ulink>
40382 the following tables:</para>
40390 <para>biblioitems</para>
40398 <para>auth_header</para>
40402 <para>sessions</para>
40406 <para>zebraqueue</para>
40411 <section id="resetzebra">
40412 <title>Reset the Zebra Index</title>
40414 <para>Run the following commands to reset the authorities and biblios
40415 Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
40416 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
40420 <appendix id="importantlinks">
40421 <title>Important Links</title>
40425 <section id="koharelatedlinks">
40426 <title>Koha Related</title>
40430 <para>Report Koha Bugs - <ulink
40431 url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
40435 <para>Koha Versioning Control - <ulink
40436 url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
40440 <para>Database Structure - <ulink
40441 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>
40445 <para>Koha as a CMS - <ulink
40446 url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
40450 <para>Kyles's Koha Tools - <ulink
40451 url="http://millruntech.com/koha">http://millruntech.com/koha</ulink></para>
40455 <para>Koha Bibliography - <ulink
40456 url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
40460 <para>Koha Shared Links - <ulink
40461 url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
40465 <para>Koha Presentations - <ulink
40466 url="http://www.slideshare.net/group/koha-ils/slideshows">http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
40471 <section id="catalogrelatedlinks">
40472 <title>Cataloging Related</title>
40476 <para>Koha MARC Tutorials - <ulink
40477 url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
40481 <para>Z39.50 Server Search - <ulink
40482 url="http://targettest.indexdata.com/">http://targettest.indexdata.com/</ulink></para>
40486 <para>Z39.50 Server List - <ulink
40487 url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm">http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
40491 <para>Library of Congress Authorities - <ulink
40492 url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
40496 <para>MARC Country Codes - <ulink
40497 url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
40501 <para>Search the MARC Code List for Organizations - <ulink
40502 url="http://www.loc.gov/marc/organizations/org-search.php">http://www.loc.gov/marc/organizations/org-search.php</ulink></para>
40506 <para>Search for Canadian MARC Codes - <ulink
40507 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>
40511 <para>Z39.50 Bib-1 Attribute - <ulink
40512 url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink></para>
40517 <section id="enhancedcontentlinks">
40518 <title>Enhanced Content Related</title>
40522 <para>Amazon Associates - <ulink
40523 url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
40527 <para>Amazon Web Services - <ulink
40528 url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
40532 <para>WorldCat Affiliate Tools - <ulink
40533 url="http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister">http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister</ulink></para>
40537 <para>XISBN - <ulink
40538 url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
40542 <para>LibraryThing for Libraries - <ulink
40543 url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
40548 <section id="opaclinks">
40549 <title>Design Related</title>
40553 <para>JQuery Library - <ulink
40554 url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
40558 <para>Owen Leonard's Koha Blog - <ulink
40559 url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
40564 <section id="reportlinks">
40565 <title>Reports Related</title>
40569 <para>SQL Reports Library - <ulink
40570 url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink></para>
40574 <para>Database Schema - <ulink
40575 url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
40579 <para>Sample reports from NEKLS - <ulink
40580 url="http://www.nexpresslibrary.org/training/reports-training/">http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
40585 <section id="installlinks">
40586 <title>Installation Guides</title>
40590 <para>Installing Koha 3 on Ubuntu - <ulink
40591 url="http://www.blazingmoon.org/guides/k3-on-u810-1.html">http://www.blazingmoon.org/guides/k3-on-u810-1.html</ulink></para>
40595 <para>Koha on Debian installation documentation - <ulink
40596 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>
40600 <para>Koha 3.2 on Debian Squeeze - <ulink
40601 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>
40606 <section id="misclinks">
40607 <title>Misc</title>
40611 <para>Zotero - <ulink
40612 url="http://zotero.org">http://zotero.org</ulink></para>
40616 <para>SOPAC - <ulink
40617 url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
40623 <appendix id="XSLTiTypes">
40624 <title>Koha XSLT Item Types</title>
40626 <para>When you have any of the XSLT system preferences (<link
40627 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>, <link
40628 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>, <link
40629 linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>, and/or <link
40630 linkend="XSLTResultsDisplay">XSLTResultsDisplay</link>) along with the
40631 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
40632 preference turned on you will see item type icons on the related screen.
40634 <para>These images are coming from values found in your leader, if
40635 your leader is not cataloged properly it might be best to turn off the
40636 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
40637 preference (which can be done while leaving the other XSLT preferences
40639 </important></para>
40642 <screeninfo>Book image</screeninfo>
40646 <imagedata fileref="images/appendix-xslt/book.png"/>
40653 <para>Book [BK]</para>
40657 <para>leader6 = a (and one of the leader7 values below)</para>
40661 <para>leader7 = a</para>
40665 <para>leader7 = c</para>
40669 <para>leader7 = d</para>
40673 <para>leader7 = m</para>
40679 <para>leader6 = t</para>
40686 <screeninfo>Computer Image</screeninfo>
40690 <imagedata fileref="images/appendix-xslt/comp.png"/>
40697 <para>Computer File [CF]</para>
40701 <para>leader6 = m</para>
40708 <screeninfo>Continuing Resource Image</screeninfo>
40712 <imagedata fileref="images/appendix-xslt/cr.png"/>
40719 <para>Continuing Resource [CR]</para>
40723 <para>leader7 = b</para>
40727 <para>leader7 = i</para>
40731 <para>leader7 = s</para>
40738 <screeninfo>Map Image</screeninfo>
40742 <imagedata fileref="images/appendix-xslt/map.png"/>
40749 <para>Map [MP]</para>
40753 <para>leader6 = e</para>
40757 <para>leader6 = f</para>
40764 <screeninfo>Mixed Materials Image</screeninfo>
40768 <imagedata fileref="images/appendix-xslt/mixed.png"/>
40775 <para>Mixed [MX]</para>
40779 <para>leader6 = p</para>
40786 <screeninfo>Sound Image</screeninfo>
40790 <imagedata fileref="images/appendix-xslt/sound.png"/>
40797 <para>Sound [MU]</para>
40801 <para>leader6 = c</para>
40805 <para>leader6 = d</para>
40809 <para>leader6 = i</para>
40813 <para>leader6 = j</para>
40820 <screeninfo>Visual Material Image</screeninfo>
40824 <imagedata fileref="images/appendix-xslt/visual.png"/>
40831 <para>Visual Material [VM]</para>
40835 <para>leader6 = g</para>
40839 <para>leader6 = k</para>
40843 <para>leader6 = r</para>
40850 <screeninfo>Kit Image</screeninfo>
40854 <imagedata fileref="images/appendix-xslt/kit.png"/>
40865 <para>leader6 = o</para>
40872 <appendix id="marcedit">
40873 <title>MarcEdit</title>
40877 <section id="marceditprefix">
40878 <title>Adding a prefix to call numbers</title>
40880 <para>When bringing data into Koha, you may want to first clean it up.
40881 One common action among Koha users is to add a prefix to the call
40886 <para>Open MarcEdit</para>
40889 <screeninfo>MarcEdit</screeninfo>
40893 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
40900 <para>Click 'MarcEditor'</para>
40904 <para>Go to Tools > Edit Subfield Data</para>
40907 <screeninfo>Edit subfield data</screeninfo>
40911 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
40918 <para>To prepend data the special character is: ^b To simply
40919 prepend data to the beginning of a subfield, add ^b to the Field
40920 Data: textbox and the data to be appended in the Replace</para>
40923 <screeninfo>Prepend data to a field</screeninfo>
40927 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
40934 <para>To prepend data to the beginning of the subfield while
40935 replacing a text string, add ^b[string to replace] to the Field
40936 Data textbox and the data to be appended in the Replace With
40944 <section id="marceditexcel">
40947 <firstname>Kanika</firstname>
40949 <surname>Goyal</surname>
40952 <orgname>Delhi Technological University</orgname>
40957 <firstname>Nicole C.</firstname>
40959 <surname>Engard</surname>
40962 <pubdate>2010</pubdate>
40964 <bibliosource><ulink
40965 url="http://www.botskool.com/geeks/how-import-excel-data-koha">http://www.botskool.com/geeks/how-import-excel-data-koha</ulink></bibliosource>
40968 <title>Importing Excel data into Koha</title>
40970 <para>Suppose you have records of your library in excel data sheet
40971 format and want them to import into Koha. But how will you do this? Koha
40972 will not let you import excel records directly. Well here is a very
40973 simple solution for you which will let you import your excel records in
40974 Koha easily. First, we will convert excel file into Marc file and then
40975 will import it into Koha.</para>
40977 <para>Follow the given steps to import your excel records into
40980 <section id="convertexcel">
40981 <title>Converting from Excel format into .mrk format</title>
40983 <para>First, we will convert excel format into .mrk format. For this
40984 we will use MarcEdit. You can download it from <ulink
40985 url="http://people.oregonstate.edu/~reeset/marcedit/html/downloads.html">http://people.oregonstate.edu/~reeset/marcedit/html/downloads.html</ulink>.</para>
40987 <para>Now open it and select Add-ins-->Delimited Text
40991 <screeninfo>Delimited Text Translator</screeninfo>
40995 <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
41000 <para>Click Next when the following window appears.</para>
41003 <screeninfo>Delimited Text Translator</screeninfo>
41007 <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
41012 <para>Browse for your excel file.</para>
41015 <screeninfo>Delimited Text Translator</screeninfo>
41019 <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
41024 <para>Locate your excel file by choosing the format Excel
41025 File(*.xls).</para>
41028 <screeninfo>Delimited Text Translator</screeninfo>
41032 <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
41037 <para>Similarly, fill all the other entries such as Output File, Excel
41038 Sheet Name and check UTF-8 Encoded (if required) and Click
41042 <screeninfo>Delimited Text Translator</screeninfo>
41046 <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
41051 <para>Now you will be prompted for mapping the fields to recognise the
41052 fields by standard marc format.</para>
41054 <para>Suppose for Field 0 that is first column I entered Map to:
41055 022$a( Valid ISSN for the continuing resource) and then click on
41059 <screeninfo>Delimited Text Translator</screeninfo>
41063 <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
41069 <para>You can customize Indicators and all other things, for more
41070 information on marc21 format visit the <ulink
41071 url="http://www.loc.gov/marc/bibliographic/">official library of
41072 congress site</ulink>.</para>
41075 <para>Similarly map all other fields and then Click on Finish.</para>
41078 <screeninfo>Delimited Text Translator</screeninfo>
41082 <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
41087 <para>And then a window will appear indicating that your Marc Text
41088 File(*.mrk) has been created.</para>
41091 <screeninfo>Delimited Text Translator</screeninfo>
41095 <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
41100 <para>Click Close and we have created a .mrk file from .xls file in
41101 this step. You can view the file by double clicking on it.</para>
41104 <section id="convertmrk">
41105 <title>Convert .mrk file to .mrc</title>
41107 <para>We will convert .mrk file that we have created in the above step
41108 into raw Marc format that can be directly imported into Koha.</para>
41110 <para>For this again open MarcEdit and Select MARC Tools.</para>
41113 <screeninfo>MARC Tools</screeninfo>
41117 <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
41122 <para>Next Select MarcMaker to convert .mrk file into .mrc
41126 <screeninfo>MarcMaker</screeninfo>
41130 <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
41135 <para>Locate your input file and name your output file. Then Click
41139 <screeninfo>MarcMaker</screeninfo>
41143 <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
41148 <para>And it will show you the Result.</para>
41151 <screeninfo>MarcMaker</screeninfo>
41155 <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
41160 <para>Click Close and now we have raw Marc records with us (.mrc
41164 <section id="importmrc">
41165 <title>Import .mrc into Koha</title>
41167 <para>More information on importing records into Koha can be found in
41168 the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
41169 section of this manual.</para>
41171 <para>Finally we will import above created .mrc file into Koha.</para>
41173 <para>Click on Tools in your Koha staff client.</para>
41176 <screeninfo>Koha Staff Client</screeninfo>
41180 <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
41185 <para>Next Click on Stage MARC Records for Import.</para>
41188 <screeninfo>Stage MARC Records for Import</screeninfo>
41192 <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
41197 <para>After this, choose your previously created .mrc file and click
41201 <screeninfo>Stage File</screeninfo>
41205 <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
41210 <para>You can also add comment about file and finally click on Stage
41214 <screeninfo>Stage for Import</screeninfo>
41218 <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
41223 <para>When the import is done, you will get a result something like
41227 <screeninfo>Staged Records Summary</screeninfo>
41231 <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
41236 <para>Next, click on Manage staged records.</para>
41238 <para>Here you can even change matching rules.</para>
41241 <screeninfo>Manage Staged Records</screeninfo>
41245 <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
41250 <para>Click on Import this batch into catalog when you are
41253 <para>Thats it. After all the records get imported, check Status and
41254 it should read "imported"</para>
41257 <screeninfo>Finalize Import</screeninfo>
41261 <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
41266 <para>You can even undo the Import operation.</para>
41268 <para>And within few minutes, we have imported around 10,000 records
41274 <appendix id="talkingtechappendix">
41275 <title>Talking Tech</title>
41277 <para>Talking Tech I-tiva is a third party, proprietary, product that
41278 libraries can subscribe to. Learn more here: <ulink
41279 url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
41281 <section id="talkingtechinstall">
41282 <title>Installation and Setup Instructions</title>
41284 <para>Be sure you've run
41285 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
41286 to install the required data pack (new syspref, notice placeholders and
41287 messaging transport preferences)</para>
41289 <para>To use, <link
41290 linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
41291 syspref must be turned on.</para>
41293 <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
41295 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
41296 system preference turned on, and patrons to have filled in a preference
41297 for receiving these notices by phone.</para>
41299 <para>For OVERDUE messages, overdue notice triggers must be configured
41300 under Koha -> Tools -> <link linkend="noticetriggers">Overdue
41301 Notice Triggers</link>. Either branch-specific triggers or the default
41302 level triggers may be used (script will select whichever is
41303 appropriate).</para>
41306 <section id="talkingtechsend">
41307 <title>Sending Notices File</title>
41311 <para>Add the <link
41312 linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
41313 script to your crontab</para>
41317 <para>Add an FTP/SFTP or other transport method to send the output
41318 file to the I-tiva server</para>
41322 <para>If you wish, archive the sent notices file in another
41323 directory after sending</para>
41327 <para>Run TalkingTech_itiva_outbound.pl --help for more
41331 <section id="talkingtechreceive">
41332 <title>Receiving Results File</title>
41336 <para>Add an FTP/SFTP or other transport method to send the Results
41337 file to a known directory on your Koha server</para>
41341 <para>Add the <link
41342 linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
41343 script to your crontab, aimed at that directory</para>
41347 <para>If you wish, archive the results file in another directory
41348 after processing</para>
41352 <para>Run TalkingTech_itiva_inbound.pl --help for more
41357 <appendix id="faqs">
41358 <title>FAQs</title>
41362 <section id="displayfaq">
41363 <title>Display</title>
41367 <section id="customicons">
41368 <title>Custom Item Type/Authorized Value Icons</title>
41370 <para><emphasis role="bold">Question:</emphasis> Can I have my own set
41371 of item type images (or authorized value icons)?</para>
41373 <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
41374 additional icons to your system you simply add a new directory to
41375 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
41376 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
41377 directory. Your icons will show up in a new tab as soon as they are in
41378 the folders.</para>
41383 <para>Remember to put the icons in both places (on the OPAC and
41384 the intranet).</para>
41390 <section id="customkohaimages">
41391 <title>Customizing Koha Images</title>
41393 <para><emphasis role="bold">Question</emphasis>: Can I customize the
41394 images in the OPAC?</para>
41396 <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
41397 with a series of original images that you can alter to meet your
41398 needs. The originals can be found in the misc/interface_customization/
41402 <section id="opacdisplayfaq">
41403 <title>OPAC Display Fields</title>
41405 <para><emphasis role="bold">Question</emphasis>: What MARC fields
41406 print to the different OPAC screens in Koha?</para>
41408 <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
41409 must be set as follows for the following fields to show</para>
41414 linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
41415 using XSLT stylesheets</para>
41420 linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
41421 using XSLT stylesheets</para>
41426 linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
41431 <para>The OPAC Results page shows:</para>
41439 <para>100, 110, 111</para>
41443 <para>700, 710, 711</para>
41463 <para>The OPAC Details page shows:</para>
41471 <para>100, 110, 111</para>
41475 <para>700, 710, 711</para>
41479 <para>440, 490</para>
41507 <para>130, 240</para>
41547 <para>plus all of the 5xx fields in the Notes tab at the
41553 <section id="displaysubtitle">
41554 <title>Subtitle Display on Bib Records</title>
41556 <para><emphasis role="bold">Question</emphasis>: How do I get the
41557 subtitle to display on the detail pages for my bib records?</para>
41559 <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
41560 depends on there being a <link linkend="keywordmapping">keyword
41561 mapping</link> for the MARC field in question. Adding a mapping for
41562 "subtitle" -> "245b" for an item's framework results in display of
41563 the subtitle in OPAC and staff client search and detail pages
41564 (although not in all instances where subtitles might be displayed,
41565 e.g. the Cart).</para>
41568 <section id="customlogo">
41571 <firstname>Owen</firstname>
41573 <surname>Leonard</surname>
41576 <orgname>Athens County Public Library</orgname>
41580 <pubdate>July 2010</pubdate>
41583 <title>Customize Logo on Staff Client</title>
41585 <para><emphasis role="bold">Question</emphasis>: How do I change the
41586 Koha logo on the Staff Client login page?</para>
41588 <para><emphasis role="bold">Answer</emphasis>: <link
41589 linkend="opacsmallimage">Opacsmallimage</link> controls the display of
41590 the Koha logo in the OPAC, but there is no system preference
41591 controlling the logo on the staff client login page. Luckily the logo
41592 is displayed via CSS so it can be easily customized through some
41595 <para>These are the relevant parts of the staff client default CSS:
41596 <programlisting>#login h1 {
41597 background:url("../../img/koha-logo.gif") no-repeat scroll center
41599 margin-bottom:0.5em;
41604 border-bottom:medium none;
41607 text-indent:-1000px;
41608 }</programlisting></para>
41610 <para>If you have access to the file system on your Koha server you
41611 can add a custom CSS file and specify that file using the <link
41612 linkend="intranetcolorstylesheet">intranetcolorstylesheet</link>
41613 system preference.</para>
41615 <para>There is no analogue to the <link
41616 linkend="OPACUserCSS">OPACUserCSS</link> preference in the staff
41617 client, but you can get around this by putting this in the <link
41618 linkend="intranetuserjs">intranetuserjs</link> preference:
41619 <programlisting>//]]>
41621 <style type="text/css">
41622 /* inline styles */
41624 <script type="text/javascript">
41625 //<![CDATA[</programlisting></para>
41627 <para>In the above snippet where it says /* inline styles */ we'll
41628 redeclare the relevant properties from the styles of the login
41629 image:<programlisting>//]]>
41631 <style type="text/css">
41632 /* inline styles */
41635 background:url("../../img/koha-logo.gif") no-repeat scroll center
41643 <script type="text/javascript">
41645 </programlisting></para>
41647 <para>I've only reproduced the properties necessary to make the change
41648 we want. You can see that the "background:" property sets the path to
41649 the default logo. You can change this to point to any image you want,
41650 on the Koha server or anywhere else. Then you just need to change the
41651 #login h1 a's "height" property to match the height of the image you
41654 <para>For example:</para>
41656 <para><programlisting>//]]>
41658 <style type="text/css">
41659 /* inline styles */
41662 background:url("http://www.myacpl.org/sites/all/themes/npl/logo.png")
41663 no-repeat scroll center top transparent;
41670 <script type="text/javascript">
41671 //<![CDATA[</programlisting></para>
41674 <section id="opacbarcodesfaq">
41675 <title>Show patrons the barcodes of items they have checked
41678 <para><emphasis role="bold">Question</emphasis>: Can patrons see the
41679 barcodes for the items they have checked out.</para>
41681 <para><emphasis role="bold">Answer</emphasis>: Not by default, but
41682 with a few edits to the patron record you can make a barcode column
41683 appear on the patron's check out summary in the OPAC. You can set up a
41684 <link linkend="patronattributetypes">patron attribute</link> with the
41685 value of SHOW_BCODE and <link linkend="authorizedvalues">authorized
41686 value</link> of YES_NO to make this happen.</para>
41689 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
41693 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
41698 <para>Then on the <link linkend="editpatrons">patron's record set the
41699 value</link> for SHOW_BCODE to yes.</para>
41702 <screeninfo>Setting value for SHOW_BCODE on patron
41703 record</screeninfo>
41707 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
41712 <para>This will add a column to the check out summary in the OPAC that
41713 shows the patrons the barcodes of the items they have checked
41717 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
41721 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
41726 <para>Clicking on the 'Overdue' tab will show only the items that are
41731 <section id="circfaq">
41732 <title>Circulation/Notices</title>
41736 <section id="dropboxfaq">
41737 <title>Dropbox Date</title>
41739 <para><emphasis role="bold">Question</emphasis>: How is the dropbox
41740 date is determined? Is it the last open date for the checkout branch?
41741 Is it today's date minus one? Can the dropbox checkin date be
41744 <para><emphasis role="bold">Answer</emphasis>: If the library is
41745 closed for four days for renovations, for example, there would be more
41746 than one day needed for the dropbox date. You will only have one
41747 dropbox date and that will be the last day that the library open
41748 (determined by the holiday calendar) because there is no real way to
41749 know what day the books were dropped into the box during the 4 closed
41750 days. The only way to change the effective checkin date in dropbox
41751 mode is to modify the calendar.</para>
41754 <section id="dupoverduefaq">
41755 <title>Duplicate Overdue Notices</title>
41757 <para><emphasis role="bold">Question</emphasis>: Why are patrons
41758 getting two overdue notices?</para>
41760 <para><emphasis role="bold">Answer</emphasis>: This tool takes all
41761 branches in the overdue rules and sent notifications to them. So, if
41762 you have a default rule & a branch rule, the notification will be
41763 generated twice. A quick fix is to discard "default rule" for
41767 <section id="printoverduefaq">
41768 <title>Printing Overdue Notices</title>
41770 <para><emphasis role="bold">Question</emphasis>: Can I print overdue
41771 notices for patrons without email addresses on file?</para>
41773 <para><emphasis role="bold">Answer</emphasis>: Yes. The <link
41774 linkend="overduenoticecron">overdue notice cron job</link> has a
41775 setting to generate the overdue notices as HTML for printing. An
41776 example of this usage would be:</para>
41778 <para><programlisting>overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author </programlisting>In
41779 this example, we wanted to use only certain item fields in our
41780 notices, so we specified itemscontent fields in the cron entry; that's
41781 not a requirement for the feature.</para>
41783 <para>The command line needs to specify a web-accessible directory
41784 where the print notices will go -- they get a filename like
41785 notices-2009-11-24.html (or holdnotices-2009-11-24.html). The overdue
41786 notice itself can be formatted to fit a Z-mailer. Within the notice
41787 file, the text is spaced down or over to where it will print properly
41788 on the form. The script has code that wraps around the notice file to
41789 tell the HTML to obey the formatting, and to do a page break between
41790 notices. That's so that when staff print it out, they get one per
41791 page. We had to add an extra syspref (<link
41792 linkend="PrintNoticesMaxLines">PrintNoticesMaxLines</link>) to specify
41793 page length because our client allows a _lot_ of checkouts which meant
41794 some notices were running onto multiple pages. That syspref says to
41795 truncate the print notice at that page length and put in a message
41796 about go check your OPAC account for the full list.</para>
41798 <para>The print and email overdues use the same notice file. The print
41799 notices for holds are different -- there's a separate HOLD_PRINT
41800 notice file and the system uses it if there's no email address. Then a
41801 nightly cron job runs to gather those up from the message queue and
41802 put them in an HTML file in the notice directory, as above.</para>
41804 <para>The cron entry is gather_print_notices.pl /tmp/noticedir</para>
41807 <section id="renewfaq">
41808 <title>Unable to Renew Items</title>
41810 <para><emphasis role="bold">Question</emphasis>: We're trying to renew
41811 some items for our patron. One of the items is on hold and ineligible
41812 for renewal, but the other two items refuse to renew even though they
41813 should be eligible. When I try to use the override renewal limit, it
41814 just returns a little message that says “renewal failed". Any
41815 idea what's going on here?</para>
41817 <para><emphasis role="bold">Answer</emphasis>: At the very least you
41818 will need to set an absolute <link linkend="circfinerules">default
41819 circulation rule</link>. This rule should be set for the default
41820 itemtype, default branchcode and default patron category. That will
41821 catch anyone who doesn't match a specific rule. Patrons who do not
41822 match a specific rule will get blocked from placing holds, since there
41823 was no baseline number of holds to utilize.</para>
41826 <section id="holdsfaq">
41827 <title>Unable to Place Holds</title>
41829 <para><emphasis role="bold">Question</emphasis>: Why can't I place
41830 holds when I have all of the preferences turned on.</para>
41832 <para><emphasis role="bold">Answer</emphasis>: You probably need to
41833 set a default circulation rule. At the very least you will need to set
41834 an default circulation rule. This rule should be set for all item
41835 types, all branches and all patron categories. That will catch all
41836 instances that do not match a specific rule. When checking out if you
41837 do not have a rule for the default branch, default item and default
41838 patron category then you may see patrons getting blocked from placing
41842 <section id="keyboardshort">
41843 <title>Keyboard Shortcuts</title>
41845 <para><emphasis role="bold">Question</emphasis>: Do I have to use my
41846 mouse to access the checkout, checkin and cataloging tabs at the top
41847 of the circulation pages?</para>
41849 <para><emphasis role="bold">Answer</emphasis>: You can jump between
41850 the tabs on the quick search box at the top of the screen by using the
41851 following hot keys (if the tab is available):</para>
41855 <para>jump to the catalog search with Alt+Q</para>
41859 <para>jump to the checkout with Alt+U</para>
41863 <para>this will not work for Mac user</para>
41869 <para>jump to the checkin with Alt+R</para>
41874 <para>Mac users use the OPTION button in place of ALT</para>
41878 <section id="smsnoticefaq">
41879 <title>SMS Notices/Messages</title>
41881 <para><emphasis role="bold">Question</emphasis>: I want Koha to send
41882 notices via SMS, what do I need to do?</para>
41884 <para><emphasis role="bold">Answer</emphasis>: First you need to
41885 choose a SMS service to use with Koha. There is a list available here:
41887 url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all</ulink>
41888 Not all SMS services available to libraries have Perl drivers, so be
41889 sure to check this list to see if the provider you're considering is
41890 listed. If not you want to ask your provider if they have a Perl
41891 module, if not you should consider another service. Some common
41892 options in the US (that have Perl drivers) are:</para>
41897 url="http://www.aql.com">www.aql.com</ulink>)</para>
41901 <para>Wadja (<ulink
41902 url="http://wadja.com">wadja.com</ulink>)</para>
41906 <para>Ipipi (<ulink
41907 url="http://ipipi.com">ipipi.com</ulink>)</para>
41911 <para>T-mobile</para>
41915 <para>SMSDiscount (<ulink
41916 url="http://smsdiscount.com">smsdiscount.com</ulink>)</para>
41920 <para>Clickatell</para>
41926 <section id="catfaq">
41927 <title>Cataloging</title>
41931 <section id="authorityfaq">
41932 <title>Authority Fields</title>
41934 <para><emphasis role="bold">Question: </emphasis>Why can't I edit 1xx,
41935 6xx, or 7xx fields in my catalog record?</para>
41937 <para><emphasis role="bold">Answer:</emphasis> These fields are
41938 authority controlled and you probably have the <link
41939 linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> set to
41940 'allow'. When it is set to 'don't allow' these fields will be locked
41941 and require you to search for an existing authority record.</para>
41944 <screeninfo>Locked fields show with a lock icon in the
41949 <imagedata fileref="images/cataloging/lockedauthority.png"/>
41955 <section id="kohamarcfaq">
41956 <title>Koha to MARC Mapping</title>
41958 <para><emphasis role="bold">Question</emphasis>: What's the
41959 relationship between 'Koha to MARC Mapping' and 'MARC Bibliographic
41960 Frameworks'?</para>
41962 <para><emphasis role="bold">Answer</emphasis>: Mapping can be defined
41963 through 'MARC Bibliographic Frameworks' OR 'Koha to MARC Mapping'.
41964 'Koha to MARC Mapping' is just a shortcut to speed up linkage. If you
41965 change a mapping in one of these modules, the mapping will change in
41966 the other as well. (In other words, the two modules 'overwrite' each
41967 other in order to prevent conflicts from existing in Koha).</para>
41970 <section id="itemsperbibfaq">
41971 <title>Number of Items Per Bib Record</title>
41973 <para><emphasis role="bold">Question</emphasis>: Is there a limit on
41974 the number of items I can attach to a bib record?</para>
41976 <para><emphasis role="bold">Answer</emphasis>: There is no explicit
41977 limit to the number of items you can attach to a bibliographic record,
41978 but if you attach enough of them, your MARC record will exceed the
41979 maximum file size limit for the ISO-2709 standard, which breaks
41980 indexing for that record. I've found this occurs somewhere between 600
41981 and 1000 items on a 'normal' bibliographic record.</para>
41984 <section id="analyticsfaq">
41985 <title>Analytics</title>
41987 <para><emphasis role="bold">Question</emphasis>: I am using the <link
41988 linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> feature,
41989 but my links in the OPAC and Staff Client to 'Show Analytics' are not
41992 <para><emphasis role="bold">Answer</emphasis>: If you plan on using
41993 <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> you
41994 will want to make sure to set your <link
41995 linkend="UseControlNumber">UseControlNumber</link> preference to
41996 "Don't use," this will prevent broken links.</para>
42000 <section id="acqfaq">
42001 <title>Acquisitions</title>
42005 <section id="planningcatfaq">
42006 <title>Planning Categories</title>
42008 <para><emphasis role="bold">Question</emphasis>: What is a planning
42011 <para><emphasis role="bold">Answer</emphasis>: When you plan in
42012 advance for the way your budget is going to be spent, you initially
42013 plan for how it's going to be spent over time, that's the most natural
42014 thing to do.</para>
42016 <para>So you plan for $1000 in Jan. $1000 in Feb., $3000 in March,
42017 etc. You can basically do the same thing with a list of values in lieu
42018 of the months.</para>
42020 <para>Say you have a list like this one:</para>
42024 <para>< 1 month</para>
42028 <para>< 6 months</para>
42032 <para>< 1 year</para>
42036 <para>< 3 years</para>
42040 <para>< 10 years</para>
42044 <para>> 10 years</para>
42048 <para>The list is meant to represent when the books acquired where
42049 published. Then you plan for it, saying: we went to spend at list 40%
42050 of our budgets on books published less than a year ago, 10% on books
42051 more than 10 years old, etc.</para>
42053 <para>Upon acquiring new material, you'll be able to select, for a
42054 given item, a value from this list in a drop down. Then, after the
42055 material has been acquired, at the end of the year, you'll be able to
42056 compare the goals set, with what's been achieved.</para>
42060 <section id="serialsfaq">
42061 <title>Serials</title>
42065 <section id="advancedpatternfaq">
42066 <title>Advanced Patterns</title>
42068 <para><emphasis role="bold">Question</emphasis>: What is the 'inner
42069 counter' on the advanced serials pattern interface?</para>
42071 <para><emphasis role="bold">Answer</emphasis>: I think it is better to
42072 give an example to understand this :</para>
42074 <para>Example for a monthly subscription :</para>
42078 <para>First issue publication date : April 2010</para>
42082 <para>Numbering : No {X}, year {Y}</para>
42086 <para>First issue : No 4, year 2010</para>
42090 <para>For the year Y : you will want the year change on January
42093 <para>So, the advanced pattern for Y will be :</para>
42097 <para>Add : 1</para>
42101 <para>once every : 12</para>
42105 <para>When more than 9999999</para>
42109 <para>inner counter : 3</para>
42113 <para>Set back to 0</para>
42117 <para>Begins with 2010</para>
42121 <para>Year is going to change after 12 received issues from April
42122 2010, that is in April 2011 if you don't set inner counter. Set inner
42123 counter to 3 will say to Koha : change year after 12-3 = 9 received
42126 <para>Inner counter says to Koha to take into account the first issues
42127 of the year, even if they are not received with Koha. If you begin
42128 with first issue of the year write nothing or 0.</para>
42132 <section id="reportsfaq">
42133 <title>Reports</title>
42137 <section id="accounttypefaq">
42138 <title>Define Codes Stored in DB</title>
42142 <section id="finescodefaq">
42143 <title>Fines Table</title>
42145 <para><emphasis role="bold">Question:</emphasis> What do the codes
42146 in the accounttype field in the accountlines table stand for?</para>
42148 <para><emphasis role="bold">Answer:</emphasis></para>
42152 <para>A = acc't management fee</para>
42156 <para>C = credit</para>
42160 <para>F = overdue fine</para>
42164 <para>FOR =forgiven</para>
42168 <para>FU = overdue, still acccruing</para>
42172 <para>L = Lost Item</para>
42176 <para>M = Sundry</para>
42180 <para>N = New Card</para>
42184 <para>PAY = payment</para>
42188 <para>W = writeoff</para>
42193 <section id="statscodefaq">
42194 <title>Statistics Table</title>
42196 <para><emphasis role="bold">Question: </emphasis>What are the
42197 possible codes for the type field in the statistics table?</para>
42199 <para><emphasis role="bold">Answer:</emphasis></para>
42203 <para>localuse</para>
42207 <para>Registers if an item that had been checked out to a
42208 statistics patron (category type = 'X') is returned</para>
42218 <para>return</para>
42226 <para>writeoff</para>
42230 <para>payment</para>
42234 <para>CreditXXX</para>
42238 <para>stores different types of fee credits, so a query to
42239 catch them all would include a clause like "type LIKE
42247 <section id="rescodefaq">
42248 <title>Reserves Table</title>
42250 <para><emphasis role="bold">Question</emphasis>: What are the
42251 possible codes for the found field in the reserves and old_reserves
42254 <para><emphasis role="bold">Answer</emphasis>:</para>
42258 <para>NULL: means the patron requested the 1st available, and we
42259 haven't chosen the item</para>
42263 <para>T = Transit: the reserve is linked to an item but is in
42264 transit to the pickup branch</para>
42268 <para>W =Waiting: the reserve is linked to an item, is at the
42269 pickup branch, and is waiting on the hold shelf</para>
42273 <para>F = Finished: the reserve has been completed, and is
42279 <section id="reportdicfaq">
42280 <title>Reports Dictionary Table</title>
42282 <para><emphasis role="bold">Question</emphasis>: What are the
42283 possible codes for the area field in the reports_dictionary
42286 <para><emphasis role="bold">Answer</emphasis>:</para>
42290 <para>1 = Circulation</para>
42294 <para>2 = Catalog</para>
42298 <para>3 = Patrons</para>
42302 <para>4 = Acquistions</para>
42306 <para>5 = Accounts</para>
42311 <section id="msgtablefaq">
42312 <title>Messages Table</title>
42314 <para><emphasis role="bold">Question</emphasis>: What are the
42315 possible codes for the message_type field in the messages
42318 <para><emphasis role="bold">Answer</emphasis>:</para>
42322 <para>L = For Librarians</para>
42326 <para>B = For Patrons/Borrowers</para>
42331 <section id="serialtablefaq">
42332 <title>Serial Table</title>
42334 <para><emphasis role="bold">Question</emphasis>: What are the
42335 possible codes for the status field in the serial table"?</para>
42337 <para><emphasis role="bold">Answer</emphasis>:</para>
42341 <para>1 = Expected</para>
42345 <para>2 = Arrived</para>
42349 <para>3 = Late</para>
42353 <para>4 = Missing</para>
42357 <para>5 = Not Available</para>
42361 <para>6 = Delete</para>
42367 <section id="runtimefaq">
42368 <title>Runtime Parameters</title>
42370 <para><emphasis role="bold">Question</emphasis>: Is there a way to
42371 filter my custom SQL reports before they run?</para>
42373 <para><emphasis role="bold">Answer</emphasis>: If you feel that your
42374 report might be too resource intensive you might want to consider
42375 using runtime parameters to your query. Runtime parameters basically
42376 make a filter appear before the report is run to save your system
42379 <para>There is a specific syntax that Koha will understand as 'ask for
42380 values when running the report'. The syntax is <<Question to
42381 ask|authorized_value>>.</para>
42385 <para>The << and >> are just delimiters. You must put
42386 << at the beginning and >> at the end of your
42391 <para>The 'Question to ask' will be displayed on the left of the
42392 string to enter.</para>
42396 <para>The authorized_value can be omitted if not applicable. If it
42397 contains an authorized value category, or branches or itemtype or
42398 categorycode, a list with the Koha authorized values will be
42399 displayed instead of a free field Note that you can have more than
42400 one parameter in a given SQL Note that entering nothing at run
42401 time won't probably work as you expect. It will be considered as
42402 "value empty" not as "ignore this parameter". For example entering
42403 nothing for : "title=<<Enter title>>" will display
42404 results with title='' (no title). If you want to have to have
42405 something not mandatory, use "title like <<Enter
42406 title>>" and enter a % at run time instead of nothing</para>
42410 <para>Examples:</para>
42414 <para>SELECT surname,firstname FROM borrowers WHERE
42415 branchcode=<<Enter patrons library|branches>> AND
42416 surname like <<Enter filter for patron surname (% if
42417 none)>></para>
42421 <para>SELECT * FROM items WHERE homebranch = <<Pick your
42422 branch|branches>> and barcode like <<Partial barcode
42423 value here>></para>
42428 <para>To generate a date picker calendar to the right of the field
42429 when running a report you can use the 'date' keyword like this:
42430 <<Enter Date|date>></para>
42433 <screeninfo>Date Picker</screeninfo>
42437 <imagedata fileref="images/reports/datepicker.png"/>
42444 <para>You have to put "%" in a text box to 'leave it blank'.
42445 Otherwise, it literally looks for "" (empty string) as the value for
42450 <para>In addition to using any authorized value code to generate a
42451 dropdown, you can use the following values as well: Branches
42452 (branches), Item Types (itemtypes) and Patron Categories
42453 (categorycode). For example a branch pull down would be generated
42454 like this <<Branch|branches>></para>
42457 <screeninfo>Branch pull down</screeninfo>
42461 <imagedata fileref="images/reports/branchpulldown.png"/>
42465 </important></para>
42468 <section id="reportlimitfaq">
42469 <title>Results Limited</title>
42471 <para><emphasis role="bold">Question</emphasis>: When I download my
42472 report it's limited to 10,000 results, how do I get all of the results
42473 to download?</para>
42475 <para><emphasis role="bold">Answer</emphasis>: There is a limit of
42476 10,000 records put on SQL statements entered in Koha. To get around
42477 this you want to add 'LIMIT 100000' to the end of your SQL statement
42478 (or any other number above 10,000.</para>
42482 <section id="searchfaq">
42483 <title>Searching</title>
42487 <section id="advancedsearchfaq">
42488 <title>Advanced Search</title>
42492 <section id="scanindexfaq">
42493 <title>Scan Indexes</title>
42495 <para><emphasis role="bold">Question</emphasis>: What does 'scan
42496 indexes' on the advanced search page mean?</para>
42498 <para><emphasis role="bold">Answer</emphasis>: When you choose an
42499 index, enter a term, click 'scan indexes' and do the search, Koha
42500 displays the searched term and the following terms found in this
42501 index with the number of corresponding records That is search is not
42502 made directly in the catalog, but first in the indexes It works only
42503 for one index at once, and only with no limit in Location (All
42504 libraries needed)</para>
42507 <section id="searchstartswith">
42508 <title>Searching for Terms that Start With a Character</title>
42510 <para><emphasis role="bold">Question</emphasis>: How do I search for
42511 all titles that start with the letter 'C'?</para>
42513 <para><emphasis role="bold">Answer</emphasis>: You can choose to
42514 search for things that start with a character or series of
42515 characters by using the CCL 'first-in-subfield'</para>
42519 <para>example: ti,first-in-subfield=C</para>
42525 <section id="wildcardsearchfaq">
42526 <title>Wildcard Searching</title>
42528 <para><emphasis role="bold">Question</emphasis>:What is the difference
42529 between a keyword search using the ‘*’ (asterisk) versus
42530 a keyword search using the ‘%’ (percent)? Both work in
42531 the catalog, but return different sets. Why?</para>
42533 <para><emphasis role="bold">Answer</emphasis>: A wildcard is a
42534 character (*,?,%,.) that can be used to represent one or more
42535 characters in a word. Two of the wildcard characters that can be used
42536 in Koha searches are the asterisk (‘*’) and the percent
42537 sign (‘%’). However, these two characters act differently
42538 when used in searching.</para>
42540 <para>The ‘*’ is going to force a more exact search of
42541 the first few characters you enter prior to the ‘*’. The
42542 asterisk will allow for an infinite number of characters in the search
42543 as long as the first few characters designated by your search remain
42544 the same. For example, searching for authors using the term, Smi*,
42545 will return a list that may include Smith, Smithers, Smithfield,
42546 Smiley, etc depending on the authors in your database.</para>
42548 <para>The ‘%’ will treat the words you enter in the terms
42549 of “is like”. So a search of Smi% will search for words
42550 like Smi. This results in a much more varied results list. For
42551 example, a search on Smi% will return a list containing Smothers,
42552 Smith, Smelley, Smithfield and many others depending on what is your
42555 <para>The bottom line in searching with wildcards: ‘*’ is
42556 more exact while ‘%’ searches for like terms.</para>
42560 <section id="enhancedcontentfaq">
42561 <title>Enhanced Content</title>
42565 <section id="frbrfaq">
42566 <title>FRBRizing Content</title>
42568 <para><emphasis role="bold">Question: </emphasis>At our public library
42569 we are running a Koha installation and we've tried to turn on all the
42570 nice functionalities in Koha such as the frbrising tool, but do not
42571 get the same result as Nelsonville public library.</para>
42573 <para><emphasis role="bold">Answer: </emphasis>In fact, this feature
42574 is quite tricky to make that right. First it looks at XISBN service.
42575 And then search in your database for that ISBN. So both XISBN and your
42576 internal ISBN (in biblio table) have to be normalized. You could
42577 therefore use the script misc/batchupdateISBNs.pl (it removes all the
42578 - in your local ISBNs)</para>
42581 <section id="amzfaq">
42582 <title>Amazon</title>
42586 <section id="amzprivatekey">
42587 <title>Amazon Private Key</title>
42589 <para><emphasis role="bold">Question</emphasis>: Why do I need the
42590 <link linkend="AWSPrivateKey">AWSPrivateKey</link> as well as the
42591 <link linkend="AWSAccessKeyID">AWSAccessKeyID</link> to use Amazon
42594 <para><emphasis role="bold">Answer</emphasis>: After 2009-08-15,
42595 Amazon Web Services will expect that all requests to the Product
42596 Advertising API, which is what Koha uses for retrieving reviews and
42597 other enhanced content from Amazon, include signatures. This patch
42598 and subsequent patches implement this functionality.</para>
42600 <para>What this means in practice (assuming the user has elected to
42601 use any enhanced content from Amazon) is that</para>
42605 <para>The user must get a Amazon Secret Access Key. This can be
42606 done by logging in to the user's AWS account at (e.g.)
42607 http://aws.amazon.com/, going to the 'Access Identifiers' page,
42608 and from there retrieving and/or creating a new Secret Access
42613 <para>The contents of the Secret Access Key should then be
42614 entered into the new AWSPrivateKey system preference.</para>
42618 <para>Once that is done, grabbing reviews and table of contents from
42619 Amazon should work as normal. If the user doesn't do this before
42620 2009-08-15, reviews and TOCs will no longer be supplied from Amazon,
42621 although there should be no crashes - the content will simply not
42624 <para>Note that the requirement to sign requests does *NOT* appear
42625 to apply to simply displaying book covers from Amazon.</para>
42628 <section id="amazonfaq">
42629 <title>All Amazon Content</title>
42631 <para><emphasis role="bold">Question</emphasis>: I have all of the
42632 Amazon preferences turned on and have entered both of my keys, but
42633 none of the content appears in my system, why is that?</para>
42635 <para><emphasis role="bold">Answer</emphasis>: Amazon's API checks
42636 your server time on all requests and if your server time is not set
42637 properly requests will be denied. To resolve this issue be sure to
42638 set your system time appropriately. Once that change in made Amazon
42639 content should appear immediately.</para>
42641 <para>On Debian the the command is <emphasis>date -s "2010-06-30
42642 17:21"</emphasis> (with the proper date and time for your
42648 <section id="systemfaq">
42649 <title>System Administration</title>
42653 <section id="zebracronfaq">
42654 <title>Errors in Zebra Cron</title>
42656 <para><emphasis role="bold">Question</emphasis>: I am noticing some
42657 errors in the koha-zebradaemon-output.log file. When new records are
42658 added it takes a bit longer to index than we think they should.
42659 Running rebuild zebra is often faster. Zebra ends up indexing and
42660 search works, but I am concerned about the errors. Any ideas?</para>
42662 <para><emphasis role="bold">Answer</emphasis>: Rebuild_zebra.pl -r
42663 deletes all of the files in the Zebra db directories (such as
42664 reci-0.mf) and then recreates them. Thus, permissions will be lost,
42665 and the files will be owned by the user who ran rebuild_zebra.pl. If
42666 one rebuilds the zebra indexes as root, the daemons, which typically
42667 run under the user Koha, will not be able to update the indexes. Thus,
42668 it's important then that the zebra rebuilds are put in the cronjob
42669 file of the user Koha, and not root. Also important is that other
42670 users, such as root, don't manually execute rebuilds.</para>
42672 <para>If one desires that another user be able to execute
42673 rebuild_zebra.pl, he should be given the permission to execute 'sudo
42674 -u Koha .../rebuild_zebra.pl,' (if you want to do this, you also have
42675 to edit the sudoers file to pass the PERL5LIB variable with the
42676 env_keep option as by default sudo strips away almost all environment
42677 variables). Or, as root user, one can use a simple 'su koha' and then
42678 the rebuild_zebra.pl command.</para>
42680 <para>I've also tried to set the sticky bit on rebuild_zebra.pl, but
42681 for whatever reason it didn't seem to work due to some problem with
42682 the PERL5LIB variable that I wasn't able to figure. That seems to me
42683 the easiest thing to do, if anybody has any idea how to make it work.
42684 If it worked and were the default, I think it would help folks to
42685 avoid a great deal of the problems that come up with zebra.</para>
42688 <section id="publicztarget">
42689 <title>Making Z39.50 Target Public</title>
42691 <para><emphasis role="bold">Question</emphasis>: Could someone tell me
42692 the exact steps I need to take to configure Zebra to expose my Koha 3
42693 db as a public Z39.50 service?</para>
42695 <para><emphasis role="bold">Answer</emphasis>: Edit the KOHA_CONF file
42696 that your Koha is using. Uncomment the publicserver line like:</para>
42698 <para><!-- <listen id="publicserver"
42699 >tcp:@:9999</listen> --></para>
42701 <para>to be:</para>
42703 <para><listen id="publicserver"
42704 >tcp:@:9999</listen></para>
42706 <para>Then restart zebasrv and connect on the port specified
42710 <section id="authvalfaq">
42711 <title>Shelving Location Authorized Values</title>
42713 <para><emphasis role="bold">Question</emphasis>: When editing an item,
42714 the new shelving location I created is not showing up by default in
42715 the items where I assigned it to.</para>
42717 <para><emphasis role="bold">Answer</emphasis>: This is because you
42718 created the new shelving location with a code value of 0 (zero) Just
42719 FYI the system interprets authorized values of 0 as equaling a null so
42720 when you edit a record in cataloging where the authorized value in a
42721 field was assigned where the code was 0, the value displays as null in
42722 the item editor (or MARC editor) instead of the value the library
42723 meant it to be.</para>
42726 <section id="whyauthvals">
42727 <title>Why do I need Authorized Values?</title>
42729 <para><emphasis role="bold">Question</emphasis>: Why would I want to
42730 define authorized values for MARC tags?</para>
42732 <para><emphasis role="bold">Answer</emphasis>: Authorized Values
42733 create a 'controlled vocabulary' for your staff. As an example, let us
42734 assume that your Koha installation is used by several libraries, and
42735 you use MARC 21. You might want to restrict the 850a MARC subfield to
42736 the institution codes for just those libraries. In that case, you
42737 could define an authorized values category (perhaps called "INST") and
42738 enter the institution codes as the authorized values for that
42742 <para>Koha automatically sets up authorized value categories for
42743 your item types and branch codes, and you can link these authorized
42744 values to MARC subfields when you set up your MARC tag
42749 <section id="sessionstblfaq">
42750 <title>How do I clean up the sessions table?</title>
42752 <para><emphasis role="bold">Question</emphasis>: Is there a periodic
42753 job that can be run to cull old sessions from the table? We don't want
42754 to backup all the useless session data every night.</para>
42756 <para><emphasis role="bold">Answer</emphasis>: You can run <link
42757 linkend="cleandbcron">cleanup database cron job</link>.</para>
42759 <para>Or just before doing a backup command (mysqldump), you can
42760 truncate session table: </para>
42762 <para><programlisting>mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'</programlisting></para>
42766 <section id="hardwarefaq">
42767 <title>Hardware</title>
42771 <section id="barcodefaq">
42772 <title>Barcode Scanners</title>
42774 <para><emphasis role="bold">Question</emphasis>: What barcode scanners
42775 have been known to work with Koha?</para>
42777 <para><emphasis role="bold">Answer</emphasis>: The simple rule of
42778 thumb is, does it act like a keyboard device?, if so, it will work.
42779 (i.e. can you take the scanner, scan a barcode and have it show up in
42780 a text editor, if so, it will work.)</para>
42782 <para>The main points to check are that it connects to your PC
42783 conveniently (can be USB or "keyboard wedge" which means it connects
42784 in line with the keyboard, which is useful with older computers), and
42785 that it scans the barcode type that you are using.</para>
42787 <para>It is a good idea to test some 'used' barcodes if you have any,
42788 to see whether the scanner can read scuffed or slightly wrinkled ones
42789 successfully. Most scanners are capable of reading several barcode
42790 types - there are many, and the specification should list the ones it
42791 can read. You may need to adjust settings slightly, such as prefix and
42792 suffix characters, or whether you want to send an 'enter' character or
42795 <para>One more tip - some can be set 'always on' and may come with a
42796 stand, some have triggers under the handle, some have buttons on top,
42797 some are held like a pen. Think about the staff working with the
42798 hardware before choosing, as a button in the wrong place can be very
42799 awkward to use.</para>
42802 <section id="printersfaq">
42803 <title>Printers</title>
42807 <section id="kohaprinters">
42808 <title>Printers used by Koha libraries</title>
42812 <para>POS-X receipt printer</para>
42816 <para>Star Micronics printer (exact model unknown) with a
42817 generic/plain text driver.</para>
42821 <para>Star SP2000 (Nelsonville)</para>
42825 <para>Star TSP-100 futurePRINT (Geauga)</para>
42829 <para>"I know there have been a lot of questions on receipt
42830 printers so I thought I'd pass on my findings. We have been
42831 testing the Star TSP-100 futurePRINT. I found this print to
42832 be VERY easy to configure for Koha. I was even able to
42833 customize the print job by adding our system logo (a .gif)
42834 to the top of every receipt. Also with a bitmap created in
42835 Paint was able to add a message at the bottom of each
42836 receipt with the contact information, hours and website for
42837 the library that the materials were checked out at."</para>
42843 <para>Epson TM 88 IIIP thermal receipt printers</para>
42847 <para>Epson TM-T88IV</para>
42851 <para>1x1 labels using a Dymolabelwriter printer</para>
42856 <section id="braillefaq">
42857 <title>Braille Support</title>
42859 <para><emphasis role="bold">Question</emphasis>: Are there any
42860 braille embosser or printer which has inbuilt braille converter and
42861 it is accessible with UNIX environment?</para>
42863 <para><emphasis role="bold">Answer</emphasis>: You may want to look
42864 into BRLTTY (<ulink
42865 url="http://www.emptech.info/product_details.php?ID=1232">http://www.emptech.info/product_details.php?ID=1232</ulink>).</para>
42868 <section id="hardwaresupport">
42869 <title>Additional Support</title>
42874 url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></para>
42882 <appendix id="extending">
42883 <title>Extending Koha</title>
42885 <section id="amzlookup">
42888 <firstname>Cab</firstname>
42890 <surname>Vinton</surname>
42893 <orgname>Sanbornton Public Library</orgname>
42897 <pubdate>September 2009</pubdate>
42899 <bibliosource><ulink
42900 url="http://lists.katipo.co.nz/pipermail/koha/2009-September/020003.html">http://lists.katipo.co.nz/pipermail/koha/2009-September/020003.html</ulink></bibliosource>
42903 <title>Amazon lookup script for Koha libraries</title>
42905 <para>We order most of our materials from Amazon, so I've been looking
42906 for a convenient way to tell if a book under consideration is in our
42907 catalog already.</para>
42909 <para>Greasemonkey & a custom user script fit the bill
42915 url="https://addons.mozilla.org/en-US/firefox/addon/748">https://addons.mozilla.org/en-US/firefox/addon/748</ulink></para>
42920 url="http://userscripts.org/scripts/show/56847">http://userscripts.org/scripts/show/56847</ulink></para>
42924 <para>A few caveats:</para>
42928 <para>Like most scripts, this one was designed to work with Firefox;
42929 I haven't explored getting it to work with other browsers.</para>
42933 <para>I'm not a JavaScript programmer -- this was adapted from
42934 others' work. Just a few lines would have to be changed to get the
42935 script to work with your catalog.</para>
42939 <para>It depends on the existence of ISBN for the item in question,
42940 so movies, older books, etc. would not work.</para>
42944 <para>Others have added all sorts of bells & whistles: XISBN lookups
42945 to search for related titles, custom messages based on the status of
42946 items (on order, on hold, etc.), ... just search the UserScripts site
42947 for Amazon + library. For a later date!</para>
42950 <section id="extendkeywordclouds">
42951 <title>Keyword Clouds</title>
42953 <para>In addition to the traditional tag cloud available in Koha, there
42954 is a way to generate clouds for popular subjects within Koha.</para>
42956 <para>The <link linkend="keywordclouds">Author/Subject Cloud cron
42957 job</link> is used to help with this process. This cron job sends its
42958 output to files.</para>
42962 <para>/home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html</para>
42966 <para>/home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</para>
42970 <para>This means that you can produce clouds for authors, collective
42971 author, all kind of subjects, classifications, etc. And since it works
42972 on zebra indexes, it is quick, even on large DBs. Tags clouds are sent
42973 to files. It's up to library webmaster to deal with those files in order
42974 to include them in <link
42975 linkend="OpacMainUserBlock">OPACMainUserBlock</link>, or include them
42976 into their library CMS.</para>
42978 <para>Some libraries even send the file into a Samba shared folder where
42979 webmaster take them, eventually clean them a little bit before
42980 integrating them into navigation widgets or pages.</para>
42983 <section id="newtitlesoption">
42984 <title>Newest Titles Pulldown</title>
42986 <para>Often we want to add a way for our patrons to do searches for the
42987 newest items. In this example I'll show you how to create a pull down
42988 menu of the newest items by item type. These tips will work (with a
42989 couple changes) for collection codes or shelving locations as
42992 <para>First, it's important to note that every link in Koha is a
42993 permanent link. This means if I do a search for everything of a specific
42994 item type sorted by the acquisitions date and bookmark that URL,
42995 whenever I click it I'll see the newest items of that type on the first
42996 few pages of the results.</para>
42998 <para>I took this knowledge and wrote a form takes this functionality in
42999 to consideration. It basically just does a search of your Koha catalog
43000 for a specific item type and sorts the results by acquisitions
43003 <para>The first thing I did was write a MySQL statement to generate a
43004 list of item types for me - why copy and paste when you can use the
43005 power of MySQL?</para>
43007 <para><programlisting>select concat('<option value=\"mc-itype:', itemtype, '\">',description,'</option>') from itemtypes</programlisting></para>
43009 <para>The above looks at the itemtypes table and slaps the necessary
43010 HTML around each item type for me. I then exported that to CSV and
43011 opened it in my text editor and added the other parts of the
43014 <para><programlisting><p><strong>New Items</strong></p>
43015 <p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl">
43016 <input name="idx" value="kw" type="hidden">
43017 <input name="sort_by" value="acqdate_dsc" type="hidden">
43018 <input name="do" value="OK" type="hidden">
43019 <select name="limit" onchange="this.form.submit()">
43020 <option>-- Please choose --</option>
43021 <option value="mc-itype:BOOK">Book</option>
43022 <option value="mc-itype:BOOKCD">Book on CD</option>
43023 <option value="mc-itype:DVD">DVD</option>
43024 <option value="mc-itype:LRG_PRINT">Large print book</option>
43025 <option value="mc-itype:MAGAZINE">Magazine</option>
43026 <option value="mc-itype:NEWSPAPER">Newspaper</option>
43027 <option value="mc-itype:VIDEO">Videocassette</option>
43030 </p></programlisting></para>
43032 <para>Now, what does all of that mean? The important bits are
43035 <para>First the starting of the form.</para>
43037 <para><programlisting><p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl"></programlisting></para>
43039 <para>This tells the browser to take any value selected and put it at
43040 the end of this http://YOURSITE/cgi-bin/koha/opac-search.pl. If you want
43041 to embed this form on your library website (and not on your OPAC) you
43042 can put the full OPAC URL in there.</para>
43044 <para>Next, there is a hidden value that is telling the search to sort
43045 by acquisitions date descending (newest items at the top):</para>
43047 <para><programlisting><input name="sort_by" value="acqdate_dsc" type="hidden"></programlisting></para>
43049 <para>And finally you have an option for each item type you want people
43050 to search.<programlisting><option value="mc-itype:BOOK">Book</option></programlisting></para>
43052 <para>These options each include the string "mc-itype:" which tells Koha
43053 to do an item type search.</para>
43055 <para>Once you have all of that in place you can copy and paste the form
43056 to somewhere on your OPAC. The <ulink
43057 url="http://catalog.farmingtonlibraries.org">Farmington Public Libraries
43058 OPAC</ulink> has a few examples of this on the left.</para>
43062 <appendix id="siteintegration">
43063 <title>Koha and Your Website</title>
43065 <para>This appendix will include tips for integrating Koha in to your
43066 library website.</para>
43068 <section id="embedsearch">
43069 <title>Koha search on your site</title>
43071 <para>Often you'll want to add a Koha search box to your library
43072 website. To do so, just copy and paste the following code in to your
43073 library website and update the YOURCATALOG bit with your
43074 catalog’s URL and you’re set to go.</para>
43076 <para><programlisting>
43077 <form name="searchform" method="get" action="http://YOURCATLOG/cgi-bin/koha/opac-search.pl" id="searchform">
43078 <input id="transl1" name="q" type="text"><p>
43079 <select name="idx" id="masthead_search">
43080 <option value="kw">Keyword</option>
43081 <option value="ti">Title</option>
43082 <option value="au">Author</option>
43083 <option value="su">Subject</option>
43084 <option value="nb">ISBN</option>
43085 <option value="se">Series</option>
43086 <option value="callnum">Call Number</option>
43088 <input value="Search" id="searchsubmit" type="submit">
43089 </p></form>
43090 </programlisting></para>
43094 <appendix id="gpl">
43095 <title><acronym>GNU</acronym> General Public License version 3</title>
43097 <para>Version 3, 29 June 2007</para>
43099 <para>Copyright © 2007 Free Software Foundation, Inc. <ulink
43100 url="http://fsf.org/">http://fsf.org/</ulink></para>
43102 <para>Everyone is permitted to copy and distribute verbatim copies of this
43103 license document, but changing it is not allowed.</para>
43105 <bridgehead id="Preamble" renderas="sect1">Preamble</bridgehead>
43107 <para>The <acronym>GNU</acronym> General Public License is a free,
43108 copyleft license for software and other kinds of works.</para>
43110 <para>The licenses for most software and other practical works are
43111 designed to take away your freedom to share and change the works. By
43112 contrast, the <acronym>GNU</acronym> General Public License is intended to
43113 guarantee your freedom to share and change all versions of a
43114 program—to make sure it remains free software for all its users. We,
43115 the Free Software Foundation, use the <acronym>GNU</acronym> General
43116 Public License for most of our software; it applies also to any other work
43117 released this way by its authors. You can apply it to your programs,
43120 <para>When we speak of free software, we are referring to freedom, not
43121 price. Our General Public Licenses are designed to make sure that you have
43122 the freedom to distribute copies of free software (and charge for them if
43123 you wish), that you receive source code or can get it if you want it, that
43124 you can change the software or use pieces of it in new free programs, and
43125 that you know you can do these things.</para>
43127 <para>To protect your rights, we need to prevent others from denying you
43128 these rights or asking you to surrender the rights. Therefore, you have
43129 certain responsibilities if you distribute copies of the software, or if
43130 you modify it: responsibilities to respect the freedom of others.</para>
43132 <para>For example, if you distribute copies of such a program, whether
43133 gratis or for a fee, you must pass on to the recipients the same freedoms
43134 that you received. You must make sure that they, too, receive or can get
43135 the source code. And you must show them these terms so they know their
43138 <para>Developers that use the <acronym>GNU</acronym>
43139 <acronym>GPL</acronym> protect your rights with two steps: (1) assert
43140 copyright on the software, and (2) offer you this License giving you legal
43141 permission to copy, distribute and/or modify it.</para>
43143 <para>For the developers' and authors' protection, the
43144 <acronym>GPL</acronym> clearly explains that there is no warranty for this
43145 free software. For both users' and authors' sake, the
43146 <acronym>GPL</acronym> requires that modified versions be marked as
43147 changed, so that their problems will not be attributed erroneously to
43148 authors of previous versions.</para>
43150 <para>Some devices are designed to deny users access to install or run
43151 modified versions of the software inside them, although the manufacturer
43152 can do so. This is fundamentally incompatible with the aim of protecting
43153 users' freedom to change the software. The systematic pattern of such
43154 abuse occurs in the area of products for individuals to use, which is
43155 precisely where it is most unacceptable. Therefore, we have designed this
43156 version of the <acronym>GPL</acronym> to prohibit the practice for those
43157 products. If such problems arise substantially in other domains, we stand
43158 ready to extend this provision to those domains in future versions of the
43159 <acronym>GPL</acronym>, as needed to protect the freedom of users.</para>
43161 <para>Finally, every program is threatened constantly by software patents.
43162 States should not allow patents to restrict development and use of
43163 software on general-purpose computers, but in those that do, we wish to
43164 avoid the special danger that patents applied to a free program could make
43165 it effectively proprietary. To prevent this, the <acronym>GPL</acronym>
43166 assures that patents cannot be used to render the program non-free.</para>
43168 <para>The precise terms and conditions for copying, distribution and
43169 modification follow.</para>
43171 <bridgehead>TERMS AND CONDITIONS</bridgehead>
43173 <bridgehead id="Definitions" renderas="sect1">0. Definitions.</bridgehead>
43175 <para>“This License" refers to version 3 of the
43176 <acronym>GNU</acronym> General Public License.</para>
43178 <para>“Copyright" also means copyright-like laws that apply to other
43179 kinds of works, such as semiconductor masks.</para>
43181 <para>“The Program" refers to any copyrightable work licensed under
43182 this License. Each licensee is addressed as “you". “Licensees"
43183 and “recipients" may be individuals or organizations.</para>
43185 <para>To “modify" a work means to copy from or adapt all or part of
43186 the work in a fashion requiring copyright permission, other than the
43187 making of an exact copy. The resulting work is called a “modified
43188 version" of the earlier work or a work “based on" the earlier
43191 <para>A “covered work" means either the unmodified Program or a work
43192 based on the Program.</para>
43194 <para>To “propagate" a work means to do anything with it that,
43195 without permission, would make you directly or secondarily liable for
43196 infringement under applicable copyright law, except executing it on a
43197 computer or modifying a private copy. Propagation includes copying,
43198 distribution (with or without modification), making available to the
43199 public, and in some countries other activities as well.</para>
43201 <para>To “convey" a work means any kind of propagation that enables
43202 other parties to make or receive copies. Mere interaction with a user
43203 through a computer network, with no transfer of a copy, is not
43206 <para>An interactive user interface displays “Appropriate Legal
43207 Notices" to the extent that it includes a convenient and prominently
43208 visible feature that (1) displays an appropriate copyright notice, and (2)
43209 tells the user that there is no warranty for the work (except to the
43210 extent that warranties are provided), that licensees may convey the work
43211 under this License, and how to view a copy of this License. If the
43212 interface presents a list of user commands or options, such as a menu, a
43213 prominent item in the list meets this criterion.</para>
43215 <bridgehead id="SourceCode" renderas="sect1">1. Source Code.</bridgehead>
43217 <para>The “source code" for a work means the preferred form of the
43218 work for making modifications to it. “Object code" means any
43219 non-source form of a work.</para>
43221 <para>A “Standard Interface" means an interface that either is an
43222 official standard defined by a recognized standards body, or, in the case
43223 of interfaces specified for a particular programming language, one that is
43224 widely used among developers working in that language.</para>
43226 <para>The “System Libraries" of an executable work include anything,
43227 other than the work as a whole, that (a) is included in the normal form of
43228 packaging a Major Component, but which is not part of that Major
43229 Component, and (b) serves only to enable use of the work with that Major
43230 Component, or to implement a Standard Interface for which an
43231 implementation is available to the public in source code form. A
43232 “Major Component", in this context, means a major essential
43233 component (kernel, window system, and so on) of the specific operating
43234 system (if any) on which the executable work runs, or a compiler used to
43235 produce the work, or an object code interpreter used to run it.</para>
43237 <para>The “Corresponding Source" for a work in object code form
43238 means all the source code needed to generate, install, and (for an
43239 executable work) run the object code and to modify the work, including
43240 scripts to control those activities. However, it does not include the
43241 work's System Libraries, or general-purpose tools or generally available
43242 free programs which are used unmodified in performing those activities but
43243 which are not part of the work. For example, Corresponding Source includes
43244 interface definition files associated with source files for the work, and
43245 the source code for shared libraries and dynamically linked subprograms
43246 that the work is specifically designed to require, such as by intimate
43247 data communication or control flow between those subprograms and other
43248 parts of the work.</para>
43250 <para>The Corresponding Source need not include anything that users can
43251 regenerate automatically from other parts of the Corresponding
43254 <para>The Corresponding Source for a work in source code form is that same
43257 <bridgehead id="BasicPermissions" renderas="sect1">2. Basic
43258 Permissions.</bridgehead>
43260 <para>All rights granted under this License are granted for the term of
43261 copyright on the Program, and are irrevocable provided the stated
43262 conditions are met. This License explicitly affirms your unlimited
43263 permission to run the unmodified Program. The output from running a
43264 covered work is covered by this License only if the output, given its
43265 content, constitutes a covered work. This License acknowledges your rights
43266 of fair use or other equivalent, as provided by copyright law.</para>
43268 <para>You may make, run and propagate covered works that you do not
43269 convey, without conditions so long as your license otherwise remains in
43270 force. You may convey covered works to others for the sole purpose of
43271 having them make modifications exclusively for you, or provide you with
43272 facilities for running those works, provided that you comply with the
43273 terms of this License in conveying all material for which you do not
43274 control copyright. Those thus making or running the covered works for you
43275 must do so exclusively on your behalf, under your direction and control,
43276 on terms that prohibit them from making any copies of your copyrighted
43277 material outside their relationship with you.</para>
43279 <para>Conveying under any other circumstances is permitted solely under
43280 the conditions stated below. Sublicensing is not allowed; section 10 makes
43281 it unnecessary.</para>
43283 <bridgehead id="Protecting" renderas="sect1">3. Protecting Users' Legal
43284 Rights From Anti-Circumvention Law.</bridgehead>
43286 <para>No covered work shall be deemed part of an effective technological
43287 measure under any applicable law fulfilling obligations under article 11
43288 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws
43289 prohibiting or restricting circumvention of such measures.</para>
43291 <para>When you convey a covered work, you waive any legal power to forbid
43292 circumvention of technological measures to the extent such circumvention
43293 is effected by exercising rights under this License with respect to the
43294 covered work, and you disclaim any intention to limit operation or
43295 modification of the work as a means of enforcing, against the work's
43296 users, your or third parties' legal rights to forbid circumvention of
43297 technological measures.</para>
43299 <bridgehead id="ConveyingVerbatim" renderas="sect1">4. Conveying Verbatim
43300 Copies.</bridgehead>
43302 <para>You may convey verbatim copies of the Program's source code as you
43303 receive it, in any medium, provided that you conspicuously and
43304 appropriately publish on each copy an appropriate copyright notice; keep
43305 intact all notices stating that this License and any non-permissive terms
43306 added in accord with section 7 apply to the code; keep intact all notices
43307 of the absence of any warranty; and give all recipients a copy of this
43308 License along with the Program.</para>
43310 <para>You may charge any price or no price for each copy that you convey,
43311 and you may offer support or warranty protection for a fee.</para>
43313 <bridgehead id="ConveyingModified" renderas="sect1">5. Conveying Modified
43314 Source Versions.</bridgehead>
43316 <para>You may convey a work based on the Program, or the modifications to
43317 produce it from the Program, in the form of source code under the terms of
43318 section 4, provided that you also meet all of these conditions:</para>
43320 <orderedlist numeration="loweralpha">
43322 <para>The work must carry prominent notices stating that you modified
43323 it, and giving a relevant date.</para>
43327 <para>The work must carry prominent notices stating that it is
43328 released under this License and any conditions added under section 7.
43329 This requirement modifies the requirement in section 4 to “keep
43330 intact all notices".</para>
43334 <para>You must license the entire work, as a whole, under this License
43335 to anyone who comes into possession of a copy. This License will
43336 therefore apply, along with any applicable section 7 additional terms,
43337 to the whole of the work, and all its parts, regardless of how they
43338 are packaged. This License gives no permission to license the work in
43339 any other way, but it does not invalidate such permission if you have
43340 separately received it.</para>
43344 <para>If the work has interactive user interfaces, each must display
43345 Appropriate Legal Notices; however, if the Program has interactive
43346 interfaces that do not display Appropriate Legal Notices, your work
43347 need not make them do so.</para>
43351 <para>A compilation of a covered work with other separate and independent
43352 works, which are not by their nature extensions of the covered work, and
43353 which are not combined with it such as to form a larger program, in or on
43354 a volume of a storage or distribution medium, is called an
43355 “aggregate" if the compilation and its resulting copyright are not
43356 used to limit the access or legal rights of the compilation's users beyond
43357 what the individual works permit. Inclusion of a covered work in an
43358 aggregate does not cause this License to apply to the other parts of the
43361 <bridgehead id="ConveyingNonSource" renderas="sect1">6. Conveying
43362 Non-Source Forms.</bridgehead>
43364 <para>You may convey a covered work in object code form under the terms of
43365 sections 4 and 5, provided that you also convey the machine-readable
43366 Corresponding Source under the terms of this License, in one of these
43369 <orderedlist numeration="loweralpha">
43371 <para>Convey the object code in, or embodied in, a physical product
43372 (including a physical distribution medium), accompanied by the
43373 Corresponding Source fixed on a durable physical medium customarily
43374 used for software interchange.</para>
43378 <para>Convey the object code in, or embodied in, a physical product
43379 (including a physical distribution medium), accompanied by a written
43380 offer, valid for at least three years and valid for as long as you
43381 offer spare parts or customer support for that product model, to give
43382 anyone who possesses the object code either (1) a copy of the
43383 Corresponding Source for all the software in the product that is
43384 covered by this License, on a durable physical medium customarily used
43385 for software interchange, for a price no more than your reasonable
43386 cost of physically performing this conveying of source, or (2) access
43387 to copy the Corresponding Source from a network server at no
43392 <para>Convey individual copies of the object code with a copy of the
43393 written offer to provide the Corresponding Source. This alternative is
43394 allowed only occasionally and noncommercially, and only if you
43395 received the object code with such an offer, in accord with subsection
43400 <para>Convey the object code by offering access from a designated
43401 place (gratis or for a charge), and offer equivalent access to the
43402 Corresponding Source in the same way through the same place at no
43403 further charge. You need not require recipients to copy the
43404 Corresponding Source along with the object code. If the place to copy
43405 the object code is a network server, the Corresponding Source may be
43406 on a different server (operated by you or a third party) that supports
43407 equivalent copying facilities, provided you maintain clear directions
43408 next to the object code saying where to find the Corresponding Source.
43409 Regardless of what server hosts the Corresponding Source, you remain
43410 obligated to ensure that it is available for as long as needed to
43411 satisfy these requirements.</para>
43415 <para>Convey the object code using peer-to-peer transmission, provided
43416 you inform other peers where the object code and Corresponding Source
43417 of the work are being offered to the general public at no charge under
43418 subsection 6d.</para>
43422 <para>A separable portion of the object code, whose source code is
43423 excluded from the Corresponding Source as a System Library, need not be
43424 included in conveying the object code work.</para>
43426 <para>A “User Product" is either (1) a “consumer product",
43427 which means any tangible personal property which is normally used for
43428 personal, family, or household purposes, or (2) anything designed or sold
43429 for incorporation into a dwelling. In determining whether a product is a
43430 consumer product, doubtful cases shall be resolved in favor of coverage.
43431 For a particular product received by a particular user, “normally
43432 used" refers to a typical or common use of that class of product,
43433 regardless of the status of the particular user or of the way in which the
43434 particular user actually uses, or expects or is expected to use, the
43435 product. A product is a consumer product regardless of whether the product
43436 has substantial commercial, industrial or non-consumer uses, unless such
43437 uses represent the only significant mode of use of the product.</para>
43439 <para>“Installation Information" for a User Product means any
43440 methods, procedures, authorization keys, or other information required to
43441 install and execute modified versions of a covered work in that User
43442 Product from a modified version of its Corresponding Source. The
43443 information must suffice to ensure that the continued functioning of the
43444 modified object code is in no case prevented or interfered with solely
43445 because modification has been made.</para>
43447 <para>If you convey an object code work under this section in, or with, or
43448 specifically for use in, a User Product, and the conveying occurs as part
43449 of a transaction in which the right of possession and use of the User
43450 Product is transferred to the recipient in perpetuity or for a fixed term
43451 (regardless of how the transaction is characterized), the Corresponding
43452 Source conveyed under this section must be accompanied by the Installation
43453 Information. But this requirement does not apply if neither you nor any
43454 third party retains the ability to install modified object code on the
43455 User Product (for example, the work has been installed in
43456 <acronym>ROM</acronym>).</para>
43458 <para>The requirement to provide Installation Information does not include
43459 a requirement to continue to provide support service, warranty, or updates
43460 for a work that has been modified or installed by the recipient, or for
43461 the User Product in which it has been modified or installed. Access to a
43462 network may be denied when the modification itself materially and
43463 adversely affects the operation of the network or violates the rules and
43464 protocols for communication across the network.</para>
43466 <para>Corresponding Source conveyed, and Installation Information
43467 provided, in accord with this section must be in a format that is publicly
43468 documented (and with an implementation available to the public in source
43469 code form), and must require no special password or key for unpacking,
43470 reading or copying.</para>
43472 <bridgehead id="AdditionalTerms" renderas="sect1">7. Additional
43473 Terms.</bridgehead>
43475 <para>“Additional permissions" are terms that supplement the terms
43476 of this License by making exceptions from one or more of its conditions.
43477 Additional permissions that are applicable to the entire Program shall be
43478 treated as though they were included in this License, to the extent that
43479 they are valid under applicable law. If additional permissions apply only
43480 to part of the Program, that part may be used separately under those
43481 permissions, but the entire Program remains governed by this License
43482 without regard to the additional permissions.</para>
43484 <para>When you convey a copy of a covered work, you may at your option
43485 remove any additional permissions from that copy, or from any part of it.
43486 (Additional permissions may be written to require their own removal in
43487 certain cases when you modify the work.) You may place additional
43488 permissions on material, added by you to a covered work, for which you
43489 have or can give appropriate copyright permission.</para>
43491 <para>Notwithstanding any other provision of this License, for material
43492 you add to a covered work, you may (if authorized by the copyright holders
43493 of that material) supplement the terms of this License with terms:</para>
43495 <orderedlist numeration="loweralpha">
43497 <para>Disclaiming warranty or limiting liability differently from the
43498 terms of sections 15 and 16 of this License; or</para>
43502 <para>Requiring preservation of specified reasonable legal notices or
43503 author attributions in that material or in the Appropriate Legal
43504 Notices displayed by works containing it; or</para>
43508 <para>Prohibiting misrepresentation of the origin of that material, or
43509 requiring that modified versions of such material be marked in
43510 reasonable ways as different from the original version; or</para>
43514 <para>Limiting the use for publicity purposes of names of licensors or
43515 authors of the material; or</para>
43519 <para>Declining to grant rights under trademark law for use of some
43520 trade names, trademarks, or service marks; or</para>
43524 <para>Requiring indemnification of licensors and authors of that
43525 material by anyone who conveys the material (or modified versions of
43526 it) with contractual assumptions of liability to the recipient, for
43527 any liability that these contractual assumptions directly impose on
43528 those licensors and authors.</para>
43532 <para>All other non-permissive additional terms are considered
43533 “further restrictions" within the meaning of section 10. If the
43534 Program as you received it, or any part of it, contains a notice stating
43535 that it is governed by this License along with a term that is a further
43536 restriction, you may remove that term. If a license document contains a
43537 further restriction but permits relicensing or conveying under this
43538 License, you may add to a covered work material governed by the terms of
43539 that license document, provided that the further restriction does not
43540 survive such relicensing or conveying.</para>
43542 <para>If you add terms to a covered work in accord with this section, you
43543 must place, in the relevant source files, a statement of the additional
43544 terms that apply to those files, or a notice indicating where to find the
43545 applicable terms.</para>
43547 <para>Additional terms, permissive or non-permissive, may be stated in the
43548 form of a separately written license, or stated as exceptions; the above
43549 requirements apply either way.</para>
43551 <bridgehead id="Termination" renderas="sect1">8. Termination.</bridgehead>
43553 <para>You may not propagate or modify a covered work except as expressly
43554 provided under this License. Any attempt otherwise to propagate or modify
43555 it is void, and will automatically terminate your rights under this
43556 License (including any patent licenses granted under the third paragraph
43557 of section 11).</para>
43559 <para>However, if you cease all violation of this License, then your
43560 license from a particular copyright holder is reinstated (a)
43561 provisionally, unless and until the copyright holder explicitly and
43562 finally terminates your license, and (b) permanently, if the copyright
43563 holder fails to notify you of the violation by some reasonable means prior
43564 to 60 days after the cessation.</para>
43566 <para>Moreover, your license from a particular copyright holder is
43567 reinstated permanently if the copyright holder notifies you of the
43568 violation by some reasonable means, this is the first time you have
43569 received notice of violation of this License (for any work) from that
43570 copyright holder, and you cure the violation prior to 30 days after your
43571 receipt of the notice.</para>
43573 <para>Termination of your rights under this section does not terminate the
43574 licenses of parties who have received copies or rights from you under this
43575 License. If your rights have been terminated and not permanently
43576 reinstated, you do not qualify to receive new licenses for the same
43577 material under section 10.</para>
43579 <bridgehead id="AcceptanceNotRequired" renderas="sect1">9. Acceptance Not
43580 Required for Having Copies.</bridgehead>
43582 <para>You are not required to accept this License in order to receive or
43583 run a copy of the Program. Ancillary propagation of a covered work
43584 occurring solely as a consequence of using peer-to-peer transmission to
43585 receive a copy likewise does not require acceptance. However, nothing
43586 other than this License grants you permission to propagate or modify any
43587 covered work. These actions infringe copyright if you do not accept this
43588 License. Therefore, by modifying or propagating a covered work, you
43589 indicate your acceptance of this License to do so.</para>
43591 <bridgehead id="AutomaticDownstream" renderas="sect1">10. Automatic
43592 Licensing of Downstream Recipients.</bridgehead>
43594 <para>Each time you convey a covered work, the recipient automatically
43595 receives a license from the original licensors, to run, modify and
43596 propagate that work, subject to this License. You are not responsible for
43597 enforcing compliance by third parties with this License.</para>
43599 <para>An “entity transaction" is a transaction transferring control
43600 of an organization, or substantially all assets of one, or subdividing an
43601 organization, or merging organizations. If propagation of a covered work
43602 results from an entity transaction, each party to that transaction who
43603 receives a copy of the work also receives whatever licenses to the work
43604 the party's predecessor in interest had or could give under the previous
43605 paragraph, plus a right to possession of the Corresponding Source of the
43606 work from the predecessor in interest, if the predecessor has it or can
43607 get it with reasonable efforts.</para>
43609 <para>You may not impose any further restrictions on the exercise of the
43610 rights granted or affirmed under this License. For example, you may not
43611 impose a license fee, royalty, or other charge for exercise of rights
43612 granted under this License, and you may not initiate litigation (including
43613 a cross-claim or counterclaim in a lawsuit) alleging that any patent claim
43614 is infringed by making, using, selling, offering for sale, or importing
43615 the Program or any portion of it.</para>
43617 <bridgehead id="Patents" renderas="sect1">11. Patents.</bridgehead>
43619 <para>A “contributor" is a copyright holder who authorizes use under
43620 this License of the Program or a work on which the Program is based. The
43621 work thus licensed is called the contributor's “contributor
43624 <para>A contributor's “essential patent claims" are all patent
43625 claims owned or controlled by the contributor, whether already acquired or
43626 hereafter acquired, that would be infringed by some manner, permitted by
43627 this License, of making, using, or selling its contributor version, but do
43628 not include claims that would be infringed only as a consequence of
43629 further modification of the contributor version. For purposes of this
43630 definition, “control" includes the right to grant patent sublicenses
43631 in a manner consistent with the requirements of this License.</para>
43633 <para>Each contributor grants you a non-exclusive, worldwide, royalty-free
43634 patent license under the contributor's essential patent claims, to make,
43635 use, sell, offer for sale, import and otherwise run, modify and propagate
43636 the contents of its contributor version.</para>
43638 <para>In the following three paragraphs, a “patent license" is any
43639 express agreement or commitment, however denominated, not to enforce a
43640 patent (such as an express permission to practice a patent or covenant not
43641 to sue for patent infringement). To “grant" such a patent license to
43642 a party means to make such an agreement or commitment not to enforce a
43643 patent against the party.</para>
43645 <para>If you convey a covered work, knowingly relying on a patent license,
43646 and the Corresponding Source of the work is not available for anyone to
43647 copy, free of charge and under the terms of this License, through a
43648 publicly available network server or other readily accessible means, then
43649 you must either (1) cause the Corresponding Source to be so available, or
43650 (2) arrange to deprive yourself of the benefit of the patent license for
43651 this particular work, or (3) arrange, in a manner consistent with the
43652 requirements of this License, to extend the patent license to downstream
43653 recipients. “Knowingly relying" means you have actual knowledge
43654 that, but for the patent license, your conveying the covered work in a
43655 country, or your recipient's use of the covered work in a country, would
43656 infringe one or more identifiable patents in that country that you have
43657 reason to believe are valid.</para>
43659 <para>If, pursuant to or in connection with a single transaction or
43660 arrangement, you convey, or propagate by procuring conveyance of, a
43661 covered work, and grant a patent license to some of the parties receiving
43662 the covered work authorizing them to use, propagate, modify or convey a
43663 specific copy of the covered work, then the patent license you grant is
43664 automatically extended to all recipients of the covered work and works
43665 based on it.</para>
43667 <para>A patent license is “discriminatory" if it does not include
43668 within the scope of its coverage, prohibits the exercise of, or is
43669 conditioned on the non-exercise of one or more of the rights that are
43670 specifically granted under this License. You may not convey a covered work
43671 if you are a party to an arrangement with a third party that is in the
43672 business of distributing software, under which you make payment to the
43673 third party based on the extent of your activity of conveying the work,
43674 and under which the third party grants, to any of the parties who would
43675 receive the covered work from you, a discriminatory patent license (a) in
43676 connection with copies of the covered work conveyed by you (or copies made
43677 from those copies), or (b) primarily for and in connection with specific
43678 products or compilations that contain the covered work, unless you entered
43679 into that arrangement, or that patent license was granted, prior to 28
43682 <para>Nothing in this License shall be construed as excluding or limiting
43683 any implied license or other defenses to infringement that may otherwise
43684 be available to you under applicable patent law.</para>
43686 <bridgehead id="NoSurrender" renderas="sect1">12. No Surrender of Others'
43687 Freedom.</bridgehead>
43689 <para>If conditions are imposed on you (whether by court order, agreement
43690 or otherwise) that contradict the conditions of this License, they do not
43691 excuse you from the conditions of this License. If you cannot convey a
43692 covered work so as to satisfy simultaneously your obligations under this
43693 License and any other pertinent obligations, then as a consequence you may
43694 not convey it at all. For example, if you agree to terms that obligate you
43695 to collect a royalty for further conveying from those to whom you convey
43696 the Program, the only way you could satisfy both those terms and this
43697 License would be to refrain entirely from conveying the Program.</para>
43699 <bridgehead id="UsedWithAGPL" renderas="sect1">13. Use with the
43700 <acronym>GNU</acronym> Affero General Public License.</bridgehead>
43702 <para>Notwithstanding any other provision of this License, you have
43703 permission to link or combine any covered work with a work licensed under
43704 version 3 of the <acronym>GNU</acronym> Affero General Public License into
43705 a single combined work, and to convey the resulting work. The terms of
43706 this License will continue to apply to the part which is the covered work,
43707 but the special requirements of the <acronym>GNU</acronym> Affero General
43708 Public License, section 13, concerning interaction through a network will
43709 apply to the combination as such.</para>
43711 <bridgehead id="RevisedVersions" renderas="sect1">14. Revised Versions of
43712 this License.</bridgehead>
43714 <para>The Free Software Foundation may publish revised and/or new versions
43715 of the <acronym>GNU</acronym> General Public License from time to time.
43716 Such new versions will be similar in spirit to the present version, but
43717 may differ in detail to address new problems or concerns.</para>
43719 <para>Each version is given a distinguishing version number. If the
43720 Program specifies that a certain numbered version of the
43721 <acronym>GNU</acronym> General Public License “or any later version"
43722 applies to it, you have the option of following the terms and conditions
43723 either of that numbered version or of any later version published by the
43724 Free Software Foundation. If the Program does not specify a version number
43725 of the <acronym>GNU</acronym> General Public License, you may choose any
43726 version ever published by the Free Software Foundation.</para>
43728 <para>If the Program specifies that a proxy can decide which future
43729 versions of the <acronym>GNU</acronym> General Public License can be used,
43730 that proxy's public statement of acceptance of a version permanently
43731 authorizes you to choose that version for the Program.</para>
43733 <para>Later license versions may give you additional or different
43734 permissions. However, no additional obligations are imposed on any author
43735 or copyright holder as a result of your choosing to follow a later
43738 <bridgehead id="WarrantyDisclaimer" renderas="sect1">15. Disclaimer of
43739 Warranty.</bridgehead>
43741 <para>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
43742 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
43743 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS" WITHOUT
43744 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
43745 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
43746 PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF
43747 THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
43748 THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
43750 <bridgehead id="LiabilityLimitation" renderas="sect1">16. Limitation of
43751 Liability.</bridgehead>
43753 <para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
43754 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
43755 CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
43756 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
43757 ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
43758 LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
43759 SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE
43760 WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
43761 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
43763 <bridgehead id="InterpretationSecs1516" renderas="sect1">17.
43764 Interpretation of Sections 15 and 16.</bridgehead>
43766 <para>If the disclaimer of warranty and limitation of liability provided
43767 above cannot be given local legal effect according to their terms,
43768 reviewing courts shall apply local law that most closely approximates an
43769 absolute waiver of all civil liability in connection with the Program,
43770 unless a warranty or assumption of liability accompanies a copy of the
43771 Program in return for a fee.</para>
43773 <bridgehead>END OF TERMS AND CONDITIONS</bridgehead>
43775 <bridgehead id="HowToApply" renderas="sect1">How to Apply These Terms to
43776 Your New Programs</bridgehead>
43778 <para>If you develop a new program, and you want it to be of the greatest
43779 possible use to the public, the best way to achieve this is to make it
43780 free software which everyone can redistribute and change under these
43783 <para>To do so, attach the following notices to the program. It is safest
43784 to attach them to the start of each source file to most effectively state
43785 the exclusion of warranty; and each file should have at least the
43786 “copyright" line and a pointer to where the full notice is
43790 <replaceable>one line to give the program's name and a brief idea of what it does.</replaceable>
43791 Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
43793 This program is free software: you can redistribute it and/or modify
43794 it under the terms of the <acronym>GNU</acronym> General Public License as published by
43795 the Free Software Foundation, either version 3 of the License, or
43796 (at your option) any later version.
43798 This program is distributed in the hope that it will be useful,
43799 but WITHOUT ANY WARRANTY; without even the implied warranty of
43800 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43801 <acronym>GNU</acronym> General Public License for more details.
43803 You should have received a copy of the <acronym>GNU</acronym> General Public License
43804 along with this program. If not, see <ulink
43805 url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.
43808 <para>Also add information on how to contact you by electronic and paper
43811 <para>If the program does terminal interaction, make it output a short
43812 notice like this when it starts in an interactive mode:</para>
43815 <replaceable>program</replaceable> Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
43816 This program comes with ABSOLUTELY NO WARRANTY; for details type ‘<literal>show w</literal>'.
43817 This is free software, and you are welcome to redistribute it
43818 under certain conditions; type ‘<literal>show c</literal>' for details.
43821 <para>The hypothetical commands ‘<literal>show w</literal>' and
43822 ‘<literal>show c</literal>' should show the appropriate parts of the
43823 General Public License. Of course, your program's commands might be
43824 different; for a GUI interface, you would use an “about box".</para>
43826 <para>You should also get your employer (if you work as a programmer) or
43827 school, if any, to sign a “copyright disclaimer" for the program, if
43828 necessary. For more information on this, and how to apply and follow the
43829 <acronym>GNU</acronym> <acronym>GPL</acronym>, see <ulink
43830 url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.</para>
43832 <para>The <acronym>GNU</acronym> General Public License does not permit
43833 incorporating your program into proprietary programs. If your program is a
43834 subroutine library, you may consider it more useful to permit linking
43835 proprietary applications with the library. If this is what you want to do,
43836 use the <acronym>GNU</acronym> Lesser General Public License instead of
43837 this License. But first, please read <ulink
43838 url="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</ulink>.</para>