1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- This document is maintained with oXygen. -->
3 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
6 <title>Koha 3.16 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">
20 <holder>Nicole C. Engard/ByWater Solutions/BibLibre</holder>
23 <legalnotice id="manuallegal">
24 <para>This manual is licensed under the <ulink url="http://www.gnu.org/licenses/gpl.html">GNU General Public License,
25 version 3</ulink> or later</para>
27 <para>Learn more about this license in the <link linkend="gpl">GPL3
28 Appendix</link></para>
31 <pubdate id="manualpubdate">Published: 2014</pubdate>
33 <chapter id="introchapter">
34 <title>Introduction</title>
36 <title id="introbasics">Koha Basics</title>
37 <para>Koha is the first free and open source software library automation package (ILS).
38 Development is sponsored by libraries of varying types and sizes, volunteers, and support
39 companies from around the world.</para>
40 <para>Learn more about Koha by visiting the official Koha website: <ulink
41 url="http://koha-community.org">http://koha-community.org</ulink></para>
43 <section id="introrecommend">
44 <title>Koha Recommendations</title>
45 <para>Full system recommendations can be found on the official Koha wiki along with the
46 developer documentation: <ulink url="http://wiki.koha-community.org">
47 http://wiki.koha-community.org</ulink></para>
48 <para>When working in the Koha staff client it is strongly recommended that you use the
49 Firefox browser. Koha's staff client is not supported in Internet Explorer and has not yet
50 been fully optimized for Google Chrome.</para>
52 <section id="usingmanual">
53 <title>Using this Manual</title>
54 <para>This manual is always changing and suggestions for edits can be sent to the
55 Documentation Manager via the <ulink
56 url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
57 list</ulink>. The manual is organized by Koha module. At the start of most sections (and
58 throughout) you will find 'Get there' tips. These lines tell you how to get to the section
60 <para>For example: <emphasis>Get there:</emphasis> More > Administration > Global System
64 <screeninfo>Get there: More > Administration > Global System Preferences</screeninfo>
67 <imagedata fileref="images/intro/getthere.png"/>
72 <para>The instruction tells you where to find the necessary menu option at the top of the Koha
74 <para>Links will be found throughout the manual to other sections in the manual and images
75 will depict what should be seen on the screen. </para>
76 <para>The manual can be searched using the custom Google search on the <ulink
77 url="http://koha-community.org/documentation/">Koha Documentation</ulink> page.</para>
79 <section id="contributing">
80 <title>Contributing to the Manual</title>
81 <para>This manual is an ever-changing document and edits to the manual are welcome at any
83 <para>The <ulink url="http://manual.koha-community.org/">Koha Manual</ulink> is managed by the
84 Documentation Manager, but that doesn't mean we can't all participate in making the best
85 manual possible. </para>
86 <para>The manual is stored in git at: <ulink
87 url="http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary"
88 >http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary</ulink></para>
89 <para>To edit the manual we recommend <ulink url="http://www.oxygenxml.com">oXygen</ulink> or
90 other XML/DocBook editor. We ask that every chapter and section have an ID tag associated
91 with it to enable permanent linking and searching. </para>
92 <para>Patches to the manual should be emailed to the <ulink
93 url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
94 list</ulink> and will be reviewed by the Documentation Manager before inclusion. </para>
98 <chapter id="administration">
99 <title>Administration</title>
101 <section id="globalsysprefs">
102 <title>Global System Preferences</title>
104 <para>Global system preferences control the way your Koha system works
105 in general. Set these preferences before anything else in Koha.</para>
109 <para><emphasis>Get there:</emphasis> More > Administration > Global System
115 <screeninfo>Global System Preferences Link and Search</screeninfo>
119 <imagedata fileref="images/admin/globalprefs/prefsearch.png"/>
124 <para>System preferences can be searched (using any part of the
125 preference name or description) using the search box on the
126 'Administration' page or the search box at the top of each system
127 preferences page.</para>
130 <screeninfo>Preferences search at the top of System Preference
135 <imagedata fileref="images/admin/globalprefs/prefsearch1.png"/>
140 <para>When editing preferences a '(modified)' tag will appear next to
141 items you change until you click the 'Save All' button:</para>
144 <screeninfo>After editing TagsModeration the '(modified)' label
149 <imagedata fileref="images/admin/globalprefs/saveallprefs.png"/>
154 <para>After saving your preferences you'll get a confirmation message
155 telling you what preferences were saved:</para>
158 <screeninfo>Preference save confirmation message</screeninfo>
162 <imagedata fileref="images/admin/globalprefs/saveconfirmation.png"/>
167 <para>Each section of preferences can be sorted alphabetically by
168 clicking the small down arrow to the right of the word 'Preference' in
169 the header column</para>
172 <screeninfo>Sort option at the top right of each section of
173 preferences</screeninfo>
177 <imagedata fileref="images/admin/globalprefs/sortprefs.png"/>
182 <para>If the preference refers to monetary values (like <link linkend="maxoutstanding"
183 >maxoutstanding</link>) the currency displayed will be the default you set in your <link
184 linkend="currexchangeadmin">Currency and Exchange Rate</link> administration area. In the
185 examples to follow they will all read USD for U.S. Dollars.<important>
186 <para>For libraries systems with unique URLs for each site the system preference can be
187 overridden by editing your koha-http.conf file this has to be done by a system
188 administrator or someone with access to your system files. For example if all libraries
189 but one want to have search terms highlighted in results you set the
190 OpacHighlightedWords preference to 'Highlight' then edit the koha-http.conf for the
191 library that wants this turned off by adding 'SetEnv
192 OVERRIDE_SYSPREF_OpacHighlightedWords "0"'. After restarting the web server that one
193 library will no longer see highlighted terms. Consult with your system administrator
194 for more information.</para>
197 <section id="acqprefs">
198 <title>Acquisitions</title>
200 <para><emphasis>Get there:</emphasis> More > Administration >
201 Global System Preferences > Acquisitions</para>
203 <section id="acqprefspolicy">
204 <title>Policy</title>
206 <section id="AcqCreateItem">
207 <title>AcqCreateItem</title>
209 <para>Default: placing an order</para>
211 <para>Asks: Create an item when ___.</para>
217 <para>cataloging a record</para>
221 <para>placing an order</para>
225 <para>receiving an order</para>
229 <para>Description:</para>
233 <para>This preference lets you decide when you'd like to
234 create an item record in Koha. If you choose to add an item
235 record when 'placing an order' then you will enter item
236 information in as you place records in your basket. If you
237 choose to add the item when 'receiving an order' you will be
238 asked for item record information when you're receiving orders
239 in acquisitions. If you choose to add the item when
240 'cataloging a record' then item records will not be created in
241 acquisitions at all, you will need to go to the cataloging
242 module to add the items.</para>
246 <section id="AcqItemSetSubfieldsWhenReceived">
247 <title>AcqItemSetSubfieldsWhenReceived</title>
248 <para>Asks: Upon receiving items, update their subfields if they were created when
249 placing an order (e.g. o=5|a="foo bar"). ___</para>
250 <para>Description:<itemizedlist>
252 <para>This preference allows you to set default values for items that you receive
253 via acquisitions. Enter the data as subfield=value and split your values with a
254 bar ( | ). For example you can remove the Ordered status on the item
255 automatically when you receive it just by entering 7=0 in this preference. That
256 will set the Not for Loan status (subfield 7) to 0 which is available.</para>
258 </itemizedlist></para>
261 <section id="AcqViewBaskets">
262 <title>AcqViewBaskets</title>
264 <para>Default: created by staff member</para>
266 <para>Asks: Show baskets ___</para>
272 <para>created by staff member</para>
276 <para>from staff member's branch</para>
280 <para>in system, regardless of owner</para>
284 <para>Description:</para>
288 <para>When in acquisitions this preference allows you to
289 control whose baskets you can see when looking at a vendor.
290 The default value of 'created by staff member' makes it so
291 that you only see the baskets you created. Choosing to see
292 baskets 'from staff member's branch' will show you the baskets
293 created by anyone at the branch you're logged in at. Finally,
294 you can choose to set this preference to show you all baskets
295 regardless of who created it ('in system, regardless of
296 owner). Regardless of which value you choose for this
297 preference, superlibrarians can see all baskets created in the
302 <section id="AcqWarnOnDuplicateInvoice">
303 <title>AcqWarnOnDuplicateInvoice</title>
304 <para>Default: Do not warn</para>
305 <para>Asks: ___ when the librarian tries to create an invoice with a duplicate
307 <para>Values: <itemizedlist>
309 <para>Do not warn</para>
314 </itemizedlist></para>
317 <section id="BasketConfirmations">
318 <title>BasketConfirmations</title>
320 <para>Default: always ask for confirmation</para>
322 <para>Asks: When closing or reopening a basket, ___.</para>
328 <para>always ask for confirmation</para>
332 <para>do not ask for confirmation</para>
336 <para>Descriptions:</para>
340 <para>This preference adds the option to skip confirmations on
341 closing and reopening a basket. If you skip the confirmation,
342 you do not create a new basket group.</para>
347 <section id="CurrencyFormat">
348 <title>CurrencyFormat</title>
350 <para>Default: 360,000.00 (US)</para>
352 <para>Asks: Display currencies using the following format
359 <para>360,000.00 (US)</para>
363 <para>360 000,00 (FR)</para>
371 <para>Default: 0</para>
373 <para>Asks: The default tax rate is ___</para>
375 <para>Description:</para>
379 <para>This preference will allow the library to define a
380 default Goods and Services Tax rate. The default of value of 0
381 will disable this preference.</para>
386 <para>Enter this value as a number (.06) versus a percent
390 <section id="MarcFieldsToOrder">
391 <title>MarcFieldsToOrder</title>
392 <para>Asks: Set the mapping values for a new order line created from a MARC record in a
394 <para>Description:<itemizedlist>
396 <para>This preference includes MARC fields to check for order information to use
397 when <link linkend="orderfromstagedfile">ordering from a staged file</link> in
398 acquisitions. You can use the following fields: price, quantity, budget_code,
399 discount, sort1, sort2.</para>
401 example:<programlisting>price: 947$a|947$c
403 budget_code: 922$a</programlisting></para>
405 </itemizedlist></para>
408 <section id="UniqueItemFields">
409 <title>UniqueItemFields</title>
411 <para>Default: barcode</para>
413 <para>Asks:___ (space-separated list of fields that should be
414 unique for items, must be valid SQL fields of <ulink url="http://schema.koha-community.org/tables/items.html">items</ulink>
417 <para>Description:</para>
421 <para>If this preference is left blank when adding items in
422 acquisitions there will be no check for uniqueness. This means
423 that a duplicate barcode can be created in acquisitions which
424 will cause errors later when checking items in and out.</para>
430 <section id="acqprefsprinting">
431 <title>Printing</title>
433 <section id="OrderPdfFormat">
434 <title>OrderPdfFormat</title>
436 <para>Default: pdfformat::layout2pages</para>
438 <para>Asks: Use ___ when printing basket groups.</para>
443 <section id="adminprefs">
444 <title>Administration</title>
446 <para>These preferences are general settings for your system.</para>
448 <para><emphasis>Get there:</emphasis> More > Administration >
449 Global System Preferences > Administration</para>
451 <section id="casauthentication">
452 <title>CAS Authentication</title>
454 <para>The Central Authentication Service (CAS) is a single sign-on
455 protocol for the web. If you don't know what this is, leave these
456 preferences set to their defaults.</para>
458 <section id="AllowPKIAuth">
459 <title>AllowPKIAuth</title>
461 <para>Default: no</para>
463 <para>Asks: Use ___ field for SSL client certificate
464 authentication</para>
474 <para>the common name</para>
478 <para>the email address</para>
483 <section id="casAuthentication">
484 <title>casAuthentication</title>
486 <para>Default: Don't use</para>
488 <para>Asks: ___ CAS for login authentication.</para>
491 <section id="casLogout">
492 <title>casLogout</title>
494 <para>Default: Don't logout</para>
496 <para>Asks: ___ of CAS when logging out of Koha.</para>
499 <section id="casServerUrl">
500 <title>casServerUrl</title>
502 <para>Asks: The CAS Authentication Server can be found at
507 <section id="adminprefsinterface">
508 <title>Interface options</title>
510 <para>These preference are related to your Koha interface</para>
512 <section id="DebugLevel">
513 <title>DebugLevel</title>
515 <para>Default: lots of</para>
517 <para>Asks: Show ___ debugging information in the browser when an
518 internal error occurs.</para>
524 <para>lots of - will show as much information as
529 <para>no - will only show basic error messages</para>
533 <para>some - will show only some of the information
538 <para>Description:</para>
542 <para>This preference determines how much information will be
543 sent to the user's screen when the system encounters an error.
544 The most detail will be sent when the value level is set at 2,
545 some detail will be sent when the value is set at 1, and only
546 a basic error message will display when the value is set at 0.
547 This setting is especially important when a system is new and
548 the administration is interested in working out the bugs
549 (errors or problems) quickly. Having detailed error messages
550 makes quick fixes more likely in problem areas.</para>
555 <section id="delimiter">
556 <title>delimiter</title>
558 <para>Default: semicolons</para>
560 <para>Asks: Separate columns in an exported report file with ___
571 <para>backslashes</para>
579 <para>semicolons</para>
591 <para>Description:</para>
595 <para>This preference determines how reports exported from
596 Koha will separate data. In many cases you will be able to
597 change this option when exporting if you'd like.</para>
602 <section id="KohaAdminEmailAddress">
603 <title>KohaAdminEmailAddress</title>
605 <para>This is the default 'From' address for emails unless there
606 is one for the particular branch, and is referred to when an
607 internal error occurs.</para>
609 <para>Asks: Use ___ as the email address for the administrator of
612 <para>Description:</para>
616 <para>This preference allows one email address to be used in
617 warning messages set to the OPAC. If no email address is set
618 for the branch this address will receive messages from patrons
619 regarding modification requests, purchase suggestions, and
620 questions or information regarding overdue notices. It is
621 recommended that a email address that can be accessed by
622 multiple staff members be used for this purpose so that if one
623 librarian is out the others can address these requests. This
624 email address can be changed when needed.</para>
629 <section id="noItemTypeImages">
630 <title>noItemTypeImages</title>
632 <para>Default: Show</para>
634 <para>Asks: ___ itemtype icons in the catalog.</para>
644 <para>Don't show</para>
648 <para>Description:</para>
652 <para>This preference allows the system administrator to
653 determine if users will be able to set and see an <link linkend="itemtypeadmin">item type icon</link> the catalog on
654 both the OPAC and the Staff Client. The images will display in
655 both the OPAC and the Staff Client/Intranet. If images of item
656 types are disabled, text labels for item types will still
657 appear in the OPAC and Staff Client.</para>
662 <section id="virtualshelves">
663 <title>virtualshelves</title>
665 <para>Default: Allow</para>
667 <para>Asks: ___ staff and patrons to create and view saved lists
678 <para>Don't Allow</para>
682 <para>Description:</para>
686 <para>This preference controls whether the lists functionality
687 will be available in the staff client and OPAC. If this is set
688 to "Don't allow" then no one will be able to save items to
689 public or private lists.</para>
695 <section id="adminprefslogin">
696 <title>Login options</title>
698 <para>These preferences are related to logging into your Koha
701 <section id="AutoLocation">
702 <title>AutoLocation</title>
704 <para>Default: Don't require</para>
706 <para>Asks: ___ staff to log in from a computer in the IP address
707 range specified by their library (if any).</para>
711 <para>Set IP address range in the library administration
716 <para><emphasis>Get there:</emphasis> More >
717 Administration > Basic Parameters > <link linkend="libsgroups">Libraries & Groups</link></para>
727 <para>Don't require</para>
735 <para>Description:</para>
739 <para>This preference protects the system by blocking
740 unauthorized users from accessing the staff client program and
741 settings. Authorized and unauthorized users are determined by
742 their computer's IP addresses. When the preference is set to
743 'Require', IP authorization is in effect and unauthorized IP
744 addresses will be blocked. This means that staff cannot work
745 from home unless their IP address has been authorized. When
746 set to 'Don't require', anyone with a staff client login will
747 have access no matter which IP address they are using.</para>
752 <section id="IndependentBranches">
753 <title>IndependentBranches</title>
754 <para>Default: Don't prevent</para>
755 <para>Asks: ___ staff (but not superlibrarians) from modifying objects (holds, items,
756 patrons, etc.) belonging to other libraries.</para>
760 <para>Don't prevent</para>
766 <para>Description:</para>
769 <para>This preference should only be used by library systems which are sharing a
770 single Koha installation among multiple branches but are considered independent
771 organizations, meaning they do not share material or patrons with other branches
772 and do not plan to change that in the future. If set to 'Prevent' it increases the
773 security between library branches by: prohibiting staff users from logging into
774 another branch from within the staff client, filtering out patrons from patron
775 searches who are not a part of the login branch conducting the search, limiting
776 the location choices to the login branch when adding or modifying an item record,
777 preventing users from other branch locations from placing holds or checking out
778 materials from library branches other than their own, and preventing staff from
779 editing item records which belong to other library branches. All of these security
780 safeguards can be overridden only by the superlibrarian, the highest level of
785 <para>It is important that this value be set before going live and that it NOT be
790 <section id="SessionStorage">
791 <title>SessionStorage</title>
793 <para>Default: in the MySQL database</para>
795 <para>Asks: Store login session information ___</para>
801 <para>as temporary files</para>
805 <para>in the MySQL database</para>
809 <para>in the PostgreSQL database</para>
814 <para>PostgreSQL is not yet supported</para>
821 <para>Description:</para>
825 <para>This preference allows administrators to choose what
826 format session data is stored in during web sessions.</para>
831 <section id="timeout">
832 <title>timeout</title>
834 <para>Default: 12000000</para>
836 <para>Asks: Automatically log out users after ___ seconds of inactivity.</para>
838 <para>Description:</para>
842 <para>This preference sets the length of time the Staff Client
843 or OPAC accounts can be left inactive before re-logging in is
844 necessary. The value of this preference is in seconds. At this
845 time, the amount of time before a session times out must be
846 the same for both the Staff Client and the OPAC.</para>
851 <section id="mozillapersona">
852 <title>Mozilla Persona</title>
853 <section id="persona">
854 <title>Persona</title>
855 <para>Default: Don't allow</para>
856 <para>Asks: ___ Mozilla persona for login.</para>
862 <screeninfo>Persona login on OPAC</screeninfo>
865 <imagedata fileref="images/admin/globalprefs/persona.png"/>
871 <para>Don't allow</para>
874 <para>Description:<itemizedlist>
876 <para>Mozilla Persona is an OpenID-like service that lets you log in to multiple
877 websites with your Mozilla credentials. If you allow Persona log in for Koha
878 then your patrons can log in to the OPAC using their Mozilla Persona. Learn
879 more about Persona on the <ulink url="http://www.mozilla.org/en-US/persona/">official Mozilla site</ulink>.<important>
880 <para>For Persona log in to work you will need you <link linkend="OPACBaseURL">OPACBaseURL</link> preference to be set correctly.</para>
883 </itemizedlist></para>
886 <section id="searchengineprefs">
887 <title>Search Engine</title>
888 <section id="SearchEngine">
889 <title>SearchEngine</title>
891 <para>This preference is highly experimental and should not be changed from the
892 default value in a production environment.</para>
894 <para>Default: Zebra</para>
895 <para>Asks: ___ is the search engine used. </para>
896 <para>Values:<itemizedlist>
903 </itemizedlist></para>
904 <para>Description:<itemizedlist>
906 <para>This preference will be used to control which search engine Koha uses for
907 catalog searches in the OPAC and the staff client.</para>
909 </itemizedlist></para>
914 <section id="authprefs">
915 <title>Authorities</title>
917 <para><emphasis>Get there:</emphasis> More > Administration >
918 Global System Preferences > Authorities</para>
920 <section id="generalauthorities">
921 <title>General</title>
923 <section id="AuthDisplayHierarchy">
924 <title>AuthDisplayHierarchy</title>
926 <para>Default: Don't display</para>
928 <para>Asks: ___ broader term/narrower term hierarchies when
929 viewing authorities.</para>
938 <screeninfo>AuthDisplayHierarchy</screeninfo>
942 <imagedata fileref="images/admin/globalprefs/AuthDisplayHierarchy.png"/>
949 <para>Don't display</para>
953 <para>Description:</para>
957 <para>If your authority records includes 5xx fields with
958 linked references to broader and/or narrower see also
959 references this preference will turn on a display of those
960 authorities at the top of the record.</para>
965 <section id="AutoCreateAuthorities">
966 <title>AutoCreateAuthorities</title>
968 <para>Default: do not generate</para>
970 <para>Asks: When editing records, ___ authority records that are
977 <para>do not generate</para>
981 <para>generate</para>
986 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
987 must be set to "allow" for this to have any effect</para>
990 <para>Description:</para>
994 <para>When this and <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
995 are both turned on, automatically create authority records for
996 headings that don't have any authority link when cataloging.
997 When BiblioAddsAuthorities is on and AutoCreateAuthorities is
998 turned off, do not automatically generate authority records,
999 but allow the user to enter headings that don't match an
1000 existing authority. When BiblioAddsAuthorities is off, this
1001 has no effect.</para>
1006 <section id="BiblioAddsAuthorities">
1007 <title>BiblioAddsAuthorities</title>
1009 <para>Default: allow</para>
1011 <para>Asks: When editing records, ___ them to automatically create
1012 new authority records if needed, rather than having to reference
1013 existing authorities.</para>
1015 <para>Values:</para>
1023 <para>This setting allows you to type values in the fields
1024 controlled by authorities and then adds a new authority if
1025 one does not exist</para>
1031 <para>don't allow</para>
1035 <para>This setting will lock the authority controlled
1036 fields, forcing you to search for an authority versus
1037 allowing you to type the information in yourself.</para>
1044 <section id="dontmerge">
1045 <title>dontmerge</title>
1047 <para>Default: Don't</para>
1049 <para>Asks: ___ automatically update attached biblios when
1050 changing an authority record.</para>
1052 <para>Values:</para>
1064 <para>Description:</para>
1068 <para>This preference tells Koha how to handle changes to your
1069 Authority records. If you edit an authority record and this
1070 preference is set to 'Do' Koha will update all of the bib
1071 records linked to the authority with the new authority
1072 record's data. If this is set to "Don't" then Koha won't edit
1073 bib records when changes are made to authorities.</para>
1078 <para>If this is set to merge you will need to ask your administrator to enable the
1079 <link linkend="mergeauthcron">merge_authority.pl cronjob</link>.</para>
1083 <section id="MARCAuthorityControlField008">
1084 <title>MARCAuthorityControlField008</title>
1086 <para>Default: || aca||aabn | a|a d</para>
1088 <para>Asks: Use the following text for the contents of MARC21 authority control field
1089 008 position 06-39 (fixed length data elements).</para>
1092 <para>Do not include the date (position 00-05) in this
1093 preference, Koha will calculate automatically and put that in
1094 before the values in this preference.</para>
1095 </important>Description:</para>
1099 <para>This preference controls the default value in the 008
1100 field on Authority records. It does not effect bibliographic
1105 <section id="UNIMARCAuthorityField100">
1106 <title>UNIMARCAuthorityField100</title>
1107 <para>Default: afrey50 ba0</para>
1108 <para>Asks: Use the following text for the contents of UNIMARC authority field 100
1109 position (fixed length data elements). <important>
1110 <para>Do not include the date (position 00-07) in this preference, Koha will
1111 calculate automatically and put that in before the values in this
1114 <para>Description:<itemizedlist>
1116 <para>This preference controls the default value in the 100 field on Authority
1117 records cataloged in UNIMARC. It does not effect bibliographic records.</para>
1119 </itemizedlist></para>
1122 <section id="UseAuthoritiesForTracings">
1123 <title>UseAuthoritiesForTracings</title>
1125 <para>Default: Don't use</para>
1127 <para>Asks: ___ authority record numbers instead of text strings
1128 for searches from subject tracings.</para>
1130 <para>Values:</para>
1134 <para>Don't use</para>
1138 <para>Search links look for subject/author keywords
1139 (example: opac-search.pl?q=su:Business%20networks)</para>
1149 <para>Search links look for an authority record (example:
1150 opac-search.pl?q=an:354)</para>
1156 <para>Description:</para>
1160 <para>For libraries that have authority files, they may want
1161 to make it so that when a link to an authorized subject or
1162 author is clicked on the OPAC or staff client it takes the
1163 searcher only to a list of results with that authority record.
1164 Most libraries do not have complete authority files and so
1165 setting this preference to 'Don't use' will allow searchers to
1166 click on links to authors and subject headings and perform a
1167 keyword search against those fields, finding all possible
1168 relevant results instead.</para>
1174 <section id="linkerauthorities">
1175 <title>Linker</title>
1177 <para>These preferences will control how Koha links bibliographic records to authority
1178 records. All bibliographic records added to Koha after these preferences are set will
1179 link automatically to authority records, for records added before these preferences are
1180 set there is a script (misc/link_bibs_to_authorities.pl) that your system administrator
1181 can run to link records together.</para>
1183 <section id="CatalogModuleRelink">
1184 <title>CatalogModuleRelink</title>
1186 <para>Default: Do not</para>
1188 <para>Asks: ___ automatically relink headings that have previously
1189 been linked when saving records in the cataloging module.</para>
1191 <para>Values:</para>
1203 <para>Description:</para>
1207 <para>Longtime users of Koha don't expect the authority and
1208 bib records to link consistently. This preference makes it
1209 possible to disable authority relinking in the cataloging
1210 module only (i.e. relinking is still possible if
1211 link_bibs_to_authorities.pl is run). Note that though the
1212 default behavior matches the previous behavior of Koha
1213 (retaining links to outdated authority records), it does not
1214 match the intended behavior (updating biblio/authority link
1215 after bibliographic record is edited). Libraries that want the
1216 intended behavior of authority control rather than the way
1217 Koha used to handle linking should set CatalogModuleRelink to
1218 'Do'. Once setting this to 'Do' the following preferences can
1224 <section id="LinkerKeepStale">
1225 <title>LinkerKeepStale</title>
1227 <para>Default: Do not</para>
1229 <para>Asks: ___ keep existing links to authority records for
1230 headings where the linker is unable to find a match.</para>
1232 <para>Values:</para>
1244 <para>Description:</para>
1248 <para>When set to 'Do', the linker will never remove a link to
1249 an authority record, though, depending on the value of <link linkend="LinkerRelink">LinkerRelink</link>, it may change the
1255 <section id="LinkerModule">
1256 <title>LinkerModule</title>
1258 <para>Default: Default</para>
1260 <para>Asks: Use the ___ linker module for matching headings to
1261 authority records.</para>
1263 <para>Values:</para>
1267 <para>Default</para>
1271 <para>Retains Koha's previous behavior of only creating
1272 links when there is an exact match to one and only one
1273 authority record; if the <link linkend="LinkerOptions">LinkerOptions</link> preference is
1274 set to 'broader_headings', it will try to link headings to
1275 authority records for broader headings by removing
1276 subfields from the end of the heading</para>
1282 <para>First match</para>
1286 <para>Creates a link to the first authority record that
1287 matches a given heading, even if there is more than one
1288 authority record that matches</para>
1294 <para>Last match</para>
1298 <para>Creates a link to the last authority record that
1299 matches a given heading, even if there is more than one
1300 record that matches</para>
1306 <para>Description:</para>
1310 <para>This preference tells Koha which match to use when
1311 searching for authority matches when saving a record.</para>
1316 <section id="LinkerOptions">
1317 <title>LinkerOptions</title>
1319 <para>Asks: Set the following options for the authority linker
1321 <para>This feature is experimental and shouldn't be used in a
1322 production environment until further expanded upon.</para>
1325 <para>Description:</para>
1329 <para>This is a pipe separated (|) list of options. At the
1330 moment, the only option available is "broader_headings." With
1331 this option set to "broader_headings", the linker will try to
1332 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1334 <para>First: Camins-Esakov, Jared--Coin
1335 collections--Catalogs--Early works to 1800</para>
1337 <para>Next: Camins-Esakov, Jared--Coin
1338 collections--Catalogs</para>
1340 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1342 <para>Next: Camins-Esakov, Jared (matches! if a previous
1343 attempt had matched, it would not have tried this)</para>
1348 <section id="LinkerRelink">
1349 <title>LinkerRelink</title>
1351 <para>Default: Do</para>
1353 <para>Asks: ___ relink headings that have previously been linked
1354 to authority records.</para>
1356 <para>Values:</para>
1368 <para>Description:</para>
1372 <para>When set to 'Do', the linker will confirm the links for
1373 headings that have previously been linked to an authority
1374 record when it runs, correcting any incorrect links it may
1375 find. When set to 'Do not', any heading with an existing link
1376 will be ignored, even if the existing link is invalid or
1384 <section id="catprefs">
1385 <title>Cataloging</title>
1387 <para><emphasis>Get there:</emphasis> More > Administration >
1388 Global System Preferences > Cataloging</para>
1390 <section id="catdisplayprefs">
1391 <title>Display</title>
1394 <section id="AcquisitionDetails">
1395 <title>AcquisitionDetails</title>
1396 <para>Default: Display</para>
1397 <para>Asks: ___ acquisition details on the biblio detail page. </para>
1398 <para>Values:<itemizedlist>
1400 <para>Display</para>
1403 <para>Don't display</para>
1405 </itemizedlist></para>
1406 <para>Description:<itemizedlist>
1408 <para>This preference controls whether a tab will show on the detail page in the
1409 staff client that includes detailed acquisitions information for the title. This
1410 tab will include links to order information stored in the acquisitions module.<screenshot>
1411 <screeninfo>AcquisitionDetails</screeninfo>
1414 <imagedata fileref="images/admin/globalprefs/AcquisitionDetails.png"/>
1417 </screenshot></para>
1419 </itemizedlist></para>
1422 <section id="authoritysep">
1423 <title>authoritysep</title>
1425 <para>Default: --</para>
1427 <para>Asks: Separate multiple displayed authors, series or
1428 subjects with ___.</para>
1431 <section id="hide_marc">
1432 <title>hide_marc</title>
1434 <para>Default: Display</para>
1436 <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1439 <para>Values:</para>
1443 <para>Display -- shows the tag numbers on the cataloging
1447 <screeninfo>MARC editor with tags showing</screeninfo>
1451 <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1458 <para>Don't display -- shows just descriptive text when
1462 <screeninfo>MARC editor without tags showing</screeninfo>
1466 <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1474 <section id="IntranetBiblioDefaultView">
1475 <title>IntranetBiblioDefaultView</title>
1477 <para>Default: ISBD form</para>
1479 <para>Asks: By default, display biblio records in ___</para>
1481 <para>Values:</para>
1485 <para>ISBD form -- displays records in the staff client in the
1486 old card catalog format</para>
1490 <para>See <link linkend="isbdpref">ISBD</link> preference
1491 for more information</para>
1497 <para>Labelled MARC form -- displays records in the staff
1498 client in MARC with text labels to explain the different
1503 <para>MARC form -- displays records in the staff client in
1508 <para>normal form -- visual display in the staff client (for
1509 the average person)</para>
1513 <para>Description:</para>
1517 <para>This setting determines the bibliographic record display
1518 when searching the catalog on the staff client. This setting
1519 does not affect the display in the OPAC which is changed using
1520 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1521 preference under the OPAC preference tab. This setting changes
1522 the look of the record when first displayed. The MARC and ISBD
1523 views can still be seen by clicking in the sidebar.</para>
1528 <section id="isbdpref">
1531 <para>Default: <link linkend="isbddefault">MARC21 Default
1532 Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1533 Appendix</link></para>
1535 <para>Asks: Use the following as the ISBD template:</para>
1537 <para>Description:</para>
1541 <para>This determines how the ISBD information will display.
1542 Elements in the list can be reordered to produce a different
1543 ISBD view. ISBD, the International Standard Bibliographic
1544 Description, was first introduced by IFLA (International
1545 Federation of Library Associations) in 1969 in order to
1546 provide guidelines for descriptive cataloging. The purpose of
1547 ISBD is to aid the international exchange of bibliographic
1548 records for a variety of materials.</para>
1553 <section id="LabelMARCView">
1554 <title>LabelMARCView</title>
1556 <para>Default: Don't</para>
1558 <para>Asks: ___ collapse repeated tags of the same type into one
1561 <para>Values:</para>
1565 <para>Do -- will combine all identical tag numbers under one
1566 heading in the MARC view in the OPAC and Staff Client</para>
1569 <screeninfo>MARC View in the Staff Client with LabelMARCView
1570 set to Do</screeninfo>
1574 <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
1581 <para>Don't -- will list all of the tags individually in the
1582 MARC view in the OPAC and Staff Client</para>
1585 <screeninfo>MARC View in the Staff Client with LabelMARCView
1586 set to Don't</screeninfo>
1590 <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
1597 <section id="NotesBlacklist">
1598 <title>NotesBlacklist</title>
1599 <para>Asks: Don't show these ___ note fields in title notes separator (OPAC record
1600 details) and in the description separator (Staff client record details). </para>
1601 <para>Description:<itemizedlist>
1603 <para>This preference lets you define which of your note fields are hidden from
1604 the title notes (OPAC) and descriptions (Staff) tabs. Enter the values as a
1605 comma separated list. For example to hide the local note and the bibliography
1606 note in MARC21 enter 504, 590.</para>
1608 </itemizedlist></para>
1611 <section id="OpacSuppression">
1612 <title>OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and
1613 OpacSuppressionMessage</title>
1614 <para>OpacSuppression Default: Don't hide</para>
1616 <para>Asks: ___ items marked as suppressed from OPAC search results. Note that you must
1617 have the Suppress index set up in Zebra and at least one suppressed item, or your
1618 searches will be broken. Restrict the suppression to IP adresses outside of the IP
1619 range ___ (Leave blank if not used. Define a range like 192.168..) Redirect the opac
1620 detail page for suppressed records to ___ Display the following message on the
1621 redirect page for suppressed biblios ___.</para>
1623 <para>OpacSuppression Values:</para>
1627 <para>Don't hide</para>
1631 <para>Will show records in OPAC search results if they are marked
1642 <para>Will not show records in OPAC search results if they're marked as
1648 <para>OpacSuppressionRedirect Values:<itemizedlist>
1650 <para>an explanatory page ('This record is blocked').</para>
1653 <para>the 404 error page ('Not found').</para>
1655 </itemizedlist></para>
1657 <para>Description:</para>
1661 <para>These preferences control hiding of bibliographic records from display in the
1662 OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have
1663 the value "1" in the field mapped with Suppress index (942$n field in MARC21, no
1664 official field in UNIMARC). The indexer then hides it from display in OPAC but
1665 will still display it in the Staff Client. If you want to further control
1666 suppression you can set an IP address range to still show suppressed items to.
1667 Define a range like 192.168.. If you don't want to limit suppression in this way,
1668 leave the IP field blank. You can also decide what the patrons will see in the
1669 OPAC when a title is suppressed by setting the OpacSuppressionRedirect and
1670 OpacSuppressionMessage preferences. You can either show the patron a 404 page if
1671 they try to see a suppressed record or you can create a custom page by entering
1672 the HTML in the OpacSuppressionMessage part of this preference.</para>
1675 <para>An <link linkend="authorizedvalues">authorized value</link> for the MARC21
1676 942$n field (or the equivalent UNIMARC field) should be set to eliminate
1677 errors. One example would be to create an authorized value titled SUPPRESS
1678 with a value of 0 for don't suppress and 1 for suppress.</para>
1685 <para>If this preference is set to 'hide' and you have the 942n
1686 field set to 1, it will hide the entire bib record - not just an
1687 individual item.</para>
1691 <para>You must have the Suppress index set up in Zebra and at least one record with
1692 the value "1" in the field mapped with this index, or your searches will be
1693 completely broken in OPAC (you won't get any results at all).</para>
1696 <section id="SeparateHoldings">
1697 <title>SeparateHoldings & SeparateHoldingsBranch </title>
1698 <para>SeparateHoldings default: Don't separate</para>
1699 <para>SeparateHoldingsBranch default: home library </para>
1700 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
1701 ___ is the logged in user's library. The second tab will contain all other items. </para>
1702 <para>SeparateHoldings values:<itemizedlist>
1704 <para>Don't separate</para>
1707 <para>Separate</para>
1709 </itemizedlist></para>
1710 <para>SeparateHoldingsBranch values:<itemizedlist>
1712 <para>holding library</para>
1715 <para>home library</para>
1717 </itemizedlist></para>
1718 <para>Description:</para>
1721 <para>This preference lets you decide if you would like to have the holding
1722 information on the bibliographic detail page in the staff client split in to
1723 multiple tabs. The default is to show all holdings on one tab.</para>
1725 <screeninfo>Separate holdings tabs</screeninfo>
1728 <imagedata fileref="images/admin/globalprefs/SeparateHoldings.png"/>
1736 <section id="URLLinkText">
1737 <title>URLLinkText</title>
1739 <para>Default: Online Resource</para>
1741 <para>Asks: Show ___ as the text of links embedded in MARC
1744 <para>Description:</para>
1748 <para>If the 856 field does not have a subfield 3 or y
1749 defined, the OPAC will say 'Click here to access online.' If
1750 you would like the field to say something else enter that in
1756 <section id="UseControlNumber">
1757 <title>UseControlNumber</title>
1759 <para>Default: Don't use</para>
1761 <para>Asks: ___ record control number ($w subfields) and control
1762 number (001) for linking of bibliographic records.</para>
1764 <para>Values:</para>
1768 <para>Don't use</para>
1772 <para>When clicking on links to titles that appear next to
1773 'Continues' and 'Continued by' in the detail display Koha
1774 will perform a title search</para>
1784 <para>When clicking on links to titles that appear next to
1785 'Continues' and 'Continued by' in the detail display Koha
1786 will perform a control number (MARC field 001)
1794 <para>Unless you are going in and manually changing 773$w to
1795 match your rigorously-defined bibliographic relationships, you
1796 should set this preference to "Don't use" and instead set <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
1800 <para>Description:</para>
1804 <para>If you have a serial called "Journal of Interesting
1805 Things" which has a separate record from when it was called
1806 "Transactions of the Interesting Stuff Society," you could add
1807 linking fields to indicate the relationship between the two
1808 records. UseControlNumber allows you to use your local
1809 accession numbers for those links. In MARC21, the relevant
1810 sections of the two records might look like
1811 this:<programlisting> =001 12345
1812 =110 2_$aInteresting Stuff Society.
1813 =245 10$aTransactions of the Interesting Stuff Society.
1814 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1817 =110 2_$aInteresting Stuff Society.
1818 =245 10$aJournal of Interesting Things.
1819 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
1821 <para>With UseControlNumber set to 'Use', the 78x links will
1822 use the Control Numbers is subfield $w, instead of doing a
1823 title search on "Journal of Interesting Things" and
1824 "Transactions of the Interesting Stuff Society"
1825 respectively.</para>
1830 <section id="catimportprefs">
1831 <title>Importing</title>
1832 <section id="AggressiveMatchOnISBN">
1833 <title>AggressiveMatchOnISBN</title>
1834 <para>Default: don't</para>
1835 <para>Asks: When matching on ISBN with the record import tool, ___ attempt to match
1836 aggressively by trying all variations of the ISBNs in the imported record as a phrase
1837 in the ISBN fields of already cataloged records. </para>
1838 <para>Values:<itemizedlist>
1845 </itemizedlist>Description:<itemizedlist>
1847 <para>This preference allows you to choose to alter the ISBN matching rule used
1848 when staging records for import to be more aggressive. This means that all text
1849 will be stripped from the ISBN field so that a pure number match is possible. If
1850 this preference is set to "Don't" then Koha will find a match only if the ISBN
1851 fields are identical.</para>
1853 </itemizedlist><important>
1854 <para>Note that this preference has no effect if <link linkend="UseQueryParser"
1855 >UseQueryParser</link> is on. </para>
1860 <section id="catinterfaceprefs">
1861 <title>Interface</title>
1865 <section id="advancedMARCeditor">
1866 <title>advancedMARCeditor</title>
1868 <para>Default: Don't display</para>
1870 <para>Asks: ___ descriptions of fields and subfields in the MARC
1873 <para>Description:</para>
1877 <para>This preference determines whether or not MARC field
1878 names will be present when editing or creating MARC
1883 <para>Values:</para>
1887 <para>Display</para>
1890 <screeninfo>MARC editor with text labels</screeninfo>
1894 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
1901 <para>Don't display</para>
1904 <screeninfo>MARC editor without text labels</screeninfo>
1908 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
1916 <section id="DefaultClassificationSource">
1917 <title>DefaultClassificationSource</title>
1919 <para>Default: Dewey Decimal System</para>
1921 <para>Asks: Use ___ as the default classification source.</para>
1923 <para>Values:</para>
1927 <para>ANSCR (Sound Recordings)</para>
1931 <para>Dewey Decimal Classification</para>
1935 <para>Library of Congress Classification</para>
1939 <para>Other/Generic Classification Scheme</para>
1943 <para>SuDoc Classification (U.S. GPO)</para>
1947 <para>Universal Decimal Classification</para>
1952 <section id="EasyAnalyticalRecords">
1956 <firstname>Linda</firstname>
1957 <surname>Culberson</surname>
1959 <orgname>Ms. Dept. of Archives and History</orgname>
1964 <firstname>Nicole C.</firstname>
1965 <surname>Engard</surname>
1966 <contrib>Fixed typos, changed content
1967 where necessary and added new screenshots.</contrib>
1971 <pubdate>October 2011</pubdate>
1974 <title>EasyAnalyticalRecords</title>
1975 <para>Default: Don't Display</para>
1977 <para>Asks: ___ easy ways to create analytical record
1978 relationships</para>
1980 <para>Values:</para>
1984 <para>Display</para>
1988 <para>Don't Display</para>
1993 <para>If you decide to use this feature you'll want to make sure
1994 that your <link linkend="UseControlNumber">UseControlNumber</link> preference is
1995 set to "Don't use" or else the "Show analytics" links in the
1996 staff client and the OPAC will be broken.</para>
1999 <para>Description:</para>
2003 <para>An analytic entry in a catalog is one that describes a
2004 part of a larger work that is also described in the catalog.
2005 In bibliographic cataloging, analytic entries may be made for
2006 chapters in books or special issues of articles in
2007 periodicals. In archival cataloging, analytic entries may be
2008 made for series or items within a collection. This feature in
2009 Koha allows for an easy way of linking analytic entries to the
2010 host records, and this system preference adds several new menu
2011 options to the staff cataloging detail pages to allow that to
2018 <section id="catrecordprefs">
2019 <title>Record Structure</title>
2023 <section id="AlternateHoldingsField">
2024 <title>AlternateHoldingsField &
2025 AlternateHoldingsSeparator</title>
2027 <para>Asks: Display MARC subfield ___ as holdings information for
2028 records that do not have items, with the subfields separated by
2031 <para>Description:</para>
2035 <para>Sometimes libraries migrate to Koha with their holding
2036 info in the 852 field (OCLC holdings information field) and
2037 choose not to transfer that information into the 952 (Koha
2038 holdings information field) because they don't plan on
2039 circulating those items. For those libraries or other
2040 libraries that have data in the 852 fields of their records
2041 that they want to display, these preferences let you choose to
2042 display holdings info from a field other than the 952 field.
2043 The AlternateHoldingsField preference can contain multiple
2044 subfields to look in; for instance 852abhi would look in 852
2045 subfields a, b, h, and i.</para>
2049 <para>With AlternateHoldingsField set to 852abhi and
2050 AlternateHoldingsSeparator set to a space the holdings would
2051 look like the following:</para>
2054 <screeninfo>Alternate Holdings Display</screeninfo>
2058 <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
2066 <section id="autoBarcode">
2067 <title>autoBarcode</title>
2069 <para>Default: generated in the form
2070 <branchcode>yymm0001</para>
2072 <para>Asks: Barcodes are ___</para>
2074 <para>Values:</para>
2078 <para>generated in the form <branchcode>yymm0001</para>
2082 <para>generated in the form <year>-0001, <year>-0002</para>
2086 <para>generated in the form 1, 2, 3</para>
2090 <para>incremental EAN-13 barcodes</para>
2094 <para>not generated automatically</para>
2098 <para>Description:</para>
2102 <para>This setting is for libraries wishing to generate
2103 barcodes from within Koha (as opposed to scanning in
2104 pre-printed barcodes or manually assigning them). The default
2105 behavior makes it so that when you click in the barcode field
2106 (952$p in MARC21) it will populate with the automatic barcode
2107 you have chosen. If you would rather it only enter an
2108 automatic barcode when you click on the plugin (the ... to the
2109 right of the field) you can change the plugin used for that
2110 field in the framework. Set the plugin for 952$p (if using
2111 MARC21 or equivalent field mapped to items.barcode in your
2112 local MARC format) for your frameworks to barcode_manual.pl
2113 instead of barcode.pl. Learn more about editing frameworks
2114 under the <link linkend="marcbibframeworks">MARC Bibliographic
2115 Frameworks</link> section of this manual.</para>
2120 <section id="DefaultLanguageField008">
2121 <title>DefaultLanguageField008</title>
2122 <para>Default: Empty defaults to eng</para>
2124 <para>Asks: Fill in the default language for field 008 Range 35-37 of MARC21 records
2127 <para>Description:</para>
2131 <para>This preference will allow you to set the language for your MARC21 008 field
2132 by default. If this is left empty it will default to English (eng). See the <ulink
2133 url="http://www.loc.gov/marc/languages/language_code.html">MARC Code List for
2134 Languages</ulink> for additional values for this preference.</para>
2138 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2142 <section id="item-level_itypes">
2143 <title>item-level_itypes</title>
2145 <para>Default: specific item</para>
2147 <para>Asks: Use the item type of the ___ as the authoritative item
2148 type (for determining circulation and fines rules, etc).</para>
2150 <para>Values:</para>
2154 <para>biblio record</para>
2158 <para>specific item</para>
2162 <para>Description:</para>
2166 <para>This preference determines whether the item type Koha
2167 uses for issuing rules will be an attribute of the
2168 bibliographic record or the item record. Most libraries refer
2169 to the item record for item types. It also determines if the
2170 item type icon appears on the OPAC search results. If you have
2171 the preference set to 'biblio record' then Koha displays the
2172 item type icon on the search results to the left of the result
2176 <screeninfo>Item Type Icons to the Left of Result
2177 Information</screeninfo>
2181 <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
2189 <section id="itemcallnumber">
2190 <title>itemcallnumber</title>
2192 <para>Default: 082ab</para>
2194 <para>Asks: Map the MARC subfield to an item's callnumber.</para>
2197 <para>This can contain multiple subfields to look in; for
2198 instance 082ab would look in 082 subfields a and b.</para>
2201 <para>Description:</para>
2205 <para>This setting determines which MARC field will be used to determine the call
2206 number that will be entered into item records automatically (952$o). The value is
2207 set by providing the MARC field code (050, 082, 090, 852 are all common in MARC21)
2208 and the subfield codes without the delimiters ($a, $b would be ab).</para>
2212 <para>Examples:</para>
2216 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
2217 item record: 852hi</para>
2222 <section id="marcflavour">
2223 <title>marcflavour</title>
2225 <para>Default: MARC21</para>
2227 <para>Asks: Interpret and store MARC records in the ___
2230 <para>Values:</para>
2234 <para>MARC21<itemizedlist>
2236 <para>The standard style for the US, Canada, Australia, New Zealand, United
2237 Kingdom, Germany and other countries</para>
2239 </itemizedlist></para>
2243 <para>UNIMARC<itemizedlist>
2245 <para>The standard style used in France, Italy, Portugal, Russia, and other
2248 </itemizedlist></para>
2251 <para>NORMARC<itemizedlist>
2253 <para>The standard style for Norway</para>
2255 </itemizedlist></para>
2258 <para>Description:</para>
2261 <para>This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used
2262 for encoding.</para>
2266 <para>Changing the value of this preference will not convert your records from one
2267 MARC style to an other.</para>
2271 <section id="MARCOrgCode">
2272 <title>MARCOrgCode</title>
2274 <para>Default: OSt</para>
2276 <para>Asks: Fill in the MARC organization code ___ by default in new MARC21 records
2277 (leave blank to disable). </para>
2279 <para>Description:</para>
2283 <para>The MARC Organization Code is used to identify libraries
2284 with holdings of titles and more.</para>
2288 <para>Learn more and find your library's MARC21 code on the <ulink
2289 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC Code list for
2290 Organizations</ulink> or in Canada on the <ulink
2291 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
2292 Symbols Directory</ulink>.<tip>
2293 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2297 <section id="NewItemsDefaultLocation">
2298 <title>NewItemsDefaultLocation</title>
2300 <para>Asks: When items are created, give them the temporary
2301 location of ___ (should be a location code, or blank to
2304 <section id="PrefillItem">
2305 <title>PrefillItem</title>
2306 <para>Default: the new item is not prefilled with last created item values.</para>
2307 <para>Asks: When a new item is added ___</para>
2308 <para>Values:<itemizedlist>
2310 <para>the new item is not prefilled with last created item values.</para>
2313 <para>the new item is prefilled with last created item values.</para>
2315 </itemizedlist></para>
2316 <para>Description:<itemizedlist>
2318 <para>This preference controls the behavior used when adding new items. Using the
2319 options here you can choose to have your next new item prefill with the values
2320 used in the last item was added to save time typing values or to have the item
2321 form appear completely blank. Using <link linkend="SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</link> you can control specifically which fields
2322 are prefilled.</para>
2324 </itemizedlist></para>
2326 <section id="SubfieldsToUseWhenPrefill">
2327 <title>SubfieldsToUseWhenPrefill</title>
2328 <para>Asks: Define a list of subfields to use when prefilling items ___<important>
2329 <para>Separate values with a space.</para>
2331 <para>Description:<itemizedlist>
2333 <para>When the <link linkend="PrefillItem">PrefillItem</link> preference is set to
2334 prefill item values with those from the last added item, this preference can
2335 control which fields are prefilled (and which are not). Enter a space separated
2336 list of fields that you would like to prefill when adding a new item.</para>
2338 </itemizedlist></para>
2341 <section id="z3950NormalizeAuthor">
2342 <title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
2344 <para>Defaults: Don't copy & 701,702,700</para>
2346 <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
2347 commas) to the correct author tags when importing a record using
2350 <para>Description for z3950NormalizeAuthor:</para>
2354 <para>This preference allows for 'Personal Name Authorities'
2355 to replace authors as the bibliographic authority. This
2356 preference should only be considered by libraries using
2361 <para>Values for z3950NormalizeAuthor:</para>
2369 <para>Don't copy</para>
2373 <para>Description for z3950AuthorAuthFields:</para>
2377 <para>This preference defines which MARC fields will be used
2378 for 'Personal Name Authorities' to replace authors as the
2379 bibliographic authorities. This preference only applies to
2380 those using UNIMARC encoding. The MARC fields selected here
2381 will only be used if 'z3950NormalizeAuthor' is set to "Copy".
2382 The default field are 700, 701, and 702.</para>
2388 <section id="catspineprefs">
2389 <title>Spine Labels</title>
2393 <section id="SpineLabelAutoPrint">
2394 <title>SpineLabelAutoPrint</title>
2396 <para>Default: don't</para>
2398 <para>Asks: When using the quick spine label printer, ___
2399 automatically pop up a print dialog.</para>
2401 <para>Values:</para>
2414 <section id="SpineLabelFormat">
2415 <title>SpineLabelFormat</title>
2417 <para>Default: <itemcallnumber><copynumber></para>
2419 <para>Asks: Include the following fields on a quick-printed spine
2420 label: (Enter in columns from the biblio, biblioitems or items
2421 tables, surrounded by < and >.)</para>
2424 <section id="SpineLabelShowPrintOnBibDetails">
2425 <title>SpineLabelShowPrintOnBibDetails</title>
2427 <para>Default: Don't display</para>
2429 <para>Asks: ___ buttons on the bib details page to print item
2430 spine labels.</para>
2432 <para>Values:</para>
2436 <para>Display</para>
2439 <screeninfo>'Print Label' link appears on bibliographic
2440 record in the staff client</screeninfo>
2444 <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2451 <para>Don't display</para>
2458 <section id="circprefs">
2459 <title>Circulation</title>
2461 <para><emphasis>Get there:</emphasis> More > Administration >
2462 Global System Preferences > Circulation</para>
2463 <section id="checkinpolicyprefs">
2464 <title>Checkin Policy</title>
2466 <section id="AllowMultipleIssuesOnABiblio">
2467 <title>AllowMultipleIssuesOnABiblio</title>
2468 <para>Default: Allow</para>
2469 <para>Asks: ___ patrons to check out multiple items from the same record, except for
2470 records with subscriptions.</para>
2471 <para>Values:<itemizedlist>
2476 <para>Don't allow</para>
2478 </itemizedlist></para>
2479 <para>Description:<itemizedlist>
2481 <para>If this preference is set to 'Allow' then patrons will be able to check out
2482 multiple copies of the same title at the same time. If it's set to "Don't allow"
2483 then patrons will only be allowed to check out one item attached to a record at
2484 a time. Regardless of the option chosen in this preference records with
2485 subscriptions attached will allow multiple check outs.</para>
2487 </itemizedlist></para>
2489 <section id="BlockReturnOfWithdrawnItems">
2490 <title>BlockReturnOfWithdrawnItems</title>
2491 <para>Default: Block</para>
2492 <para>Asks: ___ returning of items that have been withdrawn. </para>
2493 <para>Values:<itemizedlist>
2498 <para>Don't block</para>
2500 </itemizedlist>Description:<itemizedlist>
2502 <para>This preference controls whether and item with a withdrawn status (952$0 in
2503 MARC21) can be checked in or not.</para>
2505 </itemizedlist></para>
2507 <section id="CalculateFinesOnReturn">
2508 <title>CalculateFinesOnReturn</title>
2509 <para>Default: Do</para>
2510 <para>Asks: ___ calculate and update overdue charges when an item is returned.</para>
2511 <para>Values:<itemizedlist>
2518 </itemizedlist></para>
2519 <para>Description:<itemizedlist>
2521 <para>If this preference is set to "Do" and the <link linkend="finescronjob">fines
2522 cron job</link> is off then Koha will calculate fines only when items are
2523 returned. If you have the fines cron job on and this preference set to "Do" then
2524 this preference will calculate fines based on the cron (usually run nightly) and
2525 then again when you check the item in. This option is best for those who are
2526 doing hourly loans. If this preference is set to "Don't" then fines will only
2527 be accrued if the fines cron job is running.</para>
2529 </itemizedlist></para>
2532 <para>If you are doing hourly loans then you should have this set to 'Do'.</para>
2538 <section id="circcheckoutpolicy">
2539 <title>Checkout Policy</title>
2543 <section id="AgeRestrictionMarker">
2544 <title>AgeRestrictionMarker</title>
2546 <para>Asks: Restrict patrons with the following target audience
2547 values from checking out inappropriate materials: ___</para>
2549 <para>Description:</para>
2553 <para>This preference defines certain keywords that will
2554 trigger Koha to restrict checkout based on age. These
2555 restrictions can be overridden by the <link linkend="AgeRestrictionOverride">AgeRestrictionOverride</link>
2556 preference. Enter in this field a series of keywords separated
2557 by bar (|) with no spaces. For example PG|R|E|EC|Age| will
2558 look for PG followed by an age number, R folllowed by an age
2559 number, Age followed by an age number, and so on. These values
2560 can appear in any MARC field, but Library of Congress
2561 recommends the 521$a (Target Audience Note). Whatever field
2562 you decide to use you must map the word agerestriction in the
2563 biblioitems table to that field in the <link linkend="kohamarcmapping">Koha to MARC Mapping</link>. When
2564 cataloging you can enter values like PG 13 or E 10 in the
2565 521$a and Koha will then notify circulation librarians that
2566 the material may not be recommended for the patron based on
2567 their age.<important>
2568 <para>You must map the word agerestriction in the biblioitems table to the MARC
2569 field where this information will appear via the <link linkend="kohamarcmapping">Koha to MARC Mapping</link> administration
2576 <section id="AgeRestrictionOverride">
2577 <title>AgeRestrictionOverride</title>
2579 <para>Default: Don't allow</para>
2581 <para>Asks: ___ staff to check out an item with age
2584 <para>Values:</para>
2591 <screeninfo>Allow age restriction override</screeninfo>
2595 <imagedata fileref="images/admin/globalprefs/AgeRestrictionOverride.png"/>
2602 <para>Don't allow</para>
2605 <screeninfo>Don't allow age restriction
2606 override</screeninfo>
2610 <imagedata fileref="images/admin/globalprefs/AgeRestrictionMarker.png"/>
2617 <para>Description:</para>
2621 <para>When the <link linkend="AgeRestrictionMarker">AgeRestrictionMarker</link>
2622 preference is set, Koha will try to warn circulation
2623 librarians before checking out an item that might have an age
2624 restriction listed in the MARC record. This preference asks if
2625 you would like the staff to be able to still check out these
2626 items to patrons under the age limit.</para>
2631 <section id="AllFinesNeedOverride">
2632 <title>AllFinesNeedOverride</title>
2634 <para>Default: Require</para>
2636 <para>Asks: ___ staff to manually override all fines, even fines
2637 less than <link linkend="noissuescharge">noissuescharge</link>.</para>
2639 <para>Values:</para>
2643 <para>Don't require</para>
2647 <para>Require</para>
2651 <para>Description:</para>
2655 <para>This preference let's you decide if you want to always
2656 be warned that the patron has fines when checking out. If you
2657 have it set to 'Require' then no matter how much money the
2658 patron owes a message will pop up warning you that the patron
2664 <section id="AllowFineOverride">
2665 <title>AllowFineOverride</title>
2667 <para>Default: Don't allow</para>
2669 <para>Asks: ___ staff to manually override and check out items to
2670 patrons who have more than <link linkend="noissuescharge">noissuescharge</link> in fines.</para>
2672 <para>Values:</para>
2680 <para>Don't allow</para>
2684 <para>Description:</para>
2688 <para>This preference lets you decide if you staff can check
2689 out to patrons who owe more money than you usually let them
2690 carry on their account. If set to 'Allow' staff will be warned
2691 that the patrons owes money, but it won't stop the staff from
2692 checking out to the patron.</para>
2697 <section id="AllowItemsOnHoldCheckout">
2698 <title>AllowItemsOnHoldCheckout</title>
2700 <para>Default: Don't allow</para>
2702 <para>Asks: ___ checkouts of items reserved to someone else. If
2703 allowed do not generate RESERVE_WAITING and RESERVED warning. This
2704 allows self checkouts for those items.</para>
2706 <para>Values:</para>
2714 <para>Don't allow</para>
2719 <para>This system preference relates only to SIP based self
2720 checkout, not Koha's web based self checkout.</para>
2723 <para>Description:</para>
2727 <para>When this preference is set to 'Allow' patrons will be
2728 able to use your external self check machine to check out a
2729 book to themselves even if it's on hold for someone else. If
2730 you would like Koha to prevent people from checking out books
2731 that are on hold for someone else set this preference to
2732 "Don't allow."</para>
2737 <section id="AllowNotForLoanOverride">
2738 <title>AllowNotForLoanOverride</title>
2740 <para>Default: Allow</para>
2742 <para>Asks: ___ staff to override and check out items that are
2743 marked as not for loan.</para>
2745 <para>Values:</para>
2753 <para>Don't allow</para>
2757 <para>Description:</para>
2761 <para>This parameter is a binary setting which controls the
2762 ability of staff (patrons will always be prevented from
2763 checking these items out) to check out items that are marked
2764 as "not for loan". Setting it to "Allow" would allow such
2765 items to be checked out, setting it to "Don't allow" would
2766 prevent this. This setting determines whether items meant to
2767 stay in the library, such as reference materials, and other
2768 library resources can be checked out by patrons.</para>
2773 <section id="AllowRenewalLimitOverride">
2774 <title>AllowRenewalLimitOverride</title>
2776 <para>Default: Allow</para>
2778 <para>Asks: ___ staff to manually override the renewal limit and
2779 renew a checkout when it would go over the renewal limit.</para>
2781 <para>Values:</para>
2789 <para>Don't allow</para>
2793 <para>Description:</para>
2797 <para>This preference is a binary setting which controls the
2798 ability of staff to override the limits placed on the number
2799 of times an item can be renewed. Setting it to "Allow" would
2800 allow such limits to be overridden, setting it to "Don't
2801 allow" would prevent this. This is a preference in which if it
2802 is set to "allow" it would allow the library staff to use
2803 their judgment for overriding the renew limit for special
2804 cases, setting it to "Don't allow" prevents an opportunity for
2805 abuse by the library staff.</para>
2810 <section id="AllowReturnToBranch">
2811 <title>AllowReturnToBranch</title>
2813 <para>Default: to any library</para>
2815 <para>Asks: Allow materials to be returned to ___</para>
2817 <para>Values:</para>
2821 <para>either the library the item is from or the library it
2822 was checked out from.</para>
2826 <para>only the library the item is from.</para>
2830 <para>only the library the item was checked out from.</para>
2834 <para>to any library.</para>
2838 <para>Description:</para>
2842 <para>This preference lets the library system decide how they
2843 will accept returns. Some systems allow for items to be
2844 returned to any library in the system (the default value of
2845 this preference) others want to limit item returns to only
2846 specific branches. This preference will allow you to limit
2847 item returns (checkins) to the branch(es) set in the
2852 <section id="AllowTooManyOverride">
2853 <title>AllowTooManyOverride</title>
2854 <para>Default: Allow</para>
2855 <para>Asks: ___ staff to override and check out items when the patron has reached the
2856 maximum number of allowed checkouts.</para>
2857 <para>Values:</para>
2862 <screeninfo>Allow too many checkouts override</screeninfo>
2865 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-yes.png"
2872 <para>Don't allow</para>
2874 <screeninfo>Don't allow too many checkouts override</screeninfo>
2877 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-no.png"/>
2883 <para>Description:<itemizedlist>
2885 <para>If this preference is set to "Allow" then staff all will be presented with
2886 an option to checkout more items to a patron than are normally allowed in the
2887 <link linkend="circfinerules">Circulation and Fine Rules</link>. If this
2888 preference is set to "Don't allow" then no staff member will be able to check
2889 out more than the circulation limit.</para>
2891 </itemizedlist></para>
2894 <section id="AutomaticItemReturn">
2895 <title>AutomaticItemReturn</title>
2897 <para>Default: Do</para>
2899 <para>Asks: ___ automatically transfer items to their home branch
2900 when they are returned.</para>
2902 <para>Values:</para>
2914 <para>Description:</para>
2918 <para>This preference is a binary setting which determines
2919 whether an item is returned to its home branch automatically
2920 or not. If set to "Don't", the staff member checking an item
2921 in at a location other than the item's home branch will be
2922 asked whether the item will remain at the non-home branch (in
2923 which case the new location will be marked as a holding
2924 location) or returned. Setting it to "Do" will ensure that
2925 items checked in at a branch other than their home branch will
2926 be sent to that home branch.</para>
2930 <section id="AutoRemoveOverduesRestrictions">
2931 <title>AutoRemoveOverduesRestrictions</title>
2932 <para>Default: Do not</para>
2933 <para>Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared
2934 automatically when all overdue items are returned by a patron. </para>
2935 <para>Values:<itemizedlist>
2942 </itemizedlist></para>
2943 <para>Description:<itemizedlist>
2945 <para>Using the <link linkend="noticetriggers">Overdue Notice/Status
2946 Triggers</link> you can restrict patrons after they receive an overdue notice.
2947 This preference lets you define whether Koha will automatically remove that
2948 restriction once the overdue items in question are returned or not.</para>
2950 </itemizedlist></para>
2953 <section id="CircControl">
2954 <title>CircControl</title>
2956 <para>Default: the library the item is from</para>
2958 <para>Asks: Use the checkout and fines rules of ___</para>
2960 <para>Values:</para>
2964 <para>the library the item is from</para>
2968 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2969 will be determined by the library that owns the item</para>
2975 <para>the library the patron is from</para>
2979 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2980 will be determined the patron's home library</para>
2986 <para>the library you are logged in at</para>
2990 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2991 will be determined by the library that checked the item out to the
2999 <section id="HomeOrHoldingBranch">
3000 <title>HomeOrHoldingBranch</title>
3002 <para>Default: the library the item was checked out from</para>
3004 <para>Asks: Use the checkout and fines rules of ___</para>
3006 <para>Values:</para>
3010 <para>the library the item is from</para>
3014 <para>the library the item was checked out from</para>
3019 <para>It is not recommend that this setting be changed after initial setup of Koha
3020 because it will change the behavior of items already checked out.</para>
3022 <para>Description:</para>
3025 <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set to
3026 'Prevent' and <link linkend="CircControl">CircControl</link> is set to 'the
3027 library the item is from' this preference decides whether the library holding the
3028 item (holding library on the item record) may check the item out to its own patron
3029 or if it must immediately send the item back to the owning location (home library
3030 on the item record).</para>
3034 <para>This preference does nothing unless the <link linkend="IndependentBranches"
3035 >IndependentBranches</link> preference is set to 'Prevent'.</para>
3038 <section id="HomeOrHoldingBranchReturn">
3039 <title>HomeOrHoldingBranchReturn</title>
3040 <para>Default: the library the item is from</para>
3041 <para>Asks: On checkin route the returned item to ___</para>
3042 <para>Values:<itemizedlist>
3044 <para>the library the item is from</para>
3047 <para>the library item was checked out from</para>
3049 </itemizedlist></para>
3050 <para>Description:<itemizedlist>
3052 <para>This preference will control where Koha prompts you to return the checked in
3053 item to. The value in this preference is overridden by any values you have
3054 related to item returns and floating collections in the <link linkend="circfinerules">Circulation and Fine Rules</link>.</para>
3056 </itemizedlist></para>
3059 <section id="InProcessingToShelvingCart">
3060 <title>InProcessingToShelvingCart</title>
3062 <para>Default: Don't move</para>
3064 <para>Asks: ___ items that have the location PROC to the location
3065 CART when they are checked in.</para>
3067 <para>Values:</para>
3071 <para>Don't move</para>
3080 <section id="IssuingInProcess">
3081 <title>IssuingInProcess</title>
3083 <para>Default: Don't prevent</para>
3085 <para>Asks: ___ patrons from checking out an item whose rental
3086 charge would take them over the limit.</para>
3088 <para>Values:</para>
3092 <para>Don't prevent</para>
3096 <para>Prevent</para>
3100 <para>Description:</para>
3104 <para>This preference determines if a patron can check items
3105 out if there is an overdue fine on the account and any of the
3106 materials the patron wishes to check out will potentially tip
3107 the account balance over the maximum fines policy the library
3108 has in place.</para>
3112 <para>Example: Your library has a $5 limit set for 'fines' (ie,
3113 after incurring $5 in fines, a patron can no longer check out
3114 items). A patron comes to the desk with 5 items to check out (4
3115 books and a video) The patron has $4 in charges already on their
3116 account. One of the videos has a rental charge of $1, therefore
3117 making the total fines on the patron's account suddenly $5 (the
3121 <section id="IssueLostItem">
3122 <title>IssueLostItem</title>
3124 <para>Default: display a message</para>
3126 <para>Asks: When issuing an item that has been marked as lost,
3129 <para>Values:</para>
3133 <para>display a message</para>
3136 <screeninfo>Lost message when checking out</screeninfo>
3140 <imagedata fileref="images/admin/globalprefs/IssueLostItem-msg.png"/>
3147 <para>do nothing</para>
3151 <para>This option will just check the item out without
3152 notifying you that the item was marked lost.</para>
3158 <para>require confirmation</para>
3161 <screeninfo>Confirm checkout of lost item</screeninfo>
3165 <imagedata fileref="images/admin/globalprefs/IssueLostItem-confirm.png"/>
3172 <para>Description:</para>
3176 <para>This preference lets you define how library staff are
3177 notified that an item with a lost status is being checked out.
3178 This will help staff mark items as 'available' if you choose
3179 to 'display a message' or 'require confirmation.' If you
3180 choose to 'do nothing,' there will be no notification that the
3181 item being checked out is marked as 'lost.'</para>
3185 <section id="ManInvInNoissuesCharge">
3186 <title>ManInvInNoissuesCharge</title>
3187 <para>Default: Include</para>
3188 <para>Asks: ___ MANUAL_INV charges when summing up charges for noissuescharge. </para>
3189 <para>Values:<itemizedlist>
3191 <para>Don't include</para>
3194 <para>Include</para>
3196 </itemizedlist></para>
3197 <para>Description:<itemizedlist>
3199 <para>This preference lets you decide if charges entered as manual invoices are
3200 included when calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is set to include then Koha will include all
3201 manual invoices when deciding if the patron owes too much money to check
3202 anything else out of the library. If it's set to Don't include then Koha will
3203 ignore all manual invoice charges when figuring out if the patron owes too much
3204 money to checkout additional materials.</para>
3206 </itemizedlist></para>
3209 <section id="maxoutstanding">
3210 <title>maxoutstanding</title>
3212 <para>Default: 5</para>
3214 <para>Asks: Prevent patrons from making holds on the OPAC if they
3215 owe more than ___ USD in fines.</para>
3218 <section id="noissuescharge">
3219 <title>noissuescharge</title>
3221 <para>Default: 5</para>
3223 <para>Asks: Prevent patrons from checking out books if they have
3224 more than ___ USD in fines.</para>
3226 <para>Description:</para>
3230 <para>This preference is the maximum amount of money owed to the library before the
3231 user is banned from borrowing more items. Using the <link linkend="ManInvInNoissuesCharge">ManInvInNoissuesCharge</link> and <link linkend="RentalsInNoissuesCharge">RentalsInNoissuesCharge</link> preferences you
3232 can control which types of charges are considered in this total. This also
3233 coincides with <link linkend="maxoutstanding">maxoutstanding</link> that limits
3234 patrons from placing holds when the maximum amount is owed to the library.</para>
3239 <section id="OverduesBlockCirc">
3240 <title>OverduesBlockCirc</title>
3242 <para>Default: Ask for confirmation</para>
3244 <para>Asks: ___ when checking out to a borrower that has overdues
3247 <para>Values:</para>
3251 <para>Ask for confirmation</para>
3255 <para>Will not let you check an item out to patrons with
3256 overdues until a librarian confirms that it is okay</para>
3266 <para>Block all patrons with overdue items from being able
3273 <para>Don't block</para>
3277 <para>Allow all patrons with overdue items to continue to
3285 <section id="OverdueNoticeBcc">
3286 <title>OverdueNoticeBcc</title>
3288 <para>Asks: Send all notices as a BCC to this email address
3291 <para>This preference makes it so that a librarian can get a copy of every notice sent
3292 out to patrons.<tip>
3293 <para>If you'd like more than one person to receive the blind copy you can simply
3294 enter in multiple email addresses separated by commas.</para>
3296 <para>The name of this preference is misleading, it does not only send overdues, but
3297 all notices to the BCC address.</para>
3301 <section id="PrintNoticesMaxLines">
3302 <title>PrintNoticesMaxLines</title>
3304 <para>Asks: Include up to ___ item lines in a printed overdue
3308 <para>If the number of items is greater than this number, the
3309 notice will end with a warning asking the borrower to check
3310 their online account for a full list of overdue items.</para>
3314 <para>Set to 0 to include all overdue items in the notice, no
3315 matter how many there are.</para>
3319 <para>This preference only refers to the print notices, not
3320 those sent via email.</para>
3324 <section id="RenewalPeriodBase">
3325 <title>RenewalPeriodBase</title>
3327 <para>Default: the old due date of the checkout</para>
3329 <para>Asks: When renewing checkouts, base the new due date on
3332 <para>Values:</para>
3336 <para>the old due date of the checkout</para>
3340 <para>the current date</para>
3344 <section id="RenewalSendNotice">
3345 <title>RenewalSendNotice</title>
3346 <para> Default: Don't send </para>
3347 <para>Asks: ____ a renewal notice according to patron checkout alert preferences. </para>
3348 <para>Values: <itemizedlist>
3350 <para>Don't send</para>
3355 </itemizedlist></para>
3356 <para>Description:<itemizedlist>
3358 <para>If a patron has chosen to receive a check out notice in their messaging
3359 preferences and this preference is set to 'Send' then those patrons will also
3360 receive a notice when they renew materials. You will want to set up a <link
3361 linkend="addnotices">new notice</link> with the code of RENEWAL (if you don't
3362 already have it) with custom text for renewing items.<important>
3363 <para>This preference requires that you have <link
3364 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
3365 set to 'Allow'</para>
3368 </itemizedlist></para>
3370 <section id="RentalsInNoissuesCharge">
3371 <title>RentalsInNoissuesCharge</title>
3372 <para>Default: Include</para>
3373 <para>Asks: ___ rental charges when summing up charges for noissuescharge. </para>
3374 <para>Values:<itemizedlist>
3376 <para>Don't include</para>
3379 <para>Include</para>
3381 </itemizedlist></para>
3382 <para>Description:<itemizedlist>
3384 <para>This preference lets you decide if rental charges are included when
3385 calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is
3386 set to include then Koha will include all rental charges when deciding if the
3387 patron owes too much money to check anything else out of the library. If it's
3388 set to Don't include then Koha will ignore all rental charges when figuring out
3389 if the patron owes too much money to checkout additional materials.</para>
3391 </itemizedlist></para>
3394 <section id="ReturnBeforeExpiry">
3395 <title>ReturnBeforeExpiry</title>
3397 <para>Default: Don't require</para>
3399 <para>Asks: ___ patrons to return books before their accounts
3400 expire (by restricting due dates to before the patron's expiration
3403 <para>Values:</para>
3407 <para>Don't require</para>
3411 <para>Require</para>
3415 <para>Description:</para>
3419 <para>This is preference may prevent a patron from having
3420 items checked out after their library card has expired. If
3421 this is set to "Require", then a due date of any checked out
3422 item can not be set for a date which falls after the patron's
3423 card expiration. If the setting is left "Don't require" then
3424 item check out dates may exceed the expiration date for the
3425 patron's library card.</para>
3430 <section id="ReturnToShelvingCart">
3431 <title>ReturnToShelvingCart</title>
3433 <para>Default: Don't move</para>
3435 <para>Asks: ___ all items to the location CART when they are
3438 <para>Values:</para>
3442 <para>Don't move</para>
3451 <section id="TransfersMaxDaysWarning">
3452 <title>TransfersMaxDaysWarning</title>
3454 <para>Default: 3</para>
3456 <para>Asks: Show a warning on the "Transfers to Receive" screen if
3457 the transfer has not been received ___ days after it is
3460 <para>Description:</para>
3464 <para>The TransferMaxDaysWarning preference is set at a
3465 default number of days. This preference allows for a warning
3466 to appear after a set amount of time if an item being
3467 transferred between library branches has not been received.
3468 The warning will appear in the <link linkend="transferstoreceive">Transfers to Receive</link>
3474 <section id="UseBranchTransferLimits">
3475 <title>UseBranchTransferLimits &
3476 BranchTransferLimitsType</title>
3478 <para>Defaults: Don't enforce & collection code</para>
3480 <para>Asks: ___ branch transfer limits based on ___</para>
3482 <para>UseBranchTransferLimits Values:</para>
3486 <para>Don't enforce</para>
3490 <para>Enforce</para>
3494 <para>BranchTransferLimitsType Values:</para>
3498 <para>collection code</para>
3502 <para>item type</para>
3506 <para>BranchTransferLimitsType Description:</para>
3510 <para>This parameter is a binary setting which determines
3511 whether items are transferred according to item type or
3512 collection code. This value determines how the library manager
3513 is able to restrict what items can be transferred between the
3519 <section id="useDaysMode">
3520 <title>useDaysMode</title>
3522 <para>Default: Don't include</para>
3524 <para>Asks: Calculate the due date using ___.</para>
3526 <para>Values:</para>
3530 <para>circulation rules only.</para>
3534 <para>the calendar to push the due date to the next open
3539 <para>the calendar to skip all days the library is
3544 <para>Description:</para>
3548 <para>This preference controls how scheduled library closures
3549 affect the due date of a material. The 'the calendar to skip
3550 all days the library is closed' setting allows for a scheduled
3551 closure not to count as a day in the loan period, the
3552 'circulation rules only' setting would not consider the
3553 scheduled closure at all, and 'the calendar to push the due
3554 date to the next open day' would only effect the due date if
3555 the day the item is due would fall specifically on the day of
3560 <para>Example:</para>
3564 <para>The library has put December 24th and 25th in as
3565 closures on the calendar. A book checked out by a patron has a
3566 due date of December 25th according to the circulation and
3567 fine rules. If this preference is set to 'circulation rules
3568 only' then the item will remain due on the 25th. If the
3569 preference is set to 'the calendar to push the due date to the
3570 next open day' then the due date will be December 26th. If the
3571 preference is set to 'the calendar to skip all days the
3572 library is closed' then the due date will be pushed to the
3573 27th of December to accommodate for the two closed
3578 <para>The calendar is defined on a branch by branch basis. To
3579 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
3582 <section id="UseTransportCostMatrix">
3583 <title>UseTransportCostMatrix</title>
3584 <para>Default: Don't use</para>
3585 <para>Asks: ___ Transport Cost Matrix for calculating optimal holds filling between
3587 <para>Values:<itemizedlist>
3589 <para>Don't use</para>
3594 </itemizedlist></para>
3595 <para>Description:<itemizedlist>
3597 <para>If the system is configured to use the <link linkend="transportcostmatrix">Transport cost matrix</link> for filling holds, then when attempting to fill
3598 a hold, the system will search for the lowest cost branch, and attempt to fill
3599 the hold with an item from that branch first. Branches of equal cost will be
3600 selected from randomly. The branch or branches of the next highest cost shall be
3601 selected from only if all the branches in the previous group are unable to fill
3603 <para>The system will use the item's current holding branch when determining
3604 whether the item can fulfill a hold using the Transport Cost Matrix. This
3605 behaviour will be overruled if the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link> system preference is enabled.</para>
3607 </itemizedlist></para>
3610 <section id="coursereserveprefs">
3611 <title>Course Reserves</title>
3612 <section id="UseCourseReserves">
3613 <title>UseCourseReserves</title>
3614 <para>Default: Don't use</para>
3615 <para>Asks: ___ course reserves</para>
3616 <para>Values:</para>
3619 <para>Don't use</para>
3625 <para>Description:<itemizedlist>
3627 <para>The <link linkend="coursereserves">Course Reserves</link> module in Koha
3628 allows you to temporarily move items to 'reserve' and assign different
3629 circulation rules to these items while they are being used for a specific
3632 </itemizedlist></para>
3636 <section id="circfinespolicy">
3637 <title>Fines Policy</title>
3641 <section id="finesCalendar">
3642 <title>finesCalendar</title>
3644 <para>Default: not including the days the library is closed</para>
3646 <para>Asks: Calculate fines based on days overdue ___</para>
3648 <para>Values:</para>
3652 <para>directly</para>
3656 <para>not including the days the library is closed</para>
3660 <para>Description:</para>
3664 <para>This preference will determine whether or not fines will
3665 be accrued during instances when the library is closed.
3666 Examples include holidays, library in-service days, etc.
3667 Choosing "not including the days the library is closed"
3668 setting will enable Koha to access its <link linkend="calholidays">Calendar</link> module and be
3669 considerate of dates when the library is closed. To make use
3670 of this setting the administrator must first access Koha's
3671 calendar and mark certain days as "holidays" ahead of
3676 <para>The calendar is defined on a branch by branch basis. To
3677 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
3680 <section id="FinesIncludeGracePeriod">
3681 <title>FinesIncludeGracePeriod</title>
3682 <para>Default: Include</para>
3683 <para>Asks: ___ the grace period when calculating the fine for an overdue item.</para>
3684 <para>Values:<itemizedlist>
3686 <para>Don't include</para>
3689 <para>Include</para>
3691 </itemizedlist></para>
3692 <para>Description:<itemizedlist>
3694 <para>This preference lets you control how Koha calculates fines when there is a
3695 grace period. If you choose to include the grace period when calculating fines
3696 then Koha will charge for the days in the grace period should the item be
3697 overdue more than those days. If you choose not to include the grace period then
3698 Koha will only charge for the days overdue after the grace period.</para>
3700 </itemizedlist></para>
3703 <section id="finesMode">
3704 <title>finesMode</title>
3706 <para>Default: Calculate (but only for mailing to the
3709 <para>Asks: ___ fines</para>
3711 <para>Values:</para>
3715 <para>Calculate (but only for mailing to the admin)</para>
3719 <para>Calculate and charge</para>
3723 <para>Don't calculate</para>
3728 <para>Requires that you have the fines cron job running
3729 (misc/cronjobs/fines.pl)</para>
3732 <section id="RefundLostItemFeeOnReturn">
3733 <title>RefundLostItemFeeOnReturn</title>
3734 <para>Default: Refund</para>
3735 <para>Asks: ___ lost item fees charged to a borrower when the lost item is
3737 <para>Values:<itemizedlist>
3739 <para>Don't refund</para>
3744 </itemizedlist></para>
3745 <para>Description:<itemizedlist>
3747 <para>When an item is marked lost in Koha the system charges the patron the
3748 replacement fee for the item. This preference lets you control how Koha handles
3749 returns of these items. By default when an item that was previously marked lost
3750 is checked in Koha refunds the patron the replacement fee. Change this
3751 preference to "Don't refund" if you would like Koha to not refund the
3752 replacement fee.</para>
3754 </itemizedlist></para>
3756 <section id="WhenLostChargeReplacementFee">
3757 <title>WhenLostChargeReplacementFee</title>
3758 <para>Default: Charge</para>
3759 <para>Asks: ___ the replacement price when a patron loses an item. </para>
3760 <para>Values:<itemizedlist>
3765 <para>Don't charge</para>
3767 </itemizedlist></para>
3768 <para>Description:<itemizedlist>
3770 <para>This preference lets you tell Koha what to do with an item is marked lost.
3771 If you want Koha can 'Charge' the patron the replacement fee listed on the item
3772 they lost or it can do nothing in reference to the patron and just mark the item
3773 lost in the catalog.</para>
3775 </itemizedlist></para>
3777 <section id="WhenLostForgiveFine">
3778 <title>WhenLostForgiveFine</title>
3779 <para>Default: Don't forgive</para>
3780 <para>Asks: ___ the fines on an item when it is lost.</para>
3781 <para>Values:<itemizedlist>
3783 <para>Don't forgive</para>
3786 <para>Forgive</para>
3788 </itemizedlist></para>
3789 <para>Description:<itemizedlist>
3791 <para>This preference allows the library to decide if fines are charged in
3792 addition to the replacement fee when an item is marked as lost. If this
3793 preference is set to 'Forgive' then the patron won't be charged fines in
3794 addition to the replacement fee.</para>
3796 </itemizedlist></para>
3800 <section id="circholdspolicy">
3801 <title>Holds Policy</title>
3805 <section id="AllowHoldDateInFuture">
3806 <title>AllowHoldDateInFuture</title>
3808 <para>Default: Allow</para>
3810 <para>Asks: ___ hold requests to be placed that do not enter the
3811 waiting list until a certain future date.</para>
3813 <para>Values:</para>
3821 <para>Don't allow</para>
3826 <section id="AllowHoldsOnDamagedItems">
3827 <title>AllowHoldsOnDamagedItems</title>
3829 <para>Default: Allow</para>
3831 <para>Asks: ___ hold requests to be placed on damaged
3834 <para>Values:</para>
3842 <para>Don't allow</para>
3846 <para>Description:</para>
3850 <para>This parameter is a binary setting which controls
3851 whether or not hold requests can be placed on items that are
3852 marked as "damaged" (items are marked as damaged by editing
3853 subfield 4 on the item record). Setting this value to "Don't
3854 allow" will prevent anyone from placing a hold on such items,
3855 setting it to "Allow" will allow it. This preference is
3856 important because it determines whether or not a patron can
3857 place a request for an item that might be in the process of
3858 being repaired or not in good condition. The library may wish
3859 to set this to "Don't allow" if they were concerned about
3860 their patrons not receiving the item in a timely manner or at
3861 all (if it is determined that the item is beyond repair).
3862 Setting it to "Allow" would allow a patron to place a hold on
3863 an item and therefore receive it as soon as it becomes
3868 <section id="AllowHoldsOnPatronsPossessions">
3869 <title>AllowHoldsOnPatronsPossessions</title>
3870 <para>Default: Allow </para>
3871 <para>Asks: ____ a patron to place a hold on a record where the patron already has one
3872 or more items attached to that record checked out. </para>
3873 <para>Values:<itemizedlist>
3878 <para>Don't allow</para>
3880 </itemizedlist></para>
3881 <para>Description:<itemizedlist>
3883 <para>By setting to "Don't allow," you can prevent patrons from placing holds on
3884 items they already have out, thus preventing them from blocking anyone else from
3885 getting an item. </para>
3887 </itemizedlist></para>
3890 <section id="AllowHoldPolicyOverride">
3891 <title>AllowHoldPolicyOverride</title>
3893 <para>Default: Allow</para>
3895 <para>Asks: ___ staff to override hold policies when placing
3898 <para>Values:</para>
3906 <para>Don't allow</para>
3910 <para>Description:</para>
3914 <para>This preference is a binary setting which controls
3915 whether or not the library staff can override the circulation
3916 and fines rules as they pertain to the placement of holds.
3917 Setting this value to "Don't allow" will prevent anyone from
3918 overriding, setting it to "Allow" will allow it. This setting
3919 is important because it determines how strict the libraries
3920 rules for placing holds are. If this is set to "Allow",
3921 exceptions can be made for patrons who are otherwise normally
3922 in good standing with the library, but there is opportunity
3923 for the staff to abuse this function. If it is set to "Don't
3924 allow", no abuse of the system is possible, but it makes the
3925 system entirely inflexible in respect to holds.</para>
3930 <section id="AllowOnShelfHolds">
3931 <title>AllowOnShelfHolds</title>
3933 <para>Default: Allow</para>
3935 <para>Asks: ___ hold requests to be placed on items that are not
3938 <para>Values:</para>
3946 <para>Don't Allow</para>
3950 <para>Description:</para>
3954 <para>This preference is a binary setting which controls the
3955 ability of patrons to place holds on items that are not
3956 currently checked out. Setting it to "Don't allow" allows
3957 borrowers to place holds on items that are checked out but not
3958 on items that are on the shelf (or assumed available in the
3959 library), setting it to "Allow" allows borrowers to place
3960 holds on any item that is available for loan whether it is
3961 checked out or not. This setting might be set to "Allow" if
3962 the library system is a multi branch system and patrons used
3963 the hold system to request items from other libraries, or if
3964 the library wanted to allow users to place holds on items from
3965 home through the OPAC. Setting it to "Don't allow" would
3966 enforce a first come, first served standard.</para>
3970 <para>An item's hold status doesn't not affect whether or not the item is 'available'
3971 until the item is in 'waiting' status. Items with on-shelf holds will show as
3972 available until a librarian has pulled them from the shelf and checked the item in
3973 make it show 'waiting'.</para>
3977 <section id="AutoResumeSuspendedHolds">
3978 <title>AutoResumeSuspendedHolds</title>
3980 <para>Default: Allow</para>
3982 <para>Asks: ___ suspended holds to be automatically resumed by a
3985 <para>Values:</para>
3993 <para>Don't allow</para>
3997 <para>Description:</para>
4001 <para>If this preference is set to 'Allow' then all suspended holds will be able to
4002 have a date at after which they automatically become unsuspended. If you have this
4003 preference set to 'Allow' you will also need the <link linkend="unsuspendholdcron">Unsuspend Holds</link> cron job running.</para>
4007 <para>The holds will become unsuspended the date after that entered by the
4012 <section id="canreservefromotherbranches">
4013 <title>canreservefromotherbranches</title>
4015 <para>Default: Allow</para>
4017 <para>Asks: ___ a user from one library to place a hold on an item
4018 from another library</para>
4020 <para>Description:</para>
4024 <para>This preference is a binary setting which determines
4025 whether patrons can place holds on items from other branches.
4026 If the preference is set to "Allow" patrons can place such
4027 holds, if it is set to "Don't allow" they cannot. This is an
4028 important setting because it determines if users can use Koha
4029 to request items from another branch. If the library is
4030 sharing an installation of Koha with other independent
4031 libraries which do not wish to allow interlibrary borrowing it
4032 is recommended that this parameter be set to "Don't
4037 <para>Values:</para>
4045 <para>Don't allow (with <link linkend="IndependentBranches">independent
4046 branches</link>)</para>
4050 <section id="ConfirmFutureHolds">
4051 <title>ConfirmFutureHolds</title>
4052 <para>Default: 0</para>
4053 <para>Asks: Confirm future hold requests (starting no later than ___ days from now) at
4054 checkin time. </para>
4055 <para>Description:<itemizedlist>
4057 <para>When confirming a hold at checkin time, the number of days in this
4058 preference is taken into account when deciding which holds to show alerts for.
4059 This preference does not interfere with renewing, checking out or transferring a
4062 </itemizedlist></para>
4064 <para>This number of days will be used too in calculating the default end date for the
4065 Holds to pull-report. But it does not interfere with issuing, renewing or
4066 transferring books.</para>
4069 <para>This preference is only looked at if you're allowing hold dates in the future
4070 with <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link> or <link
4071 linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link></para>
4074 <section id="decreaseLoanHighHolds">
4075 <title>decreaseLoanHighHolds, decreaseLoanHighHoldsDuration and
4076 decreaseLoanHighHoldsValue</title>
4077 <para>Asks: ___ the reduction of loan period to ___ days for items with more than ___
4079 <para>decreaseLoanHighHolds default: Don't enable</para>
4080 <para>decreaseLoanHighHolds values:<itemizedlist>
4081 <para>Don't enable</para>
4085 </itemizedlist>Description:<itemizedlist>
4087 <para>These preferences let you change the loan length for items that have many
4088 holds on them. This will not effect items that are already checked out, but
4089 items that are checked out after the decreaseLoanHighHoldsValue is met will only
4090 be checked out for the number of days entered in the
4091 decreaseLoanHighHoldsDuration preference.</para>
4093 <screeninfo>Warning on checkout</screeninfo>
4096 <imagedata fileref="images/admin/globalprefs/decreaseLoanHighHoldsDuration.png"/>
4101 </itemizedlist></para>
4104 <section id="DisplayMultiPlaceHold">
4105 <title>DisplayMultiPlaceHold</title>
4107 <para>Default: Don't enable</para>
4109 <para>Asks: ___ the ability to place holds on multiple biblio from
4110 the search results</para>
4112 <para>Values:</para>
4116 <para>Don't enable</para>
4125 <section id="emailLibrarianWhenHoldIsPlaced">
4126 <title>emailLibrarianWhenHoldIsPlaced</title>
4128 <para>Default: Don't enable</para>
4130 <para>Asks: ___ sending an email to the Koha administrator email
4131 address whenever a hold request is placed.</para>
4133 <para>Values:</para>
4137 <para>Don't enable</para>
4145 <para>Description:</para>
4149 <para>This preference enables Koha to email the library staff
4150 whenever a patron requests an item to be held. While this
4151 function will immediately alert the librarian to the patron's
4152 need, it is extremely impractical in most library settings. In
4153 most libraries the hold lists are monitored and maintained
4154 from a separate interface. That said, many libraries that
4155 allow on shelf holds prefer to have this preference turned on
4156 so that they are alerted to pull an item from the
4162 <para>In order for this email to send you must have a <link linkend="notices"
4163 >notice</link> template with the code of HOLDPLACED</para>
4167 <para>This notice will only be sent if the <link linkend="msgqueuecron">process_message_queue.pl cronjob</link>
4168 being run periodically to send the messages.</para>
4172 <section id="ExpireReservesMaxPickUpDelay">
4173 <title>ExpireReservesMaxPickUpDelay</title>
4175 <para>Default: Don't allow</para>
4177 <para>Asks: ___ holds to expire automatically if they have not
4178 been picked by within the time period specified in <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
4180 <para>Values:</para>
4188 <para>Don't allow</para>
4192 <para>Description:</para>
4196 <para>If set to 'allow' this will cancel holds that have been
4197 waiting for longer than the number of days specified in the
4198 <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
4199 system preference. Holds will only be cancelled if the <link linkend="expiredholdscron">Expire Holds cron job</link> is
4205 <section id="ExpireReservesMaxPickUpDelayCharge">
4206 <title>ExpireReservesMaxPickUpDelayCharge</title>
4208 <para>Default: 0</para>
4210 <para>Asks: If using <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
4211 charge a borrower who allows his or her waiting hold to expire a
4212 fee of ___ USD</para>
4214 <para>Description:</para>
4218 <para>If you are expiring holds that have been waiting too
4219 long you can use this preference to charge the patron for not
4220 picking up their hold. If you don't charge patrons for items
4221 that aren't picked up you can leave this set to the default
4222 which is 0. Holds will only be cancelled and charged if the
4223 <link linkend="expiredholdscron">Expire Holds cron job</link>
4229 <section id="maxreserves">
4230 <title>maxreserves</title>
4232 <para>Default: 50</para>
4234 <para>Asks: Patrons can only have ___ holds at once.</para>
4237 <section id="OPACAllowHoldDateInFuture">
4238 <title>OPACAllowHoldDateInFuture</title>
4240 <para>Default: Allow</para>
4242 <para>Asks: ___ patrons to place holds that don't enter the
4243 waiting list until a certain future date.</para>
4245 <para>Values:</para>
4253 <para><link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
4254 must also be enabled for this to work</para>
4260 <para>Don't allow</para>
4265 <section id="OPACAllowUserToChooseBranch">
4266 <title>OPACAllowUserToChooseBranch</title>
4268 <para>Default: Allow</para>
4270 <para>Asks: ___ a user to choose the branch to pick up a hold
4273 <para>Values:</para>
4281 <para>Don't allow</para>
4285 <para>Description:</para>
4289 <para>Changing this preference will not prevent staff from
4290 being able to transfer titles from one branch to another to
4291 fill a hold, it will only prevent patrons from saying they
4292 plan on picking a book up at a branch other than their home
4298 <section id="ReservesControlBranch">
4299 <title>ReservesControlBranch</title>
4301 <para>Default: item's home library</para>
4303 <para>Asks: Check the ___ to see if the patron can place a hold on
4306 <para>Values:</para>
4310 <para>item's home library.</para>
4314 <para>patron's home library.</para>
4319 <section id="ReservesMaxPickUpDelay">
4320 <title>ReservesMaxPickUpDelay</title>
4322 <para>Default: 7</para>
4324 <para>Asks: Mark a hold as problematic if it has been waiting for
4325 more than ___ days.</para>
4327 <para>Description:</para>
4331 <para>This preference (based on calendar days, not the <link linkend="calholidays">Koha holiday calendar</link>) puts an
4332 expiration date on an item a patron has on hold. After this
4333 expiration date the staff will have the option to release the
4334 unclaimed hold which then may be returned to the library shelf
4335 or issued to the next patron on the item's hold list. Items
4336 that are 'expired' by this preference are moved to the 'Holds
4337 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
4338 Pickup</link>' report.</para>
4343 <section id="ReservesNeedReturns">
4344 <title>ReservesNeedReturns</title>
4346 <para>Default: Don't automatically</para>
4348 <para>Asks: ___ mark holds as found and waiting when a hold is
4349 placed specifically on them and they are already checked
4352 <para>Values:</para>
4356 <para>Automatically</para>
4360 <para>Don't automatically</para>
4364 <para>Description:</para>
4368 <para>This preference refers to 'item specific' holds where
4369 the item is currently on the library shelf. This preference
4370 allows a library to decide whether an 'item specific' hold is
4371 marked as "Waiting" at the time the hold is placed or if the
4372 item will be marked as "Waiting" after the item is checked in.
4373 This preference will tell the patron that their item is
4374 'Waiting' for them at their library and ready for check
4380 <section id="holdqueueweight">
4381 <title>StaticHoldsQueueWeight &
4382 RandomizeHoldsQueueWeight</title>
4384 <para>StaticHoldsQueueWeight Default: 0</para>
4386 <para>RandomizeHoldsQueueWeight Default: in that order</para>
4388 <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
4389 separated by commas; if empty, uses all libraries) ___</para>
4391 <para>RandomizeHoldsQueueWeight Values:</para>
4395 <para>in random order</para>
4399 <para>If StaticHoldsQueueWeight is left at the default
4400 Koha will randomize all libraries, otherwise it will
4401 randomize the libraries listed.</para>
4407 <para>in that order</para>
4411 <para>If StaticHoldsQueueWeight is left at the default
4412 then this will use all of your branches in alphabetical
4413 order, otherwise it will use the branches in the order
4414 that you entered them in the StaticHoldsQueueWeight
4421 <para>Descriptions:</para>
4425 <para>These preferences control how the <link linkend="holdsqueue">Holds Queue report</link> is generated
4426 using <link linkend="buildholdscron">a cron job</link>.</para>
4428 <para>If you do not want all of your libraries to participate
4429 in the on-shelf holds fulfillment process, you should list the
4430 the libraries that *do* participate in the process here by
4431 inputting all the participating library's branchcodes,
4432 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
4434 <para>By default, the holds queue will be generated such that
4435 the system will first attempt to hold fulfillment using items
4436 already at the pickup library if possible. If there are no
4437 items available at the pickup library to fill a hold,
4438 build_holds_queue.pl will then use the list of libraries
4439 defined in StaticHoldsQueueWeight. If
4440 RandomizeHoldsQueueWeight is disabled ( which it is by default
4441 ), the script will assign fulfillment requests in the order
4442 the branches are placed in the StaticHoldsQueueWeight system
4445 <para>For example, if your system has three libraries, of
4446 varying sizes ( small, medium and large ) and you want the
4447 burden of holds fulfillment to be on larger libraries before
4448 smaller libraries, you would want StaticHoldsQueueWeight to
4449 look something like "LRG,MED,SML".</para>
4451 <para>If you want the burden of holds fulfillment to be spread
4452 out equally throughout your library system, simply enable
4453 RandomizeHoldsQueueWeight. When this system preference is
4454 enabled, the order in which libraries will be requested to
4455 fulfill an on-shelf hold will be randomized each time the list
4456 is regenerated.</para>
4458 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
4459 at this time. Doing so will cause the build_holds_queue script
4460 to ignore RandomizeHoldsQueueWeight, causing the script to
4461 request hold fulfillment not randomly, but by alphabetical
4466 <para>The <link linkend="transportcostmatrix">Transport Cost Matrix</link> takes
4467 precedence in controlling where holds are filled from, if the matrix is not used
4468 then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix
4469 simply set your <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link>
4470 preference to 'Use'</para>
4474 <section id="SuspendHoldsIntranet">
4475 <title>SuspendHoldsIntranet</title>
4477 <para>Default: Allow</para>
4479 <para>Asks: ___ holds to be suspended from the intranet.</para>
4481 <para>Values:</para>
4489 <para>Don't allow</para>
4493 <para>Description:</para>
4497 <para>The holds suspension feature can be turned on and off in
4498 the staff client by altering this system preference. If this
4499 is set to 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
4500 system preference.</para>
4505 <section id="SuspendHoldsOpac">
4506 <title>SuspendHoldsOpac</title>
4508 <para>Default: Allow</para>
4510 <para>Asks: ___ holds to be suspended from the OPAC.</para>
4512 <para>Values:</para>
4520 <para>Don't allow</para>
4524 <para>Description:</para>
4528 <para>The holds suspension feature can be turned on and off in
4529 the OPAC by altering this system preference. If this is set to
4530 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
4531 system preference.</para>
4537 <section id="circinterfaceprefs">
4538 <title>Interface</title>
4542 <section id="AllowAllMessageDeletion">
4543 <title>AllowAllMessageDeletion</title>
4545 <para>Default: Don't allow</para>
4547 <para>Asks: ___ staff to delete messages added from other
4550 <para>Values:</para>
4558 <para>Don't allow</para>
4562 <section id="AllowOfflineCirculation">
4563 <title>AllowOfflineCirculation</title>
4564 <para>Default: Do not enable</para>
4565 <para>Asks: ___ offline circulation on regular circulation computers. </para>
4566 <para>Values:<itemizedlist>
4568 <para>Do not enable</para>
4573 </itemizedlist></para>
4574 <para>Description:<itemizedlist>
4576 <para>Setting this preference to 'Enable' allows you to use the Koha interface for
4577 <link linkend="offlinecirc">offline circulation</link>. This system preference
4578 does not affect the <link linkend="firefoxofflinecirc">Firefox plugin</link> or
4579 the <link linkend="windowsofflinecirc">desktop application</link>, any of these
4580 three options can be used for offline circulation without effecting the
4583 </itemizedlist></para>
4586 <section id="CircAutocompl">
4587 <title>CircAutocompl</title>
4589 <para>Default: Try</para>
4591 <para>Asks: ___ to automatically fill in the member when entering
4592 a patron search on the circulation screen.</para>
4594 <para>Description:</para>
4598 <para>This preference is a binary setting which determines
4599 whether auto-completion of fields is enabled or disabled for
4600 the circulation input field. Setting it to "Try" would enable
4601 a staff member to begin typing a name or other value into the
4602 field and have a menu pop up with suggestions for completing
4603 it. Setting it to "Don't try" would disable this feature. This
4604 preference can make staff members' jobs easier or it could
4605 potentially slow down the page loading process.</para>
4609 <para>Values:</para>
4613 <para>Don't try</para>
4620 <screeninfo>When CircAutocompl is turned on search results
4621 will appear below the search box</screeninfo>
4625 <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
4633 <section id="CircAutoPrintQuickSlip">
4634 <title>CircAutoPrintQuickSlip</title>
4636 <para>Default: open a print quick slip window</para>
4638 <para>Asks: When an empty barcode field is submitted in
4639 circulation ___</para>
4641 <para>Values:</para>
4645 <para>clear the screen</para>
4649 <para>open a print quick slip window</para>
4652 <para>open a print slip window</para>
4656 <para>Description:</para>
4660 <para>If this preference is set to open a quick slip (<link
4661 linkend="existingnotices">ISSUEQSLIP</link>) or open a slip (<link
4662 linkend="existingnotices">ISSUESLIP</link>) for printing it will eliminate the
4663 need for the librarian to click the print button to generate a checkout receipt
4664 for the patron they're checking out to. If the preference is set to clear the
4665 screen then "checking out" an empty barcode will clear the screen of the patron
4666 you were last working with.</para>
4671 <section id="FilterBeforeOverdueReport">
4672 <title>FilterBeforeOverdueReport</title>
4674 <para>Default: Don't require</para>
4676 <para>Asks: ___ staff to choose which checkouts to show before
4677 running the overdues report.</para>
4679 <para>Description:</para>
4683 <para>Koha's overdue report shows you all of the overdue items
4684 in your library system. If you have a large library system
4685 you'll want to set this preference to 'Require' to force those
4686 running the report to first limit the data generated to a
4687 branch, date range, patron category or other such filter.
4688 Requiring that the report be filtered before it's run prevents
4689 your staff from running a system heavy report and slowing down
4690 other operations in the system.</para>
4693 <screeninfo>Overdue Report Filters</screeninfo>
4697 <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
4704 <para>Values:</para>
4708 <para>Don't require</para>
4712 <para>Require</para>
4717 <section id="FineNotifyAtCheckin">
4718 <title>FineNotifyAtCheckin</title>
4720 <para>Default: Don't notify</para>
4722 <para>Asks: ___ librarians of overdue fines on the items they are
4725 <para>Values:</para>
4729 <para>Don't notify</para>
4737 <para>Description:</para>
4741 <para>With this preference set to 'Notify' all books that have
4742 overdue fines owed on them will pop up a warning when checking
4743 them in. This warning will need to acknowledged before you can
4744 continue checking items in. With this preference set to 'Don't
4745 notify,' you will still see fines owed on the patron record,
4746 you just won't have an additional notification at check
4750 <screeninfo>Fine notification at checkin</screeninfo>
4754 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
4762 <section id="DisplayClearScreenButton">
4763 <title>DisplayClearScreenButton</title>
4765 <para>Default: Show</para>
4767 <para>Asks: ___ a button to clear the current patron from the
4768 screen on the circulation screen.</para>
4770 <para>Values:</para>
4774 <para>Don't show</para>
4777 <screeninfo>No X in the top right</screeninfo>
4781 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
4791 <screeninfo>X in the top right will clear the
4796 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
4803 <section id="ExportRemoveFields">
4804 <title>ExportRemoveFields</title>
4805 <para>Asks: The following fields should be excluded from the patron checkout history CSV
4806 or iso2709 export ___ </para>
4807 <para>Description:<itemizedlist>
4809 <para>This space separated list of fields (e.g. 100a 245b) will automatically be
4810 excluded when exporting the patron's current checkout history.</para>
4812 <screeninfo>ExportRemoveFields</screeninfo>
4815 <imagedata fileref="images/admin/globalprefs/ExportRemoveFields.png"/>
4820 </itemizedlist></para>
4822 <section id="ExportWithCsvProfile">
4823 <title>ExportWithCsvProfile</title>
4824 <para>Asks: Use the ___ CSV profile when exporting patron checkout history</para>
4825 <para>Description:<itemizedlist>
4827 <para>Use this preference to define which <link linkend="csvprofiles">CSV
4828 profile</link> should be used when exporting patron's current checkout data.
4829 Enter the CSV Profile name as the value for this preference. If this preference
4830 is left blank you will not be able to export the patron's current checkout
4833 <screeninfo>ExportWithCsvProfile</screeninfo>
4836 <imagedata fileref="images/admin/globalprefs/ExportWithCsvProfile.png"/>
4841 </itemizedlist></para>
4843 <section id="HoldsToPullStartDate">
4844 <title>HoldsToPullStartDate</title>
4845 <para>Default: 2</para>
4846 <para>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago. </para>
4847 <para>Description:<itemizedlist>
4849 <para>The <link linkend="holdspull">Holds to Pull</link> report in circulation
4850 defaults to filtering holds placed 2 days ago. This preference allows you to set
4851 this default filter to any number of days.</para>
4853 </itemizedlist></para>
4855 <section id="itemBarcodeFallbackSearch">
4856 <title>itemBarcodeFallbackSearch</title>
4857 <para>Default: Don't enable</para>
4858 <para>Asks: ___ the automatic use of a keyword catalog search if the phrase entered as
4859 a barcode on the checkout page does not turn up any results during an item barcode
4861 <para>Values:</para>
4864 <para>Don't enable</para>
4869 <screeninfo>Checkout by keyword</screeninfo>
4873 fileref="images/admin/globalprefs/itemBarcodeFallbackSearch.png"/>
4879 <para>Description:<itemizedlist>
4881 <para>Sometimes libraries want to checkout using something other than the barcode.
4882 Enabling this preference will do a keyword search of Koha to find the item
4883 you're trying to check out. You can use the call number, barcode, part of the
4884 title or anything you'd enter in the keyword search when this preference is
4885 enabled and Koha will ask you which item you're trying to check out.</para>
4887 </itemizedlist></para>
4889 <para>While you're not searching by barcode a barcode is required on every title you
4890 check out. Only titles with barcodes will appear in the search results.</para>
4894 <section id="itemBarcodeInputFilter">
4895 <title>itemBarcodeInputFilter</title>
4897 <para>Default: Don't filter</para>
4899 <para>Asks: ___ scanned item barcodes.</para>
4901 <para>Values:</para>
4905 <para>Convert from CueCat format</para>
4909 <para>Convert from Libsuite8 form</para>
4913 <para>Don't filter</para>
4917 <para>EAN-13 or zero-padded UPC-A from</para>
4921 <para>Remove spaces from</para>
4925 <para>Remove the first number from T-prefix style</para>
4929 <para>This format is common among those libraries
4930 migrating from Follett systems</para>
4937 <section id="NoticeCSS">
4938 <title>NoticeCSS</title>
4940 <para>Asks: Include the stylesheet at ___ on Notices.<important>
4941 <para>This should be a complete URL, starting with
4945 <para>Description:</para>
4949 <para>If you would like to style your notices with a
4950 consistent set of fonts and colors you can use this preference
4951 to point Koha to a stylesheet specifically for your
4957 <section id="numReturnedItemsToShow">
4958 <title>numReturnedItemsToShow</title>
4960 <para>Default: 20</para>
4962 <para>Asks : Show the ___ last returned items on the checkin
4966 <section id="previousIssuesDefaultSortOrder">
4967 <title>previousIssuesDefaultSortOrder</title>
4969 <para>Default: earliest to latest</para>
4971 <para>Asks: Sort previous checkouts on the circulation page from
4972 ___ due date.</para>
4974 <para>Values:</para>
4978 <para>earliest to latest</para>
4982 <para>latest to earliest</para>
4987 <section id="RecordLocalUseOnReturn">
4988 <title>RecordLocalUseOnReturn</title>
4990 <para>Default: Don't record</para>
4992 <para>Asks: ___ local use when an unissued item is checked
4995 <para>Values:</para>
4999 <para>Don't record</para>
5007 <para>Description:</para>
5011 <para>When this preference is set to "Don't record" you can
5012 record local use of items by checking items out to the
5013 statistical patron. With this preference set to "Record" you
5014 can record local use by checking out to the statistical patron
5015 and/or by checking in a book that is not currently checked
5021 <section id="soundon">
5022 <title>soundon</title>
5024 <para>Default: Don't enable</para>
5026 <para>Asks: ___ circulation sounds during checkin and checkout in
5027 the staff interface.</para>
5029 <para>Values:</para>
5033 <para>Don't enable</para>
5042 <para>This feature is not supported by all browsers. Requires
5043 an HTML5 compliant browser.</para>
5047 <section id="SpecifyDueDate">
5048 <title>SpecifyDueDate</title>
5050 <para>Default: Allow</para>
5052 <para>Asks: ___ staff to specify a due date for a checkout.</para>
5054 <para>Due dates are calculated using your circulation and fines
5055 rules, but staff can override that if you allow them to specify a
5056 due date at checkout.</para>
5058 <para>Description:</para>
5062 <para>This preference allows for circulation staff to change a
5063 due date from the automatic due date to another calendar date.
5064 This option would be used for circumstances in which the due
5065 date may need to be decreased or extended in a specific
5066 circumstance. The "Allow" setting would allow for this option
5067 to be utilized by staff, the "Don't allow" setting would bar
5068 staff from changing the due date on materials.</para>
5072 <para>Values:</para>
5079 <screeninfo>Specify Due Date Box Shows</screeninfo>
5083 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
5090 <para>Don't allow</para>
5093 <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
5097 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
5104 <section id="SpecifyReturnDate">
5105 <title>SpecifyReturnDate</title>
5106 <para>Default: Don't allow</para>
5107 <para>Asks: ___ staff to specify a return date for a check in.</para>
5108 <para>Values:<itemizedlist>
5110 <para>Allow<screenshot>
5111 <screeninfo>Allow return date edits</screeninfo>
5114 <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate.png"/>
5117 </screenshot></para>
5120 <para>Don't allow<screenshot>
5121 <screeninfo>Don't allow return date edits</screeninfo>
5124 <imagedata fileref="images/admin/globalprefs/SpecifyReturnDate-no.png"/>
5127 </screenshot></para>
5129 </itemizedlist></para>
5130 <para>Description:<itemizedlist>
5132 <para>This preference lets you decide if staff can specify an arbitrary return
5133 date when checking in items.</para>
5135 </itemizedlist></para>
5138 <section id="todaysIssuesDefaultSortOrder">
5139 <title>todaysIssuesDefaultSortOrder</title>
5141 <para>Default: latest to earliest</para>
5143 <para>Asks: Sort today's checkouts on the circulation page from
5144 ___ due date.</para>
5146 <para>Values:</para>
5150 <para>earliest to latest</para>
5154 <para>latest to earliest</para>
5159 <section id="UpdateTotalIssuesOnCirc">
5160 <title>UpdateTotalIssuesOnCirc</title>
5162 <para>Default: Do not</para>
5164 <para>Asks: ___ update a bibliographic record's total issues count
5165 whenever an item is issued</para>
5167 <para>Values:</para>
5172 <para>This increases server load significantly; if
5173 performance is a concern, use the <link linkend="updateissuescron">cron job</link> to update the
5174 total issues count instead.</para>
5183 <para>Description:</para>
5187 <para>Koha can track the number of times and item is checked
5188 out and store that on the item record in the database. This
5189 information is not stored by default. Setting this preference
5190 to 'Do' will tell Koha to track that info everytime the item
5191 is checked out in real time. Otherwise you could use the <link linkend="updateissuescron">cron job</link> to have Koha update
5192 that field nightly.</para>
5197 <section id="UseTablesortForCirc">
5198 <title>UseTablesortForCirc</title>
5200 <para>Default: Don't enable</para>
5202 <para>Asks: ___ the sorting of current patron checkouts on the
5203 circulation screen.</para>
5205 <para>Values:</para>
5209 <para>Don't enable</para>
5218 <para>Enabling this function may slow down circulation time for
5219 patrons with many checkouts.</para>
5223 <section id="WaitingNotifyAtCheckin">
5224 <title>WaitingNotifyAtCheckin</title>
5226 <para>Default: Don't notify</para>
5228 <para>Asks: ___ librarians of waiting holds for the patron whose
5229 items they are checking in.</para>
5231 <para>Values:</para>
5235 <para>Don't notify</para>
5242 <screeninfo>Notification that a hold is waiting</screeninfo>
5246 <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
5253 <para>Description:</para>
5257 <para>When checking in books you can choose whether or not to
5258 have a notice pop up if the patron who returned the book has a
5259 hold waiting for pick up. If you choose 'Notify' for
5260 WaitingNotifyAtCheckin then every time a hold is found for the
5261 patron who had the book out last a message will appear on your
5262 check in screen.</para>
5268 <section id="circscoprefs">
5269 <title>Self Checkout</title>
5273 <section id="AllowSelfCheckReturns">
5274 <title>AllowSelfCheckReturns</title>
5276 <para>Default: Don't allow</para>
5278 <para>Asks: ___ patrons to return items through web-based self
5279 checkout system.</para>
5281 <para>Values:</para>
5289 <para>Don't allow</para>
5293 <para>Description:</para>
5297 <para>This preference is used to determine if you want patrons
5298 to be allowed to return items through your self check
5299 machines. By default Koha's self check interface is simply for
5300 checking items out.</para>
5305 <section id="AutoSelfCheckAllowed">
5306 <title>AutoSelfCheckAllowed, AutoSelfCheckID &
5307 AutoSelfCheckPass</title>
5310 <para>Most libraries will want to leave this set to 'Don't
5311 allow.' This preference turns off the requirement to log into
5312 the self checkout machine with a staff username and password by
5313 storing the username and password for automatic login.</para>
5316 <para>AutoSelfCheckAllowed Default: Don't allow</para>
5318 <para>Asks: ___ the web-based self checkout system to
5319 automatically login with this staff login ___ and this password
5322 <para>AutoSelfCheckAllowed Values:</para>
5330 <para>Don't allow</para>
5334 <para>AutoSelfCheckID Value:<itemizedlist>
5336 <para>The username of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5338 </itemizedlist></para>
5340 <para>AutoSelfCheckPass Value:<itemizedlist>
5342 <para>The password of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5344 </itemizedlist></para>
5346 <section id="SCOUserCSS">
5347 <title>SCOUserCSS</title>
5348 <para>Asks: Include the following CSS on all pages in the web-based self checkout</para>
5349 <para>Description:<itemizedlist>
5351 <para>The CSS entered in this preference will be used on all of your Koha self
5352 checkout screens.</para>
5354 </itemizedlist></para>
5356 <section id="SCOUserJS">
5357 <title>SCOUserJS</title>
5358 <para>Asks: Include the following JavaScript on all pages in the web-based self
5360 <para>Description:<itemizedlist>
5362 <para>The JavaScript entered in this preference will effect all of your Koha self
5363 checkout screens.</para>
5365 </itemizedlist></para>
5368 <section id="SelfCheckHelpMessage">
5369 <title>SelfCheckHelpMessage</title>
5371 <para>Asks: Include the following HTML in the Help page of the
5372 web-based self checkout system</para>
5374 <para>Description:</para>
5378 <para>Clicking the 'Help' link in the top right of the self
5379 checkout interface opens up a three step process for using the
5380 self check interface. Adding HTML to this system preference
5381 will print that additional help text above what's already
5387 <section id="SelfCheckoutByLogin">
5388 <title>SelfCheckoutByLogin</title>
5390 <para>Default: Barcode</para>
5392 <para>Asks: Have patrons login into the web-based self checkout
5393 system with their ___</para>
5395 <para>Values:</para>
5399 <para>Barcode</para>
5402 <screeninfo>Self Checkout Patron Card Number</screeninfo>
5406 <imagedata fileref="images/circ/selfcheckout.png"/>
5413 <para>Username and password</para>
5416 <screeninfo>Shelf checkout by login</screeninfo>
5420 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
5427 <para>Description:</para>
5431 <para>This preference lets you decide how your patrons will
5432 log in to the self checkout machine. Barcode is the patron's
5433 card number and their username and password is set using the
5434 opac/staff username and password fields on the patron
5439 <section id="SelfCheckReceiptPrompt">
5440 <title>SelfCheckReceiptPrompt</title>
5441 <para>Default: Show</para>
5442 <para>Asks: ___ the print receipt popup dialog when self checkout is finished.</para>
5443 <para>Values:<itemizedlist>
5445 <para>Don't show</para>
5450 </itemizedlist></para>
5451 <para>Description:<itemizedlist>
5453 <para>This preference controls whether a prompt shows up on the web based self
5454 check out when the patron clicks the 'Finish' button.</para>
5456 </itemizedlist></para>
5459 <section id="SelfCheckTimeout">
5460 <title>SelfCheckTimeout</title>
5462 <para>Default: 120</para>
5464 <para>Asks: Time out the current patron's web-based self checkout
5465 system login after ___ seconds.</para>
5467 <para>Description:</para>
5471 <para>After the machine is idle for the time entered in this
5472 preference the self check out system will log out the current
5473 patron and return to the starting screen.</para>
5478 <section id="ShowPatronImageInWebBasedSelfCheck">
5479 <title>ShowPatronImageInWebBasedSelfCheck</title>
5481 <para>Default: Don't show</para>
5483 <para>Asks: ___ the patron's picture (if one has been added) when
5484 they use the web-based self checkout.</para>
5486 <para>Values:</para>
5490 <para>Don't show</para>
5499 <section id="WebBasedSelfCheck">
5500 <title>WebBasedSelfCheck</title>
5502 <para>Default: Don't enable</para>
5504 <para>Asks: ___ the web-based self checkout system.</para>
5506 <para>Values:</para>
5510 <para>Don't enable</para>
5518 <para>Enabling this preference will allow access to the <link linkend="selfcheckout">self checkout</link> module in Koha.</para>
5523 <section id="creatorprefs">
5524 <title>Creators</title>
5526 <para>These preferences have to do with creating content.</para>
5528 <para><emphasis>Get there:</emphasis> More > Administration >
5529 Global System Preferences > Creators</para>
5531 <section id="creatorpatcardprefs">
5532 <title>Patron Cards</title>
5534 <para>These preferences are in reference to the <link linkend="patroncardcreator">Patron Card Creator</link> tool.</para>
5536 <section id="ImageLimit">
5537 <title>ImageLimit</title>
5539 <para>Asks: Limit the number of creator images stored in the
5540 database to ___ images.</para>
5545 <section id="enhancedcontent">
5546 <title>Enhanced Content</title>
5548 <para><emphasis>Get there:</emphasis> More > Administration >
5549 Global System Preferences > Enhanced Content</para>
5552 <para>Always read the terms of service associated with external data
5553 sources to be sure that you are using the products within the
5554 allowed limits.</para>
5558 <para>You cannot have more than one service for cover images
5559 (including local cover images) set up. If you set up more than one
5560 you will get multiple cover images. Instead choose only one source
5561 for cover images.</para>
5564 <section id="frbrenhancedprefs">
5569 <section id="FRBRizeEditions">
5570 <title>FRBRizeEditions</title>
5572 <para>Default: Don't show</para>
5574 <para>Asks: ___ other editions of an item on the staff
5577 <para>Values:</para>
5581 <para>Don't show</para>
5588 <screeninfo>Editions tab in staff client</screeninfo>
5592 <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
5599 <para>Description:</para>
5603 <para>Using the rules set forth in the Functional Requirements for Bibliographic
5604 records, this option, when enabled, pulls all editions of the same title available
5605 in your collection regardless of material type. Items will appear under an
5606 'Editions' tab on the detail page for the title in question.. According to
5607 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
5608 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
5609 records of similar materials. FRBRization brings together entities (sets of Works,
5610 Expressions, or Manifestations), rather than just sets of Items. It can aid
5611 patrons in selecting related items, expressions, and manifestations that will
5612 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
5613 web services for associated ISBNs and display an Editions tab on the details
5614 pages. Once this preference is enabled, the library must select one of the ISBN
5615 options (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>). This option is only for the Staff Client; the <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> option must be enabled
5616 to have the Editions tab appear on the OPAC.</para>
5621 <para>Requires that you turn on one or more of the ISBN services (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>)</para>
5625 <section id="OPACFRBRizeEditions">
5626 <title>OPACFRBRizeEditions</title>
5628 <para>Default: Don't show</para>
5630 <para>Asks: ___ other editions of an item on the OPAC.</para>
5632 <para>Description:</para>
5636 <para>Using the rules set forth in the Functional Requirements for Bibliographic
5637 records, this option, when enabled, pulls all editions of the same title available
5638 in your collection regardless of material type. Items will appear under an
5639 'Editions' tab on the detail page for the title in question.. According to
5640 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
5641 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
5642 records of similar materials. FRBRization brings together entities (sets of Works,
5643 Expressions, or Manifestations), rather than just sets of Items. It can aid
5644 patrons in selecting related items, expressions, and manifestations that will
5645 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
5646 web services for associated ISBNs and display an Editions tab on the details
5647 pages. Once this preference is enabled, the library must select one of the ISBN
5648 options (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>). This option is only for the OPAC; the <link linkend="FRBRizeEditions">FRBRizeEditions</link> option must be turned "On" to
5649 have the Editions tab appear on the Staff Client.</para>
5653 <para>Values:</para>
5657 <para>Don't show</para>
5664 <screeninfo>Editions tab in the OPAC</screeninfo>
5668 <imagedata fileref="images/admin/globalprefs/editions.png"/>
5675 <para>This preference pulls all editions of the same title
5676 available in your collection regardless of material type. Items
5677 will appear under an 'Editions' tab on the detail page for the
5678 title in question.</para>
5681 <para>Requires that you turn on one or more of the ISBN services (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>)</para>
5686 <section id="amazonprefs">
5687 <title>Amazon</title>
5691 <section id="AmazonAssocTag">
5692 <title>AmazonAssocTag</title>
5694 <para>Asks: Put the associate tag ___ on links to Amazon.</para>
5697 <para>This can net your library referral fees if a patron
5698 decides to buy an item after clicking through to Amazon from
5702 <para>Description:</para>
5706 <para>An Amazon Associates Tag allows a library to earn a
5707 percentage of all purchases made on Amazon when a patron
5708 accesses Amazon's site via links on the library's website.
5709 More information about the Amazon Associates program is
5710 available at Amazon's Affiliate Program's website, <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
5711 Before a tag can be obtained, however, the library must first
5712 apply for an Amazon Web Services (AWS) account. Applications
5713 are free of charge and can be made at <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
5714 Once an AWS account has been established, the library can then
5715 obtain the Amazon Associates Tag.</para>
5719 <para>Sign up at: <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
5722 <section id="AmazonCoverImages">
5723 <title>AmazonCoverImages</title>
5725 <para>Default: Don't show</para>
5727 <para>Asks: ___ cover images from Amazon on search results and
5728 item detail pages on the staff interface.</para>
5730 <para>Values:</para>
5734 <para>Don't show</para>
5742 <para>Description:</para>
5746 <para>This preference makes it possible to either allow or
5747 prevent Amazon cover images from being displayed in the Staff
5748 Client. Cover images are retrieved by Amazon, which pulls the
5749 content based on the first ISBN number in the item's MARC
5750 record. Amazon offers this service free of charge. If the
5751 value for this preference is set to "Show", the cover images
5752 will appear in the Staff Client, and if it is set to "Don't
5753 show", the images will not appear. Finally, if you're using
5754 Amazon cover images, all other cover image services must be
5755 disabled. If they are not disabled, they will prevent
5756 AmazonCoverImages from functioning properly.</para>
5761 <section id="AmazonLocale">
5762 <title>AmazonLocale</title>
5764 <para>Default: American</para>
5766 <para>Asks: Use Amazon data from its ___ website.</para>
5772 <para>American</para>
5776 <para>British</para>
5780 <para>Canadian</para>
5792 <para>Japanese</para>
5797 <section id="OPACAmazonCoverImages">
5798 <title>OPACAmazonCoverImages</title>
5800 <para>Default: Don't show</para>
5802 <para>Asks: ___ cover images from Amazon on search results and
5803 item detail pages on the OPAC.</para>
5805 <para>Values:</para>
5809 <para>Don't show</para>
5817 <para>Description:</para>
5821 <para>This preference makes it possible to either allow or
5822 prevent Amazon cover images from being displayed in the OPAC.
5823 Cover images are retrieved by Amazon, which pulls the content
5824 based on the first ISBN number in the item's MARC record.
5825 Amazon offers this service free of charge. If the value for
5826 this preference is set to "Show", the cover images will appear
5827 in the OPAC, and if it is set to "Don't show", the images will
5828 not appear. Finally, if you're using Amazon cover images, all
5829 other cover image services must be disabled. If they are not
5830 disabled, they will prevent AmazonCoverImages from functioning
5837 <section id="Babelthequeprefs">
5838 <title>Babelthèque</title>
5842 <section id="Babeltheque">
5843 <title>Babeltheque</title>
5845 <para>Default: Don't</para>
5847 <para>Asks: ___ include information (such as reviews and
5848 citations) from Babelthèque in item detail pages on the
5851 <para>Description:</para>
5855 <para>This preference makes it possible to display a
5856 Babeltheque tab in the OPAC, allowing patrons to access tags,
5857 reviews, and additional title information provided by
5858 Babeltheque. The information which Babeltheque supplies is
5859 drawn from the French language-based <ulink url="http://www.babelio.com/">Babelio.com</ulink>, a French
5860 service similar to LibraryThing for Libraries. More
5861 information about Babeltheque is available through its
5862 website, <ulink url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
5863 Libraries that wish to allow access to this information must
5864 first register for the service at <ulink url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
5865 Please note that this information is only provided in
5870 <para>Values:</para>
5877 <screeninfo>Data from Babelthèque on the bib
5882 <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
5894 <section id="Babeltheque_url_js">
5895 <title>Babeltheque_url_js</title>
5897 <para>Asks: ___ Defined the url for the Babeltheque javascript
5898 file (eg. http://www.babeltheque.com/bw_XX.js)</para>
5901 <section id="Babeltheque_url_update">
5902 <title>Babeltheque_url_update</title>
5904 <para>Asks: ___ Defined the url for the Babeltheque update
5906 http://www.babeltheque.com/.../file.csv.bz2).</para>
5910 <section id="btcontentprefs">
5911 <title>Baker & Taylor</title>
5914 <para>This is a pay service, you must contact Baker & Taylor
5915 to subscribe to this service before setting these options.</para>
5918 <section id="BakerTaylorEnabled">
5919 <title>BakerTaylorEnabled</title>
5921 <para>Default: Don't add</para>
5923 <para>Asks: ___ Baker and Taylor links and cover images to the
5924 OPAC and staff client. This requires that you have entered in a
5925 username and password (which can be seen in image links).</para>
5927 <para>Values:</para>
5935 <para>Don't add</para>
5939 <para>Description:</para>
5943 <para>This preference makes it possible to display Baker &
5944 Taylor content (book reviews, descriptions, cover images,
5945 etc.) in both the Staff Client and the OPAC. Libraries that
5946 wish to display Baker & Taylor content must first register
5947 and pay for this service with Baker & Taylor (<ulink url="http://www.btol.com">http://www.btol.com</ulink>). If
5948 Baker & Taylor content is enabled be sure to turn off
5949 other cover and review services to prevent
5950 interference.</para>
5955 <para>To use this you will need to also set the <link linkend="btuserpass">BakerTaylorUsername &
5956 BakerTaylorPassword</link> system preferences</para>
5960 <section id="BakerTaylorBookstoreURL">
5961 <title>BakerTaylorBookstoreURL</title>
5963 <para>Asks: Baker and Taylor "My Library Bookstore" links should
5964 be accessed at https:// ___ isbn</para>
5966 <para>Description:</para>
5970 <para>Some libraries generate additional funding for the
5971 library by selling books and other materials that are
5972 purchased from or have been previously leased from Baker &
5973 Taylor. These materials can be accessed via a link on the
5974 library's website. This service is often referred to as "My
5975 Library Bookstore." In order to participate in this program,
5976 the library must first register and pay for the service with
5977 Baker & Taylor. Additional information about this and
5978 other services provided by Baker & Taylor is available at
5979 the Baker & Taylor website, <ulink url="http://www.btol.com">http://www.btol.com</ulink>. The
5980 BakerTaylorBookstoreURL preference establishes the URL in
5981 order to link to the library's Baker & Taylor-backed
5982 online bookstore, if such a bookstore has been established.
5983 The default for this field is left blank; if no value is
5984 entered, the links to My Library Bookstore will remain
5985 inactive. If enabling this preference, enter the library's
5986 Hostname and Parent Number in the appropriate location within
5987 the URL. The "key" value (key=) should be appended to the URL,
5988 and https:// should be prepended.</para>
5992 <para>This should be filled in with something like
5993 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
5996 <para>Leave it blank to disable these links.</para>
6000 <para>Be sure to get this information from Baker & Taylor
6001 when subscribing.</para>
6005 <section id="btuserpass">
6006 <title>BakerTaylorUsername & BakerTaylorPassword</title>
6008 <para>Asks: Access Baker and Taylor using username ___ and
6011 <para>Descriptions:</para>
6015 <para>This setting in only applicable if the library has a
6016 paid subscription to the external Content Café service from
6017 Baker & Taylor. Use the box provided to enter in the
6018 library's Content Café username and password. Also, ensure
6019 that the <link linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
6020 and <link linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
6021 settings are properly set. The Content Café service is a feed
6022 of enhanced content such as cover art, professional reviews,
6023 and summaries that is displayed along with Staff Client/OPAC
6024 search results. For more information on this service please
6025 see the Baker & Taylor website: <ulink url="http://www.btol.com">http://www.btol.com</ulink></para>
6030 <para>Be sure to get this information from Baker & Taylor
6031 when subscribing.</para>
6036 <section id="googleprefs">
6037 <title>Google</title>
6041 <section id="GoogleJackets">
6042 <title>GoogleJackets</title>
6044 <para>Default: Don't add</para>
6046 <para>Asks: ___ cover images from Google Books to search results
6047 and item detail pages on the OPAC.</para>
6049 <para>Values:</para>
6057 <para>Don't add</para>
6061 <para>Description:</para>
6065 <para>This setting controls the display of applicable cover
6066 art from the free Google Books database, via the Google Books
6067 API. Please note that to use this feature, all other cover
6068 services should be turned off.</para>
6073 <section id="html5">
6074 <title>HTML5 Media</title>
6075 <section id="HTML5MediaEnabled">
6076 <title>HTML5MediaEnabled</title>
6077 <para>Default: not at all</para>
6078 <para>Asks: Show a tab with a HTML5 media player for files catalogued in field 856
6080 <para>Values:<itemizedlist>
6082 <para>in OPAC and staff client</para>
6085 <para>in the OPAC</para>
6087 <screeninfo>HTML5 Media in the OPAC</screeninfo>
6090 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-opac.png"/>
6096 <para>in the staff client</para>
6098 <screeninfo>HTML5 Media in the staff client</screeninfo>
6101 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-staff.png"/>
6107 <para>not at all</para>
6109 </itemizedlist></para>
6110 <para>Description:<itemizedlist>
6112 <para>If you have media elements in the 856 of your MARC record this preference
6113 can run/show those media files in a separate tab using HTML5.</para>
6115 </itemizedlist></para>
6117 <section id="HTML5MediaExtensions">
6118 <title>HTML5MediaExtensions</title>
6119 <para>Default: webm|ogg|ogv|oga|vtt</para>
6120 <para>Asks: Media file extensions ___</para>
6121 <para>Description:<itemizedlist>
6123 <para>Enter in file extensions separated with bar (|)</para>
6125 </itemizedlist></para>
6128 <section id="IDreamLibraries">
6129 <title>IDreamLibraries</title>
6130 <para><ulink url="http://idreambooks.com/">IDreamBooks.com</ulink> aggregates book reviews
6131 by critics to help you discover the very best of what's coming out each week. These
6132 preferences let you integrated content from <ulink url="http://IDreamBooks.com">IDreamBooks.com</ulink> in to your Koha OPAC. <tip>
6133 <para>This is a new website and has limited content, so you may only see these
6134 features on new popular titles until the database grows some more.</para>
6136 <section id="IDreamBooksReadometer">
6137 <title>IDreamBooksReadometer</title>
6138 <para>Default: Don't add</para>
6139 <para>Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com
6140 to the OPAC details page. </para>
6141 <para>Values:<itemizedlist>
6145 <screeninfo>Readometer on the details page</screeninfo>
6148 <imagedata fileref="images/admin/globalprefs/IDreamBooksReadometer.png"/>
6154 <para>Don't add</para>
6156 </itemizedlist></para>
6158 <section id="IDreamBooksResults">
6159 <title>IDreamBooksResults</title>
6160 <para>Default: Don't add</para>
6161 <para>Asks: ___ the rating from IDreamBooks.com to OPAC search results. </para>
6162 <para>Values:<itemizedlist>
6166 <screeninfo>iDreamBooks rating on search results</screeninfo>
6169 <imagedata fileref="images/admin/globalprefs/IDreamBooksResults.png"/>
6175 <para>Don't add</para>
6177 </itemizedlist></para>
6179 <section id="IDreamBooksReviews">
6180 <title>IDreamBooksReviews</title>
6181 <para>Default: Don't add</para>
6182 <para>Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by
6183 IDreamBooks.com. </para>
6184 <para>Values:<itemizedlist>
6188 <screeninfo>Reviews tab on the detail page</screeninfo>
6191 <imagedata fileref="images/admin/globalprefs/IDreamBooksReviews.png"/>
6197 <para>Don't add</para>
6199 </itemizedlist></para>
6203 <section id="librarythingprefs">
6204 <title>LibraryThing</title>
6206 <para>LibraryThing for Libraries is a pay service. You must first
6207 contact LibraryThing directly for pricing and subscription
6208 information. Learn more at <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
6209 Also, for further configuration instructions please see the
6210 LibraryThing Wiki: <ulink url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
6212 <section id="LibraryThingForLibrariesEnabled">
6213 <title>LibraryThingForLibrariesEnabled</title>
6215 <para>Default: Don't show</para>
6217 <para>Asks: ___ reviews, similar items, and tags from Library
6218 Thing for Libraries on item detail pages on the OPAC.</para>
6220 <para>Values:</para>
6224 <para>Don't show</para>
6232 <para>Description:</para>
6236 <para>This setting is only applicable if the library has a
6237 paid subscription to the external LibraryThing for Libraries
6238 service. This service can provide patrons with the display of
6239 expanded information on catalog items such as book
6240 recommendations. It also can offer advanced features like
6241 tagged browsing, patron written reviews, and a virtual library
6242 display accessed from the details tab.</para>
6247 <para>If this is set to 'show' you will need to enter a value in
6248 the '<link linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
6249 system preference.</para>
6253 <section id="LibraryThingForLibrariesID">
6254 <title>LibraryThingForLibrariesID</title>
6256 <para>Asks: Access Library Thing for Libraries using the customer
6259 <para>Description:</para>
6263 <para>This setting is only applicable if the library has a
6264 paid subscription to the external LibraryThing for Libraries
6265 service. Use the box provided to enter in the library's
6266 LibraryThing for Libraries ID as provided to the library by
6267 LibraryThing. The ID number is a series of numbers in the form
6268 ###-#########, and can be found on the library's account page
6269 at LibraryThing for Libraries. This service can provide
6270 patrons with the display of expanded information on catalog
6271 items such as book recommendations and cover art. It also can
6272 offer advanced features like tagged browsing, patron written
6273 reviews, and a virtual library display accessed from the
6279 <section id="LibraryThingForLibrariesTabbedView">
6280 <title>LibraryThingForLibrariesTabbedView</title>
6282 <para>Default: in line with bibliographic information</para>
6284 <para>Asks: Show Library Thing for Libraries content ___</para>
6286 <para>Values:</para>
6290 <para>in line with bibliographic information</para>
6294 <para>in tabs</para>
6298 <para>Description:</para>
6302 <para>This setting is only applicable if the library has a
6303 paid subscription to the external LibraryThing for Libraries
6304 service. This service can provide patrons with the display of
6305 expanded information on catalog items such as book
6306 recommendations and cover art. It also can offer advanced
6307 features like tagged browsing, patron written reviews, and a
6308 virtual library display accessed from the details tab.</para>
6312 <section id="ThingISBN">
6313 <title>ThingISBN</title>
6314 <para>Default: Don't use</para>
6315 <para>Asks: ___ the ThingISBN service to show other editions of a title</para>
6316 <para>Values:</para>
6319 <para>Don't use</para>
6325 <para>Description:</para>
6328 <para>Set to 'Use' to display an "Editions" tab on the item's detail page. Editions
6329 are listed, complete with cover art (if you have one of the cover services
6330 enabled) and bibliographic information. The feed comes from LibraryThing's
6331 ThingISBN web service. This is a free service to non-commercial sites with fewer
6332 than 1,000 requests per day.</para>
6336 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
6337 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to 'show'</para>
6340 <para>This is separate from Library Thing for Libraries and does not have a cost
6341 associated with it.</para>
6346 <section id="localimages">
6347 <title>Local Cover Images</title>
6351 <section id="AllowMultipleCovers">
6352 <title>AllowMultipleCovers</title>
6354 <para>Default: Don't allow</para>
6356 <para>Asks: ___ multiple images to be attached to each
6357 bibliographic record.</para>
6359 <para>Values:</para>
6367 <para>Don't allow</para>
6371 <para>Description:</para>
6375 <para>If this preference is set to 'Allow' then you can upload
6376 multiple images that will appear in the images tab on the bib
6377 record in the OPAC and the staff client. This preference
6378 requires that either one or both <link linkend="LocalCoverImages">LocalCoverImages</link> and <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
6379 set to 'Display.'</para>
6382 <screeninfo>Multiple cover images</screeninfo>
6386 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
6394 <section id="LocalCoverImages">
6395 <title>LocalCoverImages</title>
6397 <para>Default: Don't display</para>
6399 <para>Asks: ___ local cover images on intranet search and details
6402 <para>Values:</para>
6406 <para>Display</para>
6410 <para>Don't display</para>
6414 <para>Description:</para>
6418 <para>Setting this preference to 'Display' allows you to
6419 upload your own cover images to bib records and display them
6420 on the detail page in the staff client. At this time the cover
6421 will only show under the 'Images' tab on the holdings table on
6422 the detail display, not next to the title at the top left or
6423 on the search results.</para>
6428 <section id="OPACLocalCoverImages">
6429 <title>OPACLocalCoverImages</title>
6431 <para>Default: Don't display</para>
6433 <para>Asks: ___ local cover images on OPAC search and details
6436 <para>Values:</para>
6440 <para>Display</para>
6444 <para>Don't display</para>
6448 <para>Description:</para>
6452 <para>Setting this preference to 'Display' allows you to
6453 upload your own cover images to bib records and display them
6454 on the detail page and search results in the OPAC.</para>
6460 <section id="novelistselect">
6461 <title>Novelist Select</title>
6463 <para>Novelist Select is not a free service. Contact your Ebsco
6464 representitive to get your log in information to embed this content
6465 in the OPAC.<important>
6466 <para>Novelist Select does not include cover images for the search results and
6467 bibliographic detail pages. You can choose any other cover image service for this
6468 content or you can contract with Ebsco to get access to the <link linkend="btcontentprefs">Baker & Taylor Content Cafe</link> for an added
6472 <section id="NovelistSelectEnabled">
6473 <title>NovelistSelectEnabled</title>
6475 <para>Default: Don't add</para>
6477 <para>Asks: ___ Novelist Select content to the OPAC.</para>
6479 <para>Values:</para>
6487 <para>Don't add</para>
6492 <para>Enabling this requires that you have entered in a user
6493 profile and password in the <link linkend="NovelistSelectProfile">NovelistSelectProfile &
6494 NovelistSelectPassword</link> preferences</para>
6495 </important>Description:</para>
6499 <para>Novelist Select from Ebsco is a subscription service
6500 that can provide additional content in the OPAC.</para>
6505 <section id="NovelistSelectProfile">
6506 <title>NovelistSelectProfile & NovelistSelectPassword</title>
6508 <para>Asks: Access Novelist Select using user profile ___ and
6509 password ___.</para>
6512 <para>This information will be visible if someone views the
6513 source code on your OPAC.</para>
6516 <para>Description:</para>
6520 <para>Novelist Select from Ebsco is a subscription service
6521 that can provide additional content in the OPAC.</para>
6526 <section id="NovelistSelectView">
6527 <title>NovelistSelectView</title>
6529 <para>Default: in an OPAC tab</para>
6531 <para>Asks: Display Novelist Select content ___</para>
6533 <para>Description:</para>
6537 <para>Novelist Select provides a lot of content, for that
6538 reason you have four choices of where to display this content.
6539 The default view is in a tab in the holdings table.</para>
6542 <screeninfo>Novelist Select in a tab</screeninfo>
6546 <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
6551 <para>The content is the same if you choose to show it above
6552 the holdings table or below it. If shown in the right column
6553 of the page it's the same content, but displays a bit
6554 differently since space is limited.</para>
6557 <screeninfo>Novelist Select on the side</screeninfo>
6561 <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
6568 <para>Values:</para>
6572 <para>above the holdings table</para>
6576 <para>below the holdings table</para>
6580 <para>in an OPAC tab</para>
6584 <para>under the Save Record dropdown on the right</para>
6590 <section id="oclcprefs">
6595 <section id="XISBN">
6596 <title>XISBN</title>
6598 <para>Default: Don't use</para>
6600 <para>Asks: ___ the OCLC xISBN service to show other editions of a
6603 <para>Description:</para>
6607 <para>Set to 'Use' to display an "Editions" tab on the item's
6608 detail page. Editions are listed, complete with cover art and
6609 bibliographic information. The feed comes from OCLC's xISBN
6610 web service. The feed limit for non-commercial sites is 1000
6611 requests per day.</para>
6615 <para>Values:</para>
6619 <para>Don't use</para>
6628 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
6633 <section id="OCLCAffiliateID">
6634 <title>OCLCAffiliateID</title>
6636 <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
6639 <para>Description:</para>
6643 <para>This setting is only applicable if the library has an
6644 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
6645 via the XISBN programming interface. Simply enter the
6646 library's OCLC Affiliate ID in the box provided. Please note
6647 that using this data is only necessary if <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
6648 <link linkend="XISBN">XISBN</link> settings are enabled. For
6649 more information on this service please visit the OCLC
6650 website: <ulink url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
6655 <para>Unless you have signed up for an ID with OCLC, you are
6656 limited to 1000 requests per day. Available at: <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
6660 <section id="XISBNDailyLimit">
6661 <title>XISBNDailyLimit</title>
6663 <para>Default: 999</para>
6665 <para>Asks: Only use the xISBN service ___ times a day.</para>
6668 <para>Unless you have signed up for an ID with OCLC, you are
6669 limited to 1000 requests per day. Available at: <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
6674 <section id="OpenLibraryPrefs">
6675 <title>Open Library</title>
6677 <section id="OpenLibraryCovers">
6678 <title>OpenLibraryCovers</title>
6680 <para>Default: Don't add</para>
6682 <para>Asks: ___ cover images from Open Library to search results
6683 and item detail pages on the OPAC.</para>
6685 <para>Values:</para>
6693 <para>Don't add</para>
6697 <para>Description:</para>
6701 <para>This setting controls the display of applicable cover
6702 art from the free Open Library database, via the Open Library
6703 API. Please note that to use this feature, all other cover
6704 services should be turned off.</para>
6709 <section id="overdriveprefs">
6710 <title>Overdrive</title>
6711 <para>OverDrive is an pay service. You must first contact OverDrive directly for pricing
6712 and subscription information. Enabling this service will integrate Overdrive results in
6713 to your OPAC searches. You will have to apply for these 3 pieces of information through
6714 an application as an API developer. Overdrive API applications are evaluated once a week
6715 so you may not be able to use this feature immediately after signing up. To learn more
6716 please contact your OverDrive representative.</para>
6718 <screeninfo>Overdrive results</screeninfo>
6721 <imagedata fileref="images/admin/globalprefs/Overdrive.png"/>
6725 <section id="OverDriveClientKey">
6726 <title>OverDriveClientKey and OverDriveClientSecret</title>
6727 <para>Asks: Include OverDrive availability information with the client key __ and client
6729 <para>Description:<itemizedlist>
6731 <para>OverDrive customers can get this information by visiting the <ulink
6732 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
6733 Portal</ulink> and following the instructions found there to apply as an API
6734 developer. Once this data and the <link linkend="OverDriveLibraryID"
6735 >OverDriveLibraryID</link> are populated you will see OverDrive results on
6736 your OPAC searches.</para>
6738 </itemizedlist></para>
6740 <section id="OverDriveLibraryID">
6741 <title>OverDriveLibraryID</title>
6742 <para>Asks: Show items from the OverDrive catalog of library # ___</para>
6743 <para>Description:<itemizedlist>
6745 <para>OverDrive customers can get this information by visiting the <ulink
6746 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
6747 Portal</ulink> and following the instructions found there to apply as an API
6748 developer. Once this data and the <link linkend="OverDriveClientKey"
6749 >OverDriveClientKey and OverDriveClientSecret</link> are populated you will
6750 see OverDrive results on your OPAC searches.</para>
6752 </itemizedlist></para>
6755 <section id="pluginprefs">
6756 <title>Plugins</title>
6757 <section id="UseKohaPlugins">
6758 <title>UseKohaPlugins</title>
6759 <para>Default: Don't enable</para>
6760 <para>Asks: ___ the ability to use Koha Plugins.</para>
6761 <para>Values:<itemizedlist>
6763 <para>Don't enable</para>
6768 </itemizedlist></para>
6770 <para>The plugin system must also be enabled in the Koha configuration file to be
6771 fully enabled. Learn more in the <link linkend="pluginsystem">Plugins
6772 chapter</link>.</para>
6777 <section id="Syndeticsprefs">
6778 <title>Syndetics</title>
6780 <para>Syndetics is a pay service. You must first contact Syndetics
6781 directly for pricing and subscription information.</para>
6783 <section id="SyndeticsEnabled">
6784 <title>SyndeticsEnabled</title>
6786 <para>Default: Don't use</para>
6788 <para>Asks: ___ content from Syndetics.</para>
6790 <para>Values:</para>
6794 <para>Don't use</para>
6802 <para>Description:</para>
6806 <para>When this option is enabled any of the Syndetics options
6812 <para>Requires that you enter your <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
6813 this content will appear.</para>
6817 <section id="SyndeticsClientCode">
6818 <title>SyndeticsClientCode</title>
6820 <para>Asks: Use the client code ___ to access Syndetics.</para>
6822 <para>Description:</para>
6826 <para>Once the library signs up for Syndetics' services,
6827 Syndetics will provide the library with an access code. (Visit
6828 the Syndetics homepage at <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
6829 for more information.) This is the code that must be entered
6830 to access Syndetics' subscription services. Syndetics is a
6831 paid subscription service. This value must be entered before
6832 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
6833 be enabled. If the code is lost, corrupted, or forgotten, a
6834 new one can be obtained from <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
6839 <para>You will need to get your client code directly from
6844 <section id="SyndeticsCoverImages">
6845 <title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
6847 <para>SyndeticsCoverImages Default: Don't show</para>
6849 <para>SyndeticsCoverImageSize Default: medium</para>
6851 <para>Asks: ___ cover images from Syndetics on search results and
6852 item detail pages on the OPAC in a ___ size.</para>
6854 <para>Descriptions:</para>
6858 <para>When enabled, SyndeticsCoverImages, allows libraries to
6859 display Syndetics' collection of full-color cover images for
6860 books, videos, DVDs and CDs on their OPAC. For each book or
6861 item that comes up during a user search, the cover image for
6862 that title will be displayed. Since these cover images come in
6863 three sizes, the optimum size must be selected using the
6864 SyndeticsCoverImageSize preference after SyndeticsCoverImages
6865 are enabled. Syndetics cover images come in two sizes:
6866 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
6867 Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6868 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6869 be activated before this service can be used. Other cover
6870 image preferences should also be disabled to avoid
6871 interference.</para>
6875 <para>SyndeticsCoverImages Values:</para>
6879 <para>Don't show</para>
6887 <para>SyndeticsCoverImageSize Values:</para>
6900 <section id="SyndeticsAuthorNotes">
6901 <title>SyndeticsAuthorNotes</title>
6903 <para>Default: Don't show</para>
6905 <para>Asks: ___ notes about the author of a title from Syndetics
6906 on item detail pages on the OPAC.</para>
6908 <para>Values:</para>
6912 <para>Don't show</para>
6920 <para>Description:</para>
6924 <para>When this option is set to "Show", Syndetics provides
6925 notes and short author biographies for more that 300,000
6926 authors, in both fiction and nonfiction. With this option
6927 enabled the library can display Syndetics Author Notes on the
6928 OPAC. According to the Syndetics Solutions website (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
6929 Author Notes include lists of contributors for many
6930 multi-author texts and compilations. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6931 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6932 be activated before this service can be used.</para>
6937 <section id="SyndeticsAwards">
6938 <title>SyndeticsAwards</title>
6940 <para>Default: Don't show</para>
6942 <para>Asks: ___ information from Syndetics about the awards a
6943 title has won on item detail pages on the OPAC.</para>
6945 <para>Values:</para>
6949 <para>Don't show</para>
6957 <para>Description:</para>
6961 <para>When this option is set to "Show", Syndetics provides
6962 its clients with a list of awards that any title has won. With
6963 this service enabled the library can display those awards for
6964 each book on its website. For each book or item that comes up
6965 during a user search, the list of awards for that title will
6966 be displayed. When a user clicks on a given award, information
6967 about that award is presented along with a list of the other
6968 titles that have won that award. If the user clicks on any
6969 title in the list, they will see holdings information about
6970 that title in their region. This option is a paid subscription
6971 service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6972 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6973 be activated before this service can be used.</para>
6978 <section id="SyndeticsEditions">
6979 <title>SyndeticsEditions</title>
6981 <para>Default: Don't show</para>
6983 <para>Asks: ___ information about other editions of a title from
6984 Syndetics on item detail pages on the OPAC</para>
6986 <para>Description:</para>
6990 <para>When enabled this option shows information on other
6991 editions of a title from Syndetics on the item detail pages of
6992 the OPAC. Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6993 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6994 be activated before this service can be used.</para>
6998 <para>Values:</para>
7002 <para>Don't show</para>
7011 <para>Requires <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
7016 <section id="SyndeticsExcerpt">
7017 <title>SyndeticsExcerpt</title>
7019 <para>Default: Don't show</para>
7021 <para>Asks: ___ excerpts from of a title from Syndetics on item
7022 detail pages on the OPAC.</para>
7024 <para>Values:</para>
7028 <para>Don't show</para>
7036 <para>Description:</para>
7040 <para>This preference allows Syndetics to display excerpts
7041 given to them from selected publishers. The excerpts are
7042 available from prominently reviewed new titles, both fiction
7043 and non-fiction. The excerpts include poems, essays, recipes,
7044 forwards and prefaces. Automatic links provided by the ISBNs
7045 within local MARC records are required to integrate Syndetics
7046 secured, high-speed Internet servers to the library OPACs. For
7047 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7052 <section id="SyndeticsReviews">
7053 <title>SyndeticsReviews</title>
7055 <para>Default: Don't show</para>
7057 <para>Asks: ___ reviews of a title from Syndetics on item detail
7058 pages on the OPAC.</para>
7060 <para>Values:</para>
7064 <para>Don't show</para>
7072 <para>Description:</para>
7076 <para>Syndetics Reviews is an accumulation of book reviews
7077 available from a variety of journals and serials. The reviews
7078 page displays colored images of reviewed books dust jackets,
7079 partnered with the names of the journal or serial providing
7080 the review. Clicking on an icon opens a window revealing the
7081 book title, author's name, book cover icon and the critic's
7082 opinion of the book. Automatic links provided by the ISBNs
7083 within local MARC records are required to integrate Syndetics
7084 secured, high-speed Internet servers to the library OPACs. For
7085 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7090 <section id="SyndeticsSeries">
7091 <title>SyndeticsSeries</title>
7093 <para>Default: Don't show</para>
7095 <para>Asks: ___ information on other books in a title's series
7096 from Syndetics on item detail pages on the OPAC.</para>
7098 <para>Values:</para>
7102 <para>Don't show</para>
7110 <para>Description:</para>
7114 <para>Each fiction title within a series is linked to the
7115 complete series record. The record displays each title in
7116 reading order and also displays the publication order, if
7117 different. Alternate series titles are also displayed.
7118 Automatic links provided by the ISBNs within local MARC
7119 records are required to integrate Syndetics secured, high-
7120 speed Internet servers to the library OPACs. For more
7121 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7126 <section id="SyndeticsSummary">
7127 <title>SyndeticsSummary</title>
7129 <para>Default: Don't show</para>
7131 <para>Asks: ___ a summary of a title from Syndetics on item detail
7132 pages on the OPAC.</para>
7134 <para>Values:</para>
7138 <para>Don't show</para>
7146 <para>Description:</para>
7150 <para>Providing more than 5.6 million summaries and
7151 annotations derived from book jackets, edited publisher copy,
7152 or independently written annotations from Book News, Inc.
7153 Covering fiction and non-fiction, this summaries option
7154 provides annotations on both trade and scholarly titles. For
7155 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7160 <section id="SyndeticsTOC">
7161 <title>SyndeticsTOC</title>
7163 <para>Default: Don't show</para>
7165 <para>Asks: ___ the table of contents of a title from Syndetics on
7166 item detail pages on the OPAC.</para>
7168 <para>Values:</para>
7172 <para>Don't show</para>
7180 <para>Description:</para>
7184 <para>This preference allows staff and patrons to review the
7185 Table of Contents from a wide variety of publications from
7186 popular self-help books to conference proceedings. Specific
7187 Information access is the main purpose for this option,
7188 allowing patrons guidance to their preferred section of the
7189 book. Special arrangements with selected book services is used
7190 to obtain the table of contents for new publications each
7191 year. Automatic links provided by the ISBNs within local MARC
7192 records are required to integrate Syndetics secured,
7193 high-speed Internet servers to the library OPACs. For more
7194 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7200 <section id="taggingprefs">
7201 <title>Tagging</title>
7203 <section id="TagsEnabled">
7204 <title>TagsEnabled</title>
7206 <para>Default: Allow</para>
7208 <para>Asks: ___ patrons and staff to put tags on items.</para>
7210 <para>Values:</para>
7218 <para>Don't allow</para>
7222 <para>Description:</para>
7226 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
7227 added to identify an item. Tags allow patrons to classify
7228 materials on their own. TagsEnabled is the main switch that
7229 permits the tagging features. TagsEnable must be set to
7230 'Allow' to allow for other tagging features.</para>
7235 <section id="TagsModeration">
7236 <title>TagsModeration</title>
7238 <para>Default: Don't require</para>
7240 <para>Asks: ___ that tags submitted by patrons be reviewed by a
7241 staff member before being shown.</para>
7243 <para>Values:</para>
7247 <para>Don't require</para>
7251 <para>Require</para>
7255 <para>Description:</para>
7259 <para>When set to 'Require,' all tags to be first filtered by
7260 the tag moderator. Only approved tags will be visible to
7261 patrons. When set to 'Don't require' tags will bypass the tag
7262 moderator and patrons' tags to be immediately visible. When
7263 this preference is enabled the moderator, a staff member,
7264 would approve the tag in the Staff Client. The moderator will
7265 have the option to approve or reject each pending tag
7270 <para>When moderation is required all tags go through the tag
7271 moderation tool before becoming visible.</para>
7275 <para><emphasis>Get there:</emphasis> More > Tools >
7276 <link linkend="tagsmoderation">Tags</link></para>
7281 <section id="TagsShowOnList">
7282 <title>TagsShowOnList</title>
7284 <para>Default: 6</para>
7286 <para>Asks: Show ___ tags on search results on the OPAC.</para>
7289 <para>Set the value to 0 (zero) to turn this feature off.</para>
7293 <section id="TagsInputOnList">
7294 <title>TagsInputOnList</title>
7296 <para>Default: Allow</para>
7298 <para>Asks: ___ patrons to input tags on search results on the
7301 <para>Values:</para>
7308 <screeninfo>Tags on Search Results</screeninfo>
7312 <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
7319 <para>Don't allow</para>
7324 <section id="TagsShowOnDetail">
7325 <title>TagsShowOnDetail</title>
7327 <para>Default: 10</para>
7329 <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
7332 <para>Set the value to 0 (zero) to turn this feature off.</para>
7336 <section id="TagsInputOnDetail">
7337 <title>TagsInputOnDetail</title>
7339 <para>Default: Allow</para>
7341 <para>Asks: ___ patrons to input tags on item detail pages on the
7344 <para>Values:</para>
7351 <screeninfo>Add Tags on Detail</screeninfo>
7355 <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
7362 <para>Don't allow</para>
7367 <section id="TagsExternalDictionary">
7368 <title>TagsExternalDictionary</title>
7370 <para>Asks: Allow tags in the dictionary of the ispell executable
7371 ___ on the server to be approved without moderation.</para>
7373 <para>Description:</para>
7377 <para>The dictionary includes a list of accepted and rejected
7378 tags. The accepted list includes all the tags that have been
7379 pre-allowed. The rejected list includes tags that are not
7380 allowed. This preference identifies the "accepted" dictionary
7381 used. Ispell is an open source dictionary which can be used as
7382 a list of accepted terms. Since the dictionary allows for
7383 accurately spelled obscenities, the libraries policy may
7384 dictate that modifications are made to the Ispell dictionary
7385 if this preference is use. For more information about Ispell
7386 <ulink url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
7387 Enter the path on your server to a local ispell executable,
7388 used to set $Lingua::Ispell::path.</para>
7395 <section id="l18nprefs">
7396 <title>I18N/L10N</title>
7398 <para><emphasis> <emphasis>These preferences control your
7399 Internationalization and Localization settings.</emphasis>
7402 <para><emphasis>Get there:</emphasis> More > Administration >
7403 Global System Preferences > I18N/L10N</para>
7404 <section id="alphabet">
7405 <title>alphabet</title>
7406 <para>Default: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z</para>
7407 <para>Asks: Use the alphabet ___ for lists of browsable letters. This should be a space
7408 separated list of uppercase letters. </para>
7409 <para>Description:</para>
7412 <para>This preference allows you define your own alphabet for browsing patrons in Koha.</para>
7414 <screeninfo>Alphabet browse on patron module</screeninfo>
7417 <imagedata fileref="images/admin/globalprefs/alphabet.png"/>
7425 <section id="CalendarFirstDayOfWeek">
7426 <title>CalendarFirstDayOfWeek</title>
7428 <para>Default: Sunday</para>
7430 <para>Asks: Use ___ as the first day of week in the calendar.</para>
7432 <para>Values:</para>
7444 <para>Description:</para>
7448 <para>Using this preference you can control what day shows as
7449 the first day of the week in the calendar pop ups throughout
7450 Koha and on the Calendar tool. If you change this preference and
7451 don't see a change in your browser try clearing your cache since
7452 it makes changes to the Javascript on these pages.</para>
7457 <section id="dateformat">
7458 <title>dateformat</title>
7460 <para>Default: mm/dd/yyyy</para>
7462 <para>Asks: Format dates like ___</para>
7464 <para>Values:</para>
7468 <para>dd/mm/yyyy</para>
7472 <para>mm/dd/yyyy</para>
7476 <para>yyyy/mm/dd</para>
7480 <para>Description:</para>
7484 <para>This preference controls how the date is displayed. The
7485 options are the United States method, mm/dd/yyyy (04/24/2010),
7486 the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
7487 International Standard of Organization, yyyy/mm/dd (2010/04/24).
7488 The International Standard of Organization would primarily be
7489 used by libraries with locations in multiple nations that may
7490 use different date formats, to have a single display type, or if
7491 the library would be in a region that does not use the United
7492 States or metric method. More information regarding the ISO date
7493 format can be found at <ulink url="http://www.iso.org/iso/iso_catalogue.htm">http://www.iso.org/iso/iso_catalogue.htm</ulink>.</para>
7498 <section id="languagepref">
7499 <title>language</title>
7501 <para>Default: English</para>
7503 <para>Asks: Enable the following languages on the staff
7506 <para>Values:</para>
7510 <para>English</para>
7514 <para>To install additional languages you need to run
7515 misc/translation/install-code.pl. For example, to install French you
7516 would run the following command <emphasis>install-code.pl
7517 fr-FR</emphasis> to make the templates, once they exist and are in
7518 the right place then they will show up as an option in this
7522 <section id="opaclanguages">
7523 <title>opaclanguages</title>
7525 <para>Default: English</para>
7527 <para>Asks: Enable the following languages on the OPAC</para>
7529 <para>Values:</para>
7533 <para>English</para>
7537 <para>To install additional languages you need to run
7538 misc/translation/install-code.pl. For example, to install French you
7539 would run the following command <emphasis>install-code.pl
7540 fr-FR</emphasis> to make the templates, once they exist and are in
7541 the right place then they will show up as an option in this
7545 <section id="opaclanguagesdisplay">
7546 <title>opaclanguagesdisplay</title>
7548 <para>Default: Don't allow</para>
7550 <para>Asks: ___ patrons to select their language on the OPAC.</para>
7552 <para>Values:</para>
7559 <screeninfo>When this preference is on, patrons can choose
7560 their language from a list at the bottom of the
7565 <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
7572 <para>Don't allow</para>
7576 <section id="TimeFormat">
7577 <title>TimeFormat</title>
7578 <para>Default: 24 hour format</para>
7579 <para>Asks: Format times in ___ </para>
7580 <para>Values:<itemizedlist>
7582 <para>12 hour format (eg 02:18PM)</para>
7585 <para>24 hour format (eg 14:18)</para>
7587 </itemizedlist></para>
7591 <section id="localprefs">
7592 <title>Local Use</title>
7594 <para><emphasis> <emphasis>These preferences are defined
7595 locally.</emphasis> </emphasis></para>
7597 <para><emphasis>Get there:</emphasis> More > Administration >
7598 Global System Preferences > Local Use<tip>
7599 <para>Sometimes preferences which are either new or outdated will
7600 appear in this tab, if you didn't add any preferences to this tab
7601 then it's best to ignore preferences listed here.</para>
7608 <para>Logs keep track of transaction on the system. You can decide
7609 which actions you want to log and which you don't using these
7612 <para><emphasis>Get there:</emphasis> More > Administration >
7613 Global System Preferences > Logs</para>
7615 <section id="AuthoritiesLog">
7616 <title>AuthoritiesLog</title>
7618 <para>Default: Don't log</para>
7620 <para>Asks: ___ changes to authority records.</para>
7622 <para>Values:</para>
7626 <para>Don't log</para>
7635 <section id="BorrowersLog">
7636 <title>BorrowersLog</title>
7638 <para>Default: Log</para>
7640 <para>Asks: ___ changes to patron records.</para>
7642 <para>Values:</para>
7646 <para>Don't log</para>
7655 <section id="CataloguingLog">
7656 <title>CataloguingLog</title>
7658 <para>Default: Don't log</para>
7660 <para>Asks: ___ any changes to bibliographic or item records.</para>
7662 <para>Values:</para>
7666 <para>Don't log</para>
7675 <para>Since this occurs whenever a book is cataloged, edited, or
7676 checked in or out it can be very resource intensive - slowing down
7681 <section id="FinesLog">
7682 <title>FinesLog</title>
7684 <para>Default: Log</para>
7686 <para>Asks: ___ when overdue fines are charged or automatically
7689 <para>Values:</para>
7693 <para>Don't log</para>
7702 <section id="IssueLog">
7703 <title>IssueLog</title>
7705 <para>Default: Log</para>
7707 <para>Asks: ___ when items are checked out.</para>
7709 <para>Values:</para>
7713 <para>Don't log</para>
7722 <section id="LetterLog">
7723 <title>LetterLog</title>
7725 <para>Default: Log</para>
7727 <para>Asks: ___ when an automatic claim notice is sent.</para>
7729 <para>Values:</para>
7733 <para>Don't log</para>
7742 <para>This log tracks all notices that go to patrons including the
7743 overdue notices.</para>
7747 <section id="ReturnLog">
7748 <title>ReturnLog</title>
7750 <para>Default: Log</para>
7752 <para>Asks: ___ when items are returned.</para>
7754 <para>Values:</para>
7758 <para>Don't log</para>
7767 <section id="SubscriptionLog">
7768 <title>SubscriptionLog</title>
7770 <para>Default: Log</para>
7772 <para>Asks: ___ when serials are added, deleted or changed.</para>
7774 <para>Values:</para>
7778 <para>Don't log</para>
7788 <section id="opacprefs">
7791 <para><emphasis>Get there:</emphasis> More > Administration >
7792 Global System Preferences > OPAC</para>
7794 <section id="opacappearanceprefs">
7795 <title>Appearance</title>
7797 <para>These preferences control how things appear in the
7800 <section id="AuthorisedValueImages">
7801 <title>AuthorisedValueImages</title>
7803 <para>Default: Don't show</para>
7805 <para>Asks: ___ images for authorized values (such as lost
7806 statuses and locations) in search results and item detail pages on
7809 <para>Values:</para>
7813 <para>Don't show</para>
7821 <para><emphasis>Get there:</emphasis> More > Administration
7822 > <link linkend="authorizedvalues">Authorized
7823 Values</link></para>
7826 <section id="BiblioDefaultView">
7827 <title>BiblioDefaultView</title>
7829 <para>Default: in simple form</para>
7831 <para>Asks: By default, show bib records ___</para>
7833 <para>Values:</para>
7837 <para>as specified in the ISBD template.</para>
7841 <para>See <link linkend="isbdpref">ISBD</link> preference
7842 for more information</para>
7848 <para>in simple form.</para>
7852 <para>in their MARC format.</para>
7856 <para>Description:</para>
7860 <para>This preference determines the level of bibliographic
7861 detail that the patron will see on the OPAC detail page. The
7862 simple form displays the graphical interface; MARC format
7863 displays the MARC21 cataloging view; ISBD displays the ISBD
7864 (International Standard Bibliographic Description, AACR2)
7870 <section id="COinSinOPACResults">
7871 <title>COinSinOPACResults</title>
7873 <para>Default: Include</para>
7875 <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
7878 <para>Values:</para>
7882 <para>Don't include</para>
7886 <para>If you choose not to include COinS on the search
7887 results, it will still be loaded on the individual
7888 bibliographic records.</para>
7894 <para>Include</para>
7898 <para>Enabling this feature will slow OPAC search response
7905 <para>Description:</para>
7909 <para>COinS stands for ContextObjects in Spans. COinS is a
7910 method to embed bibliographic metadata in the HTML code of web
7911 pages. This allows bibliographic software to publish
7912 machine-readable bibliographic items and client reference
7913 management software (such as Zotero) to retrieve bibliographic
7914 metadata. The metadata can also be sent to an OpenURL
7915 resolver. This allows, for instance, searching for a copy of a
7916 book in one's own library.</para>
7921 <section id="DisplayOPACiconsXSLT">
7922 <title>DisplayOPACiconsXSLT</title>
7924 <para>Default: Don't show</para>
7926 <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
7927 ___ icons for itemtype and authorized values.<important>
7928 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
7929 and/or <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
7930 must be set to use an XSLT stylesheet for this to show
7931 (default or custom)</para>
7934 <para>Values:</para>
7938 <para>Don't show</para>
7945 <screeninfo>DisplayOPACiconsXSLT</screeninfo>
7949 <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
7957 <para>See the <link linkend="XSLTiTypes">XSLT Icon
7958 Guide</link> for more information on these icons.</para>
7962 <section id="hidelostitems">
7963 <title>hidelostitems</title>
7965 <para>Default: Don't show</para>
7967 <para>Asks: ___ lost items on search and detail pages.</para>
7969 <para>Description:</para>
7973 <para>Items that are marked lost by the library can either be
7974 shown or not shown on the OPAC. By setting the value to "Don't
7975 show," the lost item is not shown on the OPAC. By setting the
7976 value "Show," the lost item is shown on the OPAC for patrons
7977 to view with a status of 'lost.'</para>
7981 <para>Values:</para>
7985 <para>Don't show</para>
7992 <screeninfo>Lost item showing in the OPAC</screeninfo>
7996 <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
8003 <section id="HighlightOwnItemsOnOPAC">
8004 <title>HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich</title>
8005 <para>HighlightOwnItemsOnOPAC Default: Don't emphasize</para>
8006 <para>HighlightOwnItemsOnOPACWhich Default: patron's home library </para>
8007 <para>Asks: ___ results from the ___ by moving the results to the front and increasing
8008 the size or highlighting the rows for those results. </para>
8009 <para>HighlightOwnItemsOnOPAC Values:<itemizedlist>
8011 <para>Don't emphasize</para>
8014 <para>Emphasize</para>
8016 </itemizedlist></para>
8017 <para>HighlightOwnItemsOnOPACWhich Values:<itemizedlist>
8019 <para>OPAC's branch based via the URL<itemizedlist>
8021 <para>The library is chosen based on the Apache environment variable
8022 BRANCHCODE. For example, this could be added to the OPAC section of
8023 koha-httpd.conf: SetEnv BRANCHCODE "CPL"</para>
8025 </itemizedlist></para>
8028 <para>patron's home library<itemizedlist>
8030 <para>The items emphasized will be those of the same library as the patron's
8031 library. If no one is logged into the OPAC, no items will be
8034 </itemizedlist></para>
8036 </itemizedlist></para>
8038 <para>This preference will only effect sites that are not using an XSLT stylesheet.
8039 XSLT stylesheets are defined in the <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> and <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> preferences.</para>
8043 <section id="LibraryName">
8044 <title>LibraryName</title>
8046 <para>Asks: Show ___ as the name of the library on the
8050 <para>This value will appear in the title bar of the
8055 <para>Edit '<link linkend="opacheader">opacheader</link>' if
8056 you'd like to add a library name above your search box on the
8061 <screeninfo>Browser title and address bar</screeninfo>
8065 <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
8070 <section id="NoLoginInstructions">
8071 <title>NoLoginInstructions</title>
8072 <para>Asks: Show the following HTML on the OPAC login form when a patron is not logged
8074 <para>Description:<itemizedlist>
8076 <para>This preference allows you to override the default text seen on the log in
8077 page in the Koha OPAC. The default HTML
8078 is:<programlisting><h5>Don't have a password yet?</h5>
8079 <p> If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
8080 <h5>Don't have a library card?</h5>
8081 <p> If you don't have a library card, stop by your local library to sign up.</p></programlisting></para>
8082 <para>Any HTML in this box will replace the above text below the log in box.<screenshot>
8083 <screeninfo>No login instructions</screeninfo>
8086 <imagedata fileref="images/admin/globalprefs/NoLoginInstructions.png"/>
8089 </screenshot></para>
8091 </itemizedlist></para>
8094 <section id="OpacAddMastheadLibraryPulldown">
8095 <title>OpacAddMastheadLibraryPulldown</title>
8097 <para>Default: Don't add</para>
8099 <para>Asks: ___ a library select pulldown menu on the OPAC
8102 <para>Values:</para>
8109 <screeninfo>Library select box on Koha OPAC</screeninfo>
8113 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
8120 <para>Don't Add</para>
8123 <screeninfo>No library select box on Koha OPAC</screeninfo>
8127 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
8135 <section id="OPACBaseURL">
8136 <title>OPACBaseURL</title>
8138 <para>Asks: The OPAC is located at http:// ___</para>
8139 <para>Description:<itemizedlist>
8141 <para>This preference is looking for the URL of your public catalog (OPAC) without
8142 the http:// in front of it (enter www.mycatalog.com instead of
8143 http://www.mycatalog.com). Once it is filled in Koha will use it to generate
8144 permanent links in your RSS feeds, for your social network share buttons and in
8145 your staff client when generating links to bib records in the OPAC.</para>
8147 </itemizedlist></para>
8149 <para>Do not include a trailing slash in the URL this will break links created using
8150 this URL. (example: www.google.com not www.google.com/)</para>
8154 <para>This must be filled in with the URL of your public catalog for RSS, unAPI, and
8155 search plugins to work.</para>
8159 <para>This must be filled in with the URL of your public catalog to show 'OPAC View'
8160 links from bib records in the staff client:</para>
8164 <screeninfo>With OPACBaseURL set, links to the OPAC will appear
8165 on each individual bib record in the staff client</screeninfo>
8169 <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
8175 <section id="opaccolorstylesheet">
8176 <title>opaccolorstylesheet</title>
8178 <para>Asks: Include the additional CSS stylesheet ___ to override
8179 specified settings from the default stylesheet.</para>
8181 <para>Description:</para>
8185 <para>The preference can look for stylesheets in the template
8186 directory for your OPAC language, for instance:
8187 /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file,
8188 opac-mystyles.css to this directory, you can specify it by
8189 entering opac-mystyles.css in your opaccolorstylesheet system
8190 preference. This adds your custom stylesheet as a linked
8191 stylesheet alongside the OPAC's default CSS files. This method
8192 is preferable because linked stylesheets are cached by the
8193 user's browser, meaning upon repeat visits to your site the
8194 user's browser will not have to re-download the stylesheet,
8195 instead using the copy in the browser's cache.</para>
8199 <para>If you would rather, you can upload your CSS to another
8200 server and enter the full URL pointing to it's location
8201 remember to begin the URL with http://</para>
8206 <para>Leave this field blank to disable it</para>
8210 <para>This file will add a linked CSS, not replace the
8211 existing default CSS.</para>
8214 <para>If using the <link linkend="opacthemes">CCSR theme</link>, this preference must
8215 be set to color.css and any user generated CSS must be appended to the default
8216 color.css file.</para>
8220 <section id="opaccredits">
8221 <title>opaccredits</title>
8223 <para>Asks: Include the following HTML in the footer of all pages
8227 <para>Click the 'Click to edit; link to enter HTML to appear at
8228 the bottom of every page in the OPAC</para>
8232 <screeninfo>HTML version of a footer for your OPAC</screeninfo>
8236 <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
8242 <screeninfo>A sample of what can appear in your OPAC
8243 credits/footer</screeninfo>
8247 <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
8252 <para>Description:</para>
8256 <para>This setting is for credits that will appear at the
8257 bottom of your OPAC pages. Credits traditionally encompass
8258 copyright information, last date updated, hyperlinks or other
8259 information represented in an HTML format. This is static
8260 information and any updates must be entered manually.</para>
8264 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8265 Regions</link> section.</para>
8268 <section id="OPACDisplay856uAsImage">
8269 <title>OPACDisplay856uAsImage</title>
8271 <para>Default: Neither details or results page</para>
8273 <para>Asks: Display the URI in the 856u field as an image on:
8276 <para>Values:</para>
8280 <para>Both results and details pages</para>
8285 <para>Not implemented yet</para>
8292 <para>Detail page only</para>
8297 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
8298 needs to have a value in it for this preference to work.</para>
8304 <screeninfo>Showing the 856u as an image</screeninfo>
8308 <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
8315 <para>Neither details or results page</para>
8319 <para>Results page only</para>
8324 <para>Not yet implemented</para>
8331 <para>Description:</para>
8335 <para>In addition to this option being set, the corresponding
8336 XSLT option must be turned on. Also, the corresponding 856q
8337 field must have a valid MIME image extension (e.g., "jpg") or
8338 MIME image type (i.e. starting with "image/"), or the generic
8339 indicator "img" entered in the field. When all of the
8340 requirements are met, an image file will be displayed instead
8341 of the standard link text. Clicking on the image will open it
8342 in the same way as clicking on the link text. When you click
8343 on the image it should open to full size, in the current
8344 window or in a new window depending on the value in the system
8345 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
8348 <screeninfo>Sample 856 in MARC Record</screeninfo>
8352 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
8360 <section id="OpacExportOptions">
8361 <title>OpacExportOptions</title>
8364 bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
8366 <para>Asks: List export options that should be available from OPAC
8367 detail page separated by |: ___</para>
8369 <para>Description:</para>
8373 <para>In the OPAC on the right of each bib record there is a
8374 menu that allows for saving the record in various formats.
8375 This patch will allow you to define which options are in the
8376 pull down menu. Available options are: BIBTEX (bibtex), Dublin
8377 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
8378 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
8379 without local use -9xx, x9x, xx9- fields and subfields
8380 (marcstd), MODS (mods), and RIS (ris).</para>
8385 <section id="OpacFavicon">
8386 <title>OpacFavicon</title>
8388 <para>Asks: Use the image at ___ for the OPAC's favicon.
8390 <para>This should be a complete URL, starting with
8395 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
8398 <para>Description:</para>
8402 <para>The favicon is the little icon that appears next to the
8403 URL in the address bar in most browsers. The default value for
8404 this field (if left blank) is the small 'K' in the Koha
8408 <screeninfo>Default Koha Favicon</screeninfo>
8412 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
8420 <section id="opacheader">
8421 <title>opacheader</title>
8423 <para>Asks: Include the following HTML in the header of all pages
8427 <screeninfo>Sample HTML to be displayed at the top of my
8432 <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
8438 <para>This value will appear above the main content of your
8443 <screeninfo>OPAC display of the value from
8444 'opacheader'</screeninfo>
8448 <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
8454 <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
8455 you'd like to edit the contents of the <title> tag</para>
8458 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8459 Regions</link> section.</para>
8462 <section id="OpacHighlightedWords">
8463 <title>OpacHighlightedWords</title>
8465 <para>Default: Don't highlight</para>
8467 <para>Asks: ___ words the patron searched for in their search
8470 <para>Values:</para>
8474 <para>Don't highlight</para>
8478 <para>Highlight</para>
8483 <section id="OpacKohaUrl">
8484 <title>OpacKohaUrl</title>
8486 <para>Default: Don't show</para>
8488 <para>Values:</para>
8492 <para>Don't show</para>
8500 <para>Description:</para>
8504 <para>When this preference is set to 'Show' text will appear
8505 in the bottom right of the OPAC footer stating 'Powered by
8506 Koha' and linking to the official Koha website.</para>
8509 <screeninfo>Powered by Koha</screeninfo>
8513 <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
8521 <section id="opaclayoutstylesheet">
8522 <title>opaclayoutstylesheet</title>
8524 <para>Default: opac.css</para>
8526 <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
8527 OPAC, instead of the default</para>
8529 <para>Description:</para>
8533 <para>This setting's function is to point to the *.css file
8534 used to define the OPAC layout. A *.css file is a cascading
8535 stylesheet which is used in conjunction with HTML to set how
8536 the HTML page is formatted and will look on the OPAC. There
8537 are two stylesheets that come with the system; opac.css and
8538 opac2.css. A custom stylesheet may also be used. The
8539 stylesheets listed in the opaclayoutstylesheet preference are
8540 held on the Koha server.</para>
8545 <para>Leave this field blank to disable it and let Koha use the
8546 default file instead</para>
8549 <para>Using a custom value in this preference causes Koha to completely ignore the
8550 default layout stylesheet.</para>
8554 <section id="OpacMaintenance">
8555 <title>OpacMaintenance</title>
8557 <para>Default: Don't show</para>
8559 <para>Asks: ___ a warning that the OPAC is under maintenance,
8560 instead of the OPAC itself. <note>
8561 <para>this shows the same warning as when the database needs
8562 to be upgraded, but unconditionally.</para>
8565 <para>Description:</para>
8569 <para>This preference allows the system administrator to turn
8570 off the OPAC during maintenance and display a message to
8571 users. When this preference is switched to "Show" the OPAC is
8572 not usable. The text of this message is not editable at this
8577 <para>Values:</para>
8581 <para>Don't show</para>
8589 <para>When this preference is set to show the maintenance
8590 message the ability to search the OPAC is disabled and a
8591 message appears</para>
8594 <screeninfo>OPAC Maintenance Message</screeninfo>
8598 <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
8608 <section id="OpacMainUserBlock">
8609 <title>OpacMainUserBlock</title>
8611 <para>Default: Welcome to Koha... <hr></para>
8613 <para>Asks: Show the following HTML in its own column on the main
8614 page of the OPAC</para>
8616 <para>Description: </para>
8619 <para>HTML entered in this field will appear in the center of the main page of your
8625 <screeninfo>Sample OpacMainUserBlock appears below the search
8630 <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
8635 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8636 Regions</link> section.</para>
8638 <section id="OpacMainUserBlockMobile">
8639 <title>OpacMainUserBlockMobile</title>
8640 <para>Asks: Show the following HTML in its own column on the main page of the OPAC
8641 (mobile version)</para>
8642 <para>Description:</para>
8645 <para>This content will display below the search boxes when viewing the OPAC on a
8646 mobile device as long as the <link linkend="opacthemes">theme</link> you're using
8647 has a mobile version.</para>
8651 <para>This preference is only used with the CCSR theme.</para>
8654 <section id="OpacMaxItemsToDisplay">
8655 <title>OpacMaxItemsToDisplay</title>
8656 <para>Default: 50</para>
8657 <para>Asks: Display up to ___ items on the biblio detail page </para>
8658 <para>Description:<itemizedlist>
8660 <para>This preference will help with slow load times on the bibliographic detail
8661 pages by limiting the number of items to display by default. If the biblio has
8662 more items than this, a link is displayed instead that allows the user to choose
8663 to display all items.</para>
8665 </itemizedlist></para>
8667 <section id="OPACMobileUserCSS">
8668 <title>OPACMobileUserCSS</title>
8669 <para>Asks: Include the following CSS for the mobile view on all pages in the
8671 <para>Description:<itemizedlist>
8673 <para>This CSS will be used when your OPAC is viewed on a mobile device as long as
8674 the <link linkend="opacthemes">theme</link> you're using has a mobile
8677 </itemizedlist></para>
8679 <para>This preference is only used with the CCSR theme.</para>
8683 <section id="OPACMySummaryHTML">
8684 <title>OPACMySummaryHTML</title>
8686 <para>Asks: Include a "Links" column on the "my summary" tab when
8687 a user is logged in to the OPAC, with the following HTML (leave
8688 blank to disable).</para>
8690 <para>Description:</para>
8694 <para>In this preference you can enter HTML that will appear
8695 on the 'Checked Out' tab on the 'My Summary' section when
8696 logged in to the OPAC. The placeholders {BIBLIONUMBER},
8697 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
8698 from the displayed record. This can be used to enter in
8699 'share' links for social networks or generate searches against
8700 other library catalogs.</para>
8703 <screeninfo>Example of 'Links' column with a value in the
8704 OPACMySummaryHTML preference</screeninfo>
8708 <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
8715 <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>
8716 <br />TITLE: {TITLE}
8717 <br />AUTHOR: {AUTHOR}
8718 <br />ISBN: {ISBN}
8719 <br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
8721 <section id="OPACMySummaryNote">
8722 <title>OPACMySummaryNote</title>
8723 <para>Asks: Note to display on the patron summary page. </para>
8724 <para>Description:<itemizedlist>
8726 <para>This preference will display text above the patron's summary and below the
8727 welcome message when the patron logs in to the OPAC and view their 'my summary' tab.<screenshot>
8728 <screeninfo>OPACMySummaryNote in the OPAC</screeninfo>
8731 <imagedata fileref="images/admin/globalprefs/OPACMySummaryNote.png"/>
8734 </screenshot></para>
8736 </itemizedlist></para>
8739 <section id="OpacNav">
8740 <title>OpacNav</title>
8742 <para>Default: Important links here.</para>
8744 <para>Asks: Show the following HTML on the left hand column of the
8745 main page and patron account on the OPAC (generally navigation
8749 <screeninfo>Sample navigation links</screeninfo>
8753 <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
8758 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8759 Regions</link> section.</para>
8762 <section id="OpacNavBottom">
8763 <title>OpacNavBottom</title>
8765 <para>Asks: Show the following HTML on the left hand column of the
8766 main page and patron account on the OPAC, after <link linkend="OpacNav">OpacNav</link>, and before patron account links
8767 if available:</para>
8769 <para>Description: When a patron is logged in to their account
8770 they see a series of tabs to access their account information.
8771 <link linkend="OpacNav">OpacNav</link> appears above this list of
8772 tabs and OpacNavBottom will appear below them. When not on the
8773 patron account pages the HTML in OpacNavBottom will just appear
8774 right below <link linkend="OpacNav">OpacNav</link>.</para>
8777 <screeninfo>OpacNav and OpacNavBottom on Patron
8778 Account</screeninfo>
8782 <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
8788 <section id="OpacNavRight">
8789 <title>OpacNavRight</title>
8791 <para>Asks: Show the following HTML in the right hand column of
8792 the main page under the main login form.</para>
8794 <para>Description: HTML entered in this preference will appear on
8795 the right hand side of the OPAC under the log in form. If the log
8796 in form is not visible this content will move up on the right
8800 <screeninfo>OpacNavRight</screeninfo>
8804 <imagedata fileref="images/admin/globalprefs/OpacNavRight.png"/>
8810 <section id="OPACNoResultsFound">
8811 <title>OPACNoResultsFound</title>
8813 <para>No Default</para>
8815 <para>Asks: Display this HTML when no results are found for a
8816 search in the OPAC</para>
8818 <para>This HTML will display below the existing notice that no
8819 results were found for your search.</para>
8822 <screeninfo>HTML in OPACNoResultsFound will appear below lines
8823 that look like this</screeninfo>
8827 <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
8832 <para>You can insert placeholders {QUERY_KW} that will be replaced with the keywords
8833 of the query. </para>
8837 <section id="OpacPublic">
8838 <title>OpacPublic</title>
8840 <para>Default: Enable</para>
8842 <para>Asks: ___ Koha OPAC as public. Private OPAC requires
8843 authentication before accessing the OPAC.</para>
8845 <para>Values:</para>
8849 <para>Don't enable</para>
8857 <para>Description:</para>
8861 <para>This preference determines if your OPAC is accessible
8862 and searchable by anyone or only by members of the library. If
8863 set to 'Don't enable' only members who are logged into the
8864 OPAC can search. Most libraries will leave this setting at its
8865 default of 'Enable' to allow their OPAC to be searched by
8866 anyone and only require login for access to personalized
8872 <section id="OPACResultsSidebar">
8873 <title>OPACResultsSidebar</title>
8875 <para>Asks: Include the following HTML under the facets in OPAC
8876 search results</para>
8878 <para>Description:</para>
8882 <para>The HTML entered in this preference will appear on the
8883 search results pages below the list of facets on the left side
8884 of the screen.</para>
8889 <section id="OPACSearchForTitleIn">
8890 <title>OPACSearchForTitleIn</title>
8892 <para>Default: <li><a
8893 href="http://worldcat.org/search?q={TITLE}"
8894 target="_blank">Other Libraries (WorldCat)</a></li>
8896 href="http://www.scholar.google.com/scholar?q={TITLE}"
8897 target="_blank">Other Databases (Google
8898 Scholar)</a></li> <li><a
8899 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
8900 target="_blank">Online Stores
8901 (Bookfinder.com)</a></li></para>
8903 <para>Asks: Include a "More Searches" box on the detail pages of
8904 items on the OPAC, with the following HTML (leave blank to
8908 <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
8909 {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
8910 from the displayed record.</para>
8913 <section id="OpacSeparateHoldings">
8914 <title>OpacSeparateHoldings & OpacSeparateHoldingsBranch </title>
8915 <para>OpacSeparateHoldings default: Don't separate</para>
8916 <para>OpacSeparateHoldingsBranch default: home library </para>
8917 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
8918 ___ is the logged in user's library. The second tab will contain all other items. </para>
8919 <para>OpacSeparateHoldings values:<itemizedlist>
8921 <para>Don't separate</para>
8924 <para>Separate</para>
8926 </itemizedlist></para>
8927 <para>OpacSeparateHoldingsBranch values:<itemizedlist>
8929 <para>holding library</para>
8932 <para>home library</para>
8934 </itemizedlist></para>
8935 <para>Description:<itemizedlist>
8937 <para>This preference lets you decide if you would like to have the holding
8938 information on the bibliographic detail page in the OPAC split in to multiple
8939 tabs. The default is to show all holdings on one tab.</para>
8941 <screeninfo>Separate holdings tabs</screeninfo>
8944 <imagedata fileref="images/admin/globalprefs/OpacSeparateHoldings.png"/>
8949 </itemizedlist></para>
8952 <section id="OPACShowBarcode">
8953 <title>OPACShowBarcode</title>
8955 <para>Default: Don't show</para>
8957 <para>Asks: ___ the item's barcode on the holdings tab.</para>
8959 <para>Values:</para>
8963 <para>Don't show</para>
8966 <screeninfo>Barcode not shown in the OPAC</screeninfo>
8970 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-noshow.png"/>
8980 <screeninfo>Barcode shown in the OPAC</screeninfo>
8984 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-show.png"/>
8991 <para>Description:</para>
8995 <para>This preference allows you to control whether patrons
8996 can see items' barcodes in the OPAC.</para>
9001 <section id="OPACShowCheckoutName">
9002 <title>OPACShowCheckoutName</title>
9004 <para>Default: Don't show</para>
9006 <para>Asks: ___ the name of the patron that has an item checked
9007 out on item detail pages on the OPAC.</para>
9009 <para>Values:</para>
9013 <para>Don't show</para>
9021 <para>Description:</para>
9025 <para>This preference allows all patrons to see who has the
9026 item checked out if it is checked out. In small corporate
9027 libraries (where the OPAC is behind a firewall and not
9028 publicly available) this can be helpful so coworkers can just
9029 contact the patron with the book themselves. In larger public
9030 and academic libraries setting this to 'Show' would pose
9031 serious privacy issues.</para>
9035 <section id="OpacShowFiltersPulldownMobile">
9036 <title>OpacShowFiltersPulldownMobile</title>
9037 <para>Default: Show</para>
9038 <para>Asks: ___ the search filters pulldown on the mobile version of the OPAC. </para>
9039 <para>Values:<itemizedlist>
9041 <para>Don't show</para>
9046 </itemizedlist>Description:<itemizedlist>
9048 <para>This preference controls whether patrons can choose a search type when
9049 viewing the OPAC on mobile devices. If this is set to 'Don't show' then all
9050 searches will be keyword searches. This preference assumes that you're using a
9051 <link linkend="opacthemes">theme</link> with a mobile version.</para>
9053 </itemizedlist></para>
9056 <section id="OPACShowHoldQueueDetails">
9057 <title>OPACShowHoldQueueDetails</title>
9059 <para>Default: Don't show any hold details</para>
9061 <para>Asks: ___ to patrons in the OPAC.</para>
9063 <para>Values:</para>
9067 <para>Don't show any hold details</para>
9071 <para>Show holds</para>
9074 <screeninfo>The holdings table on the bibliographic record
9075 will show the number of holds</screeninfo>
9079 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-showholds.png"/>
9086 <para>Show holds and priority level</para>
9090 <para>Show priority level</para>
9093 <screeninfo>Patron record in the OPAC shows where in line
9094 the patron waits for their hold.</screeninfo>
9098 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-priority.png"/>
9105 <para><link linkend="opacuserlogin">opacuserlogin</link>
9106 needs to be set to 'allow'</para>
9112 <section id="OpacShowLibrariesPulldownMobile">
9113 <title>OpacShowLibrariesPulldownMobile</title>
9114 <para>Default: Show</para>
9115 <para>Asks: ___ the libraries pulldown on the mobile version of the OPAC. </para>
9116 <para>Values:<itemizedlist>
9118 <para>Don't show</para>
9123 </itemizedlist>Description:<itemizedlist>
9125 <para>This preference controls whether the library selector pull down shows when
9126 viewing the OPAC on a mobile device as long as the <link linkend="opacthemes">theme</link> you're using has a mobile version.</para>
9128 </itemizedlist></para>
9131 <section id="OpacShowRecentComments">
9132 <title>OpacShowRecentComments</title>
9134 <para>Default: Don't show</para>
9136 <para>Asks: ___ a link to recent comments in the OPAC
9139 <para>Values:</para>
9143 <para>Don't show</para>
9151 <para>Description:</para>
9155 <para>If you have chosen to allow comments in your OPAC by
9156 setting <link linkend="reviewson">reviewson</link> to 'Allow'
9157 you can include a link to the recent comments under the search
9158 box at the top of your OPAC with this preference.</para>
9161 <screeninfo>Recent Comments link on OPAC</screeninfo>
9165 <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
9173 <section id="OPACShowUnusedAuthorities">
9174 <title>OPACShowUnusedAuthorities</title>
9176 <para>Default: Show</para>
9178 <para>Asks: ___ unused authorities in the OPAC authority
9181 <para>Values:</para>
9185 <para>Do not show</para>
9194 <para>Requires that the <link linkend="OpacAuthorities">OpacAuthorities</link>
9195 preference is set to 'Allow'</para>
9202 <para>Description:</para>
9206 <para>When patrons search your authority file via the OPAC
9207 they will see all authorities in your system even if you don't
9208 have them linked to any bibliographic records. This preference
9209 lets you determine what the default behavior is when searching
9210 authorities via the OPAC. If you choose 'Do not show' it will
9211 only show patrons authority records that are linked to bib
9212 records in the search results. Otherwise the system will show
9213 all authority records even if they aren't linked to
9219 <section id="opacsmallimage">
9220 <title>opacsmallimage</title>
9222 <para>Asks: Use the image at ___ in the OPAC header, instead of
9223 the Koha logo. If this image is a different size than the Koha
9224 logo, you will need to customize the CSS.</para>
9226 <para>Description:</para>
9230 <para>The opacsmallimage system pref is a little tricky to
9231 deal with because you really have to tweak some CSS at the
9232 same time. The default CSS defines a region just large enough
9233 to display the Koha logo, and if your logo doesn't match the
9234 Koha logo's dimensions (120 pixels wide by 38 pixels high), it
9235 won't display correctly.</para>
9240 <para>This should be a complete URL, starting with
9244 <para>This preference is only used in the prog and ccsr themes.</para>
9248 <section id="OpacStarRatings">
9249 <title>OpacStarRatings</title>
9251 <para>Default: no</para>
9253 <para>Asks: Show star-ratings on ___ pages.</para>
9255 <para>Values:</para>
9263 <para>only details</para>
9266 <screeninfo>Star Ratings on the Details Page</screeninfo>
9270 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
9277 <para>results and details</para>
9280 <screeninfo>OPAC Star Ratings on the Search
9281 Results</screeninfo>
9285 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
9292 <para>Description:</para>
9296 <para>Star ratings are a way for your patrons to leave ratings
9297 without having to leave a full review. Patrons who are not
9298 logged in will only be able to see the stars, once logged in
9299 patrons can click on the stars on the details page to leave
9300 their own rating. Clicking on the stars on the search results
9301 will not submit a rating.</para>
9305 <section id="OpacSuggestionManagedBy">
9306 <title>OpacSuggestionManagedBy</title>
9307 <para>Default: Show</para>
9308 <para>Asks: ___ the name of the staff member who managed a suggestion in OPAC. </para>
9309 <para>Values:<itemizedlist>
9311 <para>Don't show</para>
9316 </itemizedlist></para>
9317 <para>Description:<itemizedlist>
9319 <para>If you're <link linkend="suggestionspref">allowing patrons to make purchase
9320 suggestions</link> then they will see the 'my suggestions' tab when logged in.
9321 This tab shows the patron the librarian who approved or rejected the purchase
9322 suggestion. This preference controls if the patron sees the librarian's name or
9325 </itemizedlist></para>
9328 <section id="opacthemes">
9329 <title>opacthemes</title>
9331 <para>Default: prog</para>
9333 <para>Asks: Use the ___ theme on the OPAC.</para>
9335 <para>Values:</para>
9339 <para>bootstrap</para>
9342 <screeninfo>Bootstrap Theme</screeninfo>
9345 <imagedata fileref="images/admin/globalprefs/opacthemes-bootstrap.png"/>
9350 <para>This theme is completely responsive</para>
9356 <screeninfo>CCSR Theme</screeninfo>
9359 <imagedata fileref="images/admin/globalprefs/opacthemes-ccsr.png"/>
9364 <para>This theme comes with a mobile version.</para>
9370 <screeninfo>PROG Theme</screeninfo>
9373 <imagedata fileref="images/admin/globalprefs/opacthemes-prog.png"/>
9378 <para>This is the original Koha 3.x theme and does not come with a mobile
9384 <section id="OPACURLOpenInNewWindow">
9385 <title>OPACURLOpenInNewWindow</title>
9387 <para>Default: don't</para>
9389 <para>Asks: When patrons click on a link to another website from
9390 your OPAC (like Amazon or OCLC), ___ open the website in a new
9393 <para>Values:</para>
9405 <para>Description:</para>
9409 <para>This preference determines if URLs in the OPAC will open
9410 in a new window or not. When clicking on a link in the OPAC, a
9411 patron does not need to worry about navigating away from their
9412 search results.</para>
9417 <section id="OPACUserCSS">
9418 <title>OPACUserCSS</title>
9420 <para>Asks: Include the following CSS on all pages in the
9423 <para>Description:</para>
9427 <para>OPACUserCSS allows the administrator to enter styles
9428 that will overwrite the OPAC's default CSS as defined in
9429 'opaclayoutstylesheet' or 'opacstylesheet'. Styles may be
9430 entered for any of the selectors found in the default style
9431 sheet. The default stylesheet will likely be found at
9432 http://your_koha_address/opac-tmpl/prog/en/css/opac.css.
9433 Unlike <link linkend="opaccolorstylesheet">opaccolorstylesheet</link> and
9434 <link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link>
9435 this preference will embed the CSS directly on your OPAC
9441 <section id="opacuserjs">
9442 <title>opacuserjs</title>
9444 <para>Asks: Include the following JavaScript on all pages in the
9448 <screeninfo>OPAC login box before opacuserjs edit</screeninfo>
9452 <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
9458 <screeninfo>JavaScript in opacuserjs to change the OPAC login
9463 <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
9469 <screeninfo>New OPAC login box after editing
9470 opacuserjs</screeninfo>
9474 <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
9479 <para>Description:</para>
9483 <para>This preference allows the administrator to enter
9484 JavaScript or JQuery that will be embedded across all pages of
9485 the OPAC. Administrators may use this preference to customize
9486 some of the interactive sections of Koha, customizing the text
9487 for the login prompts, for example. Sample JQuery scripts used
9488 by Koha libraries can be found on the wiki: <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
9493 <section id="OPACXSLTDetailsDisplay">
9494 <title>OPACXSLTDetailsDisplay</title>
9496 <para>Default: default</para>
9498 <para>Asks: Display OPAC details using XSLT stylesheet at
9501 <para>Values:</para>
9505 <para>leave empty to not use the XSLT stylesheet</para>
9509 <para>In previous versions of Koha this was the setting
9510 that read 'normally'</para>
9516 <para>enter "default" for the default one</para>
9520 <para>put a path to define a XSLT file</para>
9524 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
9528 <para>If in a multi-language system you can enter
9529 {langcode} in the path to tell Koha to look in the right
9530 language folder</para>
9535 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
9540 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
9548 <para>put an URL for an external specific stylesheet</para>
9552 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
9558 <para>Description:</para>
9562 <para>XSLT stylesheets allow for the customization of the
9563 details shows on the screen when viewing a bib record. This
9564 preference will allow you either use the default look that
9565 comes with Koha or design your own stylesheet.</para>
9570 <section id="OPACXSLTResultsDisplay">
9571 <title>OPACXSLTResultsDisplay</title>
9573 <para>Default: default</para>
9575 <para>Asks: Display OPAC results using XSLT stylesheet at
9578 <para>Values:</para>
9582 <para>leave empty to not use the XSLT stylesheet</para>
9586 <para>In previous versions of Koha this was the setting
9587 that read 'normally'</para>
9593 <para>enter "default" for the default one</para>
9597 <para>put a path to define a XSLT file</para>
9601 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
9605 <para>If in a multi-language system you can enter
9606 {langcode} in the path to tell Koha to look in the right
9607 language folder</para>
9612 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
9617 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
9625 <para>put an URL for an external specific stylesheet</para>
9629 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
9635 <para>Description:</para>
9639 <para>XSLT stylesheets allow for the customization of the
9640 details shows on the screen when viewing the search results.
9641 This preference will allow you either use the default look
9642 that comes with Koha or design your own stylesheet.</para>
9648 <section id="opacfeaturesprefs">
9649 <title>Features</title>
9653 <section id="numSearchRSSResults">
9654 <title>numSearchRSSResults</title>
9656 <para>Default: 50</para>
9658 <para>Asks: Display ___ search results in the RSS feed.</para>
9660 <para>Description:</para>
9664 <para>By default the RSS feed that is automatically generated
9665 for every search results page will list 50 items. This can
9666 sometimes be too much for some RSS feed readers and for some
9667 people this isn't enough. This preference allows you to adjust
9668 this number to show the best number of results for your
9674 <section id="OpacAuthorities">
9675 <title>OpacAuthorities</title>
9677 <para>Default: Allow</para>
9679 <para>Asks: ___ patrons to search your authority records.</para>
9681 <para>Description:</para>
9685 <para>This preference displays the link on the OPAC for the authority search. By
9686 setting the preference to "Allow" patrons can use this search link of the
9691 <para>Values:</para>
9699 <para>A link labeled 'Authority search' will appear at the top of your OPAC
9700 under the search box</para>
9703 <screeninfo>'Browse by Subject' link under search box on
9708 <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
9717 <para>Don't allow</para>
9722 <section id="opacbookbag">
9723 <title>opacbookbag</title>
9725 <para>Default: Allow</para>
9727 <para>Asks: ___ patrons to store items in a temporary "Cart" on
9730 <para>Values:</para>
9738 <para>Don't allow</para>
9742 <para>Description:</para>
9746 <para>This preference allows the user to temporarily save a
9747 list of items found on the catalog. By using the Book Bag, or
9748 Cart, the user can print out or email a list of items found.
9749 The user does not need to be logged in. This list is temporary
9750 and will be emptied, or cleared, at the end of the
9756 <section id="OpacBrowser">
9757 <title>OpacBrowser</title>
9760 <para>This preference only applies to French systems at this
9764 <para>Default: Don't allow</para>
9766 <para>Asks: ___ patrons to browse subject authorities on
9769 <para>Values:</para>
9777 <para>Don't allow</para>
9782 <para>run the <link linkend="authbrowsercron">Authorities
9783 Browser Cron Job</link> to create the browser list</para>
9787 <section id="OpacBrowseResults">
9788 <title>OpacBrowseResults</title>
9790 <para>Default: enable</para>
9792 <para>Asks: ___ browsing and paging search results from the OPAC
9795 <para>Values:</para>
9799 <para>disable</para>
9806 <screeninfo>Browsing and Paging Search Results</screeninfo>
9810 <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
9817 <para>Description:</para>
9821 <para>This preference will control the option to return to
9822 your results and/or browse them from the detail page in the
9827 <section id="OpacCloud">
9828 <title>OpacCloud</title>
9830 <para>This preference only applies to French systems at this time.</para>
9831 </important>Default: Don't show</para>
9832 <para>Asks: ___ a subject cloud on OPAC</para>
9833 <para>Values:<itemizedlist>
9835 <para>Don't show</para>
9840 </itemizedlist></para>
9843 <para>run the <link linkend="authbrowsercron">Authorities Browser Cron Job</link> to
9844 create the browser list</para>
9849 <section id="OPACFinesTab">
9850 <title>OPACFinesTab</title>
9852 <para>Default: Allow</para>
9854 <para>Asks: ___ patrons to access the Fines tab on the My Account
9855 page on the OPAC.</para>
9857 <para>Values:</para>
9865 <para><link linkend="opacuserlogin">opacuserlogin</link>
9866 needs to be set to 'allow'</para>
9872 <para>Don't allow</para>
9876 <section id="OpacHoldNotes">
9877 <title>OpacHoldNotes</title>
9878 <para>Default: Do not allow</para>
9879 <para>Asks: ___ users to add a note when placing a hold.</para>
9880 <para>Values:<itemizedlist>
9884 <screeninfo>Holds notes in the OPAC</screeninfo>
9887 <imagedata fileref="images/admin/globalprefs/OpacHoldNotes.png"/>
9893 <para>Do not allow</para>
9895 </itemizedlist></para>
9897 <section id="OpacItemLocation">
9898 <title>OpacItemLocation</title>
9899 <para>Default: call number only</para>
9900 <para>Asks: Show ____ for items on the OPAC search results.</para>
9901 <para>Values:<itemizedlist>
9903 <para>call number only</para>
9906 <para>collection code</para>
9909 <para>location</para>
9911 </itemizedlist></para>
9912 <para>Description: </para>
9915 <para>This setting allows users of the OPAC results XSLT stylesheet to choose to
9916 display collection code or location in addition to call number.</para>
9921 <section id="OpacPasswordChange">
9922 <title>OpacPasswordChange</title>
9924 <para>Default: Allow</para>
9926 <para>Asks: ___ patrons to change their own password on the
9929 <para>Values:</para>
9937 <para><link linkend="opacuserlogin">opacuserlogin</link>
9938 needs to be set to 'allow'</para>
9944 <para>Don't allow</para>
9949 <para>Enabling this will break LDAP authentication.</para>
9953 <section id="OPACPatronDetails">
9954 <title>OPACPatronDetails</title>
9956 <para>Default: Allow</para>
9958 <para>Asks: ___ patrons to notify the library of changes to their
9959 contact information from the OPAC.</para>
9961 <para>Values:</para>
9969 <para><link linkend="opacuserlogin">opacuserlogin</link>
9970 needs to be set to 'allow'</para>
9976 <para>Don't allow</para>
9980 <para>Description:</para>
9984 <para>If patrons are allowed to notify the library of changes to their account then
9985 staff will need to approve the changes via the staff client. Notification of
9986 patron account requests will appear on the dashaboard below the list of modules
9987 with other pending actions.</para>
9989 <screeninfo>Patrons requesting modifications</screeninfo>
9992 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails.png"/>
9996 <para>Once you click the notification you will be presented with the changes the
9997 patron would like to make to their account and from there you can choose how to
10000 <screeninfo>Patrons modifications</screeninfo>
10003 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails-approve.png"/>
10008 <para>You can control what fields patrons see and can modify via the OPAC by
10009 setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
10010 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
10016 <section id="OPACpatronimage">
10017 <title>OPACpatronimage</title>
10019 <para>Default: Don't show</para>
10021 <para>Asks: ___ patron images on the patron information page in
10024 <para>Values:</para>
10028 <para>Don't show</para>
10036 <para>Description:</para>
10040 <para>If <link linkend="patronimages">patronimages</link> is
10041 set to allow the upload of patron images via the staff client,
10042 then setting this preference to 'show' will show the patron
10043 what image you have on file for them when they view their
10044 personal information on their account in the OPAC.</para>
10048 <section id="OPACPopupAuthorsSearch">
10049 <title>OPACPopupAuthorsSearch</title>
10050 <para>Default: Don't display</para>
10051 <para>Asks: ___ the list of authors/subjects in a popup for a combined search on OPAC
10052 detail pages.</para>
10053 <para>Values:<itemizedlist>
10055 <para>Display</para>
10058 <screeninfo>Subject search pop up</screeninfo>
10061 <imagedata fileref="images/admin/globalprefs/OPACPopupAuthorsSearch.png"/>
10068 <para>This will only display the pop up if you are not using an XSLT
10069 stylesheet. Review your <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> to find out what stylesheet you're
10077 <para>Don't display<itemizedlist>
10079 <para>Authors and subjects will display as search links instead of pop up
10082 </itemizedlist></para>
10084 </itemizedlist></para>
10085 <para>Description:<itemizedlist>
10087 <para>If this preference is set to 'Display' then clicking a subject or author
10088 from the details page in the OPAC will present the searcher with a pop up box.
10089 From this box you can check off any of the subjects or authors listed and search
10090 them all at once by clicking 'Search' at the bottom of the pop up. The default
10091 behavior is for Koha to search just the clicked author or subject.</para>
10093 </itemizedlist></para>
10096 <section id="OpacTopissue">
10097 <title>OpacTopissue</title>
10099 <para>Default: Don't allow</para>
10101 <para>Asks: ___ patrons to access a list of the most checked out
10102 items on the OPAC.</para>
10104 <para>Values:</para>
10112 <para>A link to 'Most Popular' will appear at the top of
10116 <screeninfo>'Most Popular' link under the search
10121 <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
10130 <para>Don't allow</para>
10134 <para>Description:</para>
10138 <para>This preference allows the administrator to choose to
10139 show the "Most Popular" link at the top of the OPAC under the
10140 search box. The "Most Popular" page shows the top circulated
10141 items in the library, as determined by the number of times a
10142 title has been circulated. This allows users to see what
10143 titles are popular in their community. It is recommended that
10144 you leave this preference set to 'Don't allow' until you have
10145 been live on Koha for a couple of months, otherwise the data
10146 that it shows will not be an accurate portrayal of what's
10147 popular in your library.</para>
10150 <screeninfo>Sample top issues page</screeninfo>
10154 <imagedata fileref="images/admin/globalprefs/topissues.png"/>
10162 <section id="opacuserlogin">
10163 <title>opacuserlogin</title>
10165 <para>Default: Allow</para>
10167 <para>Asks: ___ patrons to log in to their accounts on the
10170 <para>Values:</para>
10178 <para>Don't allow</para>
10182 <para>The OPAC will still be searchable if patrons can't
10183 log in, this just disables the patron account access via
10191 <section id="QuoteOfTheDay">
10192 <title>QuoteOfTheDay</title>
10194 <para>Default: Disable</para>
10196 <para>Asks: ___ Quote of the Day display on OPAC home page</para>
10198 <para>Values:</para>
10202 <para>Disable</para>
10206 <para>Enable</para>
10210 <para>Description:</para>
10214 <para>This feature will allow you to enter a series of quotes
10215 that will then show on the OPAC homepage in random order. To
10216 add/edit quotes, visit the <link linkend="QOTDEditor">Quote of
10217 the Day Editor</link> under Tools.</para>
10222 <section id="RequestOnOpac">
10223 <title>RequestOnOpac</title>
10225 <para>Default: Allow</para>
10227 <para>Asks: ___ patrons to place holds on items from the
10230 <para>Values:</para>
10238 <para><link linkend="opacuserlogin">opacuserlogin</link>
10239 needs to be set to 'allow'</para>
10245 <para>Don't allow</para>
10250 <section id="reviewson">
10251 <title>reviewson</title>
10253 <para>Default: Allow</para>
10255 <para>Asks: ___ patrons to make comments on items on the
10258 <para>Values:</para>
10266 <para>Patrons comments/reviews all require moderation
10267 before they appear in the OPAC</para>
10271 <para><link linkend="opacuserlogin">opacuserlogin</link>
10272 needs to be set to 'Allow'</para>
10278 <para>Don't allow</para>
10282 <para>Description:</para>
10286 <para>This button allows the patrons to submit comments on
10287 books they have read via the OPAC. If this preference is set
10288 to "Allow" reviews are first sent to the staff client for
10289 staff approval before the review is displayed in the OPAC. The
10290 staff member who reviews and approves comments may find the
10291 pending comments on the <link linkend="comments">Comments</link> tool. The staff member can
10292 then choose to approve or delete the comments.</para>
10297 <section id="ShowReviewer">
10298 <title>ShowReviewer</title>
10300 <para>Default: full name</para>
10302 <para>Asks: Show ___ of commenter with comments in OPAC.</para>
10304 <para>Values:</para>
10308 <para>first name</para>
10312 <para>first name and last initial</para>
10316 <para>full name</para>
10320 <para>last name</para>
10324 <para>no name</para>
10328 <para>username</para>
10332 <para>Description:</para>
10336 <para>If you would like to protect your patron's privacy in
10337 the OPAC you can choose to hide their names or parts of their
10338 names from any of the comments they leave on bib records in
10339 your system. <link linkend="reviewson">reviewson</link> needs
10340 to be set to 'Allow' for this to preference to come in to
10346 <section id="ShowReviewerPhoto">
10347 <title>ShowReviewerPhoto</title>
10349 <para>Default: Show</para>
10351 <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
10353 <para>Values:</para>
10365 <para><link linkend="reviewson">reviewson</link> needs to
10366 be set to 'Allow' and <link linkend="ShowReviewer">ShowReviewer</link> needs to be set
10367 to 'Show' for this to preference to come in to play</para>
10370 <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
10374 <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
10383 <para>Description:</para>
10387 <para>This system preference allows libraries to show avatars
10388 next to patron's comments in the OPAC. These avatars are
10389 pulled from the <ulink url="https://www.libravatar.org">Libravatar</ulink> library,
10390 an open source powered product that allows Internet users to
10391 choose a small icon to display next to their name on various
10392 different websites. The library has no control over the images
10393 the patron chooses to display.</para>
10398 <section id="SocialNetworks">
10399 <title>SocialNetworks</title>
10401 <para>Default: Disable</para>
10403 <para>Asks: ___ social network links in opac detail pages</para>
10405 <para>Values:</para>
10409 <para>Disable</para>
10413 <para>Enable</para>
10416 <screeninfo>Social Networks</screeninfo>
10420 <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
10427 <para>Description:</para>
10431 <para>This preference will enable a line of social network
10432 share buttons below the right hand column on the detail pages
10433 of records in the OPAC.</para>
10438 <para>In order for these share buttons to work when clicked you
10439 must have filled in your <link linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
10443 <section id="suggestionspref">
10444 <title>suggestion</title>
10446 <para>Default: Allow</para>
10448 <para>Asks: ___ patrons to make purchase suggestions on the
10451 <para>Values:</para>
10459 <para><link linkend="opacuserlogin">opacuserlogin</link>
10460 needs to be set to 'allow' unless <link linkend="AnonSuggestions">AnonSuggestions</link> is set to
10467 <para>Don't allow</para>
10473 <section id="opacpolicyprefs">
10474 <title>Policy</title>
10478 <section id="AllowPurchaseSuggestionBranchChoice">
10479 <title>AllowPurchaseSuggestionBranchChoice</title>
10481 <para>Default: Don't allow</para>
10483 <para>Asks: ___ patrons to select branch when making a purchase
10486 <para>Values:</para>
10494 <para>Don't allow</para>
10498 <para>Description:</para>
10502 <para>If your library system lets patrons make purchase
10503 suggestions for a specific branch you can set this preference
10504 to 'Allow' to add a branch selection option to the purchase
10505 suggestion form.</para>
10509 <section id="BlockExpiredPatronOpacActions">
10510 <title>BlockExpiredPatronOpacActions</title>
10511 <para>Default: Don't block</para>
10512 <para>Asks: ___ expired patrons from OPAC actions such as placing a hold or renewing. </para>
10513 <para>Values:<itemizedlist>
10518 <para>Don't block</para>
10520 </itemizedlist></para>
10521 <para>Description:<itemizedlist>
10523 <para>This preference lets you set a default value for how Koha handles
10524 permissions for patrons who are expired. This preference can be overwritten by
10525 the setting on <link linkend="patcats">individual patron
10526 categories</link>.</para>
10528 </itemizedlist></para>
10531 <section id="OpacAllowPublicListCreation">
10532 <title>OpacAllowPublicListCreation</title>
10534 <para>Default: Allow</para>
10536 <para>Asks: ___ opac users to create public lists</para>
10538 <para>Values:</para>
10546 <para>Don't allow</para>
10550 <para>Description:</para>
10554 <para>Public lists are visible to anyone who visits your OPAC.
10555 With this preference you can control whether or now patrons
10556 are allowed to create these public lists. If this is set to
10557 "Don't allow" then only staff will be able to create public
10563 <para>This preference will only be taken in to account if you
10564 have <link linkend="virtualshelves">virtualshelves</link> set to
10569 <section id="OpacAllowSharingPrivateLists">
10570 <title>OpacAllowSharingPrivateLists</title>
10572 <para>Default: Don't allow</para>
10574 <para>Asks: ___ opac users to share private lists with other
10577 <para>Values:</para>
10585 <para>Don't allow</para>
10589 <para>Description:</para>
10593 <para>This feature will add the option for patrons to share their lists with other
10594 patrons. When this is set to 'Allow' patrons will see a share link at the top of
10595 their list. When they click that link it will ask for the email of the patron they
10596 would like to share with. Koha will then email the patron an invitation to see the
10602 <section id="OPACFineNoRenewals">
10603 <title>OPACFineNoRenewals</title>
10605 <para>Default: 99999</para>
10607 <para>Asks: Only allow patrons to renew their own books on the
10608 OPAC if they have less than ___ USD in fines</para>
10611 <para>Leave this field blank to disable</para>
10615 <para>To allow renewals in the OPAC, <link linkend="opacuserlogin">opacuserlogin</link> needs to be set to
10620 <section id="OpacHiddenItems">
10621 <title>OpacHiddenItems</title>
10623 <para>Asks: Allows to define custom rules for hiding specific
10624 items at opac. <tip>
10625 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
10626 directory for more information</para>
10629 <para>Description:</para>
10633 <para>In this field you can enter criteria for items you would
10634 like to hide from display in the OPAC. This field takes any
10635 combination of item fields (from the items table in the Koha
10636 database) for blocking. For example a value of:</para>
10638 <para><programlisting>itype: [07, 10]
10639 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
10640 07 or 10 as well as items that have a shelving location of
10641 STAFF or ISO.</para>
10643 <para>In items my items.itype 07 is defined in Item Types
10644 Administration as Staff Assigned My items.itype 10 in Item
10645 Types is Archival Copy The locations STAFF and ISO are in
10646 Authorized Values for category=LOC STAFF means it's assigned
10647 to the staff reading room and ISO means it is in the isolation
10653 <section id="OPACItemHolds">
10654 <title>OPACItemHolds</title>
10656 <para>Default: Allow</para>
10658 <para>Asks: ___ patrons to place holds on specific items in the
10661 <para>Values:</para>
10669 <para>Patrons can place holds on specific items as well as
10670 the next available item.</para>
10674 <para><link linkend="opacuserlogin">opacuserlogin</link>
10675 needs to be set to 'allow'</para>
10681 <para>Don't allow</para>
10685 <para>If this is disabled, users can only put a hold on
10686 the next available item.</para>
10693 <section id="OpacRenewalAllowed">
10694 <title>OpacRenewalAllowed</title>
10696 <para>Default: Don't allow</para>
10698 <para>Asks: ___ patrons to renew their own books on the
10701 <para>Values:</para>
10709 <para><link linkend="opacuserlogin">opacuserlogin</link>
10710 needs to be set to 'allow'</para>
10716 <para>Don't allow</para>
10720 <para>Staff will still be able to renew items for patrons
10721 via the staff client</para>
10727 <para>Description:</para>
10731 <para>This preference allows the administration to choose if
10732 patrons can renew their checked out materials via their
10733 checked out history in the OPAC. It allows patrons to renew
10734 their materials without having to contact the library or
10735 having to return to the library.</para>
10740 <section id="OpacRenewalBranch">
10741 <title>OpacRenewalBranch</title>
10743 <para>Default: the branch the item was checked out from</para>
10745 <para>Asks: Use ___ as branchcode to store in the statistics
10748 <para>Values:</para>
10756 <para>'OPACRenew'</para>
10760 <para>the item's home branch</para>
10764 <para>the patron's home branch</para>
10768 <para>the branch the item was checked out from</para>
10772 <para>Description:</para>
10776 <para>This value is used in the statistics table to help with
10777 reporting. The statistics table in Koha keeps track of all
10778 checkouts and renewals, this preference defines which branch
10779 is entered in to the table when a patron renews an item for
10780 themselves via the OPAC.</para>
10785 <section id="OPACViewOthersSuggestions">
10786 <title>OPACViewOthersSuggestions</title>
10788 <para>Default: Don't show</para>
10790 <para>Asks: ___ purchase suggestions from other patrons on the
10793 <para>Values:</para>
10797 <para>Don't show</para>
10805 <para><link linkend="opacuserlogin">opacuserlogin</link>
10806 needs to be set to 'allow'</para>
10813 <section id="SearchMyLibraryFirst">
10814 <title>SearchMyLibraryFirst</title>
10816 <para>Default: Don't limit</para>
10818 <para>Asks: ___ patrons' searches to the library they are
10819 registered at.</para>
10821 <para>Values:</para>
10825 <para>Don't limit</para>
10829 <para>Searching the OPAC will show results from all
10834 <para>If you're a one branch system, choose 'Don't
10845 <para>Patrons will still be able to search other libraries
10846 via the Advanced search page - but will be limited to
10847 searches for their library only from the basic search
10852 <para><link linkend="opacuserlogin">opacuserlogin</link>
10853 needs to be set to 'allow'</para>
10860 <section id="singleBranchMode">
10861 <title>singleBranchMode</title>
10863 <para>Default: Don't allow</para>
10865 <para>Asks: ___ patrons to select their branch on the OPAC.</para>
10867 <para>Values:</para>
10875 <para><link linkend="opacuserlogin">opacuserlogin</link>
10876 needs to be set to 'allow'</para>
10882 <para>Don't allow</para>
10886 <para>Description:</para>
10890 <para>This preference is for libraries that have branches but
10891 do not want to share their items among other branches within
10892 their system. If the preference is set to "Don't allow" then
10893 holdings will be shown for all branches within a system. On
10894 the "Home" screen of the OPAC users have the choice of
10895 narrowing down results by item location. Setting this
10896 preference to "Allow" will display only one branch's
10903 <section id="opacprivacyprefs">
10904 <title>Privacy</title>
10908 <section id="AnonSuggestions">
10909 <title>AnonSuggestions</title>
10911 <para>Default: Don't allow</para>
10913 <para>Asks: ___ patrons that aren't logged in to make purchase
10914 suggestions. <important>
10915 <para>If set to 'Allow', suggestions are connected to the
10916 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
10917 </important></para>
10919 <para>Values:</para>
10927 <para>Don't allow</para>
10932 <section id="AnonymousPatron">
10933 <title>AnonymousPatron</title>
10935 <para>Default: 0</para>
10937 <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for
10938 anonymous suggestions and reading history) <tip>
10939 <para>Before setting this preference <link linkend="addnewpatron">create a patron</link> to be used for
10940 all anonymous suggestions and/or reading history items. This
10941 patron can be any type and should be named something to make
10942 it clear to you that they're anonymous (ex. Anonymous
10947 <section id="EnableOpacSearchHistory">
10948 <title>EnableOpacSearchHistory</title>
10950 <para>Default: Keep</para>
10952 <para>Asks: ___ patron search history in the OPAC.</para>
10954 <para>Values:</para>
10958 <para>Don't keep</para>
10967 <section id="OPACPrivacy">
10968 <title>OPACPrivacy</title>
10970 <para>Default: Don't allow</para>
10972 <para>Asks: ___ patrons to choose their own privacy settings for
10973 their reading history. <important>
10974 <para>This requires <link linkend="opacreadinghistory">opacreadinghistory</link> set to
10975 'Allow' and <link linkend="AnonymousPatron">AnonymousPatron</link> to be set to
10976 your anonymous patron's borrowernumber.</para>
10977 </important></para>
10979 <para>Values:</para>
10987 <para>Don't allow</para>
10992 <section id="opacreadinghistory">
10993 <title>opacreadinghistory</title>
10995 <para>Default: Allow</para>
10997 <para>Asks: ___ patrons to see what books they have checked out in
11001 <para>Enabling this will make it so that patrons can view their
11002 circulation history in the OPAC unless you have OPACPrivacy set
11007 <para>This data is stored in the system regardless of your
11008 choice, unless your patrons have chosen to never have their
11009 reading history kept.</para>
11012 <section id="TrackClicks">
11013 <title>TrackClicks</title>
11014 <para>Default: Don't track</para>
11015 <para>Asks: ___ links that patrons click on.</para>
11016 <para>Values:<itemizedlist>
11018 <para>Don't track</para>
11024 <para>Track anonymously</para>
11026 </itemizedlist></para>
11027 <para>Description:<itemizedlist>
11029 <para>By setting this preference to one of the track options you will allow Koha
11030 to track every link clicked in Koha. This data will be stored in a database
11031 table so that you can run reports against that data. If you choose to 'Track'
11032 clicks then Koha will record both the link clicked and the logged in user who
11033 clicked the link. If you choose to 'Track anonymously' then the borrowernumber
11034 will not be recorded, but the rest of the data will.<tip>
11035 <para>Remember to update your local privacy policies and link to them from the
11036 OPAC to notify your users that you are tracking their information.</para>
11039 </itemizedlist></para>
11042 <section id="opacselfregistrationprefs">
11043 <title>Self Registration</title>
11044 <section id="PatronSelfRegistration">
11045 <title>PatronSelfRegistration</title>
11046 <para>Default: Don't allow</para>
11047 <para>Asks: ___ library patrons to register an account via the OPAC.</para>
11048 <para>Values:<itemizedlist>
11053 <para>Don't allow</para>
11055 </itemizedlist></para>
11056 <para>Description:</para>
11059 <para>Setting this preference to 'Allow' will provide a link on the OPAC to register
11060 for a new account. Using the other <link linkend="opacselfregistrationprefs">Self
11061 Registration</link> system preferences you can control how this preference will function.</para>
11063 <screeninfo>Register link in the OPAC</screeninfo>
11066 <imagedata fileref="images/admin/globalprefs/PatronSelfRegistration.png"/>
11073 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
11074 For this reason it is recommended that you set up a provisional <link linkend="patcats">patron category</link> with no <link linkend="circfinerules">circulation rights</link>. That way patrons will have to come in to the library
11075 to verify their identity before given circulation rights at the library. Once the
11076 patron confirms their identiy the library staff can change the category to one with
11077 permissions to check items out and place holds.</para>
11080 <section id="PatronSelfRegistrationAdditionalInstructions">
11081 <title>PatronSelfRegistrationAdditionalInstructions</title>
11082 <para>Asks: Display the following additional instructions for patrons who self register
11083 via the OPAC ( HTML is allowed ): </para>
11084 <para>Description:<itemizedlist>
11086 <para>This preference takes any HTML you'd like to display on the page the patron
11087 sees after successfully registering for their library card.</para>
11089 </itemizedlist></para>
11091 <section id="PatronSelfRegistrationBorrowerMandatoryField">
11092 <title>PatronSelfRegistrationBorrowerMandatoryField</title>
11093 <para>Default: surname|firstname</para>
11094 <para>Asks: The following database columns must be filled in on the patron entry screen:
11096 <para>Description:</para>
11099 <para>This preference allows you to define what fields patrons must fill in on their
11100 self regisration form. If any of the required fields are blank Koha will not let
11101 the patron register.</para>
11105 <para>Separate columns with |</para>
11108 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
11109 structure</ulink> associated with the borrowers table.</para>
11112 <para>If you're going to require that patrons verify their accounts via email with the
11113 <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference the email field will
11114 automatically be marked as required.</para>
11117 <section id="PatronSelfRegistrationBorrowerUnwantedField">
11118 <title>PatronSelfRegistrationBorrowerUnwantedField</title>
11119 <para>Asks: The following database columns will not appear on the patron entry screen:
11121 <para>Description:</para>
11124 <para>Using this preference you can hide fields from the patron registraion and
11125 update form in the OPAC.</para>
11129 <para>Separate columns with |</para>
11132 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
11133 structure</ulink> associated with the borrowers table.</para>
11136 <section id="PatronSelfRegistrationDefaultCategory">
11137 <title>PatronSelfRegistrationDefaultCategory</title>
11138 <para>Asks: Use the patron category code ___ as the default patron category for patrons
11139 registered via the OPAC. </para>
11140 <para>Description:</para>
11143 <para>Enter in the patron category code for the category that all new patrons
11144 registered via the OPAC will be put in to.</para>
11148 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
11149 For this reason it is recommended that you set up a provisional <link linkend="patcats">patron category</link> with no <link linkend="circfinerules">circulation rights</link>. That way patrons will have to come in to the library
11150 to verify their identity before given circulation rights at the library. Once the
11151 patron confirms their identiy the library staff can change the category to one with
11152 permissions to check items out and place holds.</para>
11155 <para>If you leave this blank or enter in an invalid code your patrons will still be
11156 able to register but will not be given a username. There will be no errors on the
11157 page to explain this, so be sure to enter a valid patron category code.</para>
11160 <section id="PatronSelfRegistrationExpireTemporaryAccountsDelay">
11161 <title>PatronSelfRegistrationExpireTemporaryAccountsDelay</title>
11162 <para>Default: 0</para>
11163 <para>Asks: Delete patrons registered via the OPAC, but not yet verified after ___
11165 <para>Description:<itemizedlist>
11167 <para>This prefence links to the <link linkend="deleteexpiredregistrationcron"
11168 >delete_expired_opac_registrations.pl cron job</link>. If that cron is set to
11169 run nightly it will clean up any registrations that have not been verified via
11170 email in the number of days entered on this preference. This is dependent on
11171 <link linkend="PatronSelfRegistrationVerifyByEmail"
11172 >PatronSelfRegistrationVerifyByEmail</link> preference.</para>
11174 </itemizedlist></para>
11176 <section id="PatronSelfRegistrationVerifyByEmail">
11177 <title>PatronSelfRegistrationVerifyByEmail</title>
11178 <para>Default: Don't require</para>
11179 <para>Asks: ___ that a self-registering patron verify his or herself via email.</para>
11180 <para>Values:<itemizedlist>
11182 <para>Don't require</para>
11185 <para>Require</para>
11187 </itemizedlist></para>
11188 <para>Description:<itemizedlist>
11190 <para>If you require patrons to verify their accounts via email they will not be
11191 able to log in to the OPAC until they acknowledge the email sent by Koha. If you
11192 don't require this then patrons will be able to log in as soon as they fill in
11193 the registration form. You can set the <link
11194 linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay"
11195 >PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference to
11196 delete the un-verified self registrations after a certain number of days.</para>
11198 </itemizedlist><tip>
11199 <para>If you're going to require that patrons verify their accounts via email then
11200 the email field will automatically be marked as required.</para>
11205 <section id="shelfbrowseprefs">
11206 <title>Shelf Browser</title>
11210 <section id="OPACShelfBrowser">
11211 <title>OPACShelfBrowser</title>
11213 <para>Default: Show</para>
11215 <para>Asks: ___ a shelf browser on item details pages, allowing
11216 patrons to see what's near that item on the shelf.</para>
11218 <para>Values:</para>
11222 <para>Don't show</para>
11229 <screeninfo>OPACShelfBrowser</screeninfo>
11233 <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
11240 <para>Description:</para>
11244 <para>This preference allows patrons to view what is located
11245 on the shelf near the item they looked up. The shelf browser
11246 option appears on the details page to the right of each items'
11247 call number. Clicking the 'Browse Shelf' link allows for a
11248 virtual shelf browsing experience via the OPAC and lets
11249 patrons see other books that may relate to their search and
11250 items that sit on the shelf near the item they are looking
11256 <para>This uses up a fairly large amount of resources on your
11257 server, and should be avoided if your collection has a large
11258 number of items.</para>
11262 <section id="ShelfBrowserUsesCcode">
11263 <title>ShelfBrowserUsesCcode</title>
11265 <para>Default: Don't use</para>
11267 <para>Asks: ___ the item collection code when finding items for
11268 the shelf browser.</para>
11270 <para>Values:</para>
11274 <para>Don't use</para>
11282 <para>Description:</para>
11286 <para>If your library uses collection codes then you might
11287 want the shelf browser to take into consideration what
11288 collection the books belong to when populating the virtual
11289 shelf browser.</para>
11294 <section id="ShelfBrowserUsesHomeBranch">
11295 <title>ShelfBrowserUsesHomeBranch</title>
11297 <para>Default: Use</para>
11299 <para>Asks: ___ the item home branch when finding items for the
11300 shelf browser.</para>
11302 <para>Values:</para>
11306 <para>Don't use</para>
11314 <para>Description:</para>
11318 <para>If you have a multiple branch system you may want to
11319 make sure that Koha takes into consideration what branch owns
11320 the books when populating the virtual shelf browser for
11326 <section id="ShelfBrowserUsesLocation">
11327 <title>ShelfBrowserUsesLocation</title>
11329 <para>Default: Use</para>
11331 <para>Asks: ___ the item location when finding items for the shelf
11334 <para>Values:</para>
11338 <para>Don't use</para>
11346 <para>Description:</para>
11350 <para>If your library uses shelving locations then you might
11351 want the shelf browser to take into consideration what
11352 shelving location the books belong to when populating the
11353 virtual shelf browser.</para>
11360 <section id="patronprefs">
11361 <title>Patrons</title>
11363 <para><emphasis>Get there:</emphasis> More > Administration >
11364 Global System Preferences > Patrons</para>
11366 <section id="AddPatronLists">
11367 <title>AddPatronLists</title>
11369 <para>Default: specific categories</para>
11371 <para>Asks: List ___ under the new patron menu.</para>
11373 <para>Values:</para>
11377 <para>general patron types</para>
11380 <screeninfo>Add patron options with AddPatronLists set to
11381 general patron types</screeninfo>
11385 <imagedata fileref="images/admin/globalprefs/AddPatronLists-category.png"/>
11392 <para>specific categories</para>
11395 <screeninfo>Add patron options with AddPatronLists set to
11396 specific categories</screeninfo>
11400 <imagedata fileref="images/admin/globalprefs/AddPatronLists-specific.png"/>
11408 <section id="AutoEmailOPACUser">
11409 <title>AutoEmailOpacUser</title>
11411 <para>Default: Don't send</para>
11413 <para>Asks: ___ an email to newly created patrons with their account
11416 <para>Description:</para>
11420 <para>AutoEmailOpacUser allows library users to be notified by
11421 email of their account details when a new account is opened at
11422 the email address specified in the <link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
11423 preference. The email contains the username and password given
11424 to or chosen by the patron when signing up for their account and
11425 can be customized by editing the <link linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
11429 <para>Values:</para>
11433 <para>Don't send</para>
11442 <section id="AutoEmailPrimaryAddress">
11443 <title>AutoEmailPrimaryAddress</title>
11445 <para>Default: alternate</para>
11447 <para>Asks: Use ___ patron email address for sending out
11450 <para>Values:</para>
11454 <para>alternate</para>
11458 <para>first valid</para>
11470 <para>Description:</para>
11474 <para>If you choose 'first valid' as the value for
11475 AutoEmailPrimaryAddress the system will check the email fields
11476 in this order: home, work, then alternate. Otherwise the system
11477 will use the email address you specify.</para>
11482 <section id="autoMemberNum">
11483 <title>autoMemberNum</title>
11485 <para>Default: Do</para>
11487 <para>Asks: ___ default the card number field on the patron addition
11488 screen to the next available card number</para>
11490 <para>Values:</para>
11498 <para>If the largest currently used card number is
11499 26345000012941, then this field will default to
11500 26345000012942 for the next patron</para>
11510 <para>Description:</para>
11514 <para>This preference determines if the patron's barcode is
11515 automatically calculated. This prevents the person setting up
11516 the library card account from having to assign a number to the
11517 new card. If set to 'Do' the system will calculate a new patron
11518 barcode by adding 1 to the maximum barcode already present in
11519 the database.</para>
11524 <section id="BorrowerMandatoryField">
11525 <title>BorrowerMandatoryField</title>
11527 <para>Default: surname|cardnumber|barcode</para>
11529 <para>Asks: The following database columns must be filled in on the
11530 patron entry screen: ___</para>
11532 <para>Description:</para>
11536 <para>This preference enables the system administrator to choose
11537 which fields your library would like required for patron
11538 accounts. Enter field names separated by | (bar). This ensures
11539 that basic information is included in each patron record. If a
11540 patron leaves one of the required fields blank an error message
11541 will issue and the account will not be created.</para>
11546 <para>Separate columns with |</para>
11550 <para>For help with field names, ask your system administrator or
11551 <ulink url="http://schema.koha-community.org/tables/borrowers.html">view
11552 the database structure</ulink> associated with the borrowers
11557 <section id="borrowerRelationship">
11558 <title>borrowerRelationship</title>
11560 <para>Default: father|mother</para>
11562 <para>Asks: Guarantors can be the following of those they guarantee
11565 <para>Description:</para>
11569 <para>This preference enables the system administrator to define
11570 valid relationships between a guarantor (usually a parent) &
11571 a guarantee (usually a child). Defining values for this field
11572 does not make the guarantor field required when adding a
11573 guarantee type patron. This preference creates a drop down list
11574 identifying the relationship of the guarantor to the guarantee.
11575 To disable the ability to add children types in Koha you can
11576 leave this field blank.</para>
11581 <para>Input multiple choices separated by |</para>
11585 <section id="BorrowerRenewalPeriodBase">
11586 <title>BorrowerRenewalPeriodBase</title>
11588 <para>Default: current date</para>
11590 <para>Asks: When renewing borrowers, base the new expiry date on
11593 <para>Values:</para>
11597 <para>current date.</para>
11601 <para>current membership expiry date.</para>
11605 <para>Description:</para>
11609 <para>This preference controls what the patron's new expiration
11610 date will be when you renew their card. Using the 'current date'
11611 will add the subscription period to today's date when
11612 calculating the new expiration date. Using 'current membership
11613 expiry date' will add the subscription period to the old
11614 expiration date for the patron when renewing their
11620 <section id="BorrowersTitles">
11621 <title>BorrowersTitles</title>
11623 <para>Default: Mr|Mrs|Miss|Ms</para>
11625 <para>Asks: Borrowers can have the following titles ___</para>
11627 <para>Description:</para>
11631 <para>This preference allows the staff to choose the titles that
11632 can be assigned to patrons. The choices present as a drop down
11633 list when creating a patron record.</para>
11638 <para>Input multiple choices separated by |</para>
11642 <section id="BorrowerUnwantedField">
11643 <title>BorrowerUnwantedField</title>
11645 <para>Asks: The following database columns will not appear on the
11646 patron entry screen: ___</para>
11648 <para>Description:</para>
11652 <para>This preference enables the system administrator to choose
11653 which fields your library doesn't need to see on the patron
11654 entry form. Enter field names separated by | (bar).</para>
11659 <para>Separate columns with |</para>
11663 <para>For help with field names, ask your system administrator or
11664 <ulink url="http://schema.koha-community.org/tables/borrowers.html">view
11665 the database structure</ulink> associated with the borrowers
11669 <section id="CardnumberLength">
11670 <title>CardnumberLength</title>
11671 <para>Asks: Card numbers for patrons must be ___ characters long. </para>
11672 <para>Description:<itemizedlist>
11674 <para>The length can be a single number to specify an exact length, a range
11675 separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum (i.e.,
11676 ',Max'). If 'cardnumber' is included in the <link linkend="BorrowerMandatoryField"
11677 >BorrowerMandatoryField</link> list, the minimum length, if not specified here,
11678 defaults to one. </para>
11680 </itemizedlist></para>
11683 <section id="checkdigit">
11684 <title>checkdigit</title>
11686 <para>Default: Don't</para>
11688 <para>Asks: ___ check and construct borrower card numbers in the
11689 Katipo style.</para>
11691 <para>Values:</para>
11704 <para>This overrides <link linkend="autoMemberNum">autoMemberNum</link> if on.</para>
11708 <section id="EnableBorrowerFiles">
11709 <title>EnableBorrowerFiles</title>
11711 <para>Default: Don't</para>
11713 <para>Asks: ___ enable the ability to upload and attach arbitrary
11714 files to a borrower record.</para>
11716 <para>Values:</para>
11728 <para>Description:</para>
11732 <para>When enabled this will add a 'Files' tab to the left of
11733 the patron detail page where you can view and upload files to
11734 the patron record.</para>
11739 <section id="EnhancedMessagingPreferences">
11740 <title>EnhancedMessagingPreferences</title>
11742 <para>Default: Allow</para>
11744 <para>Asks: ___ patrons to choose which notices they receive and
11745 when they receive them.</para>
11747 <para>Values:</para>
11755 <para>Don't allow</para>
11760 <para>This only applies to certain kinds of notices, overdue
11761 notices will be sent based on the library's rules, not the
11762 patron's choice.</para>
11765 <para>Description:</para>
11769 <para>These messages are in addition to the overdue notices that
11770 the library sends. The difference between these notices and
11771 overdues is that the patron can opt-in and out of these. Setting
11772 this preference to 'Allow' will allow patrons to choose to
11773 receive any one of the following messages:</para>
11777 <para>Item Checkout : A notice that lists all the of the items the patron has just
11778 checked out and/or renewed, this is an electronic form of the checkout
11783 <para>Item Due : A notice on the day and item is due back at
11788 <para>Hold Filled : A notice when you have confirmed the
11789 hold is waiting for the patron</para>
11793 <para>Item Checkin : A notice that lists all the of the
11794 items the patron has just checked in</para>
11798 <para>Advanced Notice : A notice in advance of the patron's
11799 items being due (The patron can choose the number of days in
11807 <section id="ExtendedPatronAttributes">
11808 <title>ExtendedPatronAttributes</title>
11810 <para>Default: Enable</para>
11812 <para>Asks: ___ searching, editing and display of custom attributes
11815 <para>Values:</para>
11819 <para>Don't enable</para>
11823 <para>Enable</para>
11827 <para>Define attributes in Koha administration</para>
11831 <para>Get there: More > Administration > <link linkend="patronattributetypes">Patron Attribute
11832 Types</link></para>
11838 <para>Description:</para>
11842 <para>Patron attributes are library-defined custom fields that
11843 can be applied to patron records.</para>
11848 <para>Use custom attributes for fields that the default patron
11849 record does not support such as driver's license number or student
11854 <section id="intranetreadinghistory">
11855 <title>intranetreadinghistory</title>
11857 <para>Default: Allow</para>
11859 <para>Asks: ___ staff to access a patron's checkout
11861 <para>If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference set to
11862 'Allow' and the patron has decided to not have their history
11863 kept staff will only see currently checked out items.</para>
11864 </important></para>
11866 <para>Values:</para>
11874 <para>Don't allow</para>
11879 <para>This data is stored in the system regardless of your
11884 <section id="MaxFine">
11885 <title>MaxFine</title>
11887 <para>Default: 9999</para>
11889 <para>Asks: The late fine for all checkouts will only go up to ___
11892 <para>Description:</para>
11896 <para>This preference controls the default cap on fines accrued
11897 by the patron. Leaving this preference blank means that there is
11898 no cap on the amount of fines a patron can accrue. If you'd
11899 like, single item caps can be specified in the <link linkend="circfinerules">circulation rules matrix</link>.</para>
11904 <section id="minPasswordLength">
11905 <title>minPasswordLength</title>
11907 <para>Default: 3</para>
11909 <para>Asks: Login passwords for staff and patrons must be at least
11910 ___ characters long.</para>
11913 <para>This applies to both the staff login and the patron OPAC
11918 <section id="NotifyBorrowerDeparture">
11919 <title>NotifyBorrowerDeparture</title>
11921 <para>Default: 30</para>
11923 <para>Asks: Show a notice that a patron is about to expire ___ days
11926 <para>Description:</para>
11930 <para>When the patron attempts to check out materials, a warning
11931 will appear in the check out window of the Staff Client telling
11932 the librarian that the patrons account is about to
11938 <para>This notice will appear on the patron's record in the staff
11943 <section id="patronimages">
11944 <title>patronimages</title>
11946 <para>Default: Allow</para>
11948 <para>Asks: ___ images to be uploaded and shown for patrons on the
11949 staff client.</para>
11951 <para>Values:</para>
11959 <para>Don't allow</para>
11962 <para>Description:<itemizedlist>
11964 <para>If this preference is set to 'Allow' the staff will be able to upload images
11965 of patrons either <link linkend="addpatronimages">one by one</link> or <link
11966 linkend="uploadpatronimages">in bulk</link>. Patrons images will show on the
11967 detail page to the left of the patron information. They can also show in the OPAC
11968 if you set the <link linkend="OPACpatronimage">OPACpatronimage</link> preference
11969 or in the self check out module if you set the <link
11970 linkend="ShowPatronImageInWebBasedSelfCheck"
11971 >ShowPatronImageInWebBasedSelfCheck</link> preference.</para>
11973 </itemizedlist></para>
11976 <section id="PatronsPerPage">
11977 <title>PatronsPerPage</title>
11979 <para>Default: 20</para>
11981 <para>Asks: By default, show ___ results per page in the staff
11983 <para>Description:<itemizedlist>
11985 <para>This preference will let you define how many patrons to show on patron search
11986 results pages.</para>
11988 </itemizedlist></para>
11991 <section id="SMSSendDriver">
11992 <title>SMSSendDriver</title>
11994 <para>Asks: Use the SMS::Send:: ___ driver to send SMS
11997 <para>Some examples of values are:</para>
12001 <para>SMS::Send::Us::Ipipi</para>
12005 <para>SMS::Send::US::TMobile</para>
12009 <para>SMS::Send::US::Verizon</para>
12013 <para>Additional values can be found here: <ulink url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
12017 <para>Only drivers available as Perl modules will work in this
12018 preference, so make sure a Perl module is available before
12019 choosing an SMS service.</para>
12022 <para>Once a driver is entered in the preference an option will
12023 appear in the staff client and the OPAC on the patron messaging form
12024 to choose to receive messages as SMS</para>
12027 <screeninfo>SMSSendDriver Options</screeninfo>
12031 <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
12037 <para>You must allow <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
12038 for this to work.</para>
12042 <section id="StatisticsFields">
12043 <title>StatisticsFields</title>
12045 <para>Default: location|itype|ccode</para>
12047 <para>Asks: Show the following fields from the items database table
12048 as columns on the statistics tab on the patron record: ___</para>
12051 <screeninfo>Statistics on Patron Record</screeninfo>
12055 <imagedata fileref="images/admin/globalprefs/StatisticsFields.png"/>
12061 <para>Enter the values separated by bars (|)</para>
12064 <para>Description:</para>
12068 <para>This preference lets you set which fields will show on the
12069 patron record on the Statistics tab.</para>
12074 <section id="TalkingTechItivaPhoneNotification">
12075 <title>TalkingTechItivaPhoneNotification</title>
12077 <para>Default: Disable</para>
12079 <para>Asks: ___ patron phone notifications using Talking Tech i-tiva
12080 (overdues, predues and holds notices currently supported).</para>
12082 <para>Values:</para>
12086 <para>Disable</para>
12090 <para>Enable</para>
12094 <para>Description:</para>
12098 <para>To learn more about setting up this third party product
12099 view the <link linkend="talkingtechappendix">Talking Tech
12100 Appendix</link>.</para>
12105 <para>Requires that you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
12106 set to Allow to use.</para>
12110 <section id="uppercasesurnames">
12111 <title>uppercasesurnames</title>
12113 <para>Default: Don't</para>
12115 <para>Asks: ___ store and display surnames (last names) in upper
12118 <para>Values:</para>
12132 <section id="searchingprefs">
12133 <title>Searching</title>
12135 <para><emphasis>Get there:</emphasis> More > Administration >
12136 Global System Preferences > Searching</para>
12138 <section id="searchfeatureprefs">
12139 <title>Features</title>
12142 <section id="EnableSearchHistory">
12143 <title>EnableSearchHistory</title>
12144 <para>Default: Don't keep</para>
12145 <para>Asks: ___ patron search history in the staff client.</para>
12146 <para>Values:<itemizedlist>
12148 <para>Don't keep</para>
12153 </itemizedlist>Description:<itemizedlist>
12155 <para>This preference controls whether the staff client keeps search history for
12156 logged in users.</para>
12158 </itemizedlist></para>
12160 <section id="IncludeSeeFromInSearches">
12161 <title>IncludeSeeFromInSearches</title>
12162 <para>Default: Don't include</para>
12163 <para>Asks: ___ <emphasis role="italic">see from</emphasis> (non-preferred form)
12164 headings in bibliographic searches. </para>
12165 <para>Values:<itemizedlist>
12167 <para>Don't include</para>
12170 <para>Include</para>
12172 </itemizedlist></para>
12173 <para>Description: <itemizedlist>
12175 <para>When this preference is set to include the search engine indexer will insert
12176 <emphasis role="italic">see from</emphasis> headings from authority records
12177 into bibliographic records when indexing, so that a search on an obsolete term
12178 will turn up relevant records. For example when you search for cookery (the old
12179 term) you get titles with the heading of cooking (the new term).</para>
12181 </itemizedlist><important>
12182 <para>You will need to reindex your bibliographic database when changing this
12183 preference. </para>
12184 </important></para>
12187 <section id="OpacGroupResults">
12188 <title>OpacGroupResults</title>
12190 <para>Default: Don't use</para>
12192 <para>Asks: ___ PazPar2 to group similar results on the
12195 <para>Values:</para>
12199 <para>Don't use</para>
12208 <para>This requires that <ulink url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
12209 and running.</para>
12213 <section id="QueryAutoTruncate">
12214 <title>QueryAutoTruncate</title>
12216 <para>Default: automatically</para>
12218 <para>Asks: Perform wildcard searching (where, for example, Har
12219 would match Harry and harp) ___ (The * character would be used
12220 like so: Har* or *logging.)</para>
12222 <para>Values:</para>
12226 <para>automatically</para>
12230 <para>only if * is added</para>
12234 <para>Description:</para>
12238 <para>This setting allows for searches to be automatically
12239 truncated or for additional characters to be added to the end
12240 of a search string. When set to "automatically" the search
12241 string automatically ends with a wildcard function. For
12242 example, a search for the word "invent" with auto truncation
12243 enabled will also retrieve results for inventor, invention,
12244 inventory, etc. If you don't want this to happen automatically
12245 you can still be perform wildcard searches manually by adding
12246 an asterisk (*). Typing "invent*" even with auto truncation
12247 disabled will retrieve the same inventor, invention, inventory
12248 results. Auto truncation bypasses the necessity to type long
12249 search strings in their entirety.</para>
12254 <section id="QueryFuzzy">
12255 <title>QueryFuzzy</title>
12257 <para>Default: Try</para>
12259 <para>Asks: ___ to match similarly spelled words in a search (for
12260 example, a search for flang would also match flange and
12263 <para>Values:</para>
12267 <para>Don't try</para>
12275 <para>Description:</para>
12279 <para>This preference enables "fuzzy" searching, in which the
12280 search engine returns results that are similar to, but not
12281 exactly matching, the word or words entered by the user. This
12282 preference enables the search function to compensate for
12283 slightly misspelled names or phrases.</para>
12288 <para>Requires that <link linkend="UseICU">UseICU</link> set to 'Not using'</para>
12292 <section id="QueryStemming">
12293 <title>QueryStemming</title>
12295 <para>Default: Try</para>
12297 <para>Asks: ___ to match words of the same base in a search</para>
12299 <para>Values:</para>
12303 <para>Don't try</para>
12311 <para>A search for enabling would also match enable and
12318 <para>Description:</para>
12322 <para>This preference enables word stemming. Stemming allows
12323 the search function to return multiple versions of the same
12324 word, as well as related terms (i.e., both fish and fishing
12325 would be returned).</para>
12330 <section id="QueryWeightFields">
12331 <title>QueryWeightFields</title>
12333 <para>Default: Enable</para>
12335 <para>Asks: ___ ranking of search results by relevance</para>
12337 <para>Values:</para>
12341 <para>Disable</para>
12345 <para>Enable</para>
12350 <section id="TraceCompleteSubfields">
12351 <title>TraceCompleteSubfields</title>
12353 <para>Default: Force</para>
12355 <para>Asks: ___ subject tracings in the OPAC and Staff Client to
12356 search only for complete-subfield matches.</para>
12358 <para>Values:</para>
12362 <para>Don't force</para>
12366 <para>Searches for subject keywords (example:
12367 opac-search.pl?q=su:World%20Wide%20Web)</para>
12377 <para>Searches for complete subject fields (example:
12378 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
12384 <para>Description:</para>
12388 <para>When TraceCompleteSubfields is set to "force," clicking
12389 on links in non-authority controlled subject tracings will
12390 only find other records where the entire subfields match.
12391 Leaving it at "don't force" does a keyword search of the
12392 subject indexes.</para>
12397 <para>This preference assumes that you're using XSLT stylesheets
12398 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12403 <section id="TraceSubjectSubdivisions">
12404 <title>TraceSubjectSubdivisions</title>
12406 <para>Default: Include</para>
12408 <para>Asks: ___ subdivisions for searches generated by clicking on
12409 subject tracings.</para>
12411 <para>Values:</para>
12415 <para>Don't include</para>
12419 <para>Searches for subject keywords (example:
12420 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
12426 <para>Include</para>
12430 <para>Searches for complete subject fields (example:
12431 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
12437 <para>Description:</para>
12441 <para>When TraceSubjectSubdivisions is set to "Include," if
12442 you click on a subject with subdivisions (subfields other than
12443 'a') they will be searched along with the subject heading
12444 (subfield 'a'). To have only the subject heading (subfield
12445 'a') searched, set this preference to "Don't include."</para>
12450 <para>This preference assumes that you're using XSLT stylesheets
12451 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12456 <section id="UseICU">
12457 <title>UseICU</title>
12459 <para>Default: Not using</para>
12461 <para>Asks: ___ ICU Zebra indexing.</para>
12463 <para>Values:</para>
12467 <para>Not using</para>
12475 <para>Description:</para>
12479 <para>ICU is a set of code libraries providing Unicode and
12480 Globalization support for software applications. What this
12481 means is ICU Zebra indexing is only necessary if you use
12482 non-roman characters in your cataloging. If using ICU Zebra
12483 indexing you will want to not use <link linkend="QueryFuzzy">QueryFuzzy</link>.</para>
12488 <para>This setting will not affect Zebra indexing, it should
12489 only be used to tell Koha that you have activated ICU indexing
12490 if you have actually done so, since there is no way for Koha to
12491 figure this out on its own.</para>
12495 <para>Talk to your system administrator when changing this
12496 preference to make sure that your system is set up properly for
12497 this to work.</para>
12500 <section id="UseQueryParser">
12501 <title>UseQueryParser</title>
12502 <para>Default: Do not try</para>
12503 <para>Asks: ___ to use the QueryParser module for parsing queries. <note>
12504 <para>Enabling this will have no impact if you do not have QueryParser installed,
12505 and everything will continue to work as usual.</para>
12507 <para>Values:<itemizedlist>
12509 <para>Do not try</para>
12514 </itemizedlist></para>
12515 <para>Description:<itemizedlist>
12517 <para>This preference enables an experimental new query parser which opens the
12518 door for a more expressive and more-effective search syntax.</para>
12520 </itemizedlist></para>
12524 <section id="searchresultsprefs">
12525 <title>Results Display</title>
12529 <section id="defaultSortField">
12530 <title>defaultSortField & defaultSortOrder</title>
12532 <para>defaultSortField Default: author</para>
12534 <para>defaultSortOrder Default: ascending</para>
12536 <para>Asks: By default, sort search results in the staff client by
12539 <para>Description:</para>
12543 <para>These preferences set the default sort field and sort
12544 order for searches on the staff side. Regardless of your
12545 choice, the other sort options are still available in the drop
12546 down list on the advanced search page.</para>
12550 <para>defaultSortField Values:</para>
12554 <para>author</para>
12558 <para>call number</para>
12562 <para>date added</para>
12566 <para>date of publication</para>
12570 <para>relevance</para>
12578 <para>total number of checkouts</para>
12582 <para>defaultSortOrder Values:</para>
12586 <para>ascending</para>
12590 <para>descending</para>
12594 <para>from A to Z</para>
12598 <para>from Z to A</para>
12603 <section id="displayFacetCount">
12604 <title>displayFacetCount</title>
12606 <para>Default: Don't show</para>
12608 <para>Asks: ___ facet counts.</para>
12610 <para>Description:</para>
12614 <para>This preference lets you decide if you show how many
12615 times a facet is used in your search results in the OPAC and
12616 the staff client. The relevance of these numbers highly
12617 depends on the value of the <link linkend="maxRecordsForFacets">maxRecordsForFacets</link>
12618 preference. Showing these numbers can potentially effect the
12619 performance of your searching, so test your system with
12620 different values for this preference to see what works
12625 <para>Values:</para>
12629 <para>Don't show</para>
12636 <screeninfo>Number of times each Facet is found in
12637 results</screeninfo>
12641 <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
12648 <section id="DisplayLibraryFacets">
12649 <title>DisplayLibraryFacets</title>
12650 <para>Default: holding library</para>
12651 <para>Asks: Show facets for ___</para>
12652 <para>Values:<itemizedlist>
12654 <para>both home and holding library</para>
12657 <para>holding library</para>
12660 <para>home library</para>
12662 </itemizedlist></para>
12663 <para>Description:<itemizedlist>
12665 <para>This preferenc controls the libraries facet that displays on search results
12666 in the staff and opac. The value selected here will determin which library(s)
12667 show in the facets when a search is run.</para>
12669 </itemizedlist></para>
12672 <section id="FacetLabelTruncationLength">
12673 <title>FacetLabelTruncationLength</title>
12675 <para>Default: 20</para>
12677 <para>Asks: Truncate facets length to ___ characters, in
12678 OPAC/staff interface.</para>
12680 <para>Description:</para>
12684 <para>In the OPAC and the staff client your facets are cut off
12685 at 20 characters by default. Depending on your layout this may
12686 be too many or two few letters, this preference lets you
12687 decide what number is best for your library's design.</para>
12692 <section id="maxItemsInSearchResults">
12693 <title>maxItemsInSearchResults</title>
12695 <para>Default: 20</para>
12697 <para>Asks: Show up to ___ items per biblio in the search
12700 <para>Description:</para>
12704 <para>This preference will let you set how many results
12705 display by default when a search is run on the Staff
12711 <section id="maxRecordsForFacets">
12712 <title>maxRecordsForFacets</title>
12714 <para>Default: 20</para>
12716 <para>Asks: Build facets based on ___ records from the search
12719 <para>Description:</para>
12723 <para>By default Koha only bases facets on the first page of
12724 results (usually 20 results). This preference lets you tell
12725 Koha to based the facet descriptions and numbers on any number
12726 of search results returned. The higher this number the longer
12727 it will take for your search results to return, so test with
12728 various different values to find the best balance for your
12734 <section id="numSearchResults">
12735 <title>numSearchResults</title>
12737 <para>Default: 20</para>
12739 <para>Asks: By default, show ___ results per page in the staff
12743 <section id="opacdefaultsort">
12744 <title>OPACdefaultSortField & OPACdefaultSortOrder</title>
12746 <para>OPACdefaultSortField Default: relevance</para>
12748 <para>OPACdefaultSortOrder Default: ascending</para>
12750 <para>Asks: By default, sort search results in the OPAC by ___,
12753 <para>Description:</para>
12757 <para>These preferences set the default sort field and sort
12758 order for searches on the OPAC. Regardless of your choice, the
12759 other sort options are still available in the drop down list
12760 on the advanced search page.</para>
12764 <para>OPACdefaultSortField Values:</para>
12768 <para>author</para>
12772 <para>call number</para>
12776 <para>date added</para>
12780 <para>date of publication</para>
12784 <para>relevance</para>
12792 <para>total number of checkouts</para>
12796 <para>OPACdefaultSortOrder Values:</para>
12800 <para>ascending</para>
12804 <para>descending</para>
12808 <para>from A to Z</para>
12812 <para>from Z to A</para>
12819 <section id="OPACItemsResultsDisplay">
12820 <title>OPACItemsResultsDisplay</title>
12822 <para>Default: Don't show</para>
12824 <para>Asks: ___ an item's branch, location and call number in OPAC
12825 search results.</para>
12827 <para>Values:</para>
12831 <para>Don't show</para>
12839 <para>Description:</para>
12843 <para>This setting selects the information about an item that
12844 will display in the search results page of the OPAC. The
12845 results can display the status of an item and/or full details
12846 including branch, location, and call number. While the 'Show'
12847 option allows for more information to be displayed on the
12848 search results page, the information can be overwhelming for
12849 large collections with multiple branches.</para>
12854 <section id="OPACnumSearchResults">
12855 <title>OPACnumSearchResults</title>
12857 <para>Default: 20</para>
12859 <para>Asks: By default, show ___ results per page in the
12864 <section id="searchformprefs">
12865 <title>Search Form</title>
12866 <section id="AdvancedSearchLanguages">
12867 <title>AdvancedSearchLanguages</title>
12868 <para>Asks: Limit the languages listed in the advanced search drop-down to the ___ ISO
12869 639-2 language codes (separate values with | or ,).</para>
12870 <para>Description:<itemizedlist>
12872 <para>This preference will allow you to decide what languages show in the pull
12873 down menu on the advanced search page in the OPAC and the staff client. If this
12874 preference is left blank, all languages will show. To limit the languages that
12875 are shown enter their <ulink
12876 url="http://www.loc.gov/standards/iso639-2/php/code_list.php">ISO 639-2
12877 language codes</ulink> separated by comma ( , ) or bar ( | ). For example to
12878 limit listing to French and Italian, enter ita|fre. </para>
12880 </itemizedlist></para>
12883 <section id="AdvancedSearchTypes">
12884 <title>AdvancedSearchTypes</title>
12886 <para>Default: itemtype</para>
12888 <para>Asks: Show tabs in OPAC and staff-side advanced search for
12889 limiting searches on the ___ fields (separate values with
12892 <para>Description:</para>
12896 <para>On the advanced search page you can choose to allow
12897 filters on one or all of the following: Item types
12898 (itemtypes), Collection Codes (ccode) and Shelving Location
12899 (loc). If you would like to be able to limit searches on item
12900 type and shelving location for example you would enter
12901 itemtypes|loc in the preference input box. The order of these
12902 fields will determine the order of the tabs in the OPAC and
12903 staff client advanced search screens. Values within the search
12904 type are OR'ed together, while each different search type is
12905 AND'ed together in the query limits. The current stored values
12906 are supported without any required modification.Each set of
12907 advanced search fields are displayed in tabs in both the OPAC
12908 and staff client. The first value in the AdvancedSearchTypes
12909 syspref is the selected tab; if no values are present,
12910 "itemtypes" is used. For non-itemtype values, the value in
12911 AdvancedSearchTypes must match the Authorised Value name, and
12912 must be indexed with 'mc-' prefixing that name.</para>
12915 <screeninfo>Searching by Item Type and Shelving
12916 Location</screeninfo>
12920 <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
12928 <section id="expandedSearchOption">
12929 <title>expandedSearchOption</title>
12931 <para>Default: don't show</para>
12933 <para>Asks: By default, ___ "More options" on the OPAC and staff
12934 advanced search pages.</para>
12936 <para>Values:</para>
12940 <para>don't show</para>
12948 <section id="IntranetNumbersPreferPhrase">
12949 <title>IntranetNumbersPreferPhrase</title>
12950 <para>Default: don't use</para>
12951 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
12952 staff client searches </para>
12953 <para>Values:<itemizedlist>
12955 <para>don't use</para>
12960 </itemizedlist></para>
12961 <para>Description:<itemizedlist>
12963 <para>When searching by call number and standard number (biblionumber) in Koha
12964 Staff Client you can choose to force the search to be a phrase search by setting
12965 this preference to 'use.' This will allow for more accurate results over doing a
12966 general keyword field search.</para>
12968 </itemizedlist></para>
12970 <section id="OPACNumbersPreferPhrase">
12971 <title>OPACNumbersPreferPhrase</title>
12972 <para>Default: don't use</para>
12973 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
12974 OPAC searches </para>
12975 <para>Values:<itemizedlist>
12977 <para>don't use</para>
12982 </itemizedlist></para>
12983 <para>Description:<itemizedlist>
12985 <para>When searching by call number and standard number (biblionumber) in the Koha
12986 OPAC you can choose to force the search to be a phrase search by setting this
12987 preference to 'use.' This will allow for more accurate results over doing a
12988 general keyword field search.</para>
12990 </itemizedlist></para>
12995 <section id="serialsprefs">
12996 <title>Serials</title>
12998 <para><emphasis>Get there:</emphasis> More > Administration >
12999 Global System Preferences > Serials</para>
13001 <section id="opacSerialDefaultTab">
13002 <title>opacSerialDefaultTab</title>
13004 <para>Default: Subscriptions tab</para>
13006 <para>Asks: Show ___ as default tab for serials in OPAC. </para>
13008 <para>Values:</para>
13012 <para>Holdings tab</para>
13016 <para>Serial Collection tab</para>
13018 <para>Please note that the Serial Collection tab is currently available only for
13019 systems using the UNIMARC standard.</para>
13022 <screeninfo>Serial Collection tab</screeninfo>
13025 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-colltab.png"/>
13032 <para>Subscriptions tab</para>
13034 <screeninfo>Subscritions tab</screeninfo>
13037 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-subtab.png"
13046 <section id="OPACSerialIssueDisplayCount">
13047 <title>OPACSerialIssueDisplayCount</title>
13049 <para>Default: 3</para>
13051 <para>Asks: Show the ___ previous issues of a serial on the
13054 <para>Description:</para>
13058 <para>This preference allows the administrator to select the
13059 number of recent issues for each serial which appear in the OPAC
13060 when the serial is accessed. This is just the default value,
13061 patrons can always click to see a full list of serials.</para>
13066 <section id="RenewSerialAddsSuggestion">
13067 <title>RenewSerialAddsSuggestion</title>
13069 <para>Default: Don't add</para>
13071 <para>Asks: ___ a suggestion for a biblio when its attached serial
13074 <para>Values:</para>
13082 <para>Don't add</para>
13086 <para>Description:</para>
13090 <para>If set to "Add", this preference will automatically add a
13091 serial to the Acquisitions Purchase Suggestions menu when
13092 clicking the 'renew' option. If you don't use the Acquisitions
13093 module to manage serials purchases it's best to leave this set
13094 as 'Don't add.'</para>
13099 <section id="RoutingListAddReserves">
13100 <title>RoutingListAddReserves</title>
13102 <para>Default: Place</para>
13104 <para>Asks: ___ received serials on hold if they are on a routing
13107 <para>Values:</para>
13115 <para>Don't place</para>
13120 <section id="RoutingListNote">
13121 <title>RoutingListNote</title>
13123 <para>Asks: Include following note on all routing lists</para>
13125 <para>Description:</para>
13129 <para>Text entered in this box will appear below the routing
13130 list information.</para>
13135 <section id="RoutingSerials">
13136 <title>RoutingSerials</title>
13138 <para>Default: Don't add</para>
13140 <para>Asks: ___ received serials to the routing list.</para>
13142 <para>Description:</para>
13146 <para>This preference determines if serials routing lists are
13147 enabled or disabled for the library. When set to "Add", serials
13148 routing is enabled and a serial can be directed through a list
13149 of people by identifying who should receive it next. The list of
13150 people can be established for each serial to be passed using the
13151 Serials module. This preference can be used to ensure each
13152 person who needs to see a serial when it arrives at the library
13153 will get it. Learn more in the <link linkend="routinglist">routing list</link> section of this
13158 <para>Values:</para>
13166 <para>Don't add</para>
13171 <section id="StaffSerialIssueDisplayCount">
13172 <title>StaffSerialIssueDisplayCount</title>
13174 <para>Default: 3</para>
13176 <para>Asks: Show the ___ previous issues of a serial on the staff
13179 <para>Description:</para>
13183 <para>This preference allows the administrator to select the
13184 number of recent issues for each serial which appear in the
13185 Staff Client when the serial is accessed. This is just the
13186 default value, staff members can always click to see a full list
13192 <section id="SubscriptionDuplicateDroppedInput">
13193 <title>SubscriptionDuplicateDroppedInput</title>
13195 <para>Asks: List of fields which must not be rewritten when a
13196 subscription is duplicated (Separated by pipe |) ___</para>
13198 <para>Description:</para>
13202 <para>When duplicating a subscription sometimes you don't want
13203 all of the fields duplicated, using this preference you can list
13204 the fields that you don't want to be duplicated. These field
13205 names come from the subscription table in the Koha database.
13206 Learn what fields are in that table on the <ulink url="http://schema.koha-community.org/tables/subscription.html">Koha
13207 DB Schema</ulink> site.</para>
13212 <section id="SubscriptionHistory">
13213 <title>SubscriptionHistory</title>
13215 <para>Default: full history</para>
13217 <para>Asks: When showing the subscription information for a
13218 bibliographic record, preselect ___ view of serial issues.</para>
13220 <para>Values:</para>
13224 <para>brief history</para>
13227 <screeninfo>Brief History</screeninfo>
13231 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
13238 <para>full history</para>
13241 <screeninfo>Full History</screeninfo>
13245 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
13252 <para>Description:</para>
13256 <para>This preference determines what information appears in the
13257 OPAC when the user clicks the More Details option. The 'brief'
13258 option displays a one-line summary of the volume and issue
13259 numbers of all issues of that serial held by the library. The
13260 'full' option displays a more detailed breakdown of issues per
13261 year, including information such as the issue date and the
13262 status of each issue.</para>
13268 <section id="staffprefs">
13269 <title>Staff Client</title>
13271 <para><emphasis>Get there:</emphasis> More > Administration >
13272 Global System Preferences > Staff Client</para>
13274 <section id="staffappearprefs">
13275 <title>Appearance</title>
13279 <section id="Display856uAsImage">
13280 <title>Display856uAsImage</title>
13282 <para>Default: Neither details or results page</para>
13284 <para>Asks: Display the URI in the 856u field as an image on:
13287 <para>Values:</para>
13291 <para>Both results and details pages</para>
13296 <para>Not implemented yet</para>
13303 <para>Detail page only</para>
13308 <para><link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
13309 needs to be on for this preference to work.</para>
13315 <screeninfo>Showing the 856u as an image</screeninfo>
13319 <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
13326 <para>Neither details or results page</para>
13330 <para>Results page only</para>
13335 <para>Not yet implemented</para>
13342 <para>Description:</para>
13346 <para>In addition to this option being set, the corresponding
13347 XSLT option must be turned on. Also, the corresponding 856q
13348 field must have a valid MIME image extension (e.g., "jpg") or
13349 MIME image type (i.e. starting with "image/"), or the generic
13350 indicator "img" entered in the field. When all of the
13351 requirements are met, an image file will be displayed instead
13352 of the standard link text. Clicking on the image will open it
13353 in the same way as clicking on the link text. When you click
13354 on the image it should open to full size, in the current
13355 window or in a new window depending on the value in the system
13356 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
13359 <screeninfo>Sample 856 Field</screeninfo>
13363 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
13370 <section id="DisplayIconsXSLT">
13371 <title>DisplayIconsXSLT</title>
13372 <para>Default: Show</para>
13373 <para>Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and
13374 detail pages in the staff client.<important>
13375 <para><link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link> and/or <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link> must be set to use an
13376 XSLT stylesheet (default or custom) for these icons to show.</para>
13377 </important></para>
13378 <para>Values:</para>
13381 <para>Don't show</para>
13386 <screeninfo>DisplayIconsXSLT</screeninfo>
13389 <imagedata fileref="images/admin/globalprefs/DisplayIconsXSLT.png"/>
13397 <para>See the <link linkend="XSLTiTypes">XSLT Icon Guide</link> for more information
13398 on these icons.</para>
13403 <section id="intranet_includes">
13404 <title>intranet_includes</title>
13406 <para>Default: includes</para>
13408 <para>Asks: Use include files from the ___ directory in the
13409 template directory, instead of includes/. (Leave blank to
13413 <section id="intranetcolorstylesheet">
13414 <title>intranetcolorstylesheet</title>
13416 <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
13417 from the default stylesheet</para>
13419 <para>Description:</para>
13423 <para>This preference is used to set the background color and style of the Staff
13424 Client. The value is a .css file. The system administrator should determine which
13425 file is appropriate. Enter just a filename, a full local path or a complete URL
13426 starting with http:// (if the file lives on a remote server). Please note that if
13427 you just enter a filename, the file should be in the css subdirectory for each
13428 active theme and language within the Koha templates directory. A full local path
13429 is expected to start from your HTTP document root. </para>
13434 <para>Leave this field blank to disable.</para>
13438 <section id="IntranetFavicon">
13439 <title>IntranetFavicon</title>
13441 <para>Asks: Use the image at ___ for the Staff Client's favicon.
13443 <para>This should be a complete URL, starting with
13445 </important></para>
13448 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
13451 <para>Description:</para>
13455 <para>The favicon is the little icon that appears next to the
13456 URL in the address bar in most browsers. The default value for
13457 this field (if left blank) is the small 'K' in the Koha
13461 <screeninfo>Default Koha Favicon</screeninfo>
13465 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
13473 <section id="IntranetmainUserblock">
13474 <title>IntranetmainUserblock</title>
13476 <para>Asks: Show the following HTML in its own column on the main
13477 page of the staff client</para>
13480 <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
13484 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
13490 <screeninfo>Message from IntranetmainUserblock as it appears on
13491 the Staff Client main page</screeninfo>
13495 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
13501 <section id="IntranetNav">
13502 <title>IntranetNav</title>
13504 <para>Asks: Show the following HTML in the More menu at the top of
13505 each page on the staff client (should be a list of links or
13509 <section id="IntranetSlipPrinterJS">
13510 <title>IntranetSlipPrinterJS</title>
13512 <para>Asks: Use the following JavaScript for printing
13515 <para>Description:</para>
13519 <para>The most logical use of this preference is in
13520 conjunction with the <ulink url="http://jsprintsetup.mozdev.org/">jsPrintSetup</ulink>
13521 Firefox add-on. Learn more about this preference and the
13522 add-on setup on the Koha wiki at <ulink url="http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently">http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently</ulink>.</para>
13527 <section id="intranetstylesheet">
13528 <title>intranetstylesheet</title>
13530 <para>Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of
13531 the default css (used when leaving this field blank). </para>
13533 <para>Description:</para>
13537 <para>The Intranetstylesheet preference is a layout and design feature for the
13538 intranet or staff client. This preference allows a library to customize the
13539 appearance of the Staff Client. Enter just a filename, a full local path or a
13540 complete URL starting with http:// (if the file lives on a remote server). Please
13541 note that if you just enter a filename, the file should be in the css subdirectory
13542 for each active theme and language within the Koha templates directory. A full
13543 local path is expected to start from your HTTP document root. </para>
13548 <section id="IntranetUserCSS">
13549 <title>IntranetUserCSS</title>
13551 <para>Asks: Include the following CSS on all pages in the staff
13555 <section id="intranetuserjs">
13556 <title>intranetuserjs</title>
13558 <para>Asks: Include the following JavaScript on all pages in the
13559 staff interface</para>
13561 <para>Description:</para>
13565 <para>This preference allows the administrator to enter
13566 JavaScript or JQuery that will be embedded across all pages of
13567 the Staff Client. Administrators may use this preference to
13568 customize some of the interactive sections of Koha,
13569 customizing the text for the login prompts, for example.
13570 Sample JQuery scripts used by Koha libraries can be found on
13571 the wiki: <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
13576 <section id="SlipCSS">
13577 <title>SlipCSS</title>
13579 <para>Asks: Include the stylesheet at ___ on Issue and Reserve
13581 <para>This should be a complete URL, starting with
13583 </important></para>
13585 <para>Description:</para>
13589 <para>If you would like to style your receipts or slips with a
13590 consistent set of fonts and colors you can use this preference
13591 to point Koha to a stylesheet specifically for your
13597 <section id="StaffAuthorisedValueImages">
13598 <title>StaffAuthorisedValueImages</title>
13600 <para>Default: Show</para>
13602 <para>Asks: ___ images for authorized values (such as lost
13603 statuses and locations) in search results.</para>
13605 <para>Values:</para>
13609 <para>Don't show</para>
13618 <section id="staffClientBaseURL">
13619 <title>staffClientBaseURL</title>
13621 <para>Asks: The staff client is located at http:// ___</para>
13624 <section id="template">
13625 <title>template</title>
13627 <para>Default: prog</para>
13629 <para>Asks: Use the ___ theme on the staff interface.</para>
13631 <para>Values:</para>
13639 <para>Do not include a trailing slash in the URL this will break links created using
13640 this URL. (example: www.google.com not www.google.com/)</para>
13644 <section id="XSLTDetailsDisplay">
13645 <title>XSLTDetailsDisplay</title>
13647 <para>Default: default</para>
13649 <para>Asks: Display details in the staff client using XSLT
13650 stylesheet at ___</para>
13652 <para>Values:</para>
13656 <para>leave empty to not use the XSLT stylesheet</para>
13660 <para>In previous versions of Koha this was the setting
13661 that read 'normally'</para>
13664 <screeninfo>Detail display without XSLT
13665 stylesheets</screeninfo>
13669 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
13678 <para>enter "default" for the default one</para>
13681 <screeninfo>Detail display using XSLT
13682 stylesheets</screeninfo>
13686 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
13693 <para>put a path to define a XSLT file</para>
13697 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
13701 <para>If in a multi-language system you can enter
13702 {langcode} in the path to tell Koha to look in the right
13703 language folder</para>
13708 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
13713 http://mykoha.org/{langcode}/stylesheet.xsl</para>
13721 <para>put an URL for an external specific stylesheet</para>
13725 <para>ex: http://mykoha.org/stylesheet.xsl</para>
13731 <para>Description:</para>
13735 <para>XSLT stylesheets allow for the customization of the
13736 details shows on the screen when viewing a bib record. This
13737 preference will allow you either use the default look that
13738 comes with Koha or design your own stylesheet.</para>
13743 <section id="XSLTResultsDisplay">
13744 <title>XSLTResultsDisplay</title>
13746 <para>Default: default</para>
13748 <para>Asks: Display results in the staff client using XSLT
13749 stylesheet at ___</para>
13751 <para>Values:</para>
13755 <para>leave empty to not use the XSLT stylesheet</para>
13759 <para>In previous versions of Koha this was the setting
13760 that read 'normally'</para>
13766 <para>enter "default" for the default one</para>
13770 <para>put a path to define a XSLT file</para>
13774 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
13778 <para>If in a multi-language system you can enter
13779 {langcode} in the path to tell Koha to look in the right
13780 language folder</para>
13785 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
13790 http://mykoha.org/{langcode}/stylesheet.xsl</para>
13798 <para>put an URL for an external specific stylesheet</para>
13802 <para>ex: http://mykoha.org/stylesheet.xsl</para>
13808 <para>Description:</para>
13812 <para>XSLT stylesheets allow for the customization of the
13813 details shows on the screen when viewing the search results.
13814 This preference will allow you either use the default look
13815 that comes with Koha or design your own stylesheet.</para>
13820 <section id="yuipath">
13821 <title>yuipath</title>
13823 <para>Default: included with Koha</para>
13825 <para>Asks: Use the Yahoo UI libraries ___</para>
13827 <para>Values:</para>
13831 <para>from Yahoo's servers</para>
13835 <para>With this option there is less demand on your
13836 servers, but if the Internet goes down there will be
13843 <para>included with Koha</para>
13847 <para>With this option calls are made faster, and they
13848 will still work if the Internet goes down</para>
13854 <para>Description:</para>
13858 <para>The yuipath preference allows for the user to define a
13859 local path or web URL to the Yahoo User Interface Library
13860 (<ulink url="http://developer.yahoo.com/yui/2/">http://developer.yahoo.com/yui/2/</ulink>).
13861 This library is a resource of developer tools including
13862 JavaScript and style sheets.</para>
13868 <section id="staffoptsprefs">
13869 <title>Options</title>
13871 <section id="HidePatronName">
13872 <title>HidePatronName</title>
13874 <para>Default: Show</para>
13876 <para>Asks: ___ the names of patrons that have items checked out
13877 or on hold on detail pages or the "Place Hold" screen.</para>
13879 <para>Values:</para>
13883 <para>Don't show</para>
13892 <section id="intranetbookbag">
13893 <title>intranetbookbag</title>
13895 <para>Default: Show</para>
13897 <para>Asks: ___ the cart option in the staff client.</para>
13899 <para>Values:</para>
13903 <para>Don't show</para>
13911 <section id="StaffDetailItemSelection ">
13912 <title>StaffDetailItemSelection</title>
13913 <para>Default: Enable</para>
13914 <para>Asks: ___ item selection in record detail page. </para>
13915 <para>Values:<itemizedlist>
13917 <para>Disable</para>
13920 <para>Enable</para>
13922 </itemizedlist></para>
13923 <para>Description:<itemizedlist>
13925 <para>This preference lets you choose to show (or not show) checkboxes to the left
13926 of every item in the holdings tab on the detail display of a record in the staff
13927 client. Showing these checkboxes allows the staff members to select multiple
13928 items to edit or delete at once.</para>
13930 <screeninfo>Items with the checkboxes enabled</screeninfo>
13933 <imagedata fileref="images/admin/globalprefs/StaffDetailItemSelection.png"
13939 </itemizedlist></para>
13942 <section id="viewISBD">
13943 <title>viewISBD</title>
13945 <para>Default: Allow</para>
13947 <para>Asks: ___ staff to view records in ISBD form on the staff
13950 <para>Values:</para>
13958 <para>Don't allow</para>
13963 <section id="viewLabeledMARC">
13964 <title>viewLabeledMARC</title>
13966 <para>Default: Allow</para>
13968 <para>Asks: ___ staff to view records in labeled MARC form on the
13969 staff client.</para>
13971 <para>Values:</para>
13979 <para>Don't allow</para>
13984 <section id="viewMARC">
13985 <title>viewMARC</title>
13987 <para>Default: Allow</para>
13989 <para>Asks: ___ staff to view records in plain MARC form on the
13990 staff client.</para>
13992 <para>Values:</para>
14000 <para>Don't allow</para>
14006 <section id="toolsprefs">
14007 <title>Tools</title>
14008 <section id="MaxItemsForBatch">
14009 <title>MaxItemsForBatch</title>
14010 <para>Default: 1000</para>
14011 <para>Asks: Process up to ___ items in a single modification or deletion batch. </para>
14012 <para>Description:<itemizedlist>
14014 <para>In the <link linkend="batchdeleteitems">batch item delete tool</link> this
14015 will prevent the display of more than the items you entered in this preference,
14016 but you will be able to delete more than the number you enter here. In the <link
14017 linkend="batchmodifyitems">batch item modification tool</link> this preference
14018 will prevent the editing of more than the number entered here.</para>
14020 </itemizedlist></para>
14024 <section id="webserviceprefs">
14025 <title>Web Services</title>
14027 <para><emphasis>Get there:</emphasis> More > Administration >
14028 Global System Preferences > Web Services</para>
14030 <section id="ilsdiprefs">
14031 <title>ILS-DI</title>
14035 <section id="ILS-DI">
14036 <title>ILS-DI</title>
14038 <para>Default: Disable</para>
14040 <para>Asks: ___ ILS-DI services for OPAC users</para>
14042 <para>Values:</para>
14046 <para>Disable</para>
14050 <para>Enable</para>
14055 <section id="ILS-DIAuthorized_IPs">
14056 <title>ILS-DI:AuthorizedIPs</title>
14058 <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
14062 <section id="oaiprefs">
14063 <title>OAI-PMH</title>
14065 <section id="OAI-PMH">
14066 <title>OAI-PMH</title>
14068 <para>Default: Disable</para>
14070 <para>Asks: ___ Koha's OAI-PMH server.</para>
14072 <para>Values:</para>
14076 <para>Disable</para>
14080 <para>Enable</para>
14084 <para>Description:</para>
14088 <para>For the Open Archives Initiative-Protocol for Metadata
14089 Harvesting (OAI-PMH) there are two groups of 'participants':
14090 Data Providers and Service Providers. Data Providers (open
14091 archives, repositories) provide free access to metadata, and
14092 may, but do not necessarily, offer free access to full texts
14093 or other resources. OAI-PMH provides an easy to implement, low
14094 barrier solution for Data Providers. Service Providers use the
14095 OAI interfaces of the Data Providers to harvest and store
14096 metadata. Note that this means that there are no live search
14097 requests to the Data Providers; rather, services are based on
14098 the harvested data via OAI-PMH. Koha at present can only act
14099 as a Data Provider. It can not harvest from other
14100 repositories. The biggest stumbling block to having Koha
14101 harvest from other repositories is that MARC is the only
14102 metadata format that Koha indexes natively. Visit <ulink url="http://www.oaforum.org/tutorial/english/page3.htm">http://www.oaforum.org/tutorial/english/page3.htm</ulink>
14103 for diagrams of how OAI-PMH works.</para>
14107 <para>Learn more about OAI-PMH at: <ulink url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
14110 <section id="OAI-PMHarchiveID">
14111 <title>OAI-PMH:archiveID</title>
14113 <para>Default: KOHA-OAI-TEST</para>
14115 <para>Asks: Identify records at this site with the prefix ___
14119 <section id="OAI-PMHAutoUpdateSets">
14120 <title>OAI-PMH:AutoUpdateSets</title>
14122 <para>Default: Disable</para>
14124 <para>Asks: ___ automatic update of OAI-PMH sets when a
14125 bibliographic record is created or updated.</para>
14127 <para>Values:</para>
14131 <para>Disable</para>
14135 <para>Enable</para>
14140 <section id="OAI-PMHConfFile">
14141 <title>OAI-PMH:ConfFile</title>
14143 <para>If this preference is left empty, Koha's OAI Server operates
14144 in normal mode, otherwise it operates in extended mode. In
14145 extended mode, it's possible to parameter other formats than
14146 marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
14147 configuration file which list available metadata formats and XSL
14148 file used to create them from marcxml records.</para>
14150 <para>For more information, see the <link linkend="oaiconfsample">sample conf file</link> in the
14154 <section id="OAI-PMHMaxCount">
14155 <title>OAI-PMH:MaxCount</title>
14157 <para>Default: 50</para>
14159 <para>Asks: Only return ___ records at a time in response to a
14160 ListRecords or ListIdentifiers query.</para>
14162 <para>Description:</para>
14166 <para>This is the maximum number of records that would be
14167 returned based on ListRecord or ListIdentifier queries from
14168 harvesters. ListRecords harvest the entire records while the
14169 ListIdentifier is an abbreviated form of ListRecords,
14170 retrieving only headers rather than records.</para>
14175 <section id="reportingservice">
14176 <title>Reporting</title>
14177 <section id="SvcMaxReportRows">
14178 <title>SvcMaxReportRows</title>
14179 <para>Default: 10</para>
14180 <para>Asks: Only return ___ rows of a report requested via the reports web
14182 <para>Description:<itemizedlist>
14184 <para>This value will be used to limit the number of results returned by <link linkend="publicreport">public reports</link>.</para>
14186 </itemizedlist></para>
14192 <section id="basicparams">
14193 <title>Basic Parameters</title>
14195 <para><emphasis>Get there:</emphasis> More > Administration</para>
14198 <para>Configure all 'parameters' in the order they appear.</para>
14201 <section id="libsgroups">
14202 <title>Libraries & Groups</title>
14204 <para>When setting up your Koha system you will want to add
14205 information for every library that will be sharing your system. This
14206 data is used in several areas of Koha.</para>
14210 <para><emphasis>Get there:</emphasis> More > Administration
14211 > Basic Parameters > Libraries and Groups</para>
14215 <para>When visiting this page you are presented with a list of the
14216 libraries and groups that have already been added to the
14220 <screeninfo>Library List</screeninfo>
14224 <imagedata fileref="images/admin/basicparams/librarylist.png"/>
14230 <screeninfo>Group Lists</screeninfo>
14234 <imagedata fileref="images/admin/basicparams/grouplists.png"/>
14239 <section id="addingalibrary">
14240 <title>Adding a Library</title>
14242 <para>To add a new library:</para>
14246 <para>Click 'New Library'</para>
14250 <para>The top of the form asks for some basics about the
14254 <screeninfo>Basic Library Info</screeninfo>
14258 <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
14265 <para>The library code should not contain any spaces and be
14266 10 or fewer characters. This code will be used as a unique
14267 identifier in the database.</para>
14271 <para>The name will be displayed on the OPAC wherever the
14272 library name displays to the public and should be a name
14273 that makes sense to your patrons.</para>
14277 <para>If you have <link linkend="addinglibgroup">groups</link> set up you can choose
14278 what group this library belongs to after entering in the
14279 code and name</para>
14285 <para>Next you can enter basic contact info about the
14289 <screeninfo>Library Contact Info</screeninfo>
14293 <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
14300 <para>The address and contact fields can be used to make
14301 notices custom for each library</para>
14305 <para>The email address field is not required, but it should
14306 be filled for every library in your system</para>
14311 <para>Be sure to enter a library email address to make
14312 sure that notices are sent to and from the right
14320 <para>If the URL field is populated then the library name
14321 will be linked in the holdings table on the OPAC</para>
14324 <screeninfo>Linked Library Name</screeninfo>
14328 <imagedata fileref="images/admin/basicparams/librarylink.png"/>
14335 <para>The OPAC Info box is for you to put information about
14336 the library that will appear in the OPAC when the branch
14337 name is moused over in the holdings table</para>
14340 <screeninfo>OPAC Info</screeninfo>
14344 <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
14351 <para>IP Address does not have be filled in unless you plan
14352 on limiting access to your staff client to a specific IP
14358 <para>An IP address is required if you have enabled
14359 <link linkend="AutoLocation">AutoLocation</link></para>
14366 <para>Finally, if you have any notes you can put them here.
14367 These will not show in the OPAC</para>
14374 <para>Of the fields listed, only 'Library code' and 'Name' are
14381 <section id="editingalibrary">
14382 <title>Editing/Deleting a Library</title>
14384 <para>You will be unable to delete any library that has patrons or
14385 items attached to it.</para>
14388 <screeninfo>Staff will be presented with a warning when trying to
14389 delete a library that is being used</screeninfo>
14393 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
14398 <para>Each library will have an 'Edit' link to the right of it.
14399 Click this link to edit/alter details associated with the library in
14403 <para>You will be unable to edit the 'Library code'</para>
14407 <section id="addinglibgroup">
14408 <title>Adding a group</title>
14410 <para>To add a Search Domain or Library Property Group click the
14411 'New Group' button at the top of the screen</para>
14414 <screeninfo>Add group form</screeninfo>
14418 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
14422 <para>Give the group a 'Category type; of 'searchdomain' and if you would like the group
14423 to show up in the library pull down at the top of the OPAC (with <link
14424 linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link> set to
14425 'Add') and on the advanced search page you can check the 'Show in search pulldown'
14428 <para>Of the fields on the group form, 'Category code', 'Name', and 'Category type' are
14429 the only required fields</para>
14431 <section id="searchdomaingroups">
14432 <title>Search Domain Groups</title>
14434 <para>Search Domain Groups allow you to search a group of
14435 libraries at the same time instead of searching just one library
14436 or all libraries.</para>
14439 <screeninfo>Search Domain Groups</screeninfo>
14443 <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
14448 <para>To see Search Domain Groups in action visit the staff client
14449 advanced search page in your Koha system:</para>
14452 <screeninfo>Library group search on staff client</screeninfo>
14456 <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
14462 <section id="libpropertygroups">
14463 <title>Library Property Groups</title>
14465 <para>You can assign specific categories to your libraries by
14466 adding groups for them</para>
14469 <screeninfo>Library Property Groups</screeninfo>
14473 <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
14478 <para>Properties are then applied to libraries via the add or edit
14479 library form</para>
14482 <screeninfo>Groups on the Add/Modify library form</screeninfo>
14486 <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
14494 <section id="itemtypeadmin">
14495 <title>Item Types</title>
14497 <para>Koha allows you to organize your collection by item types and
14498 collection codes.</para>
14502 <para><emphasis>Get there:</emphasis> More > Administration
14503 > Basic Parameters > Item Types</para>
14507 <para>Item types typically refer to the material type (book, cd, dvd,
14508 etc), but can be used in any way that works for your library.</para>
14511 <screeninfo>Item Types</screeninfo>
14515 <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
14520 <section id="additemtype">
14521 <title>Adding Item Types</title>
14523 <para>To add a new item type, simply click the 'New Item Type'
14524 button at the top of the Item Types page.</para>
14527 <screeninfo>New Item Type</screeninfo>
14531 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
14538 <para>In the 'Item Type' field, enter a short code for your item
14543 <para>The description is the plain text definition of the item
14548 <para>You can choose to have an image associated with your item
14553 <para>You can choose from a series of image
14558 <para>You can link to a remote image</para>
14562 <para>Or you can just have no image associated with the item
14568 <para>To have your item type images appear in the OPAC you
14569 need to set noItemTypeImages to 'Show'</para>
14574 <para><emphasis>Get there: </emphasis>More >
14575 Administration > Global System Preferences > <link linkend="adminprefs">Admin</link></para>
14583 <para>For items that do not circulate, check the 'Not for loan'
14588 <para>Items marked 'Not for loan' will appear in the
14589 catalog, but cannot be checked out to patrons</para>
14595 <para id="rentalcharge">For items that you charge a rental fee
14596 for, enter the total fee you charge in the 'Rental charge'
14602 <para>Do not enter symbols in this field, only numbers and
14603 decimal points (ex. $5.00 should be entered as 5 or
14609 <para>This will charge the patron on checkout</para>
14615 <para>If you would like a message or alert to appear when items of this type are
14616 checked in you can enter that in the 'Checkin message' box</para>
14618 <screeninfo>Checkin message setup</screeninfo>
14621 <imagedata fileref="images/admin/basicparams/itemtype-msgsetup.png"/>
14628 <para>The Checkin message type can be a Message or an Alert. The only
14629 difference between these two is the styling. By default a Message is blue </para>
14631 <screeninfo>Checkin Message</screeninfo>
14634 <imagedata fileref="images/admin/basicparams/itemtype-msg.png"/>
14638 <para>and an Alert is yellow.</para>
14640 <screeninfo>Checkin Alert</screeninfo>
14643 <imagedata fileref="images/admin/basicparams/itemtype-alert.png"/>
14652 <para>Some SIP devices need you to use a SIP-specific media type instead of Koha's
14653 item type (usually lockers and sorters need this media type), if you use a device
14654 like this you'll want to enter the SIP media type.</para>
14657 <para>When finished, click 'Save Changes'</para>
14661 <para>All fields, with the exception of the 'Item Type' will be editable from
14662 the Item Types list</para>
14669 <para>Your new item type will now appear on the list</para>
14672 <screeninfo>New DVD Item Type</screeninfo>
14676 <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
14684 <section id="edititemtype">
14685 <title>Editing Item Types</title>
14687 <para>Each item type has an Edit button beside it. To edit an item
14688 simply click the 'Edit' link.</para>
14691 <para>You will not be able to edit the code you assigned as the
14692 'Item Type' but you will be able to edit the description for the
14697 <section id="deleteitemtype">
14698 <title>Deleting Item Types</title>
14700 <para>Each item has a Delete button beside it. To delete an item,
14701 simply click the 'Delete' link.</para>
14704 <para>You will not be able to delete item types that are being
14705 used by items within your system.</para>
14709 <screeninfo>Warning when you try to delete an item that is in
14714 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
14721 <section id="authorizedvalues">
14722 <title>Authorized Values</title>
14724 <para>Authorized values can be used in several areas of Koha. One
14725 reason you would add an authorized value category would be to control
14726 the values that can be entered into MARC fields by catalogers.</para>
14730 <para><emphasis>Get there:</emphasis> More > Administration
14731 > Basic Parameters > Authorized Values</para>
14735 <section id="existingauthvalues">
14736 <title>Existing Values</title>
14738 <para>Koha installs with pre-defined values that your library is
14739 likely to use, for instance 'Lost'.</para>
14742 <listitem id="asort1">
14743 <para>Asort1</para>
14746 <para>Used for acquisitions statistical purposes</para>
14751 <listitem id="asort2">
14752 <para>Asort2</para>
14755 <para>Used for acquisitions statistical purposes</para>
14760 <listitem id="bornotes">
14761 <para>BOR_NOTES</para>
14764 <para>Values for custom patron messages that appear on the circulation screen and
14765 the OPAC. The value in the Description field should be the message text and is
14766 limited to 200 characters.</para>
14768 <screeninfo>Borrower messages</screeninfo>
14771 <imagedata fileref="images/admin/basicparams/bor_notes.png"/>
14779 <listitem id="bsort1">
14780 <para>Bsort1</para>
14783 <para>Values that can be entered to fill in the patron's sort 1 field</para>
14788 <listitem id="bsort2">
14789 <para>Bsort2</para>
14792 <para>Values that can be entered to fill in the patron's sort 2 field</para>
14797 <listitem id="cartauth">
14801 <para>Is the shelving cart location, used by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> and
14802 <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
14807 <listitem id="ccode">
14811 <para>Collection codes (appears when cataloging and working with items)</para>
14816 <listitem id="damageauth">
14817 <para>DAMAGED</para>
14820 <para>Descriptions for items marked as damaged (appears when cataloging and
14821 working with items)</para>
14826 <listitem id="hingsas">
14827 <para>DEPARTMENT<itemizedlist>
14829 <para>Departments are required by and will be used in the <link
14830 linkend="coursereserves">Course Reserves</link> module</para>
14832 </itemizedlist></para>
14835 <para>HINGS_AS</para>
14838 <para>General Holdings: Acquisition Status Designator :: This data element
14839 specifies acquisition status for the unit at the time of the holdings
14845 <listitem id="hingsc">
14846 <para>HINGS_C</para>
14849 <para>General Holdings: Completeness Designator</para>
14854 <listitem id="hingspf">
14855 <para>HINGS_PF</para>
14858 <para>Physical Form Designators</para>
14863 <listitem id="hingsrd">
14864 <para>HINGS_RD</para>
14867 <para>General Holdings: Retention Designator :: This data element specifies the
14868 retention policy for the unit at the time of the holdings report.</para>
14873 <listitem id="hingsut">
14874 <para>HINGS_UT</para>
14877 <para>General Holdings: Type of Unit Designator</para>
14882 <listitem id="shelvelocvals">
14886 <para>Shelving location (usually appears when adding or editing an item)</para>
14891 <listitem id="lost">
14895 <para>Descriptions for the items marked as lost (appears when adding or editing an
14900 <para>Values given to lost statuses should be numeric and not alphabetical in
14901 order for statuses to appear properly</para>
14907 <listitem id="manualinvvals">
14908 <para>MANUAL_INV</para>
14911 <para>Values for manual invoicing types</para>
14916 <para>The value set as the Authorized Value for the MANUAL_INV authorized
14917 value category will appear as the Description and the Authorized Value
14918 Description will be used as the amount. Enter monetary amounts in the
14919 description without currency symbols.</para>
14926 <listitem id="notforloan">
14927 <para>NOT_LOAN</para>
14930 <para>Reasons why a title is not for loan</para>
14934 <para>Values given to lost statuses should be numeric and not alphabetical in
14935 order for statuses to appear properly</para>
14940 <para>Negative number values will still allow holds (use for on order statuses
14941 for example) where as positive numbers will not allow holds or
14948 <listitem id="procauth">
14952 <para>The location to be used for <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> (change description as desired), also the
14953 location expected by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>.</para>
14958 <listitem id="reportgroup">
14959 <para>REPORT_GROUP</para>
14962 <para>A way to sort and filter your reports, the default values in this category
14963 include the Koha modules (Accounts, Acquitisions, Catalog, Circulation,
14966 <screeninfo>Report Groups</screeninfo>
14969 <imagedata fileref="images/admin/basicparams/report_group.png"/>
14977 <listitem id="reportsubgroup">
14978 <para>REPORT_SUBGROUP</para>
14981 <para>Can be used to further sort and filter your reports. This category is empty
14982 by default. Values here need to include the authorized value code from
14983 REPORT_GROUP in the Description (OPAC) field to link the subgroup to the
14984 appropriate group.</para>
14986 <screeninfo>Report Subgroups</screeninfo>
14989 <imagedata fileref="images/admin/basicparams/report_subgroup.png"/>
14997 <listitem id="restricted">
14998 <para>RESTRICTED</para>
15001 <para>Restricted status of an item</para>
15006 <listitem id="suggestauthorized">
15007 <para>ROADTYPE<itemizedlist>
15009 <para>Road types to be used in patron addresses</para>
15011 </itemizedlist></para>
15014 <para>SIP_MEDIA_TYPE<itemizedlist>
15016 <para>Used when <link linkend="additemtype">creating</link> or <link
15017 linkend="edititemtype">editing</link> an item type to assign a SIP specific
15018 media type for devices like lockers and sorters.</para>
15020 </itemizedlist></para>
15023 <para>SUGGEST</para>
15026 <para>List of patron suggestion reject or accept reasons (appears when managing
15027 suggestions)</para>
15032 <listitem id="withdrawnauth">
15033 <para>WITHDRAWN</para>
15036 <para>Description of a withdrawn item (appears when adding or editing an
15042 <listitem id="yesnoauth">
15043 <para>YES_NO</para>
15046 <para>A generic authorized value field that can be used anywhere you need a simple
15047 yes/no pull down menu.</para>
15054 <section id="newauthvalcat">
15055 <title>Add new Authorized Value Category</title>
15057 <para>In addition to the existing categories that come by default
15058 with Koha, librarians can add their own authorized value categories
15059 to control data that is entered into the system. To add a new
15064 <para>Click 'New Category'</para>
15067 <screeninfo>New Authorized Category form</screeninfo>
15071 <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
15078 <para>Limit your Category to 10 characters (something short to
15079 make it clear what the category is for)</para>
15084 <para>Category cannot have spaces or special characters
15085 other than underscores and hyphens in it.</para>
15092 <para>When adding a new category you're asked to create at least
15093 one authorized value</para>
15097 <para>Enter a code for your Authorized Value into the
15098 'Authorized value' field</para>
15103 <para>Authorized value is limited to 80 characters and
15104 cannot have spaces or special characters other than
15105 underscores and hyphens in it.</para>
15112 <para>Use the Description field for the actual value that will be displayed. If
15113 you want something different to show in the OPAC, enter a 'Description
15117 <para>If you would like to limit this authorized value category to only specific
15118 libraries you can choose them from the 'Branches limitation' menu. To have it
15119 show for all libraries just choose 'All branches' at the top of the list.</para>
15123 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
15124 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link>
15125 set to show images for authorized values you can choose the
15126 image under 'Choose an icon'</para>
15132 <para>Click 'Save'</para>
15136 <para>Your new category and value will appear on the list of
15137 Authorized Values</para>
15140 <screeninfo>Custom Authorized Value on list of
15141 values</screeninfo>
15145 <imagedata fileref="images/admin/basicparams/authvallist.png"/>
15153 <section id="newauthval">
15154 <title>Add new Authorized Value</title>
15156 <para>New authorized values can be added to any existing or new
15157 category. To add a value:</para>
15161 <para>Click 'New authorized value for ...'</para>
15164 <screeninfo>New Authorized Value form</screeninfo>
15168 <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
15175 <para>Enter a code for your Authorized Value into the
15176 'Authorized value' field</para>
15181 <para>Authorized value is limited to 80 characters and
15182 cannot have spaces or special characters other than
15183 underscores and hyphens in it.</para>
15190 <para>Use the Description field for the actual value that will be displayed. If you
15191 want something different to show in the OPAC, enter a 'Description (OPAC)'</para>
15194 <para>If you would like to limit this authorized value category to only specific
15195 libraries you can choose them from the 'Branches limitation' menu. To have it show
15196 for all libraries just choose 'All branches' at the top of the list.</para>
15200 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
15201 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
15202 to show images for authorized values you can choose the image
15203 under 'Choose an icon'</para>
15207 <para>Click 'Save'</para>
15211 <para>The new value will appear in the list along with existing
15215 <screeninfo>List of authorized values in MARC504
15216 category</screeninfo>
15220 <imagedata fileref="images/admin/basicparams/authvals.png"/>
15230 <section id="patscirc">
15231 <title>Patrons & Circulation</title>
15233 <para>Settings for controlling circulation and patron
15234 information.</para>
15236 <section id="patcats">
15237 <title>Patron Categories</title>
15239 <para>Patron categories allow you to organize your patrons into
15240 different roles, age groups, and patron types.</para>
15244 <para><emphasis>Get there:</emphasis> More > Administration
15245 > Patrons & Circulation > Patron Categories</para>
15250 <screeninfo>Patron category list</screeninfo>
15254 <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
15259 <para>Patrons are assigned to one of six main categories:</para>
15267 <para>Most common patron type, usually used for a general
15268 'Patron' category.</para>
15278 <para>Children patrons can have a guardian to be attached to
15289 <para>Librarians (and library workers) should be assigned the
15290 staff category so that you can <link linkend="patronpermissions">set their permissions</link> and
15291 give them access to the staff client.</para>
15297 <para>Organizational</para>
15301 <para>Organizational patrons are organizations. Organizations
15302 can be used as guarantors for Professional patrons.</para>
15308 <para>Professional</para>
15312 <para>Professional patrons can be linked to Organizational
15319 <para>Statistical</para>
15323 <para>This patron type is used strictly for statistical
15324 purposes, such as in house use of items.</para>
15330 <section id="addingpatroncat">
15331 <title>Adding a patron category</title>
15333 <para>To add a new patron category click 'New Category' at the top
15337 <screeninfo>New patron category form</screeninfo>
15341 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
15348 <para>The 'Category Code' is an identifier for your new
15354 <para>The category code is limited to 10 characters
15355 (numbers and letters)</para>
15361 <para>This field is required in order to save your patron
15362 category. If left blank you will be presented with an
15366 <screeninfo>Missing fields error</screeninfo>
15370 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15380 <para>Enter a plain text version of the category in the
15381 'Description' field.</para>
15386 <para>This field is required in order to save your patron
15387 category. If left blank you will be presented with an
15391 <screeninfo>Missing fields error</screeninfo>
15395 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15405 <para>Enrollment period (in months) should be filled in if you
15406 have a limited enrollment period for your patrons (eg. Student
15407 cards expire after 9 months or until a specific date)</para>
15412 <para>You cannot enter both a month limit and a date
15413 until. Choose to enter either one or the other.</para>
15419 <para>This field is required in order to save your patron
15420 category. If left blank you will be presented with an
15424 <screeninfo>Missing fields error</screeninfo>
15428 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15438 <para>Some patron categories can have a minimum age (in years)
15439 requirement associated with them, enter this age in the 'Age
15445 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15446 defines the dateofbirth as a required field on the patron
15454 <para>Patron categories can also have a maximum age (in years)
15455 associated with them (such as children), enter this age in the
15456 'Upperage limit'</para>
15461 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15462 defines the dateofbirth as a required field on the patron
15470 <para>If you charge a membership fee for your patrons (such as
15471 those who live in another region) you can enter that in the
15472 'Enrollment fee' field.</para>
15477 <para>Only enter numbers and decimals in this field</para>
15484 <para>If you want your patron to receive overdue notices, set
15485 the 'Overdue notice required' to 'Yes'</para>
15489 <para>You can decide on a patron category basis if lost items
15490 are shown in the staff client by making a choice from the 'Lost
15491 items in staff client' pull down</para>
15494 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
15498 <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
15506 <para>Note that this is only applicable in the staff
15507 client, so changing this value on patron categories who do
15508 not have access to the staff client won't make any
15516 <para>If you charge patrons for placing holds on items, enter
15517 the fee amount in the 'Hold fee' field.</para>
15522 <para>Only enter numbers and decimals in this field</para>
15529 <para>In the 'Category type' field choose one of the six main
15530 parent categories</para>
15533 <screeninfo>Six main patron categories</screeninfo>
15537 <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
15545 <para>This field is required in order to save your patron
15546 category. If left blank you will be presented with an
15550 <screeninfo>Missing fields error</screeninfo>
15554 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15564 <para>The Branch Limitations let you limit this patron category to only some branches
15565 in your library system. Select 'All branches' if you would like any library to be
15566 able to use this category.</para>
15569 <para>You can decide if this patron category is blocked from performing actions in the
15570 OPAC if their card is expired using the next option. By default it will follow the
15571 rule set in the <link linkend="BlockExpiredPatronOpacActions"
15572 >BlockExpiredPatronOpacActions</link> preference<screenshot>
15576 <imagedata fileref="images/admin/patroncirc/blockexpired.png"/>
15579 </screenshot></para>
15582 <para>Finally you can assign advanced messaging preferences by default to a patron
15588 <para>Requires that you have <link linkend="EnhancedMessagingPreferences"
15589 >EnhancedMessagingPreferences</link> enabled</para>
15594 <para>These defaults will be applied to new patrons that are added to the system.
15595 They will not edit the preferences of the existing patrons. Also, these can be
15596 changed for individual patrons, this setting is just a default to make it easier
15597 to set up messages for an entire category.<itemizedlist>
15600 <para>After setting the default for the patron category you can force
15601 those changes to all existing patrons by running the <emphasis
15602 role="italic">borrowers-force-messaging-defaults</emphasis> script
15603 found in the <emphasis role="italic">misc/maintenance</emphasis> folder.
15604 Ask your system administrator for assistance with this script.</para>
15607 </itemizedlist></para>
15614 <section id="circfinerules">
15615 <title>Circulation and Fine Rules</title>
15616 <para>These rules define how your items are circulated, how/when fines are calculated and
15617 how holds are handled.</para>
15620 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
15621 Circulation > Circulation and fines rules</para>
15624 <para>The rules are applied from most specific to less specific, using the first found in
15628 <para>same library, same patron type, same item type</para>
15631 <para>same library, same patron type, all item type</para>
15634 <para>same library, all patron types, same item type</para>
15637 <para>same library, all patron types, all item types</para>
15640 <para>default (all libraries), same patron type, same item type</para>
15643 <para>default (all libraries), same patron type, all item types</para>
15646 <para>default (all libraries), all patron types, same item type</para>
15649 <para>default (all libraries), all patron types, all item types</para>
15653 <para>If you are a single library system choose your branch name before creating rules
15654 (sometimes having only rules for the 'all libraries' option can cause issues with
15659 <para>At the very least you will need to set a default circulation rule. This rule
15660 should be set for all item types, all libraries and all patron categories. That will
15661 catch all instances that do not match a specific rule. When checking out if you do not
15662 have a rule for all libraries, all item types and all patron types then you may see
15663 patrons getting blocked from placing holds. You will also want a rule for your
15664 specific library set for all item types and all patron types to avoid this holds
15665 issue. Koha needs to know what rule to fall back on.</para>
15668 <section id="defaultcircrules">
15669 <title>Default Circulation Rules</title>
15670 <para>Using the issuing rules matrix you can define rules that depend on patron/item type
15671 combos. To set your rules, choose a library from the pull down (or 'all libraries' if
15672 you want to apply these rules to all branches):</para>
15674 <screeninfo>Libraries to apply the rules to</screeninfo>
15677 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
15681 <para>From the matrix you can choose any combination of patron categories and item types
15682 to apply the rules to</para>
15684 <screeninfo>Setting issuing rules for your libraries</screeninfo>
15687 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
15693 <para>First choose which patron category you'd like the rule to be applied to. If you
15694 leave this to 'All' it will apply to all patron categories</para>
15697 <para>Choose the 'Item type' you would like this rule to apply to. If you leave this
15698 to 'All' it will apply to all item types</para>
15701 <para>Limit the number of items a patron can have checked out at the same time by
15702 entering a number in the 'Current checkouts allowed' field</para>
15705 <para>Define the period of time an item can be checked out to a patron by entering the
15706 number of units (days or hours) in the 'Loan period' box.</para>
15709 <para>Choose which unit of time, Days or Hours, that the loan period and fines will be
15710 calculated in in the 'Unit' column</para>
15713 <para>You can also define a hard due date for a specific patron category and item
15714 type. A hard due date ignores your usual circulation rules and makes it so that all
15715 items of the type defined are due on, before or after the date you specify.</para>
15718 <para>'Fine amount' should have the amount you would like to charge for overdue
15723 <para>Enter only numbers and decimal points (no currency symbols).</para>
15729 <para>Enter the 'Fine charging interval' in the unit you set (ex. charge fines every 1
15730 day, or every 2 hours)</para>
15733 <para>The 'Fine grace period' is the period of time an item can be overdue before you
15734 start charging fines.</para>
15738 <para>This can only be set for the Day unit, not in Hours</para>
15744 <para>The 'Overdue fines cap' is the maximum fine for this patron and item
15749 <para>If this field is left blank then Koha will not put a limit on the fines
15750 this item will accrue. A maximum fine amount can be set using the <link linkend="MaxFine">MaxFine</link> system preference.</para>
15756 <para>If your library 'fines' patrons by suspending their account you can enter the
15757 number of days their fine should be suspended in the 'Suspension in days'
15762 <para>This can only be set for the Day unit, not in Hours</para>
15768 <para>Next decide if the patron can renew this item type and if so, enter how many
15769 times they can renew it in the 'Renewals allowed' box</para>
15772 <para>If you're allowing renewals you can control how long the renewal loan period
15773 will be (in the units you have chosen) in the 'Renewal period' box</para>
15776 <para>If you're allowing renewals you can control how soon before the due date patrons
15777 can renew their materials with the 'No renewals before' box.<itemizedlist>
15779 <para>Items can be renewed at any time if this value is left blank. Otherwise
15780 items can only be renewed if the item is before the number in units
15781 (days/hours) entered in this box.</para>
15783 </itemizedlist></para>
15786 <para>If the patron can place holds on this item type, enter the total numbers of
15787 items (of this type) that can be put on hold in the 'Holds allowed' field</para>
15790 <para>Finally, if you charge a <link linkend="rentalcharge">rental fee</link> for the
15791 item type and want to give a specific patron type a discount on that fee, enter the
15792 percentage discount (without the % symbol) in the 'Rental Discount' field</para>
15795 <para>When finished, click 'Add' to save your changes. To modify a rule, simply click the
15796 'Edit' link to the right of the fule and edit the values that appear filled in at the
15797 bottom of the form.</para>
15799 <screeninfo>Edit circ and fine rule</screeninfo>
15802 <imagedata fileref="images/admin/patroncirc/editcircfine.png"/>
15806 <para>If you would like to delete your rule, click the 'Delete' link to the right of the
15808 <para>To save time you can clone rules from one library to another by choosing the clone
15809 option above the rules matrix.</para>
15811 <screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
15814 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
15818 <para>After choosing to clone you will be presented with a confirmation message.</para>
15820 <screeninfo>Circulation & Fine Rules Successfully Cloned Message</screeninfo>
15823 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
15828 <section id="defaultcheckoutpolicy">
15829 <title>Default Checkouts and Hold Policy</title>
15830 <para>You can set a default maximum number of checkouts and hold policy that will be used
15831 if none is defined below for a particular item type or category. This is the fall back
15832 rule for defaults.</para>
15834 <screeninfo>Default Checkouts and Hold Policy</screeninfo>
15837 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
15841 <para>From this menu you can set a default to apply to all item types and patrons in the
15842 library if no other option is set in the forms below.</para>
15845 <para>In 'Total Current Checkouts Allowed' enter the total number of items patrons can
15846 have checked out at one time</para>
15849 <para>Control where patrons can place holds from using the 'Hold Policy' menu</para>
15852 <para>From Any Library: Patrons from any library may put this item on hold.
15853 (default if none is defined)</para>
15856 <para>From Home Library: Only patrons from the item's home library may put this
15857 book on hold.</para>
15860 <para>No Holds Allowed: No patron may put this book on hold.</para>
15865 <para>Control where the item returns to once it is checked in</para>
15868 <para>Item returns home</para>
15871 <para>Item returns to issuing branch</para>
15874 <para>Item floats</para>
15877 <para>When an item floats it stays where it was checked in and does not ever
15878 return 'home'</para>
15885 <para>Once your policy is set, you can unset it by clicking the 'Unset' link to the
15886 right of the rule</para>
15890 <section id="checkoutperpatron">
15891 <title>Checkouts Per Patron</title>
15892 <para>For this library, you can specify the maximum number of loans that a patron of a
15893 given category can make, regardless of the item type. </para>
15895 <screeninfo>Set default checkouts per patron category</screeninfo>
15898 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
15903 <para>If the total amount loanable for a given patron category is left blank, no limit
15904 applies, except possibly for a limit you define for a specific item type.</para>
15906 <para>For example, if you have a rule in the matrix that says Board patrons are allowed 10
15907 books and 5 DVDs but you want to make it so that Board patrons only have a total of 12
15908 things checked out at once. If you enter 12 here and the patron has 10 books out
15909 already they will only be allowed 2 DVDs to equal the 12 total they're allowed.</para>
15911 <section id="holdpolicies">
15912 <title>Item Hold Policies</title>
15913 <para>For this library, you can edit hold and return policies for a given item type,
15914 regardless of the patron's category.</para>
15916 <screeninfo>Hold policies per item type</screeninfo>
15919 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
15923 <para>The various Hold Policies have the following effects:</para>
15926 <para>From Any Library: Patrons from any library may put this item on hold. (default
15927 if none is defined)</para>
15930 <para>From Home Library: Only patrons from the item's home library may put this book
15934 <para>No Holds Allowed: No patron may put this book on hold.</para>
15938 <para>Note that if the system preference <link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link> set to 'allow', these policies can be overridden by
15939 your circulation staff.</para>
15942 <para>These policies are based on the patron's home branch, not the branch that the
15943 reserving staff member is from.</para>
15945 <para>The various Return Policies have the following effects:</para>
15948 <para>Item returns home: The item will prompt the librarian to transfer the item to
15949 its home library</para>
15953 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
15954 preference is set to automatically transfer the items home, then a prompt will
15961 <para>Item returns to issuing branch: The item will prompt the librarian to transfer
15962 the item back to the library where it was checked out</para>
15966 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
15967 preference is set to automatically transfer the items home, then a prompt will
15974 <para>Item floats: The item will not be transferred from the branch it was checked in
15975 at, instead it will remain there until transferred manually or checked in at another
15979 <para>For example you might allow holds at your libraries but not what New items or DVDs to
15980 be placed on hold by other branches so you can set the 'Hold policy' to 'From home
15981 library' so that those items can only be placed on hold if the items' owning library and
15982 the patron's home library are the same. You can also block holds completely on specific
15983 item types from this form. This is also how you can set up floating item types and
15984 types that remain with their home library.</para>
15987 <section id="patronattributetypes">
15988 <title>Patron Attribute Types</title>
15989 <para>Patron attributes can be used to define custom fields to associate with your patron
15990 records. In order to enable the use of custom fields you need to set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link> system
15994 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
15995 Circulation > Patron attribute types</para>
15998 <para>A common use for this field would be for a student ID number or a Driver's license
16001 <screeninfo>List of Patron Attributes</screeninfo>
16004 <imagedata fileref="images/admin/patroncirc/attributes.png"/>
16008 <section id="addpatattributes">
16009 <title>Adding Patron Attributes</title>
16010 <para>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at
16011 the top of the page</para>
16013 <screeninfo>Add Patron Attribute Type form</screeninfo>
16016 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
16022 <para>In the 'Patron attribute type code', enter a short code to identify this
16027 <para>This field is limited to 10 characters (numbers and letters only)</para>
16032 <para>This setting cannot be changed after an attribute is defined</para>
16038 <para>In the 'Description' field, enter a longer (plain text) explanation of what this
16039 field will contain</para>
16042 <para>Check the box next to 'Repeatable' to let a patron record have multiple values
16043 of this attribute.</para>
16047 <para>This setting cannot be changed after an attribute is defined</para>
16053 <para>If 'Unique identifier' is checked, the attribute will be a unique identifier
16054 which means, if a value is given to a patron record, the same value cannot be given
16055 to a different record.</para>
16059 <para>This setting cannot be changed after an attribute is defined</para>
16065 <para>Check 'Allow password' to make it possible to associate a password with this
16069 <para>Check 'Display in OPAC' to display this attribute on a patron's details page in
16073 <para>Check 'Searchable' to make this attribute searchable in the staff patron
16077 <para>Check 'Display in check-out' to make this attribute visible in the patron's
16078 short detail display on the left of the checkout screen and other patron
16081 <screeninfo>Show attribute in patron detail on the left</screeninfo>
16084 <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
16090 <para>Authorized value category; if one is selected, the patron record input page will
16091 only allow values to be chosen from the authorized value list.</para>
16094 <para>You will first need to add an authorized value list for it to appear in this
16098 <para><emphasis>Get there: </emphasis>More > Administration > Basic
16099 Parameters > <link linkend="authorizedvalues">Authorized
16100 Values</link></para>
16106 <para>an authorized value list is not enforced during batch patron
16113 <para>If you would like this attribute to only be used by specific branches you can
16114 choose those branches from the 'Branches limitation' list. Choose 'All branches' to
16115 show it for all libraries.<itemizedlist>
16118 <para>Note that items with locations already set on them will not be altered.
16119 The branch limitation only limits the choosing of an authorized value based
16120 on the home branch of the current staff login. All authorized values for
16121 item records (LOC, LOST, CCODE, etc) will show in the OPAC for all
16125 </itemizedlist></para>
16128 <para>If you'd like to only show this attribute on patrons of one type choose that
16129 patron type from the 'Category' pull down</para>
16132 <para>If you have a lot of attributes it might be handy to group them so that you can
16133 easily find them for editing. If you create an <link linkend="authorizedvalues">Authorized Value</link> for PA_CLASS it will show in the 'Class' pull down and
16134 you can then change your attributes page to have sections of attributes</para>
16136 <screeninfo>Patron Attributes Sorted</screeninfo>
16139 <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
16145 <para>Click Save to save your new attribute</para>
16148 <para>Once added your attribute will appear on the list of attributes and also on the
16149 patron record add/edit form</para>
16151 <screeninfo>Patron Attributes list on the Patron add/edit form</screeninfo>
16154 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
16158 <para>If you have set up classes for organizing attributes they will appear that way on
16159 the add/edit patron form</para>
16161 <screeninfo>Grouped Attributes</screeninfo>
16164 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
16169 <section id="editpatattributes">
16170 <title>Editing/Deleting Patron Attributes</title>
16171 <para>Each patron attribute has an edit and a delete link beside it on the list of
16173 <para>Some fields in the attribute will not be editable once created:</para>
16176 <para>Patron attribute type code</para>
16179 <para>Repeatable</para>
16182 <para>Unique identifier</para>
16185 <para>You will be unable to delete an attribute if it's in use.</para>
16187 <screeninfo>Warning when trying to delete an attribute that is in use</screeninfo>
16190 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
16196 <section id="libtransferlimits">
16197 <title>Library Transfer Limits</title>
16198 <para>Limit the ability to transfer items between libraries based on the library sending,
16199 the library receiving, and the collection code involved.</para>
16202 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
16203 Circulation > Library Transfer Limits</para>
16206 <para>These rules only go into effect if the preference <link linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is set to
16208 <para>Before you begin you will want to choose which library you are setting these limits
16211 <screeninfo>Choose the library you're setting limits for</screeninfo>
16214 <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
16218 <para>Transfer limits are set based on the collections codes you have applied via the <link linkend="authorizedvalues">Authorized Value</link> administration area.</para>
16220 <screeninfo>Collection Code values assigned in the Authorized Value area</screeninfo>
16223 <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
16227 <para>Collection codes will appear as tabs above the checkboxes:</para>
16229 <screeninfo>Collection Code tabs</screeninfo>
16232 <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
16236 <para>Check the boxes for the libraries that you accept checkins from for the item type you
16237 have selected at the top (in the example below - FIC)</para>
16239 <screeninfo>Example transfer limits set up</screeninfo>
16242 <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
16246 <para>In the above example, Centerville library will allow patrons to return items from all
16247 libraries except Liberty and Franklin to their branch.</para>
16249 <section id="transportcostmatrix">
16250 <title>Transport cost matrix</title>
16251 <para>The Transport cost matrix lets a library system define relative costs to transport
16252 books to one another. In order for the system to use this matrix you must first set the
16253 <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link> preference to
16255 <para>The Transport cost matrix takes precedence in controlling where holds are filled
16256 from, if the matrix is not used then Koha checks the <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>.</para>
16257 </important></para>
16258 <para>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0
16259 which is the minimum (no) cost. For example, you could just use the distance between each
16260 library in miles as your 'cost', if that would accurately reflect the cost of transferring
16261 them. Perhaps post offices would be a better measure. Libraries sharing a post office
16262 would have a cost of 1, adjacent post offices would have a cost of 2, etc.</para>
16263 <para>To enter transport costs simply click in the cell you would like to alter, uncheck the
16264 'Disable' box and enter your 'cost'</para>
16266 <screeninfo>Transport cost matrix</screeninfo>
16269 <imagedata fileref="images/admin/patroncirc/transportcostmatrix.png"/>
16273 <para>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button
16274 at the bottom of the matrix to save your changes.</para>
16276 <section id="itemcircalerts">
16277 <title>Item Circulation Alerts</title>
16278 <para>Libraries can decide if they want to have patrons automatically notified of
16279 circulation events (check ins and check outs).</para>
16282 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
16283 Circulation > Item Circulation Alerts</para>
16286 <para>These preferences are set based on patron types and item types.</para>
16288 <para>These preference can be overridden by changes in the individual patron's messaging
16289 preferences.</para>
16291 <para>To set up circulation alerts:</para>
16294 <para>Choose your library from the pull down at the top of the screen</para>
16296 <screeninfo>Libraries to set Circulation Alerts</screeninfo>
16299 <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
16305 <para>To set preferences for all libraries, keep the menu set to 'Default'</para>
16310 <para>By default all item types and all patrons are notified of check ins and check
16311 outs. To change this, click on the item/patron type combo that you would like to stop
16312 notices for.</para>
16314 <screeninfo>Circulation Alert Matrix</screeninfo>
16317 <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
16323 <para>In the above example, Juveniles and Kids will not receive check out
16331 <section id="citytowns">
16332 <title>Cities and Towns</title>
16334 <para>To standardize patron input you can define cities or towns
16335 within your region so that when new patrons are added librarians
16336 simply have to select the town from a list instead of having to type
16337 the town and zip (or postal) code information.</para>
16341 <para><emphasis>Get there:</emphasis> More > Administration
16342 > Patrons & Circulation > Cities and Towns</para>
16346 <section id="addingcity">
16347 <title>Adding a City</title>
16349 <para>To add a new city, click the 'New City' button at the top of
16350 the page and enter the city name, state, zip/postal code and
16354 <screeninfo>New city entry form</screeninfo>
16358 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
16363 <para>One you click Submit, your city will be saved and will be
16364 listed on the Cities and Towns page</para>
16367 <screeninfo>List of Cities</screeninfo>
16371 <imagedata fileref="images/admin/patroncirc/cities.png"/>
16376 <para>Cities can be edited or deleted at any time.</para>
16379 <section id="citiesonpatform">
16380 <title>Viewing Cities on Patron Add Form</title>
16382 <para>If you have defined local cities using the New city form, then
16383 when adding or editing a patron record you will see those cities in
16384 a pull down menu to make city selection easy.</para>
16387 <screeninfo>Cities pull down on the patron record</screeninfo>
16391 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
16396 <para>This will allow for easy entry of local cities into the patron
16397 record without risking the potential for typos or mistaken
16398 zip/postal codes.</para>
16403 <section id="catadmin">
16404 <title>Catalog Administration</title>
16406 <para>Set these controls before you start cataloging on your Koha
16411 <para><emphasis>Get there:</emphasis> More > Administration >
16416 <section id="marcbibframeworks">
16417 <title>MARC Bibliographic Frameworks</title>
16419 <para>Think of Frameworks as templates for creating new bibliographic
16420 records. Koha comes with some predefined frameworks that can be edited
16421 or deleted, and librarians can create their own frameworks for content
16422 specific to their libraries.</para>
16426 <para><emphasis>Get there:</emphasis> More > Administration
16427 > Catalog > MARC Bibliographic Frameworks</para>
16432 <screeninfo>Frameworks List</screeninfo>
16436 <imagedata fileref="images/admin/cataloging/frameworks.png"/>
16442 <para>Do not delete or edit the Default Framework since this will
16443 cause problems with your cataloging records - always create a new
16444 template based on the Default Framework, or alter the other
16448 <para>After clicking the 'MARC structure' link to the right of each
16449 framework you can decide how many fields you want to see on one screen
16450 by using the pagination options at the top of the table.</para>
16453 <screeninfo>Pagination options</screeninfo>
16457 <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
16462 <section id="addframework">
16463 <title>Add New Framework</title>
16465 <para>To add a new framework</para>
16469 <para>Click 'New Framework'</para>
16472 <screeninfo>Add Framework Form</screeninfo>
16476 <imagedata fileref="images/admin/cataloging/addframework.png"/>
16483 <para>Enter a code of 4 or fewer characters</para>
16487 <para>Use the Description field to enter a more detailed
16488 definition of your framework</para>
16494 <para>Click 'Submit'</para>
16498 <para>Once your Framework is added click 'MARC structure' to the
16499 right of it on the list of Frameworks</para>
16502 <screeninfo>Choose basis for new Framework</screeninfo>
16506 <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
16513 <para>You will be asked to choose a Framework to base your
16514 new Framework off of, this will make it easier than starting
16515 from scratch</para>
16521 <para>Once your Framework appears on the screen you can edit or
16522 delete each field by following the instructions for <link linkend="editsubfields">editing subfields</link></para>
16527 <section id="editframeworks">
16528 <title>Edit Existing Frameworks</title>
16530 <para>Clicking 'Edit' to the right of a Framework will only allow
16531 you to edit the Description for the Framework:</para>
16534 <screeninfo>Edit Framework</screeninfo>
16538 <imagedata fileref="images/admin/cataloging/editframework.png"/>
16543 <para>To make edits to the fields associated with the Framework you
16544 must first click 'MARC Structure' and then follow the instructions
16545 for <link linkend="editsubfields">editing subfields</link></para>
16548 <section id="addsubfieldsframework">
16549 <title>Add subfields to Frameworks</title>
16551 <para>To add a field to a Framework click the 'New Tag' button at
16552 the top of the Framework definition</para>
16555 <screeninfo>New Tag Button</screeninfo>
16559 <imagedata fileref="images/admin/cataloging/newtag.png"/>
16564 <para>This will open up a blank form for entering MARC field
16568 <screeninfo>Add a new tag to framework</screeninfo>
16572 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
16577 <para>Enter the information about your new tag:</para>
16581 <para>The 'Tag' is the MARC field number</para>
16585 <para>The 'Label for lib' is the text that will appear in the
16586 staff client when in the cataloging module</para>
16590 <para>The 'Label for OPAC' is the text that will appear in the
16591 OPAC when viewing the MARC version of the record</para>
16595 <para>If this field can be repeated, check the 'Repeatable'
16600 <para>If this field is mandatory, check the 'Mandatory'
16605 <para>If you want this field to be a pull down with limited
16606 possible answers, choose which 'Authorized value' list you want
16611 <para>When you're finished, click 'Save Changes' and you will be
16612 presented with your new field</para>
16615 <screeninfo>New tag and link to subfields</screeninfo>
16619 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
16624 <para>To the right of the new field is a link to 'Subfields,' you
16625 will need to add subfields before this tag will appear in your MARC
16626 editor. The process of entering the settings for the new subfield is
16627 the same as those found in the <link linkend="editsubfields">editing
16628 subfields in frameworks</link> section of this manual.</para>
16631 <section id="editsubfields">
16632 <title>Edit Framework Subfields</title>
16634 <para>Frameworks are made up of MARC fields and subfields. To make
16635 edits to most Frameworks you must edit the fields and subfields.
16636 Clicking 'Edit' to the right of each subfield will allow you to make
16637 changes to the text associated with the field</para>
16640 <screeninfo>Modify MARC Field</screeninfo>
16644 <imagedata fileref="images/admin/cataloging/editfield.png"/>
16651 <para>Each field has a tag (which is the MARC tag) that is uneditable</para>
16655 <para>The 'Label for lib' is what will show in the staff
16656 client if you have <link linkend="advancedMARCeditor">advancedMARCeditor</link> set
16657 to display labels</para>
16661 <para>The 'Label for OPAC' is what will show on the MARC
16662 view in the OPAC</para>
16666 <para>If you check 'Repeatable' then the field will have a
16667 plus sign next to it allowing you to add multiples of that
16672 <para>If you check 'Mandatory' the record will not be
16673 allowed to save unless you have a value assigned to this
16678 <para>'Authorized value' is where you define an <link linkend="authorizedvalues">authorized value</link> that your
16679 catalogers can choose from a pull down to fill this field
16686 <para>To edit the subfields associated with the tag, click
16687 'Subfields' to the right of the tag on the 'MARC Structure'
16692 <para>From the list of subfields you can click 'Delete' to the
16693 right of each to delete the subfields</para>
16697 <para>To edit the subfields click 'Edit Subfields'</para>
16701 <para>For each subfield you can set the following Basic constraint values</para>
16703 <screeninfo>Editing the 504 Subfield</screeninfo>
16706 <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
16713 <para>Text for librarian</para>
16717 <para>what appears before the subfield in the librarian
16724 <para>Text for OPAC</para>
16728 <para>what appears before the field in the OPAC.</para>
16732 <para>If left empty, the text for librarian is used
16741 <para>Repeatable</para>
16745 <para>the field will have a plus sign next to it
16746 allowing you to add multiples of that tag</para>
16752 <para>Mandatory</para>
16756 <para>the record will not be allowed to save unless you
16757 have a value assigned to this tag</para>
16763 <para>Managed in tab</para>
16767 <para>defines the tab where the subfield is shown. All
16768 subfields of a given field must be in the same tab or
16769 ignored. Ignore means that the subfield is not
16777 <para>For each subfield you can set the following Advanced constraint values</para>
16779 <screeninfo>Advanced constraints</screeninfo>
16782 <imagedata fileref="images/admin/cataloging/advancedoptsubfield.png"/>
16788 <para>Default value</para>
16791 <para>defines what you want to appear in the field by default, this will be
16792 editable, but it saves time if you use the same note over and over or the
16793 same value in a field often.</para>
16798 <para>Visibility</para>
16801 <para>allows you to select from where this subfield is visible/hidden, simply
16802 check the boxes where you would like the field to show and uncheck the boxes
16803 where you would like it hidden.</para>
16805 <screeninfo>Framework visibility</screeninfo>
16808 <imagedata fileref="images/admin/cataloging/frameworkvisibility.png"/>
16816 <para>Is a URL</para>
16819 <para>if checked, it means that the subfield is a URL and can be
16828 <para>If you enter a field/subfield here (200b), a link appears after the
16829 subfield in the MARC Detail view. This view is present only in the staff
16830 client, not the OPAC. If the librarian clicks on the link, a search is done
16831 on the database for the field/subfield with the same value. This can be used
16832 for 2 main topics :</para>
16835 <para>on a field like author (200f in UNIMARC), put 200f here, you will be
16836 able to see all bib records with the same author.</para>
16839 <para>on a field that is a link (4xx) to reach another bib record. For
16840 example, put 011a in 464$x, will find the serials that are with this
16847 <para>This value should not change after data has been added to your
16848 catalog. If you need to change this value you must ask your system
16849 administrator to run misc/batchRebuildBiblioTables.pl. </para>
16855 <para>Koha link</para>
16858 <para>Koha is multi-MARC compliant. So, it does not know what the 245$a means,
16859 neither what 200$f (those 2 fields being both the title in MARC21 and
16860 UNIMARC). So, in this list you can "map" a MARC subfield to its meaning.
16861 Koha constantly maintains consistency between a subfield and its meaning.
16862 When the user want to search on "title", this link is used to find what is
16863 searched (245 if you're MARC21, 200 if you're UNIMARC).</para>
16870 <para>For each subfield you can set the following Other option values</para>
16875 <imagedata fileref="images/admin/cataloging/otheroptssubfield.png"/>
16881 <para>Authorized value</para>
16884 <para>means the value cannot by typed by the librarian, but must be chosen
16885 from a pull down generated by the <link linkend="authorizedvalues"
16886 >authorized value</link> list</para>
16889 <para>In the example above, the 504a field will show the MARC504 Authorized
16890 Values when cataloging</para>
16892 <screeninfo>Example of an Authorized Subfield</screeninfo>
16895 <imagedata fileref="images/admin/cataloging/504auth.png"/>
16903 <para>Thesaurus</para>
16906 <para>means that the value is not free text, but must be searched in the
16907 authority/thesaurus of the selected category</para>
16912 <para>Plugin</para>
16915 <para>means the value is calculated or managed by a plugin. Plugins can do
16916 almost anything.</para>
16919 <para>For example, in UNIMARC there are plugins for every 1xx fields that are
16920 coded fields. The plugin is a huge help for cataloger ! There are also two
16921 plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically"
16922 find the editor from an ISBN, and the collection list for the editor)</para>
16930 <para>To save your changes simply click the 'Save Changes'
16931 button at the top of the screen</para>
16938 <section id="importexportframeworks">
16939 <title>Import/Export Frameworks</title>
16941 <para>Next to each framework is a link to either import or export
16942 the framework.</para>
16944 <section id="exportframeworks">
16945 <title>Export Framework</title>
16947 <para>To export a framework simply click the 'Export' link to the
16948 right of framework title.</para>
16951 <screeninfo>Export link next to framework</screeninfo>
16955 <imagedata fileref="images/admin/cataloging/importexport.png"/>
16960 <para>When you click 'Export' you will be prompted to choose what
16961 format to export the file in.</para>
16964 <screeninfo>Export formats</screeninfo>
16968 <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
16973 <para>A framework exported this way can be imported into any other
16974 Koha installation using the import framework option.</para>
16977 <section id="importframeworks">
16978 <title>Import Framework</title>
16980 <para>An easy way to create a new framework is to import one created for your or another
16981 Koha installation. This framework would need to be exported from the other system
16982 <link linkend="exportframeworks">using the instructions above</link> to be available
16983 for import here. </para>
16984 <para>To import a framework you first need to create <link linkend="addframework">a new
16985 framework</link>. Once you have that framework, click 'Import' to the right of the
16986 new framework.</para>
16989 <screeninfo>Import link next to framework</screeninfo>
16993 <imagedata fileref="images/admin/cataloging/importexport.png"/>
16998 <para>You will be prompted to find a file on your computer to
16999 import into the framework.</para>
17002 <screeninfo>Choose a file to import</screeninfo>
17006 <imagedata fileref="images/admin/cataloging/importfile.png"/>
17011 <para>You will be asked to confirm your actions before the file is
17015 <screeninfo>Confirm your desire to import</screeninfo>
17019 <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
17024 <para>As your file is uploaded you will see an image that will
17025 confirm that the system is working.</para>
17028 <screeninfo>Import timer</screeninfo>
17032 <imagedata fileref="images/admin/cataloging/importtimer.png"/>
17037 <para>Once your import is complete you will be brought to the
17038 framework edit tool where you can make any changes you need to the
17039 framework you imported.</para>
17044 <section id="kohamarcmapping">
17045 <title>Koha to MARC Mapping</title>
17047 <para>While Koha stores the entire MARC record, it also stores common
17048 fields for easy access in various tables in the database. Koha to MARC
17049 Mapping is used to tell Koha where to find these values in the MARC
17050 record. In many cases you will not have to change the default values
17051 set by in this tool on installation, but it is important to know that
17052 the tool is here and can be used at any time.</para>
17056 <para><emphasis>Get there:</emphasis> More > Administration
17057 > Catalog > Koha to MARC Mapping</para>
17061 <para>The Koha to MARC Mapping page offers you the option of choosing
17062 from one of three tables in the database to assign values to.</para>
17065 <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
17069 <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
17074 <para>After choosing the table you would like to view, click 'OK.' To
17075 edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
17078 <screeninfo>Map MARC Field to Koha Field</screeninfo>
17082 <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
17087 <para>Choose which MARC field you would like to map to this Koha Field
17088 and click the 'OK' button. If you would like to clear all mappings,
17089 click the 'Click to "Unmap"' button.</para>
17092 <para>At this time you can map only 1 MARC field to 1 Koha field.
17093 This means that you won't be able to map both the 100a and the 700a
17094 to the author field, you need to choose one or the other.</para>
17100 <section id="keywordmapping">
17101 <title>Keywords to MARC Mapping</title>
17103 <para>This tool will allow you to map MARC fields to a set of
17104 predefined keywords.</para>
17108 <para><emphasis>Get there:</emphasis> More > Administration
17109 > Catalog > Keywords to MARC Mapping</para>
17114 <para>This tool only effects sites that are not using the XSLT
17115 Stylesheets.</para>
17118 <para>At this time the only keyword in use is 'subtitle.'</para>
17120 <para>Using this tool you can define what MARC field prints to the
17121 detail screen of the bibliographic record using keywords. The
17122 following example will use the subtitle field.</para>
17124 <para>Using the Framework pull down menu, choose the <link linkend="marcbibframeworks">Framework</link> you would like to apply
17125 this rule to. For example, the subtitle for books can be found in the
17126 245$b field.</para>
17129 <screeninfo>Assigning Book Subtitle</screeninfo>
17133 <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
17138 <para>However the subtitle for DVDs appears in 245$p</para>
17141 <screeninfo>Assigning DVD Subtitle</screeninfo>
17145 <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
17150 <para>Using this tool you can tell Koha to print the right field as
17151 the subtitle when viewing the bibliographic record in the OPAC.</para>
17154 <screeninfo>Subtitle display in the OPAC</screeninfo>
17158 <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
17163 <para>This tool can be used to chain together pieces of the record as
17164 well. If you want the series number to show in the title on your
17165 search results you simply have to map 490 $v to 'subtitle' along with
17167 <para>Chain together the fields you want to show after the item
17168 title in the order in which you want them to appear.</para>
17171 <para>Future developments will include additional keyword assigned
17175 <section id="marcbibframeworkstest">
17176 <title>MARC Bibliographic Framework Test</title>
17178 <para>Checks the MARC structure.</para>
17182 <para><emphasis>Get there:</emphasis> More > Administration
17183 > Catalog > MARC Bibliographic Framework Test</para>
17187 <para>If you change your MARC Bibliographic framework it's recommended
17188 that you run this tool to test for errors in your definition.</para>
17191 <screeninfo>Framework Test</screeninfo>
17195 <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
17201 <section id="authoritiesadmin">
17202 <title>Authority Types</title>
17204 <para>Authority Types are basically MARC Frameworks for Authority
17205 records and because of that they follow the same editing rules found
17206 in the <link linkend="marcbibframeworks">MARC Bibliographic
17207 Frameworks</link> section of this manual. Koha comes with many of the
17208 necessary Authority frameworks already installed. To learn how to add
17209 and edit Authority Types, simply review the <link linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
17210 section of this manual.</para>
17214 <para><emphasis>Get there:</emphasis> More > Administration
17215 > Catalog > Authority Types</para>
17220 <section id="classificationsources">
17224 <firstname>Savitra</firstname>
17225 <surname>Sirohi</surname>
17227 <orgname>Nucsoft OSS Labs</orgname>
17232 <firstname>Nicole C.</firstname>
17233 <surname>Engard</surname>
17234 <contrib>Fixed typos, changed content where
17235 necessary and added new screenshots.</contrib>
17239 <pubdate>2010</pubdate>
17242 <title>Classification Sources</title>
17244 <para>Source of classification or shelving scheme is an <link linkend="authorizedvalues"
17245 >Authorized Values</link> category that is mapped to field 952$2 and 942$2 in Koha's
17246 MARC Bibliographic frameworks and stored in the items.cn_source field in the
17251 <para><emphasis>Get there:</emphasis> More > Administration
17252 > Catalog > Classification sources</para>
17257 <screeninfo>Classification Sources</screeninfo>
17261 <imagedata fileref="images/admin/cataloging/classsources.png"/>
17266 <para>Commonly used values of this field are:</para>
17270 <para>ddc - Dewey Decimal Classification</para>
17274 <para>lcc - Library of Congress Classification</para>
17278 <para>If you chose to install classification sources during Koha's
17279 installation, you would see other values too:</para>
17283 <para>ANSCR (sound recordings)</para>
17287 <para>SuDOC classification</para>
17291 <para>Universal Decimal Classification</para>
17295 <para>Other/Generic Classification</para>
17299 <section id="addingclasssource">
17300 <title>Adding/Editing Classification Sources</title>
17302 <para>You can add your own source of classification by using the New
17303 Classification Source button. To edit use the Edit link.</para>
17306 <screeninfo>Add classification source</screeninfo>
17310 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
17315 <para>When creating or editing:</para>
17319 <para>You will need to enter a code and a description.</para>
17323 <para>Check the 'Source in use?' checkbox if you want the value
17324 to appear in the drop down list for this category.</para>
17328 <para>Select the appropriate <link linkend="classfilingrules">filing rule</link> from the drop down
17336 <section id="classfilingrules">
17337 <title>Classification Filing Rules</title>
17339 <para>Filing rules determine the order in which items are placed on
17342 <para>Values that are pre-configured in Koha are:</para>
17354 <para>Generic</para>
17358 <para>Filing rules are mapped to <link linkend="addingclasssource">Classification sources</link>. You can
17359 setup new filing rules by using the New Filing Rule button. To edit
17360 use the Edit link.</para>
17362 <para>When creating or editing:</para>
17366 <para>Enter a code and a description</para>
17370 <para>Choose an appropriate filing routine - dewey, generic or
17377 <section id="recordmatchingrules">
17381 <firstname>Joy</firstname>
17382 <surname>Nelson</surname>
17384 <orgname>ByWater Solutions</orgname>
17389 <firstname>Nicole C.</firstname>
17390 <surname>Engard</surname>
17391 <contrib>Changed/edited content where necessary.</contrib>
17395 <pubdate>2013</pubdate>
17397 <title>Record Matching Rules</title>
17399 <para>Record matching rules are used when importing MARC records into
17404 <para><emphasis>Get there:</emphasis> More > Administration
17405 > Catalog > Record Matching Rules</para>
17409 <para>The rules that you set up here will be referenced with you <link linkend="stagemarc">Stage MARC Records for Import</link>.</para>
17410 <para>It is important to understand the difference between Match Points and Match Checks
17411 before adding new matching rules to Koha.</para>
17413 <para>Match Points are the criteria that you enter that must be met in order for an incoming
17414 record to match an existing MARC record in your catalog. You can have multiple match
17415 points on an import rule each with its own score. An incoming record will be compared
17416 against your existing records (‘one record at a time’) and given a score for each match
17417 point. When the total score of the matchpoints matches or exceeds the threshold given for
17418 the matching rule, Koha assumes a good match and imports/overlays according your
17419 specifications in the import process. An area to watch out for here is the sum of the
17420 match points. Doublecheck that the matches you want will add up to a successful
17423 <para>Example: </para>
17424 <para>Threshold of 1000 </para>
17425 <para>Match Point on 020$a 1000 </para>
17426 <para>Match Point on 022$a 1000 </para>
17427 <para>Match Point on 245$a 500 </para>
17428 <para>Match Point on 100$a 100</para>
17430 <para>In the example above, a match on either the 020$a or the 022$a will result in a successful match. A match on 245$a title and 100$a author (and not on 020$a or 022$a) will only add up to 600 and not be a match. And a match on 020$a and 245$a will result in 1500 and while this is a successful match, the extra 500 point for the 245$a title match are superfluous. The incoming record successfully matched on the 020$a without the need for the 245$a match. However, if you assigned a score of 500 to the 100$a Match Point, a match on 245$a title and 100$a author will be considered a successful match (total of 1000) even if the 020$a is not a match.</para>
17432 <para>Match Checks are not commonly used in import rules. However, they can serve a couple of
17433 purposes in matching records. First, match checks can be used as the matching criteria
17434 instead of the match points if your indexes are stale and out of date. The match checks go
17435 right for the data instead of relying on the data in the indexes. (If you fear your
17436 indexes are out of date, a rebuild of your indexes would be a great idea and solve that
17437 situation!) The other use for a Match Check is as a “double check” or “veto” of your
17438 matching rule. For example, if you have a matching rule as below:</para>
17439 <para>Threshold of 1000 </para>
17440 <para>Match Point on 020$a 1000 </para>
17441 <para>Match Check on 245$a</para>
17443 <para>Koha will first look at the 020$a tag/subfield to see if the incoming record matches an existing record. If it does, it will then move on to the Match Check and look directly at the 245$a value in the incoming data and compare it to the 245$a in the existing ‘matched’ record in your catalog. If the 245$a matches, Koha continues on as if a match was successful. If the 245$a does not match, then Koha concludes that the two records are not a match after all. The Match Checks can be a really useful tool in confirming true matches.</para>
17445 <para>Match Points and Match Checks are powerful tools in the import process. Harness the power of these two matching criteria and make your data behave for you!</para>
17446 <section id="addrecordmatchrule">
17447 <title>Adding Matching Rules</title>
17448 <para>To create a new matching rule :</para>
17451 <para>Click 'New Record Matching Rule'</para>
17453 <screeninfo>Add record matching rule</screeninfo>
17456 <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
17462 <para>Choose a unique name and enter it in the 'Matching rule code' field</para>
17465 <para>'Description' can be anything you want to make it clear to you what rule
17466 you're picking</para>
17469 <para>'Match threshold' is the total number of 'points' a biblio must earn to be
17470 considered a 'match'</para>
17473 <para>'Record type' is the type of import this rule will be used for - either
17474 authority or bibliographic</para>
17477 <para>Match points are set up to determine what fields to match on</para>
17480 <para>'Search index' can be found by looking at the ccl.properties file on your
17481 system which tells the zebra indexing what data to search for in the MARC
17485 <para>'Score' - The number of 'points' a match on this field is worth. If the sum
17486 of each score is greater than the match threshold, the incoming record is a
17487 match to the existing record</para>
17490 <para>Enter the MARC tag you want to match on in the 'Tag' field</para>
17493 <para>Enter the MARC tag subfield you want to match on in the 'Subfields'
17497 <para>'Offset' - For use with control fields, 001-009</para>
17500 <para>'Length' - For use with control fields, 001-009</para>
17503 <para>Koha only has one 'Normalization rule' that removes extra characters such as
17504 commas and semicolons. The value you enter in this field is irrelevant to the
17505 normalization process.</para>
17508 <para>'Required match checks' - ??</para>
17514 <section id="samplerecordmatch">
17515 <title>Sample Bibliographic Record Matching Rule: Control Number</title>
17518 <screeninfo>LOC Matching Rule</screeninfo>
17522 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
17529 <para>Match threshold: 100</para>
17532 <para>Record type: Bibliographic<itemizedlist>
17535 <para>If you'd like a rule to match on the 001 in authority records you will
17536 need the repeat all of these values and change just the record type to
17537 'Authority record'</para>
17540 </itemizedlist></para>
17544 <para>Matchpoints (just the one):</para>
17548 <para>Search index: Control-number</para>
17552 <para>Score: 101</para>
17556 <para>Tag: 001</para>
17561 <para>this field is for the control number assigned by the
17562 organization creating, using, or distributing the
17570 <para>Subfields: a</para>
17574 <para>Offset: 0</para>
17578 <para>Length: 0</para>
17582 <para>Normalization rule: Control-number</para>
17586 <para>Required Match checks: none (remove the blank one)</para>
17589 <screeninfo>Remove match check</screeninfo>
17593 <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
17602 <section id="oaisetsconfig">
17603 <title>OAI Sets Configuration</title>
17605 <para>On this page you can create, modify and delete OAI-PMH
17608 <section id="oaicreate">
17609 <title>Create a set</title>
17611 <para>To create a set:</para>
17615 <para>Click on the link 'Add a new set'</para>
17619 <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
17623 <para>Then you can add descriptions for this set. To do this
17624 click on 'Add description' and fill the newly created text box.
17625 You can add as many descriptions as you want.</para>
17629 <para>Click on 'Save' button'</para>
17634 <section id="oaimodify">
17635 <title>Modify/Delete a set</title>
17637 <para>To modify a set, just click on the link 'Modify' on the same
17638 line of the set you want to modify. A form similar to set creation
17639 form will appear and allow you to modify the setSpec, setName and
17640 descriptions.</para>
17642 <para>To delete a set, just click on the link 'Delete' on the same
17643 line of the set you want to delete.</para>
17646 <section id="oaimapping">
17647 <title>Define mappings</title>
17649 <para>Here you can define how a set will be build (what records will
17650 belong to this set) by defining mappings. Mappings are a list of
17651 conditions on record content. A record only need to match one
17652 condition to belong to the set.</para>
17656 <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
17657 example if you want to include in this set all records that have
17658 a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
17659 and 'Value' with XXX.</para>
17663 <para>If you want to add another condition, click on 'OR' button
17664 and repeat step 1.</para>
17668 <para>Click on 'Save'</para>
17672 <para>To delete a condition, just leave at least one of 'Field',
17673 'Subfield' or 'Value' empty and click on 'Save'.<note>
17674 <para>Actually, a condition is true if value in the
17675 corresponding subfield is strictly equal to what is defined if
17676 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
17677 set where condition is 999$9 = 'XXX'.</para>
17680 <para>And it is case sensitive : a record having 999$9 = 'xxx' will
17681 not belong to a set where condition is 999$9 = 'XXX'.</para>
17684 <section id="oaibuild">
17685 <title>Build sets</title>
17687 <para>Once you have configured all your sets, you have to build the
17688 sets. This is done by calling the script
17689 misc/migration_tools/build_oai_sets.pl.</para>
17694 <section id="acqadmin">
17695 <title>Acquisitions</title>
17697 <para>The Koha Acquisitions module provides a way for the library to
17698 record orders placed with vendors and manage purchase budgets.</para>
17700 <para>Before using the <link linkend="acqmodule">Acquisitions
17701 Module</link>, you will want to make sure that you have completed all of
17706 <para><emphasis>Get there:</emphasis> More > Administration >
17707 Acquisitions</para>
17711 <section id="currexchangeadmin">
17712 <title>Currencies and Exchange Rates</title>
17714 <para>If you place orders from more than one country you will want to
17715 input currency exchange rates so that your acquisitions module will
17716 properly calculate totals.</para>
17720 <para><emphasis>Get there:</emphasis> More > Administration
17721 > Acquisitions > Currencies and Exchange Rates</para>
17726 <screeninfo>Currencies</screeninfo>
17730 <imagedata fileref="images/admin/acquisitions/currencies.png"/>
17736 <para>This data is not automatically updated, so be sure to keep it
17737 up to date so that your accounting is kept correct.</para>
17739 <para>The ISO code you enter will be used when importing MARC files via the staging tools,
17740 the tool will attempt to find and use the price of the currently active currency. </para>
17742 <para>The active currency is the main currency you use in your
17743 library. Your active currency will have a check mark in the 'Active'
17744 column. If you don't have an active currency you will see an error
17745 message telling you to choose an active currency.</para>
17748 <screeninfo>No active currency warning</screeninfo>
17752 <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
17758 <section id="budgetplanning">
17759 <title>Budgets</title>
17761 <para>Budgets are used for tracking accounting values related to
17762 acquisitions. For example you could create a Budget for the current
17763 year (ex. 2012) and then break that into <link linkend="funds">Funds</link> for different areas of the library (ex.
17764 Books, Audio, etc).</para>
17768 <para><emphasis>Get there:</emphasis> More > Administration
17769 > Acquisitions > Budgets</para>
17773 <para>When visiting the main budget administration you will see two
17774 tabs, one for active and one for inactive budgets.</para>
17777 <screeninfo>Budgets List</screeninfo>
17781 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
17786 <section id="addbudget">
17787 <title>Add a budget</title>
17789 <para>Budgets can either be created from scratch or by duplicating
17790 the previous year's budget.</para>
17792 <para>To duplicate a budget from a previous year, click on the link
17793 for the budget name from the list of budgets</para>
17796 <screeninfo>Budgets List</screeninfo>
17800 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
17805 <para>On the screen listing the budget breakdown click the Edit
17806 button at the top and choose to Duplicate budget</para>
17809 <screeninfo>Duplicate Budget</screeninfo>
17813 <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
17818 <para>You will be presented with a form where you simply need to
17819 enter the new start and end date and save the budget.</para>
17822 <screeninfo>New Duplicate Budget</screeninfo>
17826 <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
17831 <para>This will not only duplicate your budget, but all of the funds
17832 associated with that budget so that you can reuse budgets and funds
17833 from year to year.</para>
17835 <para>If you haven't used Koha before for acquisitions then you'll
17836 need to start fresh with a new budget. To add a new budget click the
17837 'New Budget' button.</para>
17840 <screeninfo>New Budget Form</screeninfo>
17844 <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
17851 <para>Choose the time period this budget is for, whether it's an
17852 academic year, a fiscal year, a quarter, etc.</para>
17856 <para>The Description should be something that will help you
17857 identify the budget when ordering</para>
17861 <para>In the amount box do not use any symbols, simply enter the
17862 amount of the budget with numbers and decimals.</para>
17866 <para>Marking a budget active makes it usable when placing
17867 orders in the acquisitions module, even if the order is placed
17868 after the budget end date. This will allow you to record orders
17869 that were places in a previous budget period.</para>
17873 <para>Locking a budget means that Funds will not be able to be
17874 modified by librarians</para>
17878 <para>Once you have made your edits, click the 'Save Changes'
17879 button. You will be brought to a list of your existing
17883 <screeninfo>List of Budgets</screeninfo>
17887 <imagedata fileref="images/admin/acquisitions/budgetlist.png"/>
17894 <section id="funds">
17895 <title>Funds</title>
17899 <para><emphasis>Get there:</emphasis> More > Administration
17900 > Acquisitions > Funds</para>
17904 <section id="addbudgetfund">
17905 <title>Add a Fund</title>
17907 <para>A fund is added to a budget.</para>
17910 <para>A <link linkend="addbudget">budget</link> must be defined
17911 before a fund can be created.</para>
17912 </important>To add a new fund click the New button and then choose
17913 which Budget you would like to add the fund to.</para>
17916 <screeninfo>Choose which budget to add a fund to</screeninfo>
17920 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
17925 <para>In the form that appears you wan to enter the basics about
17929 <screeninfo>New Fund Form</screeninfo>
17933 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
17938 <para>The three first fields are required, the rest are
17943 <para>Fund Code is a unique identifier for your fund</para>
17947 <para>The Fund Name should be something that librarians will
17952 <para>Amount should be entered with only numbers and decimals, no other
17956 <para>Warning at (%) or Warning at (amount) can be filled in to make Koha warn you
17957 before you spend a certain percentage or amount of your budget. This will prevent
17958 you from overspending.</para>
17962 <para>You can choose to assign this fund to a librarian. Doing
17963 so will make it so that only that librarian can make changes to
17968 <para>Choose which library will be using this fund</para>
17972 <para>You can restrict who can order from this fund by choosing either the 'owner',
17973 'owner and users' or 'owner, users and library' from the 'Restrict access to'
17977 <screeninfo>Restrict Fund Access</screeninfo>
17981 <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
17988 <para>Without an owner, the access restriction will be ignored, be sure to enter
17989 an owner as well as choose a restriction</para>
17996 <para>Notes are simply for any descriptive notes you might want
17997 to add so that librarians know when to use this fund</para>
18001 <para>Planning categories are used for statistical purposes. To
18002 learn more about planning categories, check out the <link linkend="planningcatfaq">Planning Category FAQ</link>.</para>
18006 <para>When complete, click 'Submit' and you will be brought to a
18007 list of all of the funds for the budget.</para>
18010 <screeninfo>List of funds</screeninfo>
18014 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
18019 <para>To the right of each fund you will find the 'Edit,' 'Delete,' and 'Add Child Fund'
18021 <para>A child fund simply a sub-fund of the fund listed. An example would be to have a
18022 fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science
18023 Fiction.' It is an optional way to further organize your finances.</para>
18024 <para>Funds with children will show with a small arrow to the left. Clicking that will
18025 show you the children funds.</para>
18027 <screeninfo>Chld funds</screeninfo>
18030 <imagedata fileref="images/admin/acquisitions/childfunds.png"/>
18036 <section id="fundsplanning">
18037 <title>Budget Planning</title>
18039 <para>When viewing the list of funds click the 'Planning' button and
18040 choose how you would like to plan to spend your budget.</para>
18043 <screeninfo>Planning pull down menu</screeninfo>
18047 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
18052 <para>If you choose 'Plan by MONTHS' you will see the budgeted
18053 amount broken down by months:</para>
18056 <screeninfo>Budget Planning Formula</screeninfo>
18060 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
18065 <para>To hide some of the columns you can click the 'hide' link to the right (or below as
18066 in the screenshot above) the dates. To add more columns you can click the 'Show a
18067 column' link found below the 'Fund Remaining' heading.</para>
18070 <screeninfo>Choose columns to add</screeninfo>
18074 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
18079 <para>From here you can plan your budget spending by manually
18080 entering values or by clicking the 'Auto-fill row' button. If you
18081 choose to auto-fill the form the system will try to divide the
18082 amount accordingly, you may have to make some edits to split things
18083 more accurately.</para>
18086 <screeninfo>Auto-filled columns</screeninfo>
18090 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
18095 <para>Once your changes are made, click the 'Save' button. If you
18096 would like to export your data as a CSV file you can do so by
18097 entering a file name in the 'Output to a file named' field and
18098 clicking the 'Output' button.</para>
18101 <screeninfo>Export planning as CSV</screeninfo>
18105 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
18113 <section id="additionaladmin">
18114 <title>Additional Parameters</title>
18118 <para><emphasis>Get there:</emphasis> More > Administration >
18119 Additional Parameters</para>
18123 <section id="z3950admin">
18124 <title>Z39.50 Servers</title>
18126 <para>Z39.50 is a client–server protocol for searching and retrieving information from
18127 remote computer databases, in short it's a tool used for copy cataloging. Using Koha you
18128 can connect to any Z39.50 target that is publicly available or that you have the log in
18129 information to and copy both bibliographic and/or authority records from that
18134 <para><emphasis>Get there:</emphasis> More > Administration
18135 > Additional Parameters > Z39.50 Servers</para>
18139 <para>Koha comes with a default list of Z39.50 targets set up that you
18140 can add to, edit or delete</para>
18143 <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
18147 <imagedata fileref="images/admin/additional/z39list.png"/>
18152 <para>To find additional targets you use IndexData's IRSpy: <ulink
18153 url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink> or the Library of
18154 Congress's List of Targets <ulink url="http://www.loc.gov/z3950/"
18155 >http://www.loc.gov/z3950/</ulink>
18158 <section id="addztarget">
18159 <title>Add a Z39.50 Target</title>
18163 <para>From the main Z39.50 page, click 'New Z39.50
18166 <screeninfo>New Z39.50 Server Form</screeninfo>
18169 <imagedata fileref="images/admin/additional/newz39.png"/>
18176 <para>'Z39.50 server' should be populated with a name that will help you identify
18177 the source (such as the library name).</para>
18180 <para>'Hostname' will be the address to the Z39.50 target.</para>
18183 <para>'Port' tells Koha what port to listen on to get results from this
18187 <para>'Userid' and 'Password' are only required for servers that are password
18191 <para>Check the 'Checked' box if you want this target to always be selected by
18195 <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
18197 <para>If this is left blank the targets will be in alphabetical
18200 </itemizedlist></para>
18203 <para>'Syntax' is the MARC flavor you use.</para>
18206 <para>'Encoding' tells the system how to read special characters.</para>
18209 <para>'Timeout' is helpful for targets that take a long while. You can set the
18210 timeout so that it doesn't keep trying the target if results aren't found in a
18211 reasonable amount of time.</para>
18214 <para>'Record type' lets you define if this is a bibliographic or an authority
18222 <section id="suggestztarget">
18223 <title>Suggested Bibliographic Z39.50 Targets</title>
18225 <para>The following targets have been used successfully by other
18226 Koha libraries (in the Americas):</para>
18230 <para>ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC</para>
18233 <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
18238 <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
18242 <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
18247 <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
18251 <para>LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB</para>
18255 <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
18260 <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
18264 <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
18268 <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</para>
18271 <para>NHUPAC 199.192.6.130:211 nh_nhupac</para>
18274 <para>OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC</para>
18277 <para>OHIOLINK olc1.ohiolink.edu:210 INNOPAC</para>
18280 <para>PUBCAT prod890.dol.state.vt.us:2300 unicorn</para>
18283 <para>SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER</para>
18286 <para>SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON</para>
18290 <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
18295 <para>TRI-UNI 129.97.129.194:7090 voyager</para>
18299 <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
18303 <section id="suggestauthz39">
18304 <title>Suggested Authority Z39.50 Targets</title>
18305 <para>The following targets have been used successfully by other Koha libraries (in the
18309 <para>LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210
18310 AuthTraining Userid: ANLEZ / Password: z39.50</para>
18313 <para>LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF </para>
18316 <para>LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF</para>
18321 <section id="didyoumean">
18322 <title>Did you mean?</title>
18323 <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters
18324 > Did you mean?</para>
18325 <para>Koha can offer 'Did you mean?' options on searches based on values in your <link linkend="catauthorities">authorities</link>. <important>
18326 <para>Did you mean? only works in the OPAC at this time. The Intranet options are here
18327 for future development.</para>
18328 </important></para>
18329 <para>Using this page you can control which options Koha gives patrons on their search results.</para>
18331 <screeninfo>Did you mean?</screeninfo>
18334 <imagedata fileref="images/admin/additional/didyoumean.png"/>
18338 <para>To turn on the 'Did you mean?' bar on your search results you need to check the box
18339 next to each plugin you would like to use. The two plugins you have to choose from are:<itemizedlist>
18341 <para>The ExplodedTerms plugin suggests that the user try searching for
18342 broader/narrower/related terms for a given search (e.g. a user searching for "New
18343 York (State)" would click the link for narrower terms if they're also interested in
18344 "New York (City)"). This is only relevant for libraries with highly hierarchical
18345 authority data. </para>
18348 <para>The AuthorityFile plugin searches the authority file and suggests the user might
18349 be interested in bibs linked to the top 5 authorities</para>
18351 </itemizedlist></para>
18352 <para>If you want one plugin to take priority over another you simply drag it above the other.</para>
18354 <screeninfo>Drag and drop options</screeninfo>
18357 <imagedata fileref="images/admin/additional/didyoumeandrag.png"/>
18361 <para>If you choose both plugins you will see several options at the top of your search results</para>
18363 <screeninfo>Both plugins</screeninfo>
18366 <imagedata fileref="images/admin/additional/didyoumeanopacexplode.png"/>
18370 <para>If you choose just the AuthorityFile you'll see just authorities.</para>
18372 <screeninfo>AuthorityFile</screeninfo>
18375 <imagedata fileref="images/admin/additional/didyoumeanopacauth.png"/>
18383 <chapter id="tools">
18384 <title>Tools</title>
18386 <para>Tools in Koha all perform some sort of action. Often many of the
18387 items listed under Tools in Koha are referred to as 'Reports' in other
18388 library management systems.</para>
18392 <para><emphasis>Get there:</emphasis> More > Tools</para>
18396 <section id="patrontools">
18397 <title>Patrons and Circulation</title>
18400 <section id="patronlists">
18401 <title>Patron lists</title>
18404 <para><emphasis>Get there:</emphasis> More > Tools > Patrons and Circulation >
18405 Patron lists</para>
18408 <para>Patron lists are a way to store a group of patrons for easy modification via the <link
18409 linkend="batchpatronmod">batch patron modification tool</link> or reporting.</para>
18411 <screeninfo>Patron lists</screeninfo>
18414 <imagedata fileref="images/tools/patronlists/patronlists.png"/>
18418 <para>To create a new list of patrons click the 'New patron list' button</para>
18420 <screeninfo>New patron list</screeninfo>
18423 <imagedata fileref="images/tools/patronlists/newpatronlist.png"/>
18427 <para>Enter a list name and save the list.</para>
18429 <screeninfo>Empty patron list</screeninfo>
18432 <imagedata fileref="images/tools/patronlists/addtopatronlist.png"/>
18436 <para>To add patrons to the list click the 'Add patron's button to the right of the list name.</para>
18438 <screeninfo>Add patron to a list</screeninfo>
18441 <imagedata fileref="images/tools/patronlists/addpatrontolist.png"/>
18445 <para>Enter the patron's name or cardnumber in the search box and click on the right result
18446 to add the patron.</para>
18448 <screeninfo>Patrons to add</screeninfo>
18451 <imagedata fileref="images/tools/patronlists/patronstoadd.png"/>
18455 <para>Once you have all of the patrons you would like to add you can click the 'Update'
18456 button to save them to the list.</para>
18458 <screeninfo>List of patrons</screeninfo>
18461 <imagedata fileref="images/tools/patronlists/patronlist.png"/>
18467 <section id="comments">
18468 <title>Comments</title>
18472 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18473 and Circulation > Comments</para>
18477 <para>All comments added by patrons via the OPAC to bibliographic
18478 records require moderation by the librarians. If there are comments
18479 awaiting moderation they will be listed on the main staff dashboard
18480 under the Tools label:</para>
18483 <screeninfo>Comments pending approval</screeninfo>
18487 <imagedata fileref="images/tools/comments/commentswaiting.png"/>
18492 <para>To moderate comments click on the notification on the main
18493 dashboard or go directly to the Comments Tool and click 'Approve' or
18494 'Delete' to the right of the comments awaiting moderation.</para>
18497 <screeninfo>Comment awaiting moderation</screeninfo>
18501 <imagedata fileref="images/tools/comments/commentmoderation.png"/>
18506 <para>If there are no comments to moderate you will see a message
18507 saying just that</para>
18510 <screeninfo>No comments to moderate</screeninfo>
18514 <imagedata fileref="images/tools/comments/nocomments.png"/>
18519 <para>You can also review and unapprove comments you have approved in
18520 the past by choosing the 'Approved comments' tab</para>
18523 <screeninfo>Approved comments</screeninfo>
18527 <imagedata fileref="images/tools/comments/commentapproved.png"/>
18533 <section id="patronimport">
18534 <title>Patron Import</title>
18538 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18539 and Circulation > Import Patrons</para>
18543 <para>The patron import tool can be used at any time to add patrons in
18544 bulk. It is commonly used in universities and schools when a new batch
18545 of students registers.</para>
18547 <section id="createpatronfile">
18548 <title>Creating Patron File</title>
18550 <para>Your Koha installation comes with a blank CSV file that you
18551 can use as a template for your patron records. If you would like to
18552 create the file yourself, make sure that your file has the following
18553 fields in this order as the header row:</para>
18555 <para>borrowernumber, cardnumber, surname, firstname, title,
18556 othernames, initials, streetnumber, streettype, address, address2,
18557 city, zipcode, country, email, phone, mobile, fax, emailpro,
18558 phonepro, B_streetnumber, B_streettype, B_address, B_address2,
18559 B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth,
18560 branchcode, categorycode, dateenrolled, dateexpiry, gonenoaddress,
18561 lost, debarred, contactname, contactfirstname, contacttitle,
18562 guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
18563 password, flags, userid, opacnote, contactnote, sort1, sort2,
18564 altcontactfirstname, altcontactsurname, altcontactaddress1,
18565 altcontactaddress2, altcontactaddress3, altcontactzipcode,
18566 altcontactcountry, altcontactphone, smsalertnumber,
18567 patron_attributes</para>
18570 <para>The 'password' value should be stored in plain text, and
18571 will be converted to a md5 hash (which is an encrypted version of
18572 the password).</para>
18576 <para>If your passwords are already encrypted, talk to your
18577 systems administrator about options</para>
18583 <para>Date formats should match your <link linkend="dateformat">system preference</link>, and must be
18584 zero-padded, e.g. '01/02/2008'.</para>
18588 <para>The fields 'branchcode' and 'categorycode' are required and
18589 must match valid entries in your database.</para>
18593 <para>If loading <link linkend="patronattributetypes">patron
18594 attributes</link>, the 'patron_attributes' field should contain a
18595 comma-separated list of attribute types and values.</para>
18599 <para>The attribute type code and a colon should precede each
18604 <para>For example: <emphasis role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis role="bold">STARTDATE:January 1
18605 2010,TRACK:Day</emphasis></para>
18609 <para>If an input record has more than one attribute, the
18610 fields should either be entered as an unquoted string
18611 (previous examples), or with each field wrapped in
18612 separate double quotes and delimited by a comma:</para>
18616 <para><emphasis role="bold">"STARTDATE:January 1,
18617 2010","TRACK:Day"</emphasis></para>
18621 <para>This syntax would be required if the data might
18622 have a comma in it, like a date string.</para>
18632 <section id="importpatrons">
18633 <title>Importing Patrons</title>
18635 <para>Once you have created your file, you can use the Patron Import
18636 Tool to bring the data into Koha.</para>
18639 <screeninfo>Import Patron Form</screeninfo>
18643 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
18650 <para>Choose your CSV file and choose to match on 'Cardnumber'
18651 to prevent adding of duplicate card numbers to the system</para>
18655 <para>Next you can choose default values to apply to all patrons
18656 you are importing</para>
18660 <para>ex. If you're importing patrons specific to one branch
18661 you can use the field on the Import form to apply the branch
18662 code to all those you are importing.</para>
18668 <para>Finally you need to decide on what data you want to
18669 replace if there are duplicates.</para>
18672 <screeninfo>Record matching options</screeninfo>
18676 <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
18683 <para>A matching record is found using the field you chose
18684 for matching criteria to prevent duplication</para>
18688 <para>If you included patron attributes in your file you can
18689 decide whether to add your values to existing values or
18690 erase existing values and enter only your new values.</para>
18698 <section id="notices">
18699 <title>Notices & Slips</title>
18703 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18704 and Circulation > Notices & Slips</para>
18708 <para>All notices and circulation receipts (or slips) generated by
18709 Koha can be customized using the Notices & Slips Tool. The system
18710 comes with several predefined templates that will appear when you
18711 first visit this tool.</para>
18714 <screeninfo>Notices & Slips Tool</screeninfo>
18718 <imagedata fileref="images/tools/notices/notices.png"/>
18723 <para>Each notice can be edited, but only a few can be deleted, this
18724 is to prevent system errors should a message try to send without a
18725 template. Each notice and slip can be edited on a per library basis,
18726 by default you will see the notices for all libraries.</para>
18728 <para>If you have a style you'd like applied to all slips you can
18729 point the <link linkend="SlipCSS">SlipCSS</link> preference to a
18730 stylesheet. The same is true for notices, using the <link linkend="NoticeCSS">NoticeCSS</link> preference to define a
18732 <para>You will also want to review the <link linkend="noticesfieldguide">Notices & Slips
18733 Field Guide</link> for more information on formatting these notices. </para>
18735 <section id="addnotices">
18736 <title>Adding Notices & Slips</title>
18738 <para>To add a new notice or slip</para>
18742 <para>Click 'New Notice'</para>
18745 <screeninfo>New Notice Form</screeninfo>
18749 <imagedata fileref="images/tools/notices/newnotice.png"/>
18756 <para>Choose which library this notice or slip is for<itemizedlist>
18759 <para>Not all notices can be branch specific for more information review the
18760 <link linkend="noticesfieldguide">Notices & Slips Field Guide</link>
18761 in this manual. </para>
18764 </itemizedlist></para>
18768 <para>Choose the module this notice is related to</para>
18772 <para>The Code is limited to 20 characters</para>
18777 <para>When working with the overdue notices you want each
18778 notice at each branch to have a unique code. Think about
18779 using the branch code in front of the notice code for each
18787 <para>Use the name field to expand on your Code</para>
18792 <para>With overdue notices, be sure to put your branch
18793 name in the description as well so that it will be visible
18794 when setting up your <link linkend="noticetriggers">triggers</link>.</para>
18801 <para>Next you can customize the notice for every possible delivery method<itemizedlist>
18803 <para>Every notice should have an Email template set for it<screenshot>
18804 <screeninfo>New Email notice</screeninfo>
18807 <imagedata fileref="images/tools/notices/newemail.png"/>
18810 </screenshot></para>
18813 <para>Next, the Feed template is not yet enabled and will do nothing at this time.<screenshot>
18814 <screeninfo>New Feed notice</screeninfo>
18817 <imagedata fileref="images/tools/notices/newfeed.png"/>
18820 </screenshot></para>
18823 <para>If you're using the <link linkend="TalkingTechItivaPhoneNotification"
18824 >TalkingTechItivaPhoneNotification</link> service you can set up a Phone notification<screenshot>
18825 <screeninfo>New Phone notice</screeninfo>
18828 <imagedata fileref="images/tools/notices/newphone.png"/>
18831 </screenshot></para>
18834 <para>If you plan on printing this notice you can set the Print template next<screenshot>
18835 <screeninfo>New Print notice</screeninfo>
18838 <imagedata fileref="images/tools/notices/newprint.png"/>
18841 </screenshot></para>
18844 <para>If you have enabled SMS notices with the <link linkend="SMSSendDriver"
18845 >SMSSendDriver</link> preference you can set the text for your SMS notices next<screenshot>
18846 <screeninfo>New SMS notice</screeninfo>
18849 <imagedata fileref="images/tools/notices/newsms.png"/>
18852 </screenshot></para>
18854 </itemizedlist></para>
18857 <para>Each notice offers you the same options<itemizedlist>
18859 <para>If you plan on writing the notice or slip in HTML check
18860 the 'HTML Message' box, otherwise the content will be generated
18861 as plain text</para>
18865 <para>Message Subject is what will appear in the subject line of
18870 <para>In the message body feel free to type whatever message you
18871 feel is best, use the fields on the left hand side to enter
18872 individualized data from the from database.</para>
18877 <para>Review the <link linkend="noticesfieldguide">Notices & Slip
18878 Field Guide</link> for info on what fields can be used here.</para>
18883 <para>Overdue notices can use <<items.content>> tags by themselves,
18884 or use <item></item> to span all of the tags. Learn more about the
18885 <link linkend="noticemarkup">Overdue Notice Markup</link></para>
18888 <para>On overdue notices make sure to use <<items.content>> tags
18889 to print out the data related to all items that are overdue.</para>
18894 <para>The other option, only for overdue notices, is to use the
18895 <item></item> tags to span the line so that it will print out
18896 multiple lines One example for the <item></item> tag option
18898 <para><item>"<<biblio.title>>" by
18899 <<biblio.author>>, <<items.itemcallnumber>>,
18900 Barcode: <<items.barcode>> , Checkout date:
18901 <<issues.issuedate>>, Due date:
18902 <<issues.date_due>> Fine: <<items.fine>> Due date:
18903 <<issues.date_due>> </item></para>
18910 <para>Only the overdue notices take advantage of the <item></item>
18911 tags, all other notices referencing items need to use
18912 <<items.content>></para>
18917 <para>To add today's date you can use the <<today>> syntax</para>
18922 </itemizedlist></para>
18926 <section id="noticemarkup">
18927 <title>Overdue Notice Markup</title>
18929 <para>When creating your overdue notices there are two tags in addition to the various
18930 database fields that you can use in your notices. You will also want to review the
18931 <link linkend="noticesfieldguide">Notices & Slips Field Guide</link> for
18932 information on formatting item information in these notices. <important>
18933 <para>These new tags only work on the overdue notices, not other circulation related
18934 notices at this time.</para>
18935 </important>These tags are <item> and </item> which should enclose all
18936 fields from the biblio, biblioitems, and items tables.</para>
18938 <para>An example of using these tags in a notice template might be like:</para>
18940 <programlisting> The following item(s) is/are currently overdue:
18942 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item></programlisting>
18944 <para>Which, assuming two items were overdue, would result in a notice
18945 like:<programlisting> The following item(s) is/are currently overdue:
18947 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
18948 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50</programlisting></para>
18952 <section id="existingnotices">
18953 <title>Existing Notices & Slips</title>
18955 <para>Among the default notices are notices for several common actions within Koha. All of
18956 these notices can be customized by altering their text via the Notices & Slips tool
18957 and their style using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
18958 define a stylesheet. You will also want to review the <link linkend="noticesfieldguide"
18959 >Notices & Slips Field Guide</link> for information on formatting item information
18960 in these notices. Here are some of what those notices do:</para>
18964 <para id="ACCTDETAILS">ACCTDETAILS</para>
18968 <para>Sent to patrons when their account is set up if the
18969 <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
18970 preference is set to 'Send'</para>
18976 <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
18980 <para>Used in the claim acquisition module</para>
18984 <para><emphasis>Get there:</emphasis> More > Acquisitions
18985 > Late issues</para>
18990 <para>CHECKIN<itemizedlist>
18992 <para>This notice is sent as the 'Check in' notice for all items that are
18996 <para>This notice is used if two criteria are met:</para>
18999 <para>The <link linkend="EnhancedMessagingPreferences"
19000 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19003 <para>The patron has requested to receive this notice</para>
19006 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19010 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19011 > <link linkend="patnotices">Notices</link></para>
19017 </itemizedlist></para>
19020 <para>CHECKOUT<itemizedlist>
19022 <para>This notice is sent as the 'Check out' notice for all items that are
19026 <para>This notice is used if two criteria are met:</para>
19029 <para>The <link linkend="EnhancedMessagingPreferences"
19030 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19033 <para>The patron has requested to receive this notice</para>
19036 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19040 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19041 > <link linkend="patnotices">Notices</link></para>
19047 </itemizedlist></para>
19050 <para>DUE<itemizedlist>
19052 <para>This notice is sent as the 'Item due' for an item is due</para>
19055 <para>This notice is used if two criteria are met:</para>
19058 <para>The <link linkend="EnhancedMessagingPreferences"
19059 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19062 <para>The patron has requested to receive this notice</para>
19065 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19069 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19070 > <link linkend="patnotices">Notices</link></para>
19076 </itemizedlist></para>
19079 <para>DUEDGST<itemizedlist>
19081 <para>This notice is sent as the 'Item due' for all items that are due</para>
19084 <para>This notice is used if two criteria are met:</para>
19087 <para>The <link linkend="EnhancedMessagingPreferences"
19088 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19091 <para>The patron has requested to receive this notice as a digest</para>
19094 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19098 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19099 > <link linkend="patnotices">Notices</link></para>
19105 </itemizedlist></para>
19109 <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
19113 <para>This notice is used if two criteria are met:</para>
19117 <para>The <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
19118 is set to 'Allow'</para>
19122 <para>The patron has requested to receive this
19127 <para><emphasis>Get there: </emphasis>OPAC >
19128 Login > my messaging</para>
19132 <para><emphasis>Get there: </emphasis>Staff Client
19133 > Patron Record > <link linkend="patnotices">Notices</link></para>
19141 <para>When this notice references the branches table it is
19142 referring to the pickup branch information.</para>
19148 <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
19149 that a hold has been placed)</para>
19153 <para>This notice requires the <link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
19154 system preference to be set to 'Enable'</para>
19158 <para>When this notice references the branches table it is
19159 referring to the pickup branch information.</para>
19165 <para id="ODUE">ODUE (Overdue Notice)</para>
19169 <para>This notice is used to send Overdue Notices to
19174 <para>See a <link linkend="samplenotice">Sample Overdue
19175 Notice</link></para>
19179 <para>Requires that you set <link linkend="noticetriggers">Overdue Notice/Status
19180 Triggers</link></para>
19185 <para>PREDUE<itemizedlist>
19187 <para>This notice is sent as the 'Advanced notice' for an item is due</para>
19190 <para>This notice is used if two criteria are met:</para>
19193 <para>The <link linkend="EnhancedMessagingPreferences"
19194 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19197 <para>The patron has requested to receive this notice</para>
19200 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19204 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19205 > <link linkend="patnotices">Notices</link></para>
19211 </itemizedlist></para>
19214 <para>PREDUEDGST<itemizedlist>
19216 <para>This notice is sent as the 'Advanced notice' for all items that are
19220 <para>This notice is used if two criteria are met:</para>
19223 <para>The <link linkend="EnhancedMessagingPreferences"
19224 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19227 <para>The patron has requested to receive this notice as a digest</para>
19230 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19234 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19235 > <link linkend="patnotices">Notices</link></para>
19241 </itemizedlist></para>
19244 <para>RENEWAL<itemizedlist>
19246 <para>This notice is sent as the 'Check out' notice for all items that are
19250 <para>This notice is used if three criteria are met:</para>
19253 <para>The <link linkend="EnhancedMessagingPreferences"
19254 >EnhancedMessagingPreferences</link> is set to 'Allow'</para>
19257 <para>The <link linkend="RenewalSendNotice">RenewalSendNotice</link>
19258 preference is set to 'Send'</para>
19261 <para>The patron has requested to receive the checkout notice</para>
19264 <para><emphasis>Get there: </emphasis>OPAC > Login > my
19268 <para><emphasis>Get there: </emphasis>Staff Client > Patron Record
19269 > <link linkend="patnotices">Notices</link></para>
19275 </itemizedlist></para>
19279 <para id="RLIST">RLIST (Routing List)</para>
19283 <para>Used in the serials module to notify patrons/staff of
19284 new issues of a serial</para>
19288 <para><emphasis>Get there:</emphasis> More > Serials
19289 > <link linkend="newsubscription">New
19290 Subscription</link></para>
19296 <para>You have the option to select the 'Routing List'
19297 notice when creating a new subscription (Choose from the
19298 'Patron notification' drop down).</para>
19303 <para>Notice also that if you'd like to notify patrons of
19304 new serial issues, you can click on 'define a notice'
19305 which will take you to the 'Notices' tool</para>
19311 <para>SHARE_ACCEPT<itemizedlist>
19313 <para>Used to notify a patron when another patron has accepted their shared
19317 <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
19318 >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
19320 </itemizedlist></para>
19323 <para>SHARE_INVITE <itemizedlist>
19325 <para>Used to notify a patron that another patron would like to share a list
19329 <para>Requires that you set <link linkend="OpacAllowSharingPrivateLists"
19330 >OpacAllowSharingPrivateLists</link> to 'Allow'</para>
19332 </itemizedlist></para>
19336 <para>There are also a set of predefined slips (or receipts) listed
19337 on this page. All of these slips can be customized by altering their
19338 text via the Notices & Slips tool and their style using the
19339 <link linkend="SlipCSS">SlipCSS</link> preference to define a
19340 stylesheet. Here is what those slips are used for:</para>
19344 <para>ISSUEQSLIP</para>
19348 <para>Used to print the quick slip in circulation</para>
19352 <para>The quick slip only includes items that were checked
19359 <para>ISSUESLIP</para>
19363 <para>Used to print a full slip in circulation</para>
19367 <para>The slip or receipt will show items checked out today
19368 as well as items that are still checked out</para>
19374 <para>RESERVESLIP</para>
19378 <para>Used to print a holds slip</para>
19382 <para>The holds slip is generated when a hold is
19388 <para>TRANSFERSLIP</para>
19391 <para>Used to print a transfer slip</para>
19394 <para>The transfer slip is printed when you confirm a transfer from one branch to
19395 another in your system</para>
19403 <section id="noticetriggers">
19404 <title>Overdue Notice/Status Triggers</title>
19408 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19409 and Circulation > Overdue Notice/Status Triggers</para>
19413 <para>In order to send the overdue notices that you defined using the
19414 <link linkend="notices">Notices</link> tool, you need to first set the
19415 triggers to have these messages.</para>
19418 <para>In order to have overdue notices sent to your patrons, you
19419 need to <link linkend="addingpatroncat">set that patron
19420 category</link> to require overdue notices.</para>
19423 <para>The Overdue Notice/Status Triggers tool gives the librarian the
19424 power to send up to three notices to each patron type notifying them
19425 of overdue items</para>
19428 <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
19432 <imagedata fileref="images/tools/triggers.png"/>
19439 <para>Delay is the number of days after an issue is due before an
19440 action is triggered.</para>
19445 <para>If you want Koha to trigger an action (send a letter
19446 or restrict member), a delay value is required.</para>
19453 <para>To send additional notices, click on the tabs for 'Second'
19454 and 'Third' notice</para>
19458 <para>If you would like to prevent a patron from checking items out because of their
19459 overdue items, check the 'Restrict' box, this will put a notice on the patron's record
19460 at checkout informing the librarian that the patron cannot check out due to overdue items.<itemizedlist>
19462 <para>If you choose to restrict a patron in this way you can also have Koha
19463 automatically remove that restriction with the <link
19464 linkend="AutoRemoveOverduesRestrictions">AutoRemoveOverduesRestrictions</link>
19467 </itemizedlist></para>
19471 <para>Next you can choose the delivery method for the overdue notice. You can choose
19472 from Email, Phone (if you are using the <link
19473 linkend="TalkingTechItivaPhoneNotification">iTiva Talking Tech service</link>),
19474 Print and SMS (if you have set your <link linkend="SMSSendDriver"
19475 >SMSSendDriver</link>). <itemizedlist>
19478 <para>The Feed option is not yet a feature in Koha, it is there for future
19479 development.</para>
19482 </itemizedlist></para>
19485 <para>See a <link linkend="samplenotice">Sample Overdue Notice</link></para>
19490 <section id="patroncardcreator">
19491 <title>Patron Card Creator</title>
19495 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19496 and Circulation > Patron Card Creator</para>
19500 <para>The Patron Card Creator allow you to use layouts and templates
19501 which you design to print a nearly unlimited variety of patron cards
19502 including barcodes. Here are some of the features of the Patron Card
19503 Creator module:</para>
19507 <para>Customize patron card layouts</para>
19511 <para>Design custom card templates for printed patron cards</para>
19515 <para>Build and manage batches of patron cards</para>
19519 <para>Export single or multiple batches</para>
19523 <para>Export single or multiple patron cards from within a
19528 <para>Export card data as a PDF readable by any standard PDF
19529 reader, making patron cards printable directly on a printer</para>
19533 <para>At the top of each screen within the Patron Card Creator, you
19534 will see a toolbar allowing quick access to relevant functions. The
19535 menu to the left of each screen also allows easy access to the
19536 different sections of the Patron Card Creator. The bread crumb trail
19537 near the top of each screen will give specific indication as to where
19538 you are within the Patron Card Creator module and allow quick
19539 navigation to previously traversed sections. And finally, you can find
19540 more detailed information on each section of the Patron Card Creator
19541 by clicking the online help link at the upper left-hand corner of
19544 <section id="patrontemplate">
19545 <title>Templates</title>
19549 <para><emphasis>Get there:</emphasis> More > Tools >
19550 Patron Card Creator > Templates</para>
19554 <para>A template is the label/card stock you are using. This might
19555 be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
19556 Avery 28371 for your patron cards, just to give a couple of
19557 examples. These labels will include all of the information you will
19558 need for setting up a Koha, this information may be on the
19559 packaging, and if not it can usually be found on the vendor's
19562 <section id="addcardtemplate">
19563 <title>Add a Template</title>
19565 <para>To add a new template, you want to click on the 'Templates'
19566 button at the top of your page and choose 'New Template'</para>
19569 <screeninfo>New Template Button</screeninfo>
19573 <imagedata fileref="images/tools/patroncards/newtemplate.png"/>
19578 <para>Using the form that appears you can define the template for
19579 your sheet of labels or cards.</para>
19582 <screeninfo>Add Patron Card Template</screeninfo>
19586 <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
19593 <para>Template ID will be automatically generated after saving
19594 your template, this is simply a system generated unique
19599 <para>Template Code should be something you can use to
19600 identify your template on a list of templates</para>
19604 <para>You can use the Template Description to add additional
19605 information about the template</para>
19609 <para>The Units pull down is used to define what measurement
19610 scale you're going to be using for the template. This should
19611 probably match the unit of measurement used on the template
19612 description provided by the product vendor.</para>
19615 <screeninfo>Measurement Units</screeninfo>
19619 <imagedata fileref="images/tools/patroncards/units.png"/>
19626 <para>The measurements can be found on the vendor product
19627 packaging or website.</para>
19631 <para>A profile is a set of "adjustments" applied to a given
19632 template just prior to printing which compensates for
19633 anomalies unique and peculiar to a given printer (to which the
19634 profile is assigned).</para>
19638 <para>Before picking a profile try printing some sample
19639 cards so that you can easily define a profile that is
19640 right for your printer/template combination.</para>
19644 <para>After finding any anomalies in the printed document,
19645 <link linkend="addcardprofile">create a profile</link> and
19646 assign it to the template.</para>
19652 <para>After saving, your templates will appear on the 'Manage
19653 Templates' page.</para>
19656 <screeninfo>Manage Templates</screeninfo>
19660 <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
19667 <section id="patronprofile">
19668 <title>Profiles</title>
19672 <para><emphasis>Get there:</emphasis> More > Tools >
19673 Patron Card Creator > Profiles</para>
19677 <para>A profile is a set of "adjustments" applied to a given <link linkend="patrontemplate">template</link> just prior to printing
19678 which compensates for anomalies unique and peculiar to a given
19679 printer (to which the profile is assigned). This means if you set a
19680 template up and then print a sample set of data and find that the
19681 items are not all aligned the same on each card, you need to set up
19682 a profile for each printer to make up for the differences in
19683 printing styles, such as the shifting of text to the left, right,
19684 top or bottom.</para>
19686 <para>If your cards are printing just the way you want, you will not
19687 need a profile.</para>
19689 <section id="addcardprofile">
19690 <title>Add a Profile</title>
19692 <para>To add a new profile, you want to click on the 'Profiles'
19693 button at the top of your page and choose 'New Profile'</para>
19696 <screeninfo>New Profile Button</screeninfo>
19700 <imagedata fileref="images/tools/patroncards/newprofile.png"/>
19705 <para>Using the form that appears you can create a profile to fix
19706 any problems with your template.</para>
19709 <screeninfo>Add Printer Profile</screeninfo>
19713 <imagedata fileref="images/tools/patroncards/addprofile.png"/>
19720 <para>The Printer Name and Paper Bin do not have to match your
19721 printer exactly, they are for your reference so you can
19722 remember what printer you have set the profile for. So if you
19723 want to use the Printer model number in printer name or you
19724 can call it 'the printer on my desk'</para>
19728 <para>Template will be filled in once you have chosen which
19729 template to apply the profile to on the <link linkend="addcardtemplate">template edit form</link></para>
19733 <para>The Units pull down is used to define what measurement
19734 scale you're going to be using for your profile.</para>
19737 <screeninfo>Units of Measurement</screeninfo>
19741 <imagedata fileref="images/tools/patroncards/units.png"/>
19748 <para>Offset describes what happens when the entire image is
19749 off center either vertically or horizontally and creep
19750 describes a condition where the distance between the labels
19751 changes across the page or up and down the page</para>
19755 <para>For these values, negative numbers move the error up
19756 and to the left and positive numbers move the error down
19757 and to the right</para>
19761 <para>Example: the text is .25" from the left edge of the
19762 first label, .28" from the left edge of the second label
19763 and .31" from the left edge of the third label. This means
19764 the horizontal creep should be set to .03" to make up for
19765 this difference.</para>
19771 <para>After saving, your profiles will appear on the 'Manage
19772 Profiles' page.</para>
19775 <screeninfo>Manage Profiles</screeninfo>
19779 <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
19784 <para>Once you have saved your new profile, you can return to the
19785 list of templates and choose to edit the template that this
19786 profile is for.</para>
19790 <section id="cardlayouts">
19791 <title>Layouts</title>
19795 <para><emphasis>Get there:</emphasis> More > Tools >
19796 Patron Card Creator > Layouts</para>
19800 <para>A layout defines the text and images that will be printed on
19801 to the card and where it will appear.</para>
19803 <section id="addcardlayout">
19804 <title>Add a Layout</title>
19806 <para>To add a new layout, you want to click on the 'Layouts'
19807 button at the top of your page and choose 'New Layout'</para>
19810 <screeninfo>New Layout Button</screeninfo>
19814 <imagedata fileref="images/tools/patroncards/newlayout.png"/>
19819 <para>Using the form that appears you can create a profile to fix
19820 any problems with your template.</para>
19823 <screeninfo>Add New Layout</screeninfo>
19827 <imagedata fileref="images/tools/patroncards/addlayout.png"/>
19834 <para>The name you assign to the layout is for your benefit,
19835 name it something that will be easy to identify at a later
19840 <para>The Units pull down is used to define what measurement
19841 scale you're going to be using for your layout.</para>
19844 <screeninfo>Units of Measurement</screeninfo>
19848 <imagedata fileref="images/tools/patroncards/units.png"/>
19855 <para>Next note if this layout is for the front or the back of
19856 the patron card</para>
19860 <para>You will need a layout for both the front and back
19861 of your card if you have 2-sided library cards</para>
19867 <para>You have the option of adding up to 3 lines of text to
19868 your card. Your text can be static text of your choosing
19869 and/or fields from the patron record. If you want to print
19870 fields from the patron record you want to put the field names
19871 in brackets like so - <firstname></para>
19875 <para>For each line of text, you can choose your font, font
19876 size and the location of the text on the card using the lower
19877 X and Y coordinates</para>
19881 <para>In order to show the barcode and the patron card number
19882 you will need to check the 'Print Card Number as Barcode'
19883 option. This will turn the patron card number into a barcode.
19884 If you want the number to print in human readable format you
19885 will need to check the 'Print Card Number as Text Under
19886 Barcode' option.</para>
19890 <para>Finally you can choose up to two images to print on the
19895 <para>One can be the <link linkend="uploadpatronimages">patron image</link> which you
19896 can resize to meet your needs.</para>
19900 <para>The other image can be something like a library logo
19901 or symbol that you uploaded using the '<link linkend="managecardimages">Manage Images</link>' module of
19902 the Patron Card Creator Tool.</para>
19908 <para>After saving, your layouts will appear on the 'Manage
19909 Layouts' page.</para>
19912 <screeninfo>Manage Layouts</screeninfo>
19916 <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
19923 <section id="patroncardbatches">
19924 <title>Batches</title>
19928 <para><emphasis>Get there:</emphasis> More > Tools >
19929 Patron Card Creator > Batches</para>
19933 <para>A batch is a collection of patrons for whom you want to
19934 generate cards.</para>
19936 <section id="addcardbatch">
19937 <title>Add a Batch</title>
19939 <para>To add a new batch, you want to click on the 'Batches'
19940 button at the top of your page and choose 'New Batch'</para>
19943 <screeninfo>New Batch Button</screeninfo>
19947 <imagedata fileref="images/tools/patroncards/newbatch.png"/>
19956 <section id="managecardimages">
19957 <title>Manage Images</title>
19961 <para><emphasis>Get there:</emphasis> More > Tools >
19962 Patron Card Creator > Manage Images</para>
19966 <para>Images uploaded using this tool will appear on the menu when
19967 creating <link linkend="cardlayouts">patron card layouts</link>. You
19968 are limited in how many images you can upload (not counting patron
19969 images) by the <link linkend="ImageLimit">ImageLimit</link> system
19973 <para>Images must be under 500k in size.</para>
19977 <para>Pictures uploaded with this tool should be at least 300dpi
19978 which is the minimum quality for a printable image.</para>
19981 <para>In the center of the screen is a simple upload form, simply
19982 browse for the file on your computer and give it a name you'll
19983 recognize later.</para>
19986 <screeninfo>Upload Images</screeninfo>
19990 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
19995 <para>Once the file is uploaded you will be presented with a
19996 confirmation message.</para>
19999 <screeninfo>Image Uploaded</screeninfo>
20003 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
20008 <para>And the image will be listed with all of your others on the
20009 right hand side of the page.</para>
20012 <screeninfo>Images</screeninfo>
20016 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
20021 <para>To delete one or multiple of these images, click the checkbox
20022 to the right of each image you want to delete and click the 'Delete'
20027 <section id="anonpatrons">
20028 <title>Patrons (anonymize, bulk-delete)</title>
20032 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20033 and Circulation > Patrons (anonymize, bulk-delete)</para>
20036 <para>This tool allows you to bulk anonymize circulation histories (this means that you keep
20037 records of how many times items were checked out - but not the patrons who checked the
20038 items out) or bulk delete patrons (remove them from the system completely).<important>
20039 <para>Patrons with outstanding fines or items checked out are not saved. They are not
20040 completely removed from the system (they are only moved to the delete_borrowers
20041 table), but this tool does not provide as many checks as one may desire.</para>
20042 </important></para>
20044 <para>Before using this tool it is recommended that you backup your database. Changes made
20045 here are permanent.</para>
20048 <para>The anonymization will fail quietly if <link linkend="AnonymousPatron">AnonymousPatron</link> preference does not contain a valid value.</para>
20052 <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
20056 <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
20061 <para>To either delete or anonymize patrons</para>
20065 <para>Check the 'Verify' box on the task you would like to complete (Delete or
20070 <para>Enter a date before which you want to alter the data</para>
20073 <para>If deleting patrons you can also choose to find patrons with a specific expiration
20074 date or category</para>
20078 <para>Click 'Next'</para>
20082 <para>A confirmation will appear asking if you're sure this is
20083 what you want to happen</para>
20086 <screeninfo>Patron Anonymize/Bulk Delete
20087 Confirmation</screeninfo>
20091 <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
20098 <para>Clicking 'Finish' will delete or anonymize your data</para>
20101 <screeninfo>Completed Process</screeninfo>
20105 <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
20113 <section id="batchpatronmod">
20114 <title>Batch patron modification</title>
20118 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20119 and Circulation > Batch patron modification</para>
20123 <para>With this tool you can make edits to a batch of patron records. Simply load in a file
20124 of cardnumbers (one per line), choose from a <link linkend="patronlists">list of
20125 patrons</link> or scan patron card numbers in to the box provided.</para>
20128 <screeninfo>Batch patron modification</screeninfo>
20132 <imagedata fileref="images/tools/batchpatron/batchmodify.png"/>
20137 <para>Once you have the file loaded or the barcodes scanned click
20138 'Continue.' You will be presented with a list of the patrons and the
20139 changes you can make.</para>
20142 <screeninfo>Patrons to modify</screeninfo>
20146 <imagedata fileref="images/tools/batchpatron/modifyform.png"/>
20151 <para>To the left of each text box there is a checkbox. Clicking that
20152 checkbox will clear our the field values. <important>
20153 <para>If the field is mandatory you will not be able to clear the
20154 value in it.</para>
20155 </important></para>
20157 <para>If you have multiple patron attributes you can change them all
20158 by using the plus (+) sign to the right of the text box. This will
20159 allow you to add another attribute value.</para>
20162 <screeninfo>Editing patron attributes</screeninfo>
20166 <imagedata fileref="images/tools/batchpatron/attributes.png"/>
20171 <para>Once you have made the changes you want, you can click 'Save'
20172 and Koha will present you with the changed patron records.</para>
20175 <section id="tagsmoderation">
20176 <title>Tag Moderation</title>
20180 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20181 and Circulation > Tags</para>
20185 <para>Depending on your <link linkend="taggingprefs">tagging system preferences</link>,
20186 librarians may need to approve tags before they are published on the OPAC. This is done
20187 via the Tag Moderation Tool. If there are tags awaiting moderation they will be listed on
20188 the main staff dashboard under the module labels:</para>
20191 <screeninfo>Tags pending approval</screeninfo>
20195 <imagedata fileref="images/tools/tagging/pendingtags.png"/>
20200 <para>To moderate the tags visit the Tags tool. When first visiting
20201 the tool, you will be presented with a list of tags that are pending
20202 approval or rejection by a librarian</para>
20205 <screeninfo>Tags pending moderation</screeninfo>
20209 <imagedata fileref="images/tools/tagging/tagpending.png"/>
20216 <para>To see all of the titles this tag was added to simply click on the term<screenshot>
20217 <screeninfo>Titles with a specific tag</screeninfo>
20220 <imagedata fileref="images/tools/tagging/taggedtitles.png"/>
20223 </screenshot><itemizedlist>
20225 <para>From this list of titles you can remove a tag without outright rejecting it
20226 from being used in the future by clicking the 'Remove tag' button to the right
20227 of the title.</para>
20229 </itemizedlist></para>
20232 <para>To approve a tag, you can either click the 'Approve' button in line with the term,
20233 or check all terms you want to approve and click 'Approve' below the table.</para>
20237 <para>To reject a tag, you can either click the 'Reject' button in
20238 line with the term, or check all terms you want to approve and
20239 click 'Reject' below the table.</para>
20243 <para>Once a tag has been approved or rejected it will be moved to the
20244 appropriate list of tags. A summary of all tags will appear on the
20245 right of the screen.</para>
20248 <screeninfo>Summary of tags</screeninfo>
20252 <imagedata fileref="images/tools/tagging/tagsummary.png"/>
20257 <para>Even though a tag is approved or rejected, it can still be moved
20258 to another list. When viewing approved tags each tag has the option to
20262 <screeninfo>Approved Tags</screeninfo>
20266 <imagedata fileref="images/tools/tagging/tagapproved.png"/>
20271 <para>To check terms against the approved and rejected lists (and
20272 possibly against <link linkend="TagsExternalDictionary">the
20273 dictionary</link> you have assigned for tag moderation) simply enter
20274 the term into the search box on the bottom right of the screen to see
20275 the status of the term</para>
20278 <screeninfo>Sample Check list test search</screeninfo>
20282 <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
20286 <para>Finally you can find tags by using the filters on the left.</para>
20288 <screeninfo>Tag filters</screeninfo>
20291 <imagedata fileref="images/tools/tagging/tagfilters.png"/>
20297 <section id="uploadpatronimages">
20298 <title>Upload Patron Images</title>
20302 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
20303 and Circulation > Upload Patron Images</para>
20307 <para>Patron images can be uploaded in bulk if you are <link linkend="patronimages">allowing patron images</link> to be attached to
20308 patron records. These images can also be used when creating <link linkend="patroncardcreator">patron cards</link>.</para>
20312 <para>Create a txt file and title it "DATALINK.TXT" or
20313 "IDLINK.TXT"</para>
20317 <para>On each line in the text file enter the patron's card number
20318 followed by comma (or tab) and then the image file name</para>
20321 <screeninfo>Sample file and image</screeninfo>
20325 <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
20332 <para>Make sure that your TXT file is a plain text document,
20339 <para>Zip up the text file and the image files</para>
20343 <para>Go to the Upload Patron Images Tool</para>
20346 <screeninfo>Upload Image Tool for Single Image</screeninfo>
20350 <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
20357 <para>For a single image, simply point to the image file and enter
20358 the patron card number</para>
20362 <para>For multiple images, choose to upload a zip file</para>
20366 <para>After uploading you will be presented with a
20367 confirmation</para>
20370 <screeninfo>Image Upload Confirmation</screeninfo>
20374 <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
20382 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
20383 that the image be 200x300 pixels, but smaller images will work as well.</para>
20388 <section id="catalogtools">
20389 <title>Catalog</title>
20393 <section id="batchmodifyitems">
20394 <title>Batch item modification</title>
20398 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20399 > Batch item modification</para>
20403 <para>This tool will allow you to modify a batch of item records in
20407 <screeninfo>Batch Modification Tool</screeninfo>
20411 <imagedata fileref="images/tools/batchmod/batchmod.png"/>
20416 <para>From the tool you can choose to upload a file of barcodes or item ids, or you can scan
20417 items one by one into the box below the upload tool. You can also decide the items edited
20418 should be populated with the default values you have defined in your <link
20419 linkend="marcbibframeworks">default framework</link>.</para>
20420 <para>Once you have your file uploaded or the barcodes listed you can click
20424 <screeninfo>Batch Modify Summary</screeninfo>
20428 <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
20433 <para>You will be presented with a summary of the items you want to modify. From here you
20434 can uncheck the items you don't want to modify before making changes in the form below.
20435 You can also hide columns you don't need to see to prevent having to scroll from left to
20436 right to see the entire item form.<tip>
20437 <para>To uncheck all items thar are currently checked out you can click the 'Clear on
20438 loan' link at the top of the form.</para>
20441 <para>Using the edit form you can choose which fields to make edits
20442 to. By checking the checkbox to the right of each field you can clear
20443 the values in that field for the records you are modifying.</para>
20446 <screeninfo>Choose fields you want to change in bulk</screeninfo>
20450 <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
20455 <para>Once you have made you changes you will be presented with the
20456 resulting items.</para>
20459 <screeninfo>Item results summary</screeninfo>
20463 <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
20469 <para>You can also edit items on one bib record in a batch by going
20470 to the bib record and clicking Edit > Edit items in batch</para>
20474 <screeninfo>Edit items in a batch</screeninfo>
20478 <imagedata fileref="images/tools/batchmod/editinbatch.png"/>
20484 <section id="batchdeleteitems">
20485 <title>Batch item deletion</title>
20489 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20490 > Batch item deletion</para>
20494 <para>This tool will allow you to delete a batch of item records from
20497 <para>From the tool you can choose to upload a file of barcodes or
20498 item ids, or you can scan items one by one into the box below the
20499 upload tool.</para>
20502 <screeninfo>Batch Deletion Tool</screeninfo>
20506 <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
20511 <para>Once you have your file uploaded or the barcodes scanned you can
20512 click 'Continue.'</para>
20514 <para>You will be presented with a confirmation screen. From here you can uncheck the items
20515 you don't want to delete and decide if Koha should delete the bib record if the last item
20516 is being deleted before clicking 'Delete selected items.' If you'd like you can delete
20517 the bibliogrphic record if you're deleting the last item by clicking the checkbox next to
20518 'Delete records if no items remain'.</para>
20521 <screeninfo>Confirm Deletion</screeninfo>
20525 <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
20530 <para>If your file (or list of scanned barcodes) has more than 1000
20531 barcodes, Koha will be unable to present you with a list of the items.
20532 You will still be able to delete them, but not able to choose which
20533 items specifically to delete or delete the biblio records.</para>
20536 <screeninfo>More than 1000 records in the file</screeninfo>
20540 <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
20545 <para>If the items are checked out you will be presented with an error
20546 after clicking 'Delete selected items' and the items will not be
20550 <screeninfo>Items not Deleted</screeninfo>
20554 <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
20559 <para>If the items can be deleted they will be and you will be
20560 presented with a confirmation of your deletion.</para>
20563 <screeninfo>Batch Deletion Confirmation</screeninfo>
20567 <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
20573 <section id="exportbibs">
20574 <title>Export Data (MARC & Authorities)</title>
20578 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20579 > Export Data</para>
20583 <para>Koha comes with a tool that will allow you to export your
20584 bibliographic, holdings and/or authority data in bulk. This can be
20585 used to send your records to fellow libraries, organizations or
20586 services; or simply for backup purposes.</para>
20588 <section id="exportmarc">
20589 <title>Export Bibliographic Records</title>
20591 <para>At the top of the screen you need to pick what data you're
20592 exporting. If you're exporting bibliographic records with or without
20593 the holdings information you want to click the 'Export bibliographic
20594 records' tab.</para>
20598 <para>Fill in the form in order to limit your export to a
20599 specific range (all fields are optional)</para>
20602 <screeninfo>Select Records to Export</screeninfo>
20606 <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
20613 <para>Choose to limit your export by any one or more of the
20614 following options</para>
20618 <para>Limit to a bib number range</para>
20622 <para>Limit to a specific item type<itemizedlist>
20625 <para>This limit will use the type you have defined in the <link
20626 linkend="item-level_itypes">item-level_itypes</link> preference.
20627 If you have the item-level_itypes preference set to 'specific item'
20628 and you have no items attached to a bib record it will not be
20629 exported. To get all bib records of a specific type you will need
20630 your item-level_itypes preference set to 'biblio record'.</para>
20633 </itemizedlist></para>
20637 <para>Limit to a specific library</para>
20641 <para>Limit to a call number range</para>
20645 <para>Limit to an acquisition date range</para>
20651 <para>Next choose what to skip when exporting</para>
20654 <screeninfo>Export options</screeninfo>
20658 <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
20665 <para>By default items will be exported, if you would
20666 like to only export bibliographic data, check the 'Don't
20667 export items' box</para>
20671 <para>To limit your export only to items from the
20672 library you're logged in as (if you leave the 'Library'
20673 field set to 'All') or to the library you selected above
20674 check the 'Remove non-local items' box</para>
20678 <para>You can also choose what fields you don't want to
20679 export. This can be handy if you're sharing your data,
20680 you can remove all local fields before sending your data
20681 to another library</para>
20687 <para>Finally choose the file type and file name</para>
20690 <screeninfo>File export format</screeninfo>
20694 <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
20701 <para>Choose to export your data in marc or marcxml
20706 <para>Choose the name you want your file to save
20713 <para>Click 'Export bibliographic records'</para>
20720 <section id="exportauthority">
20721 <title>Export Authority Records</title>
20723 <para>At the top of the screen you need to pick what data you're
20724 exporting. If you're exporting authority records you want to click
20725 the 'Export authority records' tab.</para>
20729 <para>Fill in the form in order to limit your export to a
20730 specific range or type of authority record (all fields are
20734 <screeninfo>Export authorities</screeninfo>
20738 <imagedata fileref="images/tools/exportmarc/authexport-pt1.png"/>
20745 <para>Next choose fields that you would like to exclude from the
20746 export separated by a space (no commas)</para>
20749 <screeninfo>Authority export options</screeninfo>
20753 <imagedata fileref="images/tools/exportmarc/authexport-pt2.png"/>
20760 <para>If you'd like to exclude all subfields of the 200 for
20761 example just enter 200</para>
20765 <para>If you'd like to exclude a specific subfield enter it
20766 beside the field value 100a will exclude just the subfield
20767 'a' of the 100</para>
20773 <para>Finally choose the file type and file name</para>
20776 <screeninfo>Export format</screeninfo>
20780 <imagedata fileref="images/tools/exportmarc/authexport-pt3.png"/>
20787 <para>Choose to export your data in marc or marcxml
20792 <para>Choose the name you want your file to save as</para>
20798 <para>Click 'Export authority records'</para>
20804 <section id="inventory">
20805 <title>Inventory/Stocktaking</title>
20809 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20810 > Inventory/Stocktaking</para>
20814 <para>Koha's Inventory Tool can be used in one of two ways, the first
20815 is by printing out a shelf list that you can then mark items off on,
20816 or by uploading a text files of barcodes gathered by a portable
20819 <para>If you do not have the ability to use your barcode scanner on
20820 the floor of the library, the first option available to you is to
20821 generate a shelf list based on criteria you enter.</para>
20824 <screeninfo>Inventory & Stocktaking Tool</screeninfo>
20828 <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
20833 <para>Choose which library, shelving location, call number range, item
20834 status and when the item was last seen to generate a shelf list that
20835 you can then print to use while walking around the library checking
20836 your collection</para>
20839 <screeninfo>Shelf List</screeninfo>
20843 <imagedata fileref="images/tools/inventory/shelflist.png"/>
20848 <para>Alternatively you can export the list to a CSV file for altering
20849 in an application on your desktop. Simply check the box next to
20850 'Export to csv file' to generate this file.</para>
20852 <para>Once you have found the items on your shelves you can return to
20853 this list and check off the items you found to have the system update
20854 the last seen date to today.</para>
20856 <para>If you have a portable scanner (or a laptop and USB scanner) you
20857 can walk through the library with the scanner in hand and scan
20858 barcodes as you come across them. Once finished you can then upload
20859 the text file generated by the scanner to Koha</para>
20862 <screeninfo>Barcode Import for Inventory Tool</screeninfo>
20866 <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
20871 <para>Choose the text file and the date you want to mark all items as seen and then scroll
20872 to the very bottom and click 'Submit.'</para>
20875 <section id="labelcreator">
20876 <title>Label Creator</title>
20880 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20881 > Label Creator</para>
20885 <para>The Label Creator allow you to use layouts and templates which
20886 you design to print a nearly unlimited variety of labels including
20887 barcodes. Here are some of the features of the Label Creator
20892 <para>Customize label layouts</para>
20896 <para>Design custom label templates for printed labels</para>
20900 <para>Build and manage batches of labels</para>
20904 <para>Export single or multiple batches</para>
20908 <para>Export single or multiple labels from within a batch</para>
20912 <para>Export label data in one of three formats:</para>
20916 <para>PDF - Readable by any standard PDF reader, making labels
20917 printable directly on a printer</para>
20921 <para>CSV - Export label data after your chosen layout is
20922 applied allowing labels to be imported in to a variety of
20923 applications</para>
20927 <para>XML - Included as an alternate export format</para>
20933 <para>At the top of each screen within the Label Creator, you will see
20934 a toolbar allowing quick access to relevant functions. The menu to the
20935 left of each screen also allows easy access to the different sections
20936 of the Label Creator. The bread crumb trail near the top of each
20937 screen will give specific indication as to where you are within the
20938 Label Creator module and allow quick navigation to previously
20939 traversed sections. And finally, you can find more detailed
20940 information on each section of the Label Creator by clicking the
20941 online help link at the upper left-hand corner of every page.</para>
20943 <section id="labeltemplates">
20944 <title>Templates</title>
20948 <para><emphasis>Get there:</emphasis> More > Tools > Label
20949 Creator > Templates</para>
20953 <para>A template is based on the label/card stock you are using.
20954 This might be Avery 5160 for address labels, Gaylord 47-284 for
20955 spine labels or Avery 28371 for your patron cards, just to give a
20956 couple of examples. These labels will include all of the information
20957 you will need for setting up a Koha, this information may be on the
20958 packaging, and if not it can usually be found on the vendor's
20961 <section id="addlabeltemplate">
20962 <title>Add a Template</title>
20964 <para>To add a new template, you want to click on the 'New template' button at the top
20965 of the Label Creator.</para>
20968 <screeninfo>New Label Template Option</screeninfo>
20972 <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
20977 <para>Using the form that appears you can define the template for
20978 your sheet of labels or cards.</para>
20981 <screeninfo>Label Template Form</screeninfo>
20985 <imagedata fileref="images/tools/labelcreator/labelform.png"/>
20992 <para>Template ID will be automatically generated after saving
20993 your template, this is simply a system generated unique
20998 <para>Template Code should be something you can use to
20999 identify your template on a list of templates</para>
21003 <para>You can use the Template Description to add additional
21004 information about the template</para>
21008 <para>The Units pull down is used to define what measurement
21009 scale you're going to be using for the template. This should
21010 probably match the unit of measurement used on the template
21011 description provided by the product vendor.</para>
21014 <screeninfo>Measurement Units</screeninfo>
21018 <imagedata fileref="images/tools/patroncards/units.png"/>
21025 <para>The measurements, number of columns and number of rows
21026 can be found on the vendor product packaging or
21032 <para>If you do not supply a left text margin in the
21033 template, a 3/16" (13.5 point) left text margin will
21034 apply by default.</para>
21041 <para>A profile is a set of "adjustments" applied to a given
21042 template just prior to printing which compensates for
21043 anomalies unique and peculiar to a given printer (to which the
21044 profile is assigned).</para>
21048 <para>Before picking a profile try printing some sample
21049 labels so that you can easily define a profile that is
21050 right for your printer/template combination.</para>
21054 <para>After finding any anomalies in the printed document,
21055 <link linkend="addlabelprofile">create a profile</link>
21056 and assign it to the template.</para>
21062 <para>After saving, your templates will appear on the 'Manage
21063 Templates' page.</para>
21066 <screeninfo>List of label templates</screeninfo>
21070 <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
21077 <section id="labelprofiles">
21078 <title>Profiles</title>
21082 <para><emphasis>Get there:</emphasis> More > Tools > Label
21083 Creator > Profiles</para>
21087 <para>A profile is a set of "adjustments" applied to a given <link linkend="addlabeltemplate">template</link> just prior to printing
21088 which compensates for anomalies unique and peculiar to a given
21089 printer (to which the profile is assigned). This means if you set a
21090 template up and then print a sample set of data and find that the
21091 items are not all aligned the same on each label, you need to set up
21092 a profile for each printer to make up for the differences in
21093 printing styles, such as the shifting of text to the left, right,
21094 top or bottom.</para>
21096 <para>If your labels are printing just the way you want, you will
21097 not need a profile.</para>
21099 <section id="addlabelprofile">
21100 <title>Add a Profile</title>
21102 <para>To add a new profile, you want to click on the 'New profile' button at the top of
21103 the Label Creator tool.</para>
21106 <screeninfo>New Profile Button</screeninfo>
21110 <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
21115 <para>Using the form that appears you can create a profile to fix
21116 any problems with your template.</para>
21119 <screeninfo>Create a Printer Profile</screeninfo>
21123 <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
21130 <para>The Printer Name and Paper Bin do not have to match your
21131 printer exactly, they are for your reference so you can
21132 remember what printer you have set the profile for. So if you
21133 want to use the Printer model number in printer name or you
21134 can call it 'the printer on my desk'</para>
21138 <para>Template will be filled in once you have chosen which
21139 template to apply the profile to on the <link linkend="addlabeltemplate">template edit form</link></para>
21143 <para>The Units pull down is used to define what measurement
21144 scale you're going to be using for your profile.</para>
21147 <screeninfo>Units of Measurement</screeninfo>
21151 <imagedata fileref="images/tools/patroncards/units.png"/>
21158 <para>Offset describes what happens when the entire image is
21159 off center either vertically or horizontally and creep
21160 describes a condition where the distance between the labels
21161 changes across the page or up and down the page</para>
21165 <para>For these values, negative numbers move the error up
21166 and to the left and positive numbers move the error down
21167 and to the right</para>
21171 <para>Example: the text is .25" from the left edge of the
21172 first label, .28" from the left edge of the second label
21173 and .31" from the left edge of the third label. This means
21174 the horizontal creep should be set to .03" to make up for
21175 this difference.</para>
21181 <para>After saving, your profiles will appear on the 'Manage
21182 Profiles' page.</para>
21185 <screeninfo>List of Profiles</screeninfo>
21189 <imagedata fileref="images/tools/labelcreator/profiles.png"/>
21194 <para>Once you have saved your new profile, you can return to the
21195 list of templates and choose to edit the template that this
21196 profile is for.</para>
21200 <section id="labellayouts">
21201 <title>Layouts</title>
21205 <para><emphasis>Get there:</emphasis> More > Tools > Label
21206 Creator > Layouts</para>
21210 <para>A layout is used to define the fields you want to appear on
21211 your labels.</para>
21213 <section id="addlabellayout">
21214 <title>Add a Layout</title>
21216 <para>To add a new layout, you want to click on the 'New layout' button at the top of
21217 the Label Creator tool.</para>
21220 <screeninfo>New Layout Button</screeninfo>
21224 <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
21229 <para>Using the form that appears you can create a profile to fix
21230 any problems with your template.</para>
21233 <screeninfo>Add New Layout</screeninfo>
21237 <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
21244 <para>The name of your layout can be anything you'd like to
21245 help you identify it later.</para>
21249 <para>If this is a barcode label you'll want to choose the
21250 encoding (Code 39 is the most common)</para>
21254 <para>The layout type can be any combination of bibliographic
21255 information and/or barcode. For example a spine label would
21256 just be Biblio whereas a label for your circulation staff to
21257 use to checkout the book would probably be
21258 Biblio/Barcode.</para>
21262 <para>The Bibliographic Data to Print includes any of the data
21263 fields that may be mapped to your MARC frameworks. You can
21264 choose from the preset list of fields or you can click on
21265 'List Fields' and enter your own data. In 'List Fields', you
21266 can specify MARC subfields as a 4-character tag-subfield
21267 string: (ie. 254a for the title field), You can also enclose a
21268 whitespace-separated list of fields to concatenate on one line
21269 in double quotes. (ie. "099a 099b" or "itemcallnumber
21270 barcode"). The fields available are from the database tables
21271 list below. Finally you could add in static text strings in
21272 single-quote (ie. 'Some static text here.')</para>
21276 <para>You can use the schema viewer (<ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
21277 with the following tables to find field names to
21282 <para>Currently all fields in the following tables are
21283 used: items, biblioitems, biblio, branches</para>
21286 <screeninfo>List fields</screeninfo>
21290 <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
21301 <para>Choose if the label maker should print out the
21302 guidelines around each label</para>
21306 <para>Choose if you'd like Koha to try to split your call
21307 numbers (usually used on Spine Labels)</para>
21311 <para>Finally choose your text settings such as alignment,
21312 font type and size.</para>
21316 <para>After saving, your layouts will appear on the 'Manage
21317 Layouts' page.</para>
21321 <section id="labelbatches">
21322 <title>Batches</title>
21326 <para><emphasis>Get there:</emphasis> More > Tools > Label
21327 Creator > Batches</para>
21331 <para>Batches are made up of the barcodes you would like to print.
21332 Once in this tool you can search for the item records you would like
21333 to print out labels for.</para>
21335 <section id="addlabelbatch">
21336 <title>Add a Batch</title>
21338 <para>Batches can be created in one of two ways. The first is to
21339 click the 'Create Label Batch' link on the '<link linkend="managestaged">Staged MARC Management</link>' page:</para>
21342 <screeninfo>Create Label Batch Link on Staged Records
21347 <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
21352 <para>The other is to choose to create a new batch from the label
21353 creator tool</para>
21356 <screeninfo>Create New Batch</screeninfo>
21360 <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
21365 <para>You will be brought to an empty batch with an 'Add item(s)'
21366 button at the top of the page and a box to scan barcodes in
21370 <screeninfo>Add Items</screeninfo>
21374 <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
21379 <para>You can either scan barcodes in to the box provided and
21380 click the 'Add item(s)' button or you can click the 'Add item(s)'
21381 button with the barcodes box empty. Clicking 'Add item(s)' with
21382 nothing in the barcodes box will open a search window for you to
21383 find the items you want to add to the batch.</para>
21386 <screeninfo>Search for items for a Batch</screeninfo>
21390 <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
21395 <para>From the search results, click the check box next to the
21396 items you want to add to the batch and click the 'Add checked'
21397 button. You can also add items one by one by clicking the 'Add'
21398 link to the left of each item.</para>
21401 <screeninfo>Batch search results</screeninfo>
21405 <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
21410 <para>Once you have added all of the items click the 'Done'
21411 button. The resulting page will list the items you have
21415 <screeninfo>List of items in the batch</screeninfo>
21419 <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
21424 <para>To print your labels, click the 'Export Batch' button. To
21425 print only some of the labels, click the 'Export Item(s)' button.
21426 Either way you will be presented with a confirmation screen where
21427 you can choose your template and layout.</para>
21430 <screeninfo>Start batch export</screeninfo>
21434 <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
21439 <para>You will then be presented with three download options: PDF,
21440 Excel, and CSV.</para>
21443 <screeninfo>Batch save options</screeninfo>
21447 <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
21452 <para>After saving your file, simply print to the blank labels you
21453 have in your library.</para>
21458 <section id="quicklabelcreator">
21459 <title>Quick Spine Label Creator</title>
21463 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21464 > Quick Spine Label Creator</para>
21469 <para>This tool does not use the label layouts or templates, it
21470 simply prints a spine label in the first spot on the label
21475 <para>Define the fields you want to print on the spine label in
21476 the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
21477 system preference</para>
21481 <para>Format your label printing by editing spinelabel.css found
21482 in koha-tmpl/intranet-tmpl/prog/en/css/</para>
21487 <para>To use this tool you simply need the barcode for the book you'd
21488 like to print the spine label for.</para>
21491 <screeninfo>Quick Spine Label Creator</screeninfo>
21495 <imagedata fileref="images/tools/quickspinelable.png"/>
21500 <section id="marcmodtemplates">
21501 <title>MARC modification templates</title>
21502 <para>The MARC Modification Templates system gives Koha users the power to make alterations
21503 to MARC records automatically while staging MARC records for import. </para>
21504 <para>This tool is useful for altering MARC records from various venders/sources work with
21505 your MARC framework. The system essentially allows one to create a basic script using
21506 actions to Copy, Move, Add, Update and Delete fields. </para>
21507 <para>Start by adding a new template (a template can be made up of one or more actions) by
21508 entering a name and clicking 'Create template'.</para>
21510 <screeninfo>Add a new template</screeninfo>
21513 <imagedata fileref="images/tools/marcmodtemplates/addtemplate.png"/>
21517 <para>Next you can add actions to the template by filling in the Action box. For example if
21518 you're loading in a batch of files from your EBook vendor you might want to add the biblio
21519 item type of EBOOK to the 942$c.<screenshot>
21520 <screeninfo>Add action</screeninfo>
21523 <imagedata fileref="images/tools/marcmodtemplates/addaction.png"/>
21526 </screenshot><itemizedlist>
21528 <para>Choose 'Add/Update'</para>
21531 <para>Enter the field 942 and subfield c</para>
21534 <para>Enter the value of 'EBOOK' (or whatever your ebook item type code is)</para>
21537 <para>Provide a description so you can identify this action later</para>
21540 <para>Click 'Add action'</para>
21542 </itemizedlist></para>
21543 <para>Each action can also have an optional condition to check the value or existance of
21544 another field. For example you might want to add the call number to the item record if
21545 it's not already there.</para>
21547 <screeninfo>Add conditional action</screeninfo>
21550 <imagedata fileref="images/tools/marcmodtemplates/ifexample.png"/>
21556 <para>Choose 'Copy'</para>
21559 <para>Decide if you want to copy the first occurance or all occurances of the
21563 <para>Enter the field 090 (or other biblio call number field) and subfield a to
21567 <para>Enter the 952 field and o subfield to copy to</para>
21570 <para>Choose 'if'</para>
21573 <para>Enter the 952 field and o subfield</para>
21576 <para>Choose "doesn't exist"</para>
21579 <para>Provide a description so you can identify this action later</para>
21582 <para>Click 'Add action'</para>
21585 <para>The Copy & Move actions also support Regular Expressions, which can be used to
21586 automatically modify field values during the copy/move. An example would be to strip out
21587 the '$' character in field 020$c.</para>
21589 <screeninfo>Add regex action</screeninfo>
21592 <imagedata fileref="images/tools/marcmodtemplates/regexexample.png"/>
21598 <para>Choose 'Copy'</para>
21601 <para>Decide if you want to copy the first occurance or all occurances of the
21605 <para>Enter the field 020 and subfield c to copy</para>
21608 <para>Enter the 020 field and c subfield to copy to</para>
21611 <para>Check the 'RegEx' box and enter your regular expression (in this case s/\$//
21615 <para>Choose 'if'</para>
21618 <para>Enter the 020 field and c subfield</para>
21621 <para>Choose "matches"</para>
21624 <para>Check the 'RegEx' box and enter your regular expression (in this case m/^\$/
21628 <para>Provide a description so you can identify this action later</para>
21631 <para>Click 'Add action'</para>
21635 <para>The value for an update can include variables that change each time the template is
21636 used. Currently, the system supports two variables, __BRANCHCODE__ which is replaced
21637 with the branchcode of the library currently using the template, and __CURRENTDATE__
21638 which is replaced with the current date in ISO format ( YYYY-MM-DD ).</para>
21640 <para>You could also use regular expressions to add your library's proxy URL in front of
21641 links in your MARC record.<screenshot>
21642 <screeninfo>Add proxy URL</screeninfo>
21645 <imagedata fileref="images/tools/marcmodtemplates/proxyurl.png"/>
21648 </screenshot><itemizedlist>
21650 <para>Choose 'Copy'</para>
21653 <para>Decide if you want to copy the first occurance or all occurances of the
21657 <para>Enter the field 856 and subfield u to copy</para>
21660 <para>Enter the 856 field and u subfield to copy to</para>
21663 <para>Check the 'RegEx' box and enter your regular expression (in this case
21664 s/^/PROXY_URL/ )</para>
21667 <para>Provide a description so you can identify this action later</para>
21670 <para>Click 'Add action'</para>
21672 </itemizedlist></para>
21673 <para>Once your actions are saved you can view them at the top of the screen. Actions can be
21674 moved around using the arrows to the left of them. </para>
21676 <screeninfo>View actions</screeninfo>
21679 <imagedata fileref="images/tools/marcmodtemplates/viewactions.png"/>
21683 <para>Depending on your actions the order may be very important. For example you don't want
21684 to delete a field before you copy it to another field.</para>
21685 <para>To add another template you can either start fresh or click the 'Duplicate current
21686 template' checkbox to create a copy of an existing template to start with.</para>
21688 <screeninfo>Duplicate template</screeninfo>
21691 <imagedata fileref="images/tools/marcmodtemplates/duplicate.png"/>
21695 <para>Once your template is saved you will be able to pick it when using the <link
21696 linkend="stagemarc">Stage MARC Records for Import</link> tool.</para>
21698 <screeninfo>Choose template</screeninfo>
21701 <imagedata fileref="images/tools/marcmodtemplates/templatechoice.png"/>
21707 <section id="stagemarc">
21708 <title>Stage MARC Records for Import</title>
21712 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21713 > Stage MARC records for import</para>
21717 <para>This tool can be used to import both bibliographic and authority
21718 records that are saved in MARC format. Importing records into Koha
21719 includes two steps. The first is to stage records for import.</para>
21723 <para>First find the MARC file on your computer</para>
21726 <screeninfo>Stage MARC Records for Import</screeninfo>
21730 <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
21737 <para>Next you will be presented with options for record matching
21738 and item imports</para>
21741 <screeninfo>Upload options</screeninfo>
21745 <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
21752 <para>Enter 'Comments about this file' to identify your upload
21753 when going to the '<link linkend="managestaged">Manage Staged
21754 MARC Records</link>' tool</para>
21758 <para>Tell Koha which type of file this is, bibliographic or
21762 <screeninfo>Record type</screeninfo>
21766 <imagedata fileref="images/tools/marcimport/recordtype.png"/>
21773 <para>Choose the character encoding</para>
21776 <screeninfo>Chracter encoding</screeninfo>
21780 <imagedata fileref="images/tools/marcimport/encoding.png"/>
21787 <para>Choose if you would like to use a <link linkend="marcmodtemplates">MARC
21788 Modification Template</link> to alter the data you're about to import</para>
21790 <screeninfo>Choose modification template</screeninfo>
21793 <imagedata fileref="images/tools/marcimport/templatechoice.png"/>
21799 <para>Choose whether or not you want to look for matching records</para>
21801 <screeninfo>Look for matches</screeninfo>
21804 <imagedata fileref="images/tools/marcimport/matches.png"/>
21810 <para>You can set up <link linkend="recordmatchingrules">record matching
21811 rules</link> through the administration area</para>
21813 <screeninfo>Matching rules</screeninfo>
21816 <imagedata fileref="images/tools/marcimport/matchrule.png"/>
21822 <para>When using the ISBN matching rule Koha will find only exact matches.
21823 If you find that the ISBN match is not working to your satisfaction you
21824 can change the <link linkend="AggressiveMatchOnISBN"
21825 >AggressiveMatchOnISBN</link> preference to 'Do' and then run your
21826 import again.</para>
21834 <para>Next choose what to do with matching records if they are
21839 <para>Finally choose what to do with records that are
21844 <para>Next you can choose whether or not to import the item
21845 data found in the MARC records (if the file you're loading is
21846 a bibliographic file)</para>
21849 <screeninfo>Import items</screeninfo>
21853 <imagedata fileref="images/tools/marcimport/checkitems.png"/>
21859 <listitem><para>From here you can choose to always add items regardless of matching status, add them only if a
21860 matching bib was found, add items only if there was no matching bib record,
21861 replace items if a matching bib was found (The match will look at the
21862 itemnumbers and barcodes to match on for items. Itemnumbers take precendence
21863 over barcodes), or Ignore items and not add them.</para></listitem>
21869 <para>Click 'Stage for import'</para>
21873 <para>You will be presented with a confirmation of your MARC
21877 <screeninfo>MARC Import Confirmation</screeninfo>
21881 <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
21888 <para>To complete the process continue to the <link linkend="managestaged">Managed Staged MARC Records
21894 <section id="managestaged">
21895 <title>Staged MARC Record Management</title>
21899 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21900 > Staged MARC Record Management</para>
21904 <para>Once you have <link linkend="stagemarc">staged</link> your
21905 records for import you can complete the import using this tool.</para>
21908 <screeninfo>List of Staged MARC Records</screeninfo>
21912 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
21919 <para>From the list of staged records, click on the file name that
21920 you want to finish importing</para>
21924 <para>You will note that records that have already been
21925 imported will say so under 'Status'</para>
21931 <para>A summary of your import will appear along with the option
21932 to change your matching rules</para>
21935 <screeninfo>Manage Staged Records Batch</screeninfo>
21939 <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
21946 <para>Below the summary is the option to import the batch of bib
21947 records using a specific framework</para>
21950 <screeninfo>Choose Framework to Import Into</screeninfo>
21954 <imagedata fileref="images/tools/marcimport/importframework.png"/>
21961 <para>Choosing a framework other than 'Default' isn't
21962 necessary, but it's helpful for running reports and having the
21963 right bib level item type selected on import.</para>
21969 <para>Below the framework selection there will be a list of the
21970 records that will be imported</para>
21973 <screeninfo>List of Staged Records</screeninfo>
21977 <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
21984 <para>Review your summary before completing your import to
21985 make sure that your matching rule worked and that the records
21986 appear as you expect them to</para>
21992 <para>Click 'Import into catalog' to complete the import</para>
21995 <screeninfo>Import summary</screeninfo>
21999 <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
22006 <para>Once your import is complete a link to the new bib records
22007 will appear to the right of each title that was imported</para>
22011 <para>You can also undo your import by clicking the 'Undo import
22012 into catalog' button</para>
22016 <para>Records imported using this tool remain in the 'reservoir' until
22017 they are cleaned. These items will appear when searching the catalog
22018 from the <link linkend="cataloging">Cataloging</link> tool:</para>
22021 <screeninfo>Reservoir Results</screeninfo>
22025 <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
22030 <para>To clean items out of the 'reservoir':</para>
22034 <para>Visit the main screen of the Manage Staged MARC Records
22038 <screeninfo>List of Staged MARC Records</screeninfo>
22042 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
22049 <para>To clean a batch, click the 'Clean' button to the
22054 <para>You will be presented with a confirmation message</para>
22057 <screeninfo>Clean MARC Records Confirmation</screeninfo>
22061 <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
22068 <para>Accept the deletion and the records will be removed from
22069 the reservoir and the status will be changed to
22077 <section id="uploadlocalimages">
22078 <title>Upload Local Cover Image</title>
22082 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
22083 > Upload Local Cover Image</para>
22087 <para>This tool will allow you to upload cover images for the materials in your catalog. To
22088 access this tool, staff will need the <link linkend="toolspermissions"
22089 >upload_local_cover_images permission</link>. In order for images to show in the staff
22090 client and/or OPAC you will need to set your <link linkend="LocalCoverImages"
22091 >LocalCoverImages</link> and/or <link linkend="OPACLocalCoverImages"
22092 >OPACLocalCoverImages</link> preferences to 'Display.' Images can be uploaded in batches
22093 or one by one.<tip>
22094 <para>Koha does not have a maximum file size limit for this tool, but Apache may limit
22095 the maximum size of uploads (talk to your sys admin).</para>
22097 <para>When you want to upload multiple images onto a bib record, they will display left
22098 to right (then top to bottom, depending on screen real estate) in order of uploading,
22099 and the one on the left (the first one uploaded) will be the one used as a thumbnail
22100 cover in search results and on the detail page. There is no way to reorder cover
22101 images uploaded in this way, so be sure to upload them in the order you'd like them to appear.<screenshot>
22102 <screeninfo>Multiple cover images on one record</screeninfo>
22105 <imagedata fileref="images/tools/uploadlocalimg/multiplecovers.png"/>
22108 </screenshot></para>
22111 <para>If uploading a single image:</para>
22115 <para>Visit the tool and click the 'Browse' button to browse to
22116 the image on your local machine.</para>
22119 <screeninfo>Upload single cover image</screeninfo>
22123 <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
22130 <para>Click 'Upload file'</para>
22134 <para>Choose 'Image file' under the 'File type' section</para>
22138 <para>Enter the biblionumber for the record you're attaching this
22139 image to. This is not the same as the barcode, this is the system
22140 generated number assigned by Koha.</para>
22144 <para>Find the biblionumber by looking at the end of the URL
22145 in the address bar when on the detail page</para>
22148 <screeninfo>Biblionumber in URL</screeninfo>
22152 <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
22159 <para>or by clicking on the MARC tab on the detail page in the
22160 staff client</para>
22163 <screeninfo>Biblionumber on MARC Record</screeninfo>
22167 <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
22176 <para>If you would like to replace any other cover images you may
22177 have uploaded in the past, check the 'Replace existing covers' box
22178 under the 'Options' section</para>
22182 <para>Click 'Process images'</para>
22186 <para>You will be presented with a summary of the upload and a
22187 link to the record you have just added the image to</para>
22191 <para>If uploading a batch of images at once you will need to prepare
22192 a ZIP file first.</para>
22196 <para>Enter in to the ZIP file all the images you are
22201 <para>Also include a text file (*.TXT) named either datalink.txt
22202 or idlink.txt listing the biblionumber followed by the image name
22203 for each image one per line</para>
22207 <para>ex. 4091,image4091.jpg</para>
22210 <screeninfo>ZIP File Contents</screeninfo>
22214 <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
22223 <para>Browse your local computer to the ZIP file</para>
22227 <para>Click 'Upload file'</para>
22231 <para>Choose 'Zip file' under the 'File type' section</para>
22235 <para>If you would like to replace any other cover images you may
22236 have uploaded in the past, check the 'Replace existing covers' box
22237 under the 'Options' section</para>
22241 <para>Click 'Process images'</para>
22245 <para>You will be presented with a summary of the upload</para>
22248 <screeninfo>Upload Summary</screeninfo>
22252 <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
22260 <para>The source image is used to generate a 140 x 200 px thumbnail image and a 600 x 800
22261 px full-size image. The original sized image uploaded will not be stored by Koha</para>
22264 <para>You will be able to see your cover images in the staff client on
22265 the detail page under the 'Image' tab in the holdings table at the
22269 <screeninfo>Cover images in the staff client</screeninfo>
22273 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
22278 <para>In the OPAC the cover images will also appear in the images tab,
22279 as well as next to the title and on the search results.</para>
22280 <para>If you would like to remove a cover image you can click 'Delete image' below the image
22281 if you have the <link linkend="toolspermissions">upload_local_cover_images
22282 permission</link>.</para>
22286 <section id="additionaltools">
22287 <title>Additional Tools</title>
22291 <section id="calholidays">
22292 <title>Calendar</title>
22296 <para><emphasis>Get there:</emphasis> More > Tools >
22297 Additional Tools > Calendar</para>
22301 <para>Libraries can define library closings and holidays to be used
22302 when calculating due dates. You can make use of the Calendar by
22303 turning on the proper system preferences:</para>
22307 <para><emphasis>Get there: </emphasis>More > Administration
22308 > Global System Preferences > Circulation > <link linkend="useDaysMode">useDaysMode</link></para>
22312 <para>Choose the method for calculating due date - either
22313 include days the library is closed in the calculation or don't
22314 include them.</para>
22320 <para><emphasis>Get there:</emphasis> More > Administration
22321 > Global System Preferences > Circulation > <link linkend="finesCalendar">finescalendar</link></para>
22325 <para>This will check the holiday calendar before charging
22333 <screeninfo>Calendar & Holidays Tools</screeninfo>
22337 <imagedata fileref="images/tools/calendar/calendar.png"/>
22342 <section id="addevents">
22343 <title>Adding Events</title>
22345 <para>Before adding events, choose the library you would like to
22346 apply the closings to. When adding events you will be asked if you
22347 would like to apply the event to one branch or all branches. To add
22348 events, simply</para>
22352 <para>Click on the date on the calendar that you would like to
22353 apply the closing to</para>
22356 <screeninfo>Calendar Add Form</screeninfo>
22360 <imagedata fileref="images/tools/calendar/calendaradd.png"/>
22367 <para>In the form that appears above the calendar, enter the
22368 closing information (for more info on each option click the
22369 question mark [?] to the right of the option)</para>
22373 <para>Library will be filled in automatically based on the
22374 library you chose from the pull down at the top of the
22379 <para>The day information will also be filled in
22380 automatically based on the date you clicked on the
22385 <para>In the description enter the reason the library is
22390 <para>Next you can choose if this event is a one time event
22391 or if it is repeatable.</para>
22395 <para>If this is a one day holiday choose 'Holiday only
22396 on this day'</para>
22400 <para>If this is a weekly closing (like a weekend day)
22401 then you can choose 'Holiday repeated every same day of
22406 <para>If this is an annual holiday closing choose
22407 'Holiday repeated yearly on the same date'</para>
22411 <para>If the library is going to be closed for the week
22412 or a range of time choose 'Holiday on a range' and enter
22413 a 'To Date' at the top</para>
22417 <para>If the library is going to be closed for a range
22418 of time each year (such as summer holidays for schools)
22419 choose 'Holiday repeated yearly on a range' and enter a
22420 'To Date' at the top</para>
22426 <para>Finally decide if this event should be applied to all
22427 libraries or just the one you have originally
22432 <para>If you'd rather enter all the holidays and then
22433 copy them all to another branch all at once you can use
22434 the copy menu below the calendar</para>
22437 <screeninfo>Copy holidays</screeninfo>
22441 <imagedata fileref="images/tools/calendar/copyholidays.png"/>
22452 <para>After saving you will see the event listed in the summary
22453 to the right the calendar</para>
22456 <screeninfo>Calendar Summary</screeninfo>
22460 <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
22468 <section id="editevents">
22469 <title>Editing Events</title>
22471 <para>To edit events</para>
22475 <para>Click on the event on the calendar that you want to change
22476 (do this by clicking on the date on the calendar, not the event
22477 listed in the summary)</para>
22480 <screeninfo>Edit holiday form</screeninfo>
22484 <imagedata fileref="images/tools/calendar/calendaredit.png"/>
22491 <para>From this form you can make edits to the holiday or delete the holiday
22492 completely. <itemizedlist>
22494 <para>All actions require that you click 'Save' before the change will be
22497 </itemizedlist></para>
22501 <para>Clicking on repeatable events will offer slightly
22502 different options</para>
22505 <screeninfo>Edit repeatable event</screeninfo>
22509 <imagedata fileref="images/tools/calendar/calendarexception.png"/>
22516 <para>In the form above you will note that there is now an option to 'Generate an
22517 exception for this repeated holiday,' choosing this option will allow you to
22518 make it so that this date is not closed even though the library is usually
22519 closed on this date.<itemizedlist>
22521 <para>All actions require that you click 'Save' before the change will be
22524 </itemizedlist></para>
22531 <section id="calendarhelp">
22532 <title>Additional Help</title>
22534 <para>When adding or editing events you can get additional help by
22535 clicking on the question mark next to various different options on
22539 <screeninfo>Additional Calendar Help Buttons</screeninfo>
22543 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
22550 <section id="csvprofiles">
22551 <title>CSV Profiles</title>
22555 <para><emphasis>Get there:</emphasis> More > Tools >
22556 Additional Tools > CSV Profiles</para>
22560 <para>CSV Profiles are created to define how you would like your cart
22561 or list to export.</para>
22563 <section id="addcsvprofile">
22564 <title>Add CSV Profiles</title>
22566 <para>To add a CSV Profile</para>
22570 <para>Click 'CSV Profiles' from the Tools menu</para>
22573 <para>The 'Profile type' determines what type of fields you plan to use (MARC or SQL)
22574 to define your profile<itemizedlist>
22576 <para>If tyou choose MARC then you will need to enter MARC fields</para>
22578 </itemizedlist></para>
22580 <screeninfo>MARC CSV Profile</screeninfo>
22583 <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
22589 <para>If tyou choose SQL then you will need to enter SQL database fields</para>
22591 <screeninfo>SQL CSV Profile</screeninfo>
22594 <imagedata fileref="images/tools/csvprofiles/addcsv-sql.png"/>
22602 <para>The 'Profile name' will appear on the export pull down list when choosing
22603 'Download' from your cart or list</para>
22605 <screeninfo>Download List</screeninfo>
22608 <imagedata fileref="images/tools/csvprofiles/downloadcsv.png"/>
22614 <para>The 'Profile description' is for your own benefit, but will also appear in
22615 the OPAC when patrons download content, so make sure it's clear to your patrons
22619 <para>The 'CSV separator' is the character used to separate values and value groups<tip>
22620 <para>The most common option here is comma because most spreadsheet
22621 applications know how to open files split by commas.</para>
22625 <para>The 'Field separator' is the character used to separate duplicate
22629 <para>Example: You may have multiple 650 fields and this is the character that
22630 will appear in between each one in the column</para>
22632 <screeninfo>Field separators in between multiple subjects</screeninfo>
22635 <imagedata fileref="images/tools/csvprofiles/csvfieldsep.png"/>
22643 <para>The 'Subfield separator' is the character used to separate duplicate
22647 <para>Example: You may have multiple $a subfields in a field</para>
22652 <para>The 'Encoding' field lets you define the encoding used when saving the
22656 <para>Finally format your CSV file using the 'Profile MARC' or 'Profile SQL'
22660 <para>Define which fields or subfields you want to export, separated by pipes.
22661 Example : 200|210$a|301 for MARC and biblio.title|biblio.author for
22666 <para>You can also use your own headers (instead of the ones from Koha) by
22667 prefixing the field number with an header, followed by the equal sign.
22668 Example : Personal name=100|title=245$a|300</para>
22674 <para>When you have entered in all of the information for you profile, simply click
22675 'Submit' and you will be presented with a confirmation that your profile has been saved.</para>
22677 <screeninfo>Confirmation of new CSV profile</screeninfo>
22680 <imagedata fileref="images/tools/csvprofiles/csvadded.png"/>
22688 <section id="editcsvprofile">
22689 <title>Modify CSV Profiles</title>
22691 <para>Once you have created at least one CSV Profile an 'Edit
22692 profile' tab will appear next to the 'New profile' button.</para>
22695 <screeninfo>Modify CSV Profiles</screeninfo>
22699 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
22706 <para>Choose the profile you would like to edit and alter the necessary fields.</para>
22709 <para>After submitting your changes you will be presented with a confirmation message
22710 at the top of the screen</para>
22712 <screeninfo>Confirmation of CSV modification</screeninfo>
22715 <imagedata fileref="images/tools/csvprofiles/csvmodified.png"/>
22722 <para>To delete a profile, check the 'Delete selected profile'
22723 option before clicking 'Submit Query'</para>
22726 <screeninfo>Delete an existing CSV Profile</screeninfo>
22730 <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
22738 <section id="usecsvprofiles">
22739 <title>Using CSV Profiles</title>
22741 <para>Your CSV Profiles will appear on the export list or cart menu under the 'Download'
22742 button in both the staff client and the OPAC</para>
22745 <screeninfo>CSV Profiles on Download Menu in the Staff Client</screeninfo>
22749 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
22756 <section id="logviewer">
22757 <title>Log Viewer</title>
22761 <para><emphasis>Get there:</emphasis> More > Tools >
22762 Additional Tools > Log Viewer</para>
22766 <para>Actions within the Koha system are tracked in log files. Your
22767 <link linkend="logs">system preferences</link> can be changed to
22768 prevent the logging of different actions. These logs can be viewed
22769 using the Log Viewer Tool.</para>
22772 <screeninfo>Log Viewer</screeninfo>
22776 <imagedata fileref="images/tools/logs/logviewer.png"/>
22781 <para>Choosing different combinations of menu options will produce the
22782 log file for that query.</para>
22785 <screeninfo>A query for all logs related to the Circulation module
22786 produces a result like this</screeninfo>
22790 <imagedata fileref="images/tools/logs/logresults.png"/>
22795 <para>You will note that real names do not appear on the log, only
22796 identifying numbers. You need to use the identifying numbers when
22797 searching the logs as well.</para>
22800 <section id="newstool">
22801 <title>News</title>
22805 <para><emphasis>Get there:</emphasis> More > Tools >
22806 Additional Tools > News</para>
22810 <para>Koha's news module allows librarians to post news to the OPAC,
22811 staff interface and circulation receipts.</para>
22814 <screeninfo>Koha News Module</screeninfo>
22818 <imagedata fileref="images/tools/news/news.png"/>
22823 <para>To add news to either the OPAC, the Staff Client or a
22824 Circulation receipt:</para>
22828 <para>Click 'New Entry'</para>
22831 <screeninfo>Add Koha News Form</screeninfo>
22835 <imagedata fileref="images/tools/news/addnews.png"/>
22842 <para>Under 'Display Location' choose whether to put the news on the OPAC, Slip
22843 (circulation receipt) or the Librarian (Staff) Interface.<screenshot>
22844 <screeninfo>Display location</screeninfo>
22847 <imagedata fileref="images/tools/news/displaylocation.png"/>
22850 </screenshot></para>
22854 <para>Choose the library this news item will show for</para>
22857 <para>Choose a title for your entry</para>
22861 <para>Using the publication and expiration date fields you can
22862 control how long your item appears</para>
22866 <para>'Appear in position' lets you decide what order your
22867 news items appear in</para>
22871 <para>The 'News' box allows for the use of HTML for formatting
22872 of your news item</para>
22878 <para>After filling in all of the fields, click 'Submit'</para>
22882 <para>News in the OPAC will appear above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
22885 <screeninfo>News in the OPAC</screeninfo>
22889 <imagedata fileref="images/tools/news/opacnews.png"/>
22896 <para>News in the Staff Client will appear on the far left of the
22900 <screeninfo>News in the Staff Client</screeninfo>
22904 <imagedata fileref="images/tools/news/librariannews.png"/>
22911 <para>News on the circulation receipts will appear below the items
22912 that are checked out</para>
22915 <screeninfo>News at the bottom of the circulation
22916 receipt</screeninfo>
22920 <imagedata fileref="images/tools/news/slipnews.png"/>
22928 <section id="taskscheduler">
22929 <title>Task Scheduler</title>
22933 <para><emphasis>Get there:</emphasis> More > Tools >
22934 Additional Tools > Task Scheduler</para>
22938 <para>The task scheduler is a way to schedule reports to run whenever
22941 <para>To schedule a task, visit the Task Scheduler and fill in the
22945 <screeninfo>Task Scheduler</screeninfo>
22949 <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
22956 <para>Current Server Time shows the time on your server (schedule
22957 all of your reports to run based on that time - not on your local
22962 <para>Time should be entered as hh:mm (2 digit hour, 2 digit
22967 <para>Date should be entered using the calendar pop up</para>
22971 <para>From Report choose the report you want to schedule</para>
22975 <para>Choose whether to receive the text of or a link to the
22980 <para>In the Email filed enter the email of the person you want to
22981 receive your report</para>
22985 <para>Below the task scheduler form, there is a list of scheduled
22989 <screeninfo>Scheduled Tasks</screeninfo>
22993 <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
22998 <para>You can also schedule reports directly from the list of saved
22999 reports by clicking the 'Schedule' link</para>
23002 <screeninfo>Saved Reports List</screeninfo>
23006 <imagedata fileref="images/tools/tasksched/savedreports.png"/>
23011 <section id="taskscedtroubleshoot">
23012 <title>Troubleshooting</title>
23014 <para>Task scheduler will not work if the user the web server runs
23015 as doesn't have the permission to use it. To find out if the right
23016 user has the permissions necessary, check /etc/at.allow to see what
23017 users are in it. If you don't have that file, check etc/at.deny. If
23018 at.deny exists but is blank, then every user can use it. Talk to
23019 your system admin about adding the user to the right place to make
23020 the task scheduler work.</para>
23024 <section id="QOTDEditor">
23025 <title>Quote of the Day (QOTD) Editor</title>
23028 <para><emphasis>Get there:</emphasis> More > Tools > Additional Tools > Edit
23029 quotes for QOTD feature</para>
23033 <para>This tool will allow you to add and edit quotes to show on the
23034 OPAC if you're using the Quote of the Day (QOTD) feature.</para>
23036 <para>To turn this feature on set the <link linkend="QuoteOfTheDay">QuoteOfTheDay</link> preference to 'Enable and
23037 add at least one quote via the Quote of the Day Editor. Once these
23038 steps are complete you will see your quotes above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link> in the
23042 <screeninfo>Quote in the OPAC</screeninfo>
23046 <imagedata fileref="images/tools/qotd/quoteinopac.png"/>
23051 <section id="addquote">
23052 <title>Add a Quote</title>
23054 <para>To add a quote:</para>
23058 <para>Click the 'Add quote' button in the toolbar and an empty
23059 quote entry will be added to the end of the current quote
23063 <screeninfo>Add quote button</screeninfo>
23067 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
23075 <para>Both the 'Source' and the 'Text' fields must be
23076 filled in in order to save the new quote.</para>
23079 <screeninfo>Add quote</screeninfo>
23083 <imagedata fileref="images/tools/qotd/addquote.png"/>
23093 <para>When finished filling in both fields, press the
23094 <Enter> key on your keyboard to save the new quote.</para>
23098 <para>The list will update and the new quote should now be
23099 visible in the list.</para>
23104 <para>You may cancel the addition of a new quote any time prior to
23105 saving it simply by pressing the <Esc> key on your
23110 <section id="editquote">
23111 <title>Edit/Delete a Quote</title>
23113 <para>Once the current quote pool has been loaded into the editing
23114 table, you may edit the quote source and text.</para>
23118 <para>Edit either the 'Source' or 'Text' fields by clicking on
23119 the desired field.</para>
23122 <screeninfo>Edit quote</screeninfo>
23126 <imagedata fileref="images/tools/qotd/editquote.png"/>
23133 <para>When you are finished editing a field, press the
23134 <Enter> key on your keyboard to save the changes.</para>
23138 <para>The list will be updated, the edits saved, and visible.</para>
23140 <para>If you'd like you can also delete quote(s).</para>
23144 <para>Select the quote(s) you desire to delete by clicking on
23145 the corresponding quote id.</para>
23149 <para>Once quote selection is finished, simply click the 'Delete
23150 quote(s)' button.</para>
23154 <para>You will be prompted to confirm the deletion.</para>
23158 <para>After confirming the deletion, the list will update and
23159 the quote(s) will no longer appear.</para>
23164 <section id="importquote">
23165 <title>Import Quotes</title>
23167 <para>If you'd like you can import a batch of quotes as a CSV file.
23168 Your file must contain two columns in the form: "source","text" with
23169 no header row.</para>
23172 <para>You will be prompted to confirm upload of files larger than
23178 <para>To start the import process click the 'Import quotes'
23179 button at the top of the screen</para>
23182 <screeninfo>Import quotes button</screeninfo>
23186 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
23193 <para>Once on the import quotes screen you can browse your
23194 computer for the file you would like to import</para>
23197 <screeninfo>Import quotes</screeninfo>
23201 <imagedata fileref="images/tools/qotd/importquotes.png"/>
23208 <para>After selecting the CSV file, click the 'Open' button and
23209 the file will be uploaded into a temporary editing table.</para>
23212 <screeninfo>Imported quotes</screeninfo>
23216 <imagedata fileref="images/tools/qotd/importedsummary.png"/>
23223 <para>From the listing you can edit either the 'Source' or
23224 'Text' fields by clicking on the desired field. When you are
23225 finished editing a field, press the <Enter> key on your
23226 keyboard to save the changes.</para>
23229 <screeninfo>Edit imported quote</screeninfo>
23233 <imagedata fileref="images/tools/qotd/editimported.png"/>
23240 <para>You can also delete quotes from this listing before
23241 completing the import.</para>
23245 <para>Select the quote(s) you desire to delete by clicking
23246 on the corresponding quote id.</para>
23249 <screeninfo>Selected for deletion</screeninfo>
23253 <imagedata fileref="images/tools/qotd/selectfordelete.png"/>
23260 <para>Once quote selection is finished, simply click the
23261 'Delete quote(s)' key.</para>
23264 <screeninfo>Delete quote(s)</screeninfo>
23268 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
23275 <para>You will be prompted to confirm the deletion.</para>
23278 <screeninfo>Confirm deletion</screeninfo>
23282 <imagedata fileref="images/tools/qotd/confirmdelete.png"/>
23289 <para>After confirming the deletion, the list will update
23290 and the quote(s) will no longer appear.</para>
23296 <para>Once you are satisfied with the quotes, click the 'Save
23297 quotes' button in the toolbar at the top and the quotes will be
23301 <screeninfo>Save quotes button</screeninfo>
23305 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
23316 <chapter id="patrons">
23317 <title>Patrons</title>
23319 <para>Before importing and/or adding patrons be sure to set up your <link linkend="patcats">patron categories</link>.</para>
23321 <section id="addnewpatron">
23322 <title>Add a new patron</title>
23324 <para>Patrons are added by going to the 'Patrons' module.<itemizedlist>
23326 <para><emphasis>Get there:</emphasis> Patrons</para>
23328 </itemizedlist></para>
23329 <para>Once there you can add a new patron.</para>
23333 <para>Click 'New patron'</para>
23336 <screeninfo>Choose patron type</screeninfo>
23340 <imagedata fileref="images/patrons/newpatron.png"/>
23347 <para>The fields that appear on the patron add form can be
23348 controlled by editing the <link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
23353 <para>First enter the identifying information regarding your
23357 <screeninfo>Add Patron Form</screeninfo>
23361 <imagedata fileref="images/patrons/addpatronform.png"/>
23368 <para>Required fields are defined in the <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
23369 system preference</para>
23373 <para>Salutation is populated by the <link linkend="BorrowersTitles">BorrowersTitles</link> system
23380 <para>Next enter the contact information</para>
23383 <screeninfo>Patron Contact Information</screeninfo>
23387 <imagedata fileref="images/patrons/addcontact.png"/>
23394 <para>For contact information, note that the primary phone and
23395 email addresses are the ones that appear on notices and slips
23396 printed during circulation (receipts, transfer slips and hold
23397 slips). The primary email is also the one that overdue notices
23398 and other messages go to.</para>
23404 <para>If this patron is a child, you will be asked to attach the
23405 child patron to an adult patron</para>
23408 <screeninfo>Guarantor Linking</screeninfo>
23412 <imagedata fileref="images/patrons/addGuarantor.png"/>
23419 <para>Click 'Set to Patron' to search your system for an
23420 existing patron</para>
23424 <para>If the Guarantor is not in the system, you can enter the
23425 first and last name in the fields available</para>
23429 <para>The relationships are set using the <link linkend="borrowerRelationship">borrowerRelationship</link>
23430 system preference</para>
23436 <para>If this patron is a professional, you will be asked to attach
23437 the patron to an organizational patron</para>
23440 <screeninfo>Organization Linking</screeninfo>
23444 <imagedata fileref="images/patrons/addOrg.png"/>
23451 <para>Click 'Set to Patron to search your system for an existing
23458 <para>Each patron can have an alternate contact</para>
23461 <screeninfo>Alternate Contact</screeninfo>
23465 <imagedata fileref="images/patrons/addaltcontact.png"/>
23472 <para>An alternate contact could be a parent or guardian. It can
23473 also be used in academic settings to store the patron's home
23480 <para>The library management section includes values that are used
23481 within the library</para>
23484 <screeninfo>Library Management</screeninfo>
23488 <imagedata fileref="images/patrons/addlibmanagement.png"/>
23495 <para>The card number field is automatically calculated if you
23496 have the <link linkend="autoMemberNum">autoMemberNum</link>
23497 system preference set that way</para>
23502 <para>For a newly installed system this preference will
23503 start at 1 and increment by 1 each time after. To have it
23504 start with the starting number of your barcodes, enter the
23505 first barcode by hand in the patron record and save the
23506 patron. After that the field will increment that number by
23514 <para>If you accidentally chose the wrong patron category at the
23515 beginning you can fix that here</para>
23519 <para>Sort 1 and 2 are used for statistical purposes within your
23526 <para>Next, the Library Setup section includes additional library
23530 <screeninfo>Library set-up options</screeninfo>
23534 <imagedata fileref="images/patrons/addlibsetup.png"/>
23541 <para>The registration date will automatically be filled in with
23542 today's date</para>
23546 <para>If your patron cards expire (based on your <link linkend="patcats">patron category settings</link>) the Expiry
23547 date will automatically be calculated</para>
23551 <para>The OPAC Note is a note for the patron - it will appear in
23552 the OPAC on the patron's record</para>
23556 <para>The Circulation Note is meant solely for your library
23557 staff and will appear when the circulation staff goes to check
23558 an item out to the patron</para>
23561 <screeninfo>Sample Circulation Note</screeninfo>
23565 <imagedata fileref="images/patrons/circnote.png"/>
23572 <para>The Staff/OPAC asks for the username and password to be
23573 used by the patron (and/or staff member) to log into their
23574 account in the OPAC and for staff to log in to the staff
23579 <para>Staff will only be able to use this log in info to log
23580 in to the staff client if they have the <link linkend="patronpermissions">necessary
23581 permissions</link>.</para>
23589 <para>If you have set <link linkend="patronattributetypes">additional patron attributes</link>
23590 up, these will appear next</para>
23593 <screeninfo>Additional Patron Attributes</screeninfo>
23597 <imagedata fileref="images/patrons/addattributes.png"/>
23604 <para id="setpatronmessaging">Finally, if you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
23605 set to 'allow,' you can choose the messaging preferences for this
23609 <screeninfo>Patron Messaging Settings</screeninfo>
23613 <imagedata fileref="images/patrons/addpatronmsg.png"/>
23620 <para>These notices are:</para>
23623 <para>Advanced Notice : A notice in advance of the patron's items being due (The
23624 patron can choose the number of days in advance)</para>
23627 <para>Item Checkout : A notice that lists all the of the items the patron has just
23628 checked out and/or renewed, this is an electronic form of the checkout
23632 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
23636 <para>Item Due : A notice on the day and item is due back at the library</para>
23639 <para>Item Checkin : A notice that lists all the of the items the patron has just
23646 <para>These preferences will override any you set via the
23647 <link linkend="addingpatroncat">patron
23648 categories</link></para>
23654 <para>These preference can be altered by the patron via the
23662 <para>Once finished, click 'Save'</para>
23666 <para>If the system suspects this patron is a duplicate of another it
23667 will warn you.</para>
23670 <screeninfo>Patron Duplicate Suspected</screeninfo>
23674 <imagedata fileref="images/patrons/duplicatewarn.png"/>
23679 <para>A duplicate patron is detected if first and last names match and there is no date of
23680 birth populated or if first name, last name and date of birth fields are all populated. If
23681 two patrons have matching names, but one has a date of birth and the other does not they
23682 will not match as duplicates.</para>
23685 <para>If you have set a minimum or upper age limit on the patron
23686 category and are requiring that the birth date be filled in, Koha will
23687 warn you if the patron you're adding is too old or young for the patron
23688 category you have selected:</para>
23691 <screeninfo>Patron age warning</screeninfo>
23695 <imagedata fileref="images/patrons/patronagelimit.png"/>
23701 <section id="addstaffpatron">
23702 <title>Add a Staff Patron</title>
23704 <para>All staff members must be entered into Koha as patrons of the
23705 'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
23706 Patron</link> to add a staff member. To give the staff member
23707 permissions to access the staff client, follow the steps in <link linkend="patronpermissions">Patron Permissions</link></para>
23710 <para>Remember to assign your staff secure usernames and passwords
23711 since these will be used to log into the staff client.</para>
23715 <section id="addstatspatron">
23716 <title>Add a Statistical Patron</title>
23718 <para>One way to track use of in house items is to "check out" the
23719 materials to a statistical patron. The "check out" process doesn's check
23720 the book out, but instead tracks an in house use of the item. To use
23721 this method for tracking in house use you first will need a <link linkend="patcats">patron category</link> set up for your Statistical
23725 <screeninfo>In House Patron Category</screeninfo>
23729 <imagedata fileref="images/patrons/statspatcat.png"/>
23734 <para>Next, you will need to create a new patron of the statistical
23738 <screeninfo>New In House Patron</screeninfo>
23742 <imagedata fileref="images/patrons/newinhouse.png"/>
23747 <para>Next, follow the steps put forth in the '<link linkend="addnewpatron">Add a new Patron</link>' section of this manual.
23748 Since this patron is not a real person, simply fill in the required
23749 fields, the correct library and nothing else.</para>
23751 <para>To learn about other methods of tracking in house use visit the
23752 <link linkend="trackinhouse">Tracking inhouse use</link> section of this
23756 <section id="duplicatepatron">
23757 <title>Duplicate a Patron</title>
23759 <para>Sometimes when you're adding a new family to your system you don't
23760 want to type the contact information over and over. Koha allows for you
23761 to duplicate a patron and change only the parts you want to (or need to)
23766 <para>Open the patron you want to use as your base (the patron you
23767 want to duplicate information from)</para>
23771 <para>Click the 'Duplicate' button at the top of their record</para>
23774 <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
23778 <imagedata fileref="images/patrons/patronedit.png"/>
23785 <para>All of the fields with the exception of first name, card
23786 number, username and password have been duplicated. Fill in the
23787 missing pieces and click 'Save'</para>
23790 <screeninfo>Duplicating Patron Form</screeninfo>
23794 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
23802 <para>Clicking in a field that is already populated with data
23803 will clear that field of all information (making it easier for
23804 you to type in something different)</para>
23811 <para>You will be brought to your new patron</para>
23814 <screeninfo>Newly created patron</screeninfo>
23818 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
23825 <section id="addpatronimages">
23826 <title>Add Patron Images</title>
23827 <para>If you would like you can add patron images to help identify patrons. To enable this
23828 feature you must first set the <link linkend="patronimages">patronimages</link> preference
23830 <para>If the preference is set to 'Allow' you will see a placeholder image under the patron's
23831 name and box to upload a patron image below the basic contact information.</para>
23833 <screeninfo>Add patron image</screeninfo>
23836 <imagedata fileref="images/patrons/addpatronimage.png"/>
23840 <para>In the 'Upload Patron Image' box click 'Browse' to find the image on your computer and
23841 'Upload' to load the image on to the patron record.</para>
23843 <screeninfo>Patron image</screeninfo>
23846 <imagedata fileref="images/patrons/patronimage.png"/>
23852 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
23853 that the image be 200x300 pixels, but smaller images will work as well.</para>
23858 <section id="editpatrons">
23859 <title>Editing Patrons</title>
23861 <para>Patrons in Koha can be edited using one of many edit
23866 <para>To edit the entire patron record simply click the 'Edit'
23867 button at the top of the patron record.</para>
23870 <screeninfo>Main Patron Edit Menu</screeninfo>
23874 <imagedata fileref="images/patrons/patronedit.png"/>
23881 <para>Patron passwords are not recoverable. The stars show on the
23882 patron detail next to the Password label are always there even if a
23883 password isn't set. If a patron forgets their password the only
23884 option is to reset their password. To change the patron's password,
23885 click the 'Change Password' button</para>
23888 <screeninfo>Patron Password Change Form</screeninfo>
23892 <imagedata fileref="images/patrons/patronpassword.png"/>
23899 <para>Koha cannot display existing passwords. Leave the field
23900 blank to leave password unchanged.</para>
23904 <para>This form can automatically generate a random password if
23905 you click the link labeled "Click to fill with a randomly
23906 generated suggestion. Passwords will be displayed as
23913 <para>To edit a specific section of the patron record (for example
23914 the Library Use section) click the 'Edit' link below the
23918 <screeninfo>Library Use Section of Patron Record</screeninfo>
23922 <imagedata fileref="images/patrons/patroneditsection.png"/>
23929 <para>A patron image can be added by browsing for the image on your
23930 machine from the 'Manage Patron Image' section</para>
23933 <screeninfo>Manage Patron Image Form</screeninfo>
23937 <imagedata fileref="images/patrons/patronaddimage.png"/>
23944 <para>This form will not appear if you have the <link linkend="patronimages">patronimages</link> system preference to
23945 not allow patron images</para>
23949 <para>To add patron images in bulk, use the <link linkend="uploadpatronimages">Upload Patron Images</link>
23956 <para id="patronflags">Patrons can also be blocked from checking
23957 items out by setting Patron Flags</para>
23960 <screeninfo>Patron Warning Flags</screeninfo>
23964 <imagedata fileref="images/patrons/patronflags.png"/>
23971 <para>If you would like your circulation staff to confirm a
23972 patron's address before checking items out to the patron, you
23973 can see the 'Gone no Address' flag</para>
23976 <screeninfo>Patron's address in doubt</screeninfo>
23980 <imagedata fileref="images/patrons/patronaddress.png"/>
23986 <para>If the patron reports that they have lost their card you can set the 'Lost Card'
23987 flag to prevent someone else from using that card to check items out</para>
23989 <screeninfo>Patron lost card</screeninfo>
23992 <imagedata fileref="images/patrons/patroncardlost.png"/>
23999 <para>If you would like to bar a patron from the library you can add a manual
24002 <screeninfo>Add manual restriction</screeninfo>
24005 <imagedata fileref="images/patrons/addpatronrestriction.png"/>
24012 <tip><para>This flag can automatically be set with the <link linkend="noticetriggers">Overdue/Notice Status
24013 Triggers</link></para></tip>
24019 <para>If you enter in a date and/or note related to the
24020 restriction you will see that in the restricted message as
24024 <screeninfo>Restricted until message</screeninfo>
24028 <imagedata fileref="images/patrons/restricteduntil.png"/>
24037 <para>Children patrons do not become adults automatically in Koha unless you have <link linkend="j2acron">Juvenile to Adult cron job</link> running. To upgrade a child patron
24038 to and adult patron category manually go to the 'More' menu and choose 'Update Child to
24039 Adult Patron'</para>
24042 <screeninfo>Update Child to Adult Patron</screeninfo>
24046 <imagedata fileref="images/patrons/updatetoadult.png"/>
24053 <para>You will then be presented with a pop up window asking
24054 which one of your adult patron categories this Child should be
24058 <screeninfo>Choose Adult Category to Update To</screeninfo>
24062 <imagedata fileref="images/patrons/choosadulttype.png"/>
24071 <section id="mangepatronedits">
24072 <title>Manging Patron Self Edits</title>
24073 <para>If you are allowing patrons to edit their accounts via the OPAC with the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference then you will need to
24074 approve all changes via the staff client before they're applied. If there are patron edits
24075 awaiting action they will appear on the staff client dashboard below the modules list (along
24076 with other items awaiting action).</para>
24078 <screeninfo>Patron requests waiting</screeninfo>
24081 <imagedata fileref="images/patrons/pendingpatronrequest.png"/>
24085 <para>When you click the 'Patrons requesting modifications' link you will be brought to a list
24086 of patrons with requested changes.</para>
24088 <screeninfo>Manage patron updates</screeninfo>
24091 <imagedata fileref="images/patrons/managepatronupdates.png"/>
24095 <para>From here you can 'Approve' and apply the changes to the patron record, 'Delete' and
24096 remove the changes or 'Ignore' and keep the changes pending to review later.</para>
24099 <section id="patronpermissions">
24100 <title>Patron Permissions</title>
24102 <para>Patron Permissions are used to allow staff members access to the
24103 staff client.</para>
24106 <para>In order for a staff member to log into the staff interface they
24107 must have (at the very least) 'catalogue' permissions which allow them
24108 to view the staff interface.</para>
24111 <section id="setpatronperms">
24112 <title>Setting Patron Permissions</title>
24114 <para>To set patron permissions, you must first <link linkend="addstaffpatron">have a patron of the 'Staff' type</link>
24119 <para>On the patron record click More and choose Set Permissions
24120 to alter patron permissions</para>
24123 <screeninfo>Set Patron Permissions</screeninfo>
24127 <imagedata fileref="images/patrons/editpatronpermissions.png"/>
24134 <para>You will be presented with a list of preferences, some of
24135 which can be expanded by clicking the plus sign to the left of the
24136 section title.</para>
24139 <screeninfo>Patron Permissions</screeninfo>
24143 <imagedata fileref="images/patrons/GranularPermissions.png"/>
24151 <section id="patronpermsdefined">
24152 <title>Patron Permissions Defined</title>
24158 <para>superlibrarian</para>
24162 <para>Access to all librarian functions</para>
24167 <para>With this selected there is no need to choose any
24168 other permissions</para>
24177 <para>circulate</para>
24181 <para>Check out and check in items</para>
24185 <para>This section can be expanded (<link linkend="circpermissions">Learn more</link>)</para>
24191 <para>catalogue</para>
24195 <para><emphasis role="bold">Required for staff login.</emphasis> Staff access,
24196 allows viewing the catalogue in staff client<itemizedlist>
24199 <para>Must be given to all staff members to allow them to login to the staff
24203 </itemizedlist></para>
24209 <para>parameters</para>
24213 <para>Manage Koha system systems (Administration panel)</para>
24217 <para>This section can be expanded (<link linkend="parameterpermissions">Learn
24218 more</link>)</para>
24224 <para>borrowers</para>
24228 <para>Add or modify patrons</para>
24234 <para>permissions</para>
24238 <para>Set user permissions</para>
24244 <para>reserveforothers</para>
24248 <para>Place and modify holds for patrons</para>
24252 <para>This section can be expanded (<link linkend="reservepermissions">Learn more</link>)</para>
24258 <para>borrow</para>
24262 <para>Borrow books</para>
24268 <para>editcatalogue</para>
24272 <para>Edit Catalog (Modify bibliographic/hodings data)</para>
24276 <para>This section can be expanded (<link linkend="catpermissions">Learn more</link>)</para>
24282 <para>updatecharges</para>
24286 <para>Manage patrons fines and fees</para>
24289 <para>This section can be expanded (<link linkend="updatechargespermissions">Learn
24290 more</link>)</para>
24296 <para>acquisition</para>
24300 <para>Acquisition and/or suggestion management</para>
24304 <para>This section can be expanded (<link linkend="acqpermissions">Learn more</link>)</para>
24310 <para>management</para>
24314 <para>Set library management paraments (deprecated)<itemizedlist>
24317 <para>This permission level no longer controls anything.</para>
24320 </itemizedlist></para>
24330 <para>Use all tools</para>
24334 <para>This section can be expanded (<link linkend="toolspermissions">Learn more</link>)</para>
24340 <para>editauthorities</para>
24344 <para>Edit Authorities</para>
24350 <para>serials</para>
24354 <para>Manage serial subscriptions</para>
24358 <para>This section can be expanded (<link linkend="serpermissions">Learn more</link>)</para>
24364 <para>reports</para>
24368 <para>Allow access to the reports module</para>
24372 <para>Reports found on the Circulation page are not controlled
24373 by this permission</para>
24377 <para>This section can be expanded (<link linkend="reportpermissions">Learn more</link>)</para>
24383 <para>staffaccess</para>
24387 <para>Allow staff members to modify permissions for other staff members</para>
24392 <para>Requires the borrowers permission above</para>
24398 <para>plugins<itemizedlist>
24400 <para>Koha plugins</para>
24403 <para>This section can be expanded (<link linkend="pluginpermissions">Learn
24404 more</link>)</para>
24406 </itemizedlist></para>
24410 <section id="circpermissions">
24411 <title>Granular Circulate Permissions</title>
24413 <para>If the staff member has 'circulate' permissions they have the
24414 ability to perform all of these actions. If you would like to
24415 control circulation permissions on a more granular level choose from
24416 these options:</para>
24420 <para>circulate_remaining_permissions</para>
24424 <para>Remaining circulation permissions</para>
24427 <para>All circulation rights except those covered by permissions listed
24433 <para>force_checkout<itemizedlist>
24435 <para>Force checkout if a limitation exists</para>
24438 <para>With this permission a librarian will be allowed to override a check out
24439 restriction in the following cases: <itemizedlist>
24441 <para>age restriction</para>
24444 <para>the item is issued to another patron</para>
24447 <para>the item is not for loan</para>
24450 <para>the patron has overdue items</para>
24453 <para>the item is lost </para>
24456 <para>the item is a high demand item</para>
24459 <para>the item is on hold</para>
24461 </itemizedlist></para>
24463 </itemizedlist></para></listitem>
24464 <listitem><para>manage_restrictions<itemizedlist>
24466 <para>Manage restrictions for accounts</para>
24469 <para>Grants permission to the staff member to lift a restriction that might be
24470 on the patron's record</para>
24472 </itemizedlist></para>
24475 <para>overdues_report<itemizedlist>
24477 <para> Execute overdue items report </para>
24480 <para>The permission to run the overdues reports found under Circulation</para>
24482 </itemizedlist></para>
24486 <para>override_renewals</para>
24490 <para>Override blocked renewals</para>
24494 <para>Requires that the staff member also has
24495 circulate_remaining_permissions</para>
24502 <section id="parameterpermissions">
24503 <title>Granular Parameters Permissions</title>
24505 <para>If the staff member has 'parameters' permissions they have the
24506 ability to perform all of these actions. If you would like to
24507 control parameter permissions on a more granular level choose from
24508 these options:</para>
24512 <para>manage_circ_rules</para>
24516 <para>Manage circulation rules</para>
24519 <para>The ability to access the <link linkend="circfinerules">Circulation and
24520 fines rules</link> in the administration area</para>
24526 <para>parameters_remaining_permissions</para>
24530 <para>Remaining system parameters permissions</para>
24533 <para>The ability to access all areas in Administration (other than the
24534 Circulation and fine rules)</para>
24541 <section id="reservepermissions">
24542 <title>Granular Holds Permissions</title>
24544 <para>If the staff member has 'reserveforothers' permissions they
24545 have the ability to perform all of these actions. If you would like
24546 to control holds permissions on a more granular level choose from
24547 these options:</para>
24551 <para>modify_holds_priority</para>
24555 <para>Modify holds priority</para>
24558 <para>Allow staff members to alter the holds priority (moving patrons up and down
24565 <para>place_holds</para>
24569 <para>Place holds for patrons</para>
24576 <section id="catpermissions">
24577 <title>Granular Cataloging Permissions</title>
24579 <para>If the staff member has 'editcatalogue' permissions they have
24580 the ability to perform all of these actions. If you would like to
24581 control cataloging permissions on a more granular level choose from
24582 these options:</para>
24586 <para>edit_catalogue</para>
24590 <para>Edit catalog (Modify bibliographic/holdings data)</para>
24593 <para>Ability to access all cataloging functions via the <link linkend="cataloging">Cataloging</link> page</para>
24599 <para>edit_items</para>
24603 <para>Edit items</para>
24606 <para>Ability to make <link linkend="editingitems">edits to item/holdings
24607 records</link>, but not bibliographic records</para>
24613 <para id="fastaddpermissions">fast_cataloging</para>
24617 <para>Fast cataloging</para>
24620 <para>The ability to catalog using only the <link linkend="fastaddcat">Fast Add
24621 Framework</link> found on the <link linkend="circulation">Circulation</link>
24628 <section id="updatechargespermissions">
24629 <title>Granular Fines and Charges Permissions</title>
24630 <para>If a staff member has 'updatecharges' permission they have the ability to perform
24631 all of these actions. If you would like to control fines and charges permissions on a
24632 more granular level choose from these options:<itemizedlist>
24634 <para>remaining_permissions<itemizedlist>
24636 <para>Remaining permissions for managing fines and fees other than the ability
24637 to write off charges</para>
24639 </itemizedlist></para>
24642 <para>writeoff<itemizedlist>
24644 <para>Write off fines and fees</para>
24646 </itemizedlist></para>
24648 </itemizedlist></para>
24651 <section id="acqpermissions">
24652 <title>Granular Acquisitions Permissions</title>
24654 <para>If the staff member has 'acquisition' permissions they have
24655 the ability to perform all of these actions. If you would like to
24656 control acquisitions permissions on a more granular level choose
24657 from these options:</para>
24661 <para>budget_add_del</para>
24665 <para>Add and delete budgets (but can't modify them)</para>
24671 <para>budget_manage</para>
24674 <para>Manage budgets</para>
24680 <para>budget_manage_all <itemizedlist>
24682 <para>Manage all budgets</para>
24684 </itemizedlist></para>
24685 <para>budget_modify</para>
24688 <para>Modify budget (can't create lines, but can modify existing ones)</para>
24694 <para>contracts_manage</para>
24698 <para>Manage contracts</para>
24704 <para>group_manage</para>
24708 <para>Manage orders and basket groups</para>
24714 <para>order_manage</para>
24718 <para>Manage orders and baskets</para>
24723 <para>order_manage_all<itemizedlist>
24725 <para>Manage all orders and baskets, regardless of restrictions on them</para>
24727 </itemizedlist></para>
24731 <para>order_receive</para>
24735 <para>Manage orders and baskets</para>
24741 <para>period_manage</para>
24745 <para>Manage periods</para>
24751 <para>planning_manage</para>
24755 <para>Manage budget planning</para>
24761 <para>vendors_manage</para>
24765 <para>Manage vendors</para>
24772 <section id="serpermissions">
24773 <title>Granular Serials Permissions</title>
24775 <para>If the staff member has 'serials' permissions they have the
24776 ability to perform all of these actions. If you would like to
24777 control serials permissions on a more granular level choose from
24778 these options:</para>
24782 <para>check_expiration</para>
24786 <para>Check the <link linkend="serialexpiration">expiration of a
24787 serial</link></para>
24793 <para>claim_serials</para>
24797 <para>Claim missing serials via the <link linkend="serialclaims">Claims
24798 section</link></para>
24804 <para>create_subscription</para>
24808 <para>Create <link linkend="newsubscription">a new subscription</link></para>
24814 <para>delete_subscription</para>
24818 <para>Delete an existing subscription</para>
24824 <para>edit_subscription</para>
24828 <para>Edit an existing subscription</para>
24831 <para>This permission does not include the ability to delete or create a
24832 subscription</para>
24838 <para>receive_serials</para>
24842 <para>Serials receiving</para>
24845 <para>Receive serials on existing subscriptions</para>
24851 <para>renew_subscription</para>
24855 <para>Renew a subscription</para>
24861 <para>routing</para>
24865 <para>Routing</para>
24868 <para>Manage <link linkend="routinglist">routing lists</link></para>
24873 <para>superserials<itemizedlist>
24875 <para>Manage subscriptions from any branch (only applies when <link
24876 linkend="IndependentBranches">IndependantBranches</link> is used)</para>
24878 </itemizedlist></para>
24883 <section id="toolspermissions">
24884 <title>Granular Tools Permissions</title>
24886 <para>If the staff member has 'tools' permissions they have the
24887 ability to access and use all items under the Tools menu. If you
24888 would like to control which tools staff members have access to on a
24889 more granular level choose from these options:</para>
24893 <para>batch_upload_patron_images</para>
24897 <para>Upload patron images in batch or one at a time </para>
24900 <para>Access to the <link linkend="uploadpatronimages">Image Upload
24907 <para>delete_anonymize_patrons</para>
24911 <para>Delete old borrowers and anonymize circulation/reading history (deletes
24912 borrower reading history)</para>
24915 <para>Access to the <link linkend="anonpatrons">Anonymize Patron
24922 <para>edit_calendar</para>
24926 <para>Define days when the library is closed </para>
24929 <para>Access to the <link linkend="calholidays">Calendar/Holidays
24936 <para>edit_news</para>
24940 <para>Write news for the OPAC and staff interfaces </para>
24943 <para>Access to the <link linkend="newstool">News Tool</link></para>
24949 <para>edit_notice_status_triggers</para>
24953 <para>Set notice/status triggers for overdue items </para>
24956 <para>Access to the <link linkend="noticetriggers">Overdue Notice Status/Triggers
24963 <para>edit_notices</para>
24967 <para>Define notices </para>
24970 <para>Access to the <link linkend="notices">Notices Tool</link></para>
24976 <para>export_catalog</para>
24980 <para>Export bibliographic, authorities and holdings data </para>
24983 <para>Access to the <link linkend="exportbibs">Export Data Tool</link></para>
24989 <para>import_patrons</para>
24993 <para>Import patron data </para>
24996 <para>Access to the <link linkend="patronimport">Import Patrons Tool</link></para>
25002 <para>inventory</para>
25006 <para>Perform inventory (stocktaking) of your catalog </para>
25009 <para>Access to the <link linkend="inventory">Inventory Tool</link></para>
25015 <para>items_batchdel</para>
25019 <para>Perform batch deletion of items </para>
25022 <para>Access to the <link linkend="batchdeleteitems">Batch Item Deletion
25029 <para>items_batchmod</para>
25033 <para>Perform batch modification of items </para>
25036 <para>Access to the <link linkend="batchmodifyitems">Batch Item Modification
25043 <para>label_creator</para>
25047 <para>Create printable labels and barcodes from catalog and patron data </para>
25050 <para>Access to the <link linkend="labelcreator">Label Creator</link> and <link linkend="quicklabelcreator">Quick Label Creator</link> Tools</para>
25056 <para>manage_csv_profiles</para>
25060 <para>Manage CSV export profiles</para>
25063 <para>Access to the <link linkend="csvprofiles">CSV Profiles Tool</link></para>
25069 <para>manage_staged_marc</para>
25073 <para>Managed staged MARC records, including completing and reversing imports
25077 <para>Access to the <link linkend="managestaged">Manage Staged MARC Records
25084 <para>moderate_comments</para>
25088 <para>Moderate patron comments </para>
25091 <para>Access to the <link linkend="comments">Comments Tool</link>
25098 <para>moderate_tags<itemizedlist>
25100 <para>Moderate patron tags</para>
25103 <para>Access to the <link linkend="tagsmoderation">Tags Tool</link></para>
25105 </itemizedlist></para>
25108 <para>schedule_tasks</para>
25111 <para>Schedule tasks to run </para>
25114 <para>Access to the <link linkend="taskscheduler">Task Scheduler
25121 <para>stage_marc_import</para>
25125 <para>Stage MARC records into the reservoir </para>
25128 <para>Access to the <link linkend="stagemarc">Stage MARC Records
25135 <para>upload_local_cover_images</para>
25139 <para>Upload local cover images </para>
25142 <para>Access to the <link linkend="uploadlocalimages">Upload Local Cover Image
25143 Tool</link> as well as permission to add and delete local cover images from
25144 the bib detail page</para>
25150 <para>view_system_logs</para>
25154 <para>Browse the system logs </para>
25157 <para>Access to the <link linkend="logviewer">Log Viewer Tool</link></para>
25164 <section id="reportpermissions">
25165 <title>Granular Reports Permissions</title>
25167 <para>If the staff member has 'reports' permissions they have the
25168 ability to perform all of these actions. If you would like to
25169 control reports permissions on a more granular level choose from
25170 these options:</para>
25174 <para>create_reports</para>
25178 <para>Create SQL Reports</para>
25181 <para>The ability to create and edit but not run SQL reports</para>
25187 <para>execute_reports</para>
25191 <para>Execure SQL Reports</para>
25194 <para>The ability to run but not create or edit SQL reports </para>
25200 <section id="pluginpermissions">
25201 <title>Granular Plugins Permissions</title>
25202 <para>If the staff member has 'plugins' permissions they have the ability to perform all
25203 of these actions. If you would like to control reports permissions on a more granular
25204 level choose from these options:<itemizedlist>
25206 <para>configure<itemizedlist>
25208 <para>Configure plugins</para>
25211 <para>The ability to run the 'configure' section of a plugin if it has
25214 </itemizedlist></para>
25217 <para>manage<itemizedlist>
25219 <para>Manage plugins </para>
25222 <para>The ability to install or uninstall plugins</para>
25224 </itemizedlist></para>
25227 <para>report<itemizedlist>
25229 <para>Use report plugins</para>
25232 <para>The ability to use report plugins</para>
25234 </itemizedlist></para>
25237 <para>tool<itemizedlist>
25239 <para>Use tool plugins</para>
25242 <para>The ability to use tool plugins</para>
25244 </itemizedlist></para>
25246 </itemizedlist></para>
25251 <section id="patroninformation">
25252 <title>Patron Information</title>
25254 <para>When viewing a patron record you have the option to view information from one of many
25255 tabs found on the left hand side of the record.<itemizedlist>
25257 <para><emphasis role="italic">Get there:</emphasis> Patrons > Browse or search for
25258 patron > Click patron name</para>
25260 </itemizedlist></para>
25262 <section id="patcheckout">
25263 <title>Check Out</title>
25265 <para>For instruction on checking items out, view the <link linkend="checkingout">Checking Out</link> section of this
25269 <section id="patrondetails">
25270 <title>Details</title>
25272 <para>All patron information will appear on the Details tab. This
25273 includes all the contact information, notes, custom patron attributes,
25274 messaging preferences, etc entered when adding the patron.</para>
25276 <para>In the case of patrons who are marked as 'Child' or
25277 'Professional' and their Guarantors additional information will appear
25278 on their record.</para>
25282 <para>A child patron will list their Guarantor</para>
25285 <screeninfo>Guarantor listed and linked from the child
25286 record</screeninfo>
25290 <imagedata fileref="images/patrons/child.png"/>
25297 <para>On the Guarantor's record, all children and/or professionals
25298 will be listed</para>
25301 <screeninfo>Guarantees listed on the Guarantor's
25302 profile</screeninfo>
25306 <imagedata fileref="images/patrons/parent.png"/>
25313 <section id="patcircsummary">
25314 <title>Circulation Summary</title>
25316 <para>Below the patron's information on the details screen is a
25317 tabbed display of the items they have checked out, overdue, and on
25321 <screeninfo>Checkout summary</screeninfo>
25325 <imagedata fileref="images/patrons/checkoutsummary.png"/>
25330 <para>If they have family at the library staff can see what the
25331 other family members have checked out.</para>
25334 <screeninfo>Relative checkouts</screeninfo>
25338 <imagedata fileref="images/patrons/relativecheckouts.png"/>
25342 <para>The Restrictions tab will show for all patrons. If the patron has no restrictions
25343 you will see that on the tab.</para>
25345 <screeninfo>Patron restrictions</screeninfo>
25348 <imagedata fileref="images/patrons/patronrestrictions-none.png"/>
25352 <para>If the patron has restrictions on their account the tab will show the number and the
25353 description.</para>
25355 <screeninfo>Patron restrictions</screeninfo>
25358 <imagedata fileref="images/patrons/patronrestrictions.png"/>
25362 <para>Using the 'Add manual restriction' button you can add a restriction to the patron
25363 record from here.</para>
25365 <screeninfo>Add restriction</screeninfo>
25368 <imagedata fileref="images/patrons/addrestriction.png"/>
25375 <section id="patronfines">
25376 <title>Fines</title>
25378 <para>The patron's complete accounting history will appear on the
25379 Fines tab. Contrary to its name, the Fines tab does not just show fine
25380 data, it also shows membership fees, rental fees, reserve fees and any
25381 other charge you may have for patrons.</para>
25384 <screeninfo>Patron Accounting Summary</screeninfo>
25388 <imagedata fileref="images/patrons/patronaccount.png"/>
25393 <para>The table will show you the following columns:</para>
25397 <para>Date: the date the charge/payment was posted</para>
25401 <para>In the case of fines this will be the last day that the
25402 fine was accrued</para>
25408 <para>Description: a description of the charges including the due
25409 date for overdue items and a link to the item record where one is
25414 <para>Note: any notes about this charge/payment</para>
25418 <para>Amount: the total amount of the payment or charge</para>
25422 <para>Outstanding: the amount still due on charge</para>
25426 <section id="chargefines">
25427 <title>Charging Fines/Fees</title>
25429 <para>Most fees and fines will be charged automatically if the <link linkend="finescronjob">fines cron job</link> is running:</para>
25433 <para>Fines will be charged based on your <link linkend="circfinerules">Circulation & Fines
25434 Rules</link></para>
25438 <para>Hold fees will be charged based on the rules you set in
25439 the <link linkend="patcats">Patron Types & Categories</link>
25440 administration area</para>
25444 <para>Rental fees will be charged based on the settings in your
25445 <link linkend="itemtypeadmin">Item Types</link> administration
25450 <para>Marking an item 'Lost' via the cataloging module will
25451 automatically charge the patron the replacement cost for that
25457 <section id="payfines">
25458 <title>Pay/Reverse Fines</title>
25460 <para>Each line item can be paid in full (or written off) using the
25461 'Pay Fines' tab.</para>
25464 <screeninfo>Paying Fines</screeninfo>
25468 <imagedata fileref="images/patrons/makepayment.png"/>
25475 <para>Each line item can be paid in full, partially paid, or
25476 written off.</para>
25480 <para>Pay a fine in full</para>
25484 <para>Click "Pay" next to the fine you want to pay in
25489 <para>The full amount of the fine will be populated for you
25490 in the "Collect From Patron" box</para>
25493 <screeninfo>Pay fine</screeninfo>
25497 <imagedata fileref="images/patrons/payfine.png"/>
25504 <para>Click "Confirm"</para>
25508 <para>The fine will be removed from outstanding fines, and
25509 displayed as fully paid.</para>
25515 <para>Pay a partial fine</para>
25519 <para>Click "Pay" next to the fine you want to partially
25524 <para>Enter the amount you are collecting from the patron in
25525 the "Collect From Patron" box</para>
25528 <screeninfo>Pay partial fine</screeninfo>
25532 <imagedata fileref="images/patrons/paypartial.png"/>
25539 <para>Click "Confirm"</para>
25543 <para>The fine will be updated to show the original Amount,
25544 and the current Amount Outstanding</para>
25550 <para>Pay an amount towards all fines</para>
25554 <para>Click the "Pay Amount" button</para>
25558 <para>Enter the amount you are collecting from the patron in
25559 "Collect from Patron." The sum of all fines is shown in
25560 "Total Amount Outstanding"</para>
25563 <screeninfo>Pay Amount</screeninfo>
25567 <imagedata fileref="images/patrons/payamount.png"/>
25574 <para>Click "Confirm"</para>
25578 <para>The fine totals will be updated with the payment
25579 applied to oldest fines first.</para>
25585 <para>Pay Selected fines</para>
25589 <para>Check the selection boxes next to the fines you wish
25590 to pay, click "Pay Selected"</para>
25593 <screeninfo>Select lines to pay</screeninfo>
25597 <imagedata fileref="images/patrons/payselected-select.png"/>
25604 <para>Enter an amount to pay towards the fines.</para>
25607 <screeninfo>Pay Selected</screeninfo>
25611 <imagedata fileref="images/patrons/payselected.png"/>
25618 <para>Click "Confirm"</para>
25622 <para>The fine totals will be updated with the payment
25623 applied to the oldest selected fines first.</para>
25629 <para>Writeoff a single fine</para>
25633 <para>Click "Writeoff" next to the fine you wish to
25638 <para>The fine will be removed from outstanding fines, and
25639 displayed as written off.</para>
25645 <para>Writeoff All fines</para>
25649 <para>Click the "Writeoff All" button</para>
25653 <para>All fines will be removed from outstanding fines, and
25654 displayed as written off.</para>
25660 <para>If you accidentally mark and item as paid, you can reverse
25661 that line item by clicking 'Reverse' to the right of the
25665 <screeninfo>Reverse Link</screeninfo>
25669 <imagedata fileref="images/patrons/reverselink.png"/>
25676 <para>Once clicked a new line item will be added to the
25677 account, showing the payment as reversed</para>
25680 <screeninfo>Reversed Payment</screeninfo>
25684 <imagedata fileref="images/patrons/reversed.png"/>
25694 <section id="manualinvoice">
25695 <title>Creating Manual Invoices</title>
25697 <para>For fees that are not automatically charged, librarians can
25698 create a manual invoice</para>
25701 <screeninfo>Create Manual Invoice</screeninfo>
25705 <imagedata fileref="images/patrons/manualinvoice.png"/>
25712 <para>First choose the type of invoice you would like to
25717 <para>To add additional values to the manual invoice type pull down menu, add them
25718 to the <link linkend="manualinvvals">MANUAL_INV</link> Authorized Value</para>
25723 <para>The value set as the Authorized Value for the MANUAL_INV authorized
25724 value category will appear as the Description and the Authorized Value
25725 Description will be used as the amount.</para>
25733 <para>If the fee is associated with an item you can enter its
25734 barcode so that the line item shows a link to that item</para>
25738 <para>The description field is where you will enter the
25739 description of the charge</para>
25743 <para>In the amount field, do not enter currency symbols, only
25744 numbers and decimals</para>
25749 <section id="manualcredit">
25750 <title>Creating Manual Credits</title>
25752 <para>Manual credits can be used to pay off parts of fines, or to
25753 forgive a fine amount.</para>
25756 <screeninfo>Create Manual Credit</screeninfo>
25760 <imagedata fileref="images/patrons/manualcredit.png"/>
25767 <para>First choose the type of credit you'd like to apply</para>
25771 <para>If this credit is associated with an item you can enter
25772 that item's barcode so that the line item links to the right
25777 <para>The description field is where you will enter the
25778 description of the credit</para>
25782 <para>In the amount field, do not enter currency symbols, only
25783 numbers and decimals</para>
25788 <section id="printinglineitems">
25789 <title>Printing Invoices</title>
25791 <para>To the right of each account line there is a print link.
25792 Clicking that link will print an invoice for the line item that
25793 includes the date and description of the line item along with the
25794 total outstanding on the account.</para>
25797 <screeninfo>Sample Invoice</screeninfo>
25801 <imagedata fileref="images/patrons/patroninvoice.png"/>
25808 <section id="patronroutingtab">
25809 <title>Routing Lists</title>
25811 <para>A list of all of the serial routing lists the patron belongs to
25812 will be accessible via the 'Routing Lists' tab on the patron
25816 <screeninfo>Routing Lists</screeninfo>
25820 <imagedata fileref="images/patrons/routinglisttab.png"/>
25825 <para>On this tab you will be able to see and edit all of the routing
25826 lists that this patron is on.</para>
25829 <screeninfo>Patron's routing lists</screeninfo>
25833 <imagedata fileref="images/patrons/patronroutinglists.png"/>
25839 <section id="circhistory">
25840 <title>Circulation History</title>
25842 <para>The circulation history tab will appear if you have set the
25843 <link linkend="intranetreadinghistory">intranetreadinghistory</link>
25844 preference to allow it to appear. If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
25845 'Allow' and the patron has decided that the library cannot keep this
25846 information this tab will only show currently checked out
25850 <screeninfo>Patron Circulation History</screeninfo>
25854 <imagedata fileref="images/patrons/readinghistory.png"/>
25859 <para>If you would like to export a list of barcodes for the items
25860 checked in today you can find that option under the More menu on the
25861 top right of the page.</para>
25864 <screeninfo>Export today's checkins</screeninfo>
25868 <imagedata fileref="images/patrons/readinghistory-export.png"/>
25873 <para>This will generate a text file with one barcode per line.</para>
25876 <section id="patmodlog">
25877 <title>Modification Log</title>
25879 <para>If you have set your <link linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
25880 records, then this tab will appear. The Modification Log will show
25881 when changes were made to the patron record. If you also have turned
25882 on the <link linkend="IssueLog">IssueLog</link> and <link linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
25883 this screen as well.</para>
25886 <screeninfo>Changes to Patron</screeninfo>
25890 <imagedata fileref="images/patrons/borrowerlog.png"/>
25897 <para>The Librarian field shows the patron number for the
25898 librarian who made the changes</para>
25902 <para>The module lists 'MEMBERS' for the patron module</para>
25906 <para>The action will tell you what action was being logged</para>
25910 <para>The Object field lists the borrowernumber that is being
25911 modified (in the example above, it was my changing my own
25917 <section id="patnotices">
25918 <title>Notices</title>
25920 <para>The <link linkend="setpatronmessaging">patron's messaging
25921 preferences</link> are set when <link linkend="addnewpatron">adding</link> or <link linkend="editpatrons">editing</link> the patron. This tab will show
25922 the messages that have been sent and those that are queued to be
25926 <screeninfo>Patron Notices Tab</screeninfo>
25930 <imagedata fileref="images/patrons/patnoticestab.png"/>
25935 <para>Clicking on the message title will expand the view to show you
25936 the full text of the message that was sent.</para>
25939 <screeninfo>Full message text</screeninfo>
25943 <imagedata fileref="images/patrons/patnoticestab-full.png"/>
25949 <section id="patronstatstab">
25950 <title>Statistics</title>
25952 <para>Depending on what you set for the values of your <link linkend="StatisticsFields">StatisticsFields</link> system preference,
25953 you can see statistics for one patron's circulation actions.</para>
25956 <screeninfo>Patron's Statistics</screeninfo>
25960 <imagedata fileref="images/patrons/patronstats.png"/>
25966 <section id="patronfiles">
25967 <title>Files</title>
25969 <para>If you set the <link linkend="EnableBorrowerFiles">EnableBorrowerFiles</link> preference to
25970 'Do' the Files tab will be visible on the patron information
25974 <screeninfo>Patron Files Tab</screeninfo>
25978 <imagedata fileref="images/patrons/patronfilestab.png"/>
25983 <para>From here you can upload files to attach to the patron
25987 <screeninfo>Upload patron files</screeninfo>
25991 <imagedata fileref="images/patrons/nopatronfiles.png"/>
25996 <para>All files that are uploaded will appear above a form where
25997 additional files can be uploaded from.</para>
26000 <screeninfo>List of files on the patron record</screeninfo>
26004 <imagedata fileref="images/patrons/patronfileslist.png"/>
26009 <section id="patronsuggestions">
26010 <title>Purchase Suggestions</title>
26011 <para>If the patron has made any purchase suggestions you will see a purchase suggestions
26012 tab on the patron record.<screenshot>
26013 <screeninfo>Patron purchase suggestions</screeninfo>
26016 <imagedata fileref="images/patrons/purchasesuggestions.png"/>
26019 </screenshot></para>
26020 <para>From here you can see all suggestions made by the patron and their status, you can
26021 also create a purchase suggestion on the patron's behalf by clicking the 'New purchase
26022 suggestion' button at the top.</para>
26023 <para>Learn more about <link linkend="purchasesuggest">Purchase suggestions</link> in the
26024 <link linkend="acqmodule">Acquisitions</link> chapter of this manual.</para>
26028 <section id="patronsearch">
26029 <title>Patron Search</title>
26031 <para>Clicking on the link to the Patron module will bring you to a search/browse screen for
26032 patrons. From here you can search for a patron by any part of their name or their card
26036 <screeninfo>Patron Search</screeninfo>
26040 <imagedata fileref="images/patrons/patronsearch.png"/>
26044 <para>Clicking the small plus sign [+] to the right of the search box will open up an advanced
26045 patron search with more filters including the ability to limit to a specific category and/or library.</para>
26047 <screeninfo>Expanded patron search</screeninfo>
26050 <imagedata fileref="images/patrons/patronsearchexpand.png"/>
26055 <para>Depending on what you have chosen for the 'Search fields' you can
26056 search for patrons in various different ways.</para>
26059 <screeninfo>Patron Search Fields</screeninfo>
26063 <imagedata fileref="images/patrons/patronfieldsearch.png"/>
26070 <para>Standard:</para>
26074 <para>Enter any part of their name, username, email address or
26081 <para>Email:</para>
26085 <para>Enter any part of their email address and choose 'Contains' instead of 'Starts
26092 <para>Borrower number:</para>
26096 <para>Enter the Koha borrower number</para>
26102 <para>Phone number:</para>
26106 <para>Enter the phone number exactly as it is in the system or
26107 by using spaces between each batch of numbers.</para>
26111 <para>Example: To find (212) 555-1212 you can search for it
26112 exactly as it was entered or by searching for 212 555
26119 <para>Street address:</para>
26123 <para>Enter any part of the patron's address (includes all address fields) and choose
26124 'Contains' instead of 'Starts with' to find the string anywhere in the
26130 <para>Date of birth<itemizedlist>
26132 <para>A tooltip will appear telling you how to enter the date of birth, most
26133 libraries will be entering MM/DD/YYYY for the birthday search</para>
26135 <screeninfo>Birth date search tooltip</screeninfo>
26138 <imagedata fileref="images/patrons/patronsearchbday.png"/>
26143 </itemizedlist></para>
26146 <para>You can also choose to either search for fields that start with the string you entered
26147 or contain the string. Choosing 'Contains' will work like a wildcard search.</para>
26149 <screeninfo>Contains or Starts with Search</screeninfo>
26152 <imagedata fileref="images/patrons/patronsearchcontains.png"/>
26157 <para>You can also choose how your results will be sorted by using the
26158 'Order by' pull down menu at the end of the form.</para>
26161 <screeninfo>Patron search sort</screeninfo>
26165 <imagedata fileref="images/patrons/patronsearchsort.png"/>
26170 <para>You can also browse through the patron records by clicking on the
26171 linked letters across the top.</para>
26174 <screeninfo>Patron Browse</screeninfo>
26178 <imagedata fileref="images/patrons/patronbrowse.png"/>
26185 <chapter id="circulation">
26186 <title>Circulation</title>
26188 <para>Circulation functions can be accessed in several different ways. On
26189 the main page of the staff client there are some quick links in the center
26190 of the page to check items out, in or transfer them. For a complete
26191 listing of Circulation functions you can visit the Circulation page which
26192 is linked from the top left of every page or from the center of the main
26195 <para>Before circulating your collection you will want to set your <link linkend="globalsysprefs">Global System Preferences</link>, <link linkend="basicparams">Basic Parameters</link> and <link linkend="patscirc">Patrons & Circulation Rules</link>.</para>
26197 <para>While in Circulation you can jump between the tabs on the quick
26198 search box at the top of the screen by using the following hot
26203 <para>jump to the catalog search with Alt+Q</para>
26207 <para>jump to the checkout with Alt+U</para>
26211 <para>this will not work for Mac users</para>
26217 <para>jump to the checkin with Alt+R</para>
26222 <para>Mac users use the OPTION button in place of ALT</para>
26225 <section id="checkingout">
26226 <title>Check Out (Issuing)</title>
26228 <para>To begin the checkout process you must enter the patron barcode or
26229 part of their name. The checkout option appears in three main
26234 <para>Check out option on the top of the main staff client</para>
26237 <screeninfo>Check out box on main Koha Staff Client
26242 <imagedata fileref="images/circ/checkoutmain.png"/>
26249 <para>Check out option on the patron record</para>
26252 <screeninfo>Check out tab on a patron record</screeninfo>
26256 <imagedata fileref="images/circ/checkoutpatron.png"/>
26263 <para>Check out option on the quick search bar on the circulation
26267 <screeninfo>Check out tab on quick search bar</screeninfo>
26271 <imagedata fileref="images/circ/circquickbox.png"/>
26278 <section id="checkitemout">
26279 <title>Checking Items Out</title>
26281 <para>To check an item out to a patron, first search for that patron
26282 using one of the many options listed above.</para>
26285 <screeninfo>Check Out Screen</screeninfo>
26289 <imagedata fileref="images/circ/checkingout.png"/>
26294 <para>At the top of the Check Out screen is a box for you to type or
26295 scan the item's barcode into.</para>
26300 <para>Many modern barcode scanners will send a 'return' to the
26301 browser, making it so that the 'Check Out' button is
26302 automatically clicked</para>
26307 <para>If the barcode is not found you will be prompted to use fast cataloging to add the
26308 item. Learn more about <link linkend="fastaddcat">fast cataloging</link> later in this
26312 <para>If you have <link linkend="itemBarcodeFallbackSearch"
26313 >itemBarcodeFallbackSearch</link> set to 'Enable' then you can enter a keyword
26314 search in this box instead of just a barcode (this will make it possible to check out
26315 using title and/or call number).</para>
26319 <para>Below the box for the barcode there may be options for you to
26320 override the default due date for the item.</para>
26324 <para>This option will only appear if you have set the <link linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
26325 to allow staff to override the due date</para>
26329 <para>At the bottom of the page there is a summary of the patron's
26330 current checked out items along with the due date (and time if the
26331 item is an hourly loan), items checked out today will appear at the
26335 <para>If the checked out time is listed as 00:00 then the item is a
26336 daily loan item. The due time for daily checkouts will show 23:59
26337 which is the last minute of the day.</para>
26341 <screeninfo>Patron's checkout summary</screeninfo>
26345 <imagedata fileref="images/circ/checkoutsummary.png"/>
26349 <para>If you have set your <link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link>
26350 preference, you will also see the option to export the patron's current checkout
26351 information using a CSV Profile or ISO2709 (MARC21) format.</para>
26353 <screeninfo>Export patron's checkout information</screeninfo>
26356 <imagedata fileref="images/circ/exportcheckouts.png"/>
26361 <para>Also at the bottom of the page is the list of items the patron
26365 <screeninfo>Holds summary on check out screen</screeninfo>
26369 <imagedata fileref="images/circ/holdssummary.png"/>
26374 <para>From the holds list you can suspend or resume patrons holds
26375 using the options at the bottom of the list if you have the <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
26376 set to 'allow.'</para>
26379 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
26380 preference set to "Don't allow" then you will not have the option to
26381 put an end date on the hold suspension</para>
26384 <para>If there are notes on the patron record these will appear to the
26385 right of the checkout box</para>
26388 <screeninfo>Patron notes on check out screen</screeninfo>
26392 <imagedata fileref="images/circ/patronnotes.png"/>
26397 <para>If the patron has a hold waiting at the library that too will
26398 appear to the right of the check out box making it easy for the
26399 circulation librarian to see that there is another item to give the
26403 <screeninfo>Hold waiting message on check out screen</screeninfo>
26407 <imagedata fileref="images/circ/holdwaiting.png"/>
26412 <section id="printcircreceipt">
26413 <title>Printing Receipts</title>
26415 <para>Once you have checked out all of the items for the patron you
26416 can print them a receipt by choosing one of two methods.</para>
26418 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
26419 preference set to 'open a print quick slip window' you can simply
26420 hit enter on your keyboard or scan a blank piece of paper with your
26421 barcode scanner. The idea being that you're "checking out" a blank
26422 barcode which triggers Koha to print the 'Quick slip.'</para>
26424 <para>You can also click the Print button at the top of the screen
26425 and choose 'Print slip' or 'Print quick slip'.</para>
26428 <screeninfo>Print receipt to slip printer</screeninfo>
26432 <imagedata fileref="images/circ/printslip.png"/>
26437 <para>If you choose 'Print slip' it will print all of the items the
26438 patron has checked out, including those they checked out at an
26439 earlier date. Choosing 'Print quick slip' will print only the items
26440 that were checked out today.</para>
26442 <para>What prints on the slips can be customized by altering the
26443 slip templates under the <link linkend="notices">Notices &
26444 Slips</link> tool.</para>
26447 <section id="clearpatroninfo">
26448 <title>Clear Patron Information</title>
26450 <para>When you're done checking an item out if you have the <link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
26451 preference set to 'Show' you can clear the current patron by
26452 clicking the X in the top right of the patron's info to remove the
26453 current patron from the screen and start over.</para>
26456 <screeninfo>Clear Screen Button</screeninfo>
26460 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
26465 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
26466 preference set to 'clear the screen' then you simply need to hit
26467 enter or scan a blank barcode and the screen will be cleared of the
26468 current patron.</para>
26472 <section id="checkoutmsg">
26473 <title>Check Out Messages</title>
26475 <para>If you check out an item that has multiple pieces and you have
26476 cataloged that information in subfield 3 of the item record (in
26477 MARC21) a message will pop up when you check out that item telling you
26478 how many pieces should be there.</para>
26481 <screeninfo>Materials in the checked out item</screeninfo>
26485 <imagedata fileref="images/circ/materialspecified.png"/>
26490 <para>There are times when Koha will prevent the librarian from being
26491 able to check out items to a patron. When this happens a warning will
26492 appear notifying the librarian of why the patron cannot check items
26497 <para>Patron owes too much in fines</para>
26500 <screeninfo>Patron owes too much in fines</screeninfo>
26504 <imagedata fileref="images/circ/fineswarning.png"/>
26511 <para>You can set the amount at which patron checkouts are
26512 blocked with the <link linkend="noissuescharge">noissuescharge</link> system
26519 <para>Patron has been barred from the library</para>
26522 <screeninfo>Patron account barred</screeninfo>
26526 <imagedata fileref="images/circ/debarwarning.png"/>
26533 <para>This can be set by the librarian editing a patron record and adding a <link
26534 linkend="patronflags">restriction</link> or by the <link
26535 linkend="noticetriggers">Overdue/Notice Status Triggers</link></para>
26541 <para>Patron needs to confirm their address</para>
26544 <screeninfo>Patron's address warning</screeninfo>
26548 <imagedata fileref="images/circ/addresswarning.png"/>
26555 <para>This can be set by the librarian editing a patron record
26556 and adding a <link linkend="patronflags">flag</link></para>
26562 <para>Patrons has lost their library card</para>
26565 <screeninfo>Lost patron card warning</screeninfo>
26569 <imagedata fileref="images/circ/lostcardwarning.png"/>
26576 <para>This can be set by the librarian editing a patron record
26577 and adding a <link linkend="patronflags">flag</link></para>
26584 <section id="checkoutwarn">
26585 <title>Check Out Warnings</title>
26587 <para>Sometimes checkouts will trigger warning messages that will
26588 appear in a yellow box above the check out field. These warnings need
26589 to be acknowledged before you will be able to continue checking items
26594 <para>Patron has outstanding fines</para>
26597 <screeninfo>Patron has a debt</screeninfo>
26601 <imagedata fileref="images/circ/warnings/patrondebt.png"/>
26608 <para>Item on hold for someone else</para>
26611 <screeninfo>Item is on hold for someone else</screeninfo>
26615 <imagedata fileref="images/circ/warnings/onhold.png"/>
26622 <para>Item should be on the hold shelf waiting for someone
26626 <screeninfo>Item is on hold shelf waiting for someone
26631 <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
26638 <para>Item already checked out to this patron</para>
26641 <screeninfo>Item is currently checked out to this
26642 patron</screeninfo>
26646 <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
26653 <para>Item checked out to another patron</para>
26656 <screeninfo>Item checked out to another patron</screeninfo>
26660 <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
26667 <para>Item not for loan</para>
26670 <screeninfo>Item is not normally for loan</screeninfo>
26674 <imagedata fileref="images/circ/warnings/notforloan.png"/>
26681 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
26682 >AllowTooManyOverride</link> is set to 'Allow'</para>
26685 <screeninfo>Too many checkouts</screeninfo>
26689 <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
26695 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
26696 >AllowTooManyOverride</link> is set to "Don't allow"</para>
26698 <screeninfo>Too many checkouts</screeninfo>
26701 <imagedata fileref="images/circ/warnings/toomanycheckouts-no.png"/>
26708 <para>Item cannot be renewed</para>
26711 <screeninfo>No more renewals</screeninfo>
26715 <imagedata fileref="images/circ/warnings/norenewals.png"/>
26722 <para>This can be overridden with the <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
26723 system preference</para>
26729 <para>Barcode not found</para>
26732 <screeninfo>Barcode not found</screeninfo>
26736 <imagedata fileref="images/circ/barcodefastadd.png"/>
26743 <para>Learn more about <link linkend="fastaddcat">fast
26744 cataloging</link> later in this manual.</para>
26750 <para>Item being checked out is marked as 'lost'</para>
26754 <para>Depending on the value in your <link linkend="IssueLostItem">IssueLostItem</link> preference, you
26755 may just see a warning</para>
26758 <screeninfo>Warning that item is lost</screeninfo>
26762 <imagedata fileref="images/circ/lostitemmsg.png"/>
26767 <para>or a confirmation box</para>
26770 <screeninfo>Confirm checkout of lost item</screeninfo>
26774 <imagedata fileref="images/circ/lostitemconfirm.png"/>
26783 <para>Item being checked out is not recommended for a patron of
26787 <screeninfo>Age warning</screeninfo>
26791 <imagedata fileref="images/circ/warnings/agewarning.png"/>
26797 <para>Item being checked out meets the <link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds</link> system preference criteria</para>
26799 <screeninfo>Too many holds</screeninfo>
26802 <imagedata fileref="images/circ/warnings/decreaseLoanHighHoldsDuration.png"/>
26811 <section id="circrenew">
26812 <title>Renewing</title>
26814 <para>Checked out items can be renewed (checked out for another period of time) based on your
26815 <link linkend="circfinerules">circulation rules</link> and <link
26816 linkend="RenewalPeriodBase">renewal preferences</link>. </para>
26817 <para>If <link linkend="OpacRenewalAllowed">you allow it</link>, patrons can renew their own
26818 items via the OPAC, but sometimes you'll need to help them by renewing their items via the
26819 staff client. </para>
26820 <para>To renew items checked out to a patron, you can do one of two things. </para>
26821 <para>The first is to visit their details page or checkout page and review their checkout
26822 summary at the bottom.</para>
26825 <screeninfo>Circulation Summary</screeninfo>
26829 <imagedata fileref="images/circ/circsummary.png"/>
26834 <para>In the Renew column you will see how many times each item has been
26835 renewed and a checkbox to renew the item for the patron. Check the boxed
26836 of the items you would like to renew and click the 'Renew or Return
26837 checked items' button, or to renew all items checked out to the patron
26838 simply click the 'Renew all' button.</para>
26841 <screeninfo>Renew buttons</screeninfo>
26845 <imagedata fileref="images/circ/renewbutton.png"/>
26850 <para>Sometimes renewals will be blocked based on your circulation
26851 rules, to override this block you must have your <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
26852 preference set to 'Allow'. If you allow renewal limit overrides, you
26853 will see a checkbox at the bottom left of the circulation summary. Check
26854 that box and then choose the items you would like to renew.</para>
26857 <screeninfo>Override renewal limit</screeninfo>
26861 <imagedata fileref="images/circ/overriderenew.png"/>
26866 <para>Checking that box will add checkboxes in the renew column above
26867 where before the item was not renewable.</para>
26868 <para>The second option is to visit the 'Renew' page found under the Circulation menu.</para>
26870 <screeninfo>Renew</screeninfo>
26873 <imagedata fileref="images/circ/renewcirc.png"/>
26877 <para>And scan the barcodes of the items you would like to renew.</para>
26879 <screeninfo>Barcode to renew</screeninfo>
26882 <imagedata fileref="images/circ/renewbarcode.png"/>
26886 <para>If the item is renewed you will receive a confirmation message.</para>
26888 <screeninfo>Item renewed</screeninfo>
26891 <imagedata fileref="images/circ/renewed.png"/>
26895 <para>If the barcode is not found you will be presented with an error.</para>
26897 <screeninfo>No barcode found</screeninfo>
26900 <imagedata fileref="images/circ/renewnomatch.png"/>
26904 <para>If the item is not actually checked out you will also receive an error.</para>
26906 <screeninfo>Item not checked out</screeninfo>
26909 <imagedata fileref="images/circ/renewnotchecked.png"/>
26915 <section id="checkingin">
26916 <title>Check In (Returning)</title>
26918 <para>Checking in items can be performed from various different
26923 <para>The check in box on the top of the main staff client</para>
26926 <screeninfo>Check out box on main Koha Staff Client
26931 <imagedata fileref="images/circ/checkinmain.png"/>
26938 <para>The check in option on the quick search bar on the Circulation
26941 <screeninfo>Check in tab on quick search bar</screeninfo>
26945 <imagedata fileref="images/circ/checkinquickbox.png"/>
26952 <para>The check in link on the patron's checkout summary (and on the
26953 checkout summary page)</para>
26956 <screeninfo>Patron checkout summary includes 'Check In'
26961 <imagedata fileref="images/circ/checkinlink.png"/>
26968 <para>The Check in page under the Circulation menu</para>
26971 <screeninfo>Check in link on Circulation Module</screeninfo>
26975 <imagedata fileref="images/circ/checkincirc.png"/>
26982 <section id="checkitemin">
26983 <title>Checking Items In</title>
26985 <para>To check an item in scan the barcode for the item into the box
26986 provided. A summary of all items checked in will appear below the
26990 <screeninfo>Check In Summary</screeninfo>
26994 <imagedata fileref="images/circ/checkin.png"/>
26999 <para>If you are checking items in that were put in the book drop while the library was
27000 closed you can check the 'Book drop mode' box before scanning items. This will effectively
27001 roll back the returned date to the last date the library was open.</para>
27005 <para>This requires that you have your closings added to the <link linkend="calholidays">Holidays & Calendar Tool </link></para>
27009 <para>You can also choose to forgive all overdue charges for items you
27010 are checking in by checking the 'Forgive overdue charges' box before
27011 scanning items.</para>
27012 <para>If you have the <link linkend="SpecifyReturnDate">SpecifyReturnDate</link> preference
27013 set to 'Allow' you will be able to arbitrarily set the return date from below the check in box.<screenshot>
27014 <screeninfo>Specify check in date</screeninfo>
27017 <imagedata fileref="images/circ/SpecifyReturnDate.png"/>
27020 </screenshot></para>
27023 <section id="checkinmsg">
27024 <title>Check In Messages</title>
27026 <para>There are several messages that can appear when checking items
27031 <para>If you are checking an item in at a library other than the
27032 home branch, a message will appear asking you to transfer the book
27033 to the home library</para>
27036 <screeninfo>Check in Transfer Message</screeninfo>
27040 <imagedata fileref="images/circ/checkintransfer.png"/>
27047 <para>After this item is checked in the status of the item
27048 will be changed in the catalog to 'in transit'</para>
27051 <screeninfo>In Transit Status</screeninfo>
27055 <imagedata fileref="images/circ/transferstatus.png"/>
27062 <para>To mark an item as back at the home branch, check the
27063 item in at the home branch</para>
27066 <screeninfo>Check In Transferred Item</screeninfo>
27070 <imagedata fileref="images/circ/transfercheckin.png"/>
27077 <para>A message will appear tell you that the item is not
27078 checked out, but the status will now say available in the
27079 catalog. This step is necessary to mark items as received
27080 by the home branch.</para>
27088 <para>If you are checking in an item that should have multiple
27089 parts or pieces a message will appear warning you about the number
27090 of pieces you should have in your hand</para>
27093 <screeninfo>Materials Specified</screeninfo>
27097 <imagedata fileref="images/circ/materialspecified.png"/>
27104 <para>If you're checking an item in that has a hold on it, you
27105 will be prompted to confirm the hold</para>
27108 <screeninfo>Hold Found Check In Message</screeninfo>
27112 <imagedata fileref="images/circ/holdfound.png"/>
27119 <para>Clicking the Confirm hold button will mark the item as
27120 waiting for pickup from the library</para>
27123 <screeninfo>Hold waiting at the library</screeninfo>
27127 <imagedata fileref="images/circ/waitingstatus.png"/>
27134 <para>Clicking the Print Slip and Confirm button will mark the
27135 item as waiting for pickup at the library and present the
27136 library with a receipt to print and place on the book with the
27137 patron's information</para>
27141 <para>Ignoring the hold will leave the item on hold, but leave
27142 its status as Available (it will not cancel the hold)</para>
27148 <para>If you're checking in an item that has a hold on it at
27149 another branch you will be prompted to confirm and transfer the
27153 <screeninfo>Hold found for another branch</screeninfo>
27157 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
27164 <para>Clicking the Confirm hold and Transfer button will mark
27165 the item as in transit to the library where the hold was
27169 <screeninfo>In transit hold status</screeninfo>
27173 <imagedata fileref="images/circ/intransithold.png"/>
27180 <para>Clicking the Print Slip, Transfer and Confirm button
27181 will mark the item as in transit to the library where the hold
27182 was placed and present the library with a receipt to print and
27183 place on the book with the patron's information</para>
27187 <para>Ignoring the hold will leave the item on hold, but leave
27188 its status as Available (it will not cancel the hold)</para>
27194 <para>If you have the system showing you fines at the time of
27195 checkin (<link linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
27196 see a message telling you about the fine and providing you a link
27197 to the payment page for that patron</para>
27200 <screeninfo>FineNotifyAtCheckin</screeninfo>
27204 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
27213 <section id="circmessages">
27214 <title>Circulation Messages</title>
27216 <para>Circulation messages are short messages that librarians can leave
27217 for their patrons or their colleagues that will appear at the time of
27218 circulation.</para>
27220 <section id="setcircmsg">
27221 <title>Setting up Messages</title>
27223 <para>Circulation messages are set up as <link linkend="authorizedvalues">Authorized Values</link>. To add or edit
27224 Circulation Messages you want to work with the <link linkend="bornotes">BOR_NOTES</link> value.</para>
27227 <screeninfo>BOR_NOTES Authorized Values</screeninfo>
27231 <imagedata fileref="images/circ/bor_notes.png"/>
27236 <para>The 'Description' field can hold a canned message that you would
27237 like to appear on the patron's record. <important>
27238 <para>The 'Description' field is limited to 80 characters, but the
27239 patron message field can hold more than that. Enter 80 characters
27240 in the 'Description' field and then type the rest on the patron
27242 </important></para>
27245 <section id="addcircmsg">
27246 <title>Adding a Message</title>
27248 <para>When on the patron's check out tab you will see a link to 'Add a
27249 new message' to the right of the check out box.</para>
27252 <screeninfo>Circulation Message in Staff Client</screeninfo>
27256 <imagedata fileref="images/circ/staffmessages.png"/>
27261 <para>When you click 'Add a new message' you will be asked to choose
27262 if the message is for the librarians or the patron and the message you
27263 would like to leave.</para>
27266 <screeninfo>Leave a Circulation Message</screeninfo>
27270 <imagedata fileref="images/circ/leavecircmsg.png"/>
27276 <para>A message for the patron will also show to the library
27281 <section id="viewcircmsg">
27282 <title>Viewing Messages</title>
27284 <para>Circulation messages meant for the staff and/or the patron will
27285 appear on the patron's checkout screen to the right of the checkout
27286 box. Messages in bold and red are meant for the library staff only,
27287 whereas messages in regular italics font are meant for the patron and
27288 the librarian.</para>
27291 <screeninfo>Circulation Message in Staff Client</screeninfo>
27295 <imagedata fileref="images/circ/staffmessages.png"/>
27300 <para>Circulation messages meant for the patron will also appear when
27301 they log into the OPAC.</para>
27304 <screeninfo>Circulation Message in OPAC</screeninfo>
27308 <imagedata fileref="images/circ/opacmsg.png"/>
27315 <section id="holds">
27316 <title>Holds</title>
27318 <para>Koha allows patrons to put things on hold. A 'Hold' is a way to reserve an item.
27319 Depending on your <link linkend="circfinerules">circulation and fine rules</link> and <link linkend="circholdspolicy">hold preference</link> settings patrons will be able to place
27320 items on hold for pickup at the library at a later date/time.</para>
27322 <section id="holdsinstaff">
27323 <title>Placing Holds in Staff Client</title>
27325 <para>There are several ways to place holds from the staff client. The
27326 most obvious is using the 'Place Hold' button at the top of any
27327 bibliographic record.</para>
27330 <screeninfo>Place Hold Button on Bib Record</screeninfo>
27334 <imagedata fileref="images/circ/placeholdbib.png"/>
27339 <para>You can also click the smaller 'Place Hold' link found at the
27340 top of your catalog search results, or the 'Holds' link found below
27341 each result.</para>
27344 <screeninfo>Hold options on search results</screeninfo>
27348 <imagedata fileref="images/circ/placeholdsearch.png"/>
27353 <para>You will be asked to search for a patron by barcode or any part
27354 of their name to start the hold process.</para>
27357 <screeninfo>Find Patron For Hold</screeninfo>
27361 <imagedata fileref="images/circ/placeholdfindpatron.png"/>
27366 <para>If you'd like to search for the patron first and then the bib
27367 record for the hold, you can open the patron record and click on the
27368 'Search to Hold' button at the top of the patron record.</para>
27371 <screeninfo>Search to Hold on Patron Record</screeninfo>
27375 <imagedata fileref="images/circ/searchtohold.png"/>
27380 <para>After clicking the button you will be brought to the catalog
27381 search page where you can find the book(s) you want to place a hold
27382 on. Under each title on the results you'll see an option to 'Hold for
27383 Patron Name.'</para>
27386 <screeninfo>Hold for Patron links on Search Results</screeninfo>
27390 <imagedata fileref="images/circ/holdresults.png"/>
27395 <para>If you want to place a hold on multiple items, simply check the
27396 boxes to the left of them and click the arrow to the right of the
27397 'Place Hold' button.</para>
27400 <screeninfo>Hold Multiple Items for Patron</screeninfo>
27404 <imagedata fileref="images/circ/holdmultiresults.png"/>
27409 <para>Depending on how many items you choose to place a hold on at
27410 once you will see a different place hold form. If you are placing a
27411 hold on one bibliographic record you will see a list of all of the
27412 items you can place a hold on.</para>
27415 <screeninfo>Place Hold Form</screeninfo>
27419 <imagedata fileref="images/circ/placeholdsingle.png"/>
27426 <para>Enter any notes that might apply to this hold</para>
27430 <para>Choose the library where the patron will pick up the
27435 <para>If the patron wants the hold to start on a date other than
27436 today, enter that in the 'Hold starts on date' field</para>
27440 <para>This option will only appear if the <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
27441 system preference is set to 'Allow'</para>
27447 <para>If the patron has specified that they don't want the item
27448 after a certain date, or if you have limits on hold lengths, you
27449 can enter an expiration date for the hold in the 'Hold expires on
27454 <para>To have expired holds canceled automatically you will
27455 need to have the <link linkend="expiredholdscron">Expired
27456 Holds</link> cron job set to run on a regular basis.</para>
27462 <para>Next choose if you want to place a hold on the next
27463 available item or a specific item by clicking the radio button
27464 next to an individual item.</para>
27468 <para>If you're placing a hold on multiple items you will be presented
27469 with the next available option for all titles. If no items are
27470 available for hold it will say so on the confirmation screen.</para>
27473 <screeninfo>Place multiple items on hold</screeninfo>
27477 <imagedata fileref="images/circ/placeholdmultiple.png"/>
27482 <para>Once your hold is placed, if you'd like to have Koha forget that
27483 you used the 'Search to Hold' function, you can choose to have Koha
27484 'forget' the patron's name by clicking the arrow to the right of the
27485 'Place Hold' button on the search results and choosing the 'Forget'
27489 <screeninfo>Forget Search to Hold Option</screeninfo>
27493 <imagedata fileref="images/circ/forgethold.png"/>
27499 <section id="manageholds">
27500 <title>Managing Holds</title>
27502 <para>Holds can be altered and canceled from the Holds tab found on
27503 the left of the bibliographic record.</para>
27506 <screeninfo>Bibliographic Record Tabs</screeninfo>
27510 <imagedata fileref="images/circ/holdtab.png"/>
27515 <para>From the list of holds you can change the order of the holds,
27516 the pickup location, suspend and/or cancel the hold.</para>
27519 <screeninfo>Lists of Holds</screeninfo>
27523 <imagedata fileref="images/circ/holdslist.png"/>
27529 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
27530 preference set to "Don't allow" then you will not have the option to
27531 put an end date on the hold suspension</para>
27535 <para>Depending on how you have your <link linkend="HidePatronName">HidePatronName</link> system preference set
27536 the list may show card numbers instead of names in the Patron column
27537 like in the image above.</para>
27540 <para>To rearrange or delete holds, simply make a selection from the
27541 'Priority' pull down or click the arrows to the right of the priority
27545 <screeninfo>Hold Priority Menu</screeninfo>
27549 <imagedata fileref="images/circ/holdpriority.png"/>
27554 <para>If you use the priority pull down to rearrange or delete holds
27555 you will need to click the 'Update hold(s)' button to save your
27558 <para>Clicking the down arrow to the right of the hold will stick the
27559 hold at the bottom of the list even if more requests are made.</para>
27561 <para>For example, your library has home-bound patrons that are
27562 allowed to keep books out for months at a time. It would not be fair
27563 to other patrons if a home-bound patron were able to check out a brand
27564 new book and keep it for months. For this reason, the home-bound
27565 patron's hold request would stay at the bottom of the queue until
27566 everyone else who wanted to read that book has already done so.</para>
27569 <screeninfo>Lowest Priority & Delete Options for
27574 <imagedata fileref="images/circ/lowestpriority.png"/>
27579 <para>If a patron asks to have their hold suspended and you have the
27580 <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
27581 system preference set to 'allow' you can do so by clicking the Suspend
27582 button to far right. If the patron gives you a date for the items to
27583 become unsuspended you can enter that in the date box and click the
27584 'Update hold(s)' button to save your changes.</para>
27587 <screeninfo>Hold suspension column</screeninfo>
27591 <imagedata fileref="images/circ/suspendholds.png"/>
27596 <para>To delete or cancel a hold click the red 'X' to the right of the
27597 hold line. To delete/cancel a bunch of holds you can choose 'del' from
27598 pull down to the left of each line and then click 'Update hold(s)' at
27599 the bottom of the list.</para>
27602 <screeninfo>Cancel Holds</screeninfo>
27606 <imagedata fileref="images/circ/cancelholds.png"/>
27612 <section id="receiveholds">
27613 <title>Receiving Holds</title>
27615 <para>When items that are on hold are <link linkend="checkingin">checked in</link> or <link linkend="checkingout">out</link> the system will remind the circulation librarian that
27616 the item is on hold and offer them options for managing the hold.</para>
27618 <para>When you check in an item that has a hold on it the system will
27619 ask you to either confirm and transfer the item</para>
27622 <screeninfo>Confirm Hold & Transfer</screeninfo>
27626 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
27631 <para>or just confirm the hold</para>
27634 <screeninfo>Confirm Hold</screeninfo>
27638 <imagedata fileref="images/circ/holdconfirm.png"/>
27643 <para>Clicking the Confirm button will mark the item as on hold for
27644 the patron. If the item needs to be transferred the item will also be
27645 marked as in transit to the proper branch. Clicking 'Ignore' will
27646 retain the hold, but allow you to check the item out to another
27647 patron. Choosing to confirm and print will present you with a
27648 printable page that you can slip inside the book with the necessary
27649 hold and/or transfer information.</para>
27651 <para>Once confirmed the hold will show on the patron record and on
27652 the checkout screen under the 'Hold' tab.</para>
27655 <screeninfo>Hold on Patron Record</screeninfo>
27659 <imagedata fileref="images/circ/holdpatronrec.png"/>
27664 <para>The item record will also show that the item is on hold.</para>
27667 <screeninfo>Hold on Item Record</screeninfo>
27671 <imagedata fileref="images/circ/holditem.png"/>
27676 <para>In some cases a patron may come in to pick up a hold for their
27677 partner (or someone else in their household). In this case you want to
27678 make sure that the hold is cancelled when you check the item out to
27679 someone else. When trying to check out an item that is already waiting
27680 for someone else you will be presented with a warning message.</para>
27683 <screeninfo>Hold waiting for someone else</screeninfo>
27687 <imagedata fileref="images/circ/holdwaitingwarn.png"/>
27692 <para>From here you can check the item out to the patron at the desk
27693 and cancel the hold for the patron.</para>
27697 <section id="transfers">
27698 <title>Transfers</title>
27700 <para>If you work in a multi-branch system you can transfer items from one library to another
27701 by using the Transfer tool.<itemizedlist>
27703 <para><emphasis role="italic">Get there</emphasis>: Circulation > Transfer</para>
27705 </itemizedlist></para>
27706 <para>To transfer an item</para>
27710 <para>Click 'Transfer' on the Circulation page</para>
27713 <screeninfo>Transfer Tool</screeninfo>
27717 <imagedata fileref="images/circ/transfer.png"/>
27724 <para>Enter the library you would like to transfer the item
27729 <para>Scan or type the barcode on the item you would like to
27736 <para>Click 'Submit'</para>
27739 <screeninfo>Transfer Summary</screeninfo>
27743 <imagedata fileref="images/circ/itemtransferred.png"/>
27750 <para>The item will now say that it is in transit</para>
27753 <screeninfo>Item in Transit</screeninfo>
27757 <imagedata fileref="images/circ/itemintransit.png"/>
27764 <para>When the item arrives at the other branch the librarian must
27765 check the item in to acknowledge that it is no longer in
27770 <para>The item will not be permanently moved to the new
27774 <screeninfo>Item record</screeninfo>
27778 <imagedata fileref="images/circ/itemlocations.png"/>
27785 <para>The item shows the same 'Home Library' but has updated the
27786 'Current Location' to note where it resides at this time</para>
27793 <section id="setlibrary">
27794 <title>Set Library</title>
27796 <para>By default you will enter the staff client as if you are at your
27797 home library. This library will appear in the top right of the Staff
27801 <screeninfo>My Library</screeninfo>
27805 <imagedata fileref="images/circ/mylibrary.png"/>
27810 <para>This is the library that all circulation transactions will take
27811 place at. If you are at another library (or on a bookmobile) you will
27812 want to set your library before you start circulating items. To do this
27813 you can click 'Set' at the top right or on the Circulation page.</para>
27816 <screeninfo>Set Library Form</screeninfo>
27820 <imagedata fileref="images/circ/setlibrary.png"/>
27825 <para>Once you have saved your changes you new library will appear in
27826 the top right.</para>
27829 <section id="fastaddcat">
27830 <title>Fast Add Cataloging</title>
27832 <para>Sometimes circulation librarians need to quickly add a record to
27833 the system for an item they are about to check out. This is called 'Fast
27834 Add.' To allow circulation librarians access to the Fast Add Cataloging
27835 tool, simply make sure they have the <link linkend="fastaddpermissions">fast_cataloging</link> permissions. There
27836 are two ways to add titles via fast add. If you know that you're about
27837 to check out an item that isn't in you catalog you can go to the
27838 Circulation module and click 'Fast cataloging.'</para>
27841 <screeninfo>Circulation Menu</screeninfo>
27845 <imagedata fileref="images/circ/circmenu.png"/>
27850 <para>The cataloging interface will open up with the short cataloging
27854 <screeninfo>Fast Add Framework</screeninfo>
27858 <imagedata fileref="images/circ/fastadd.png"/>
27863 <para>After adding your cataloging data you will be asked to enter item
27864 data. Enter the items barcode, collection code, etc and save the item
27865 before checking it out.</para>
27867 <para>The other way to fast catalog is from the checkout screen. When
27868 you enter a barcode at checkout that Koha can't find, it will prompt you
27869 to use fast cataloging to add the item to Koha and check it out.</para>
27872 <screeninfo>Barcode not found</screeninfo>
27876 <imagedata fileref="images/circ/barcodefastadd.png"/>
27881 <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
27882 form where you can enter the title information</para>
27885 <screeninfo>Fast cataloging</screeninfo>
27889 <imagedata fileref="images/circ/fastaddbarcode.png"/>
27894 <para>After clicking 'Save' you will be brought to the item record where
27895 the barcode will already be filled in with the barcode you're trying to
27899 <screeninfo>Fast cataloging item record</screeninfo>
27903 <imagedata fileref="images/circ/fastadditem.png"/>
27908 <para>After clicking the 'Add item' button the item will automatically
27909 be checked out the patron you were trying to check the book out to
27913 <screeninfo>Checked out item</screeninfo>
27917 <imagedata fileref="images/circ/fastaddcheckedout.png"/>
27923 <section id="circreports">
27924 <title>Circulation Reports</title>
27926 <para>Most reports can be found vai the Reports module, but some of the more common
27927 circulation reports are available right from the Circulation module.<itemizedlist>
27929 <para><emphasis role="italic">Get there</emphasis>: Circulation > Circulation
27932 </itemizedlist></para>
27934 <section id="holdsqueue">
27935 <title>Holds Queue</title>
27937 <para>This report will show you all of the holds at your
27941 <screeninfo>Sample Holds Queue</screeninfo>
27945 <imagedata fileref="images/circ/holdsqueue.png"/>
27950 <para>To generate this report, you must have the <link linkend="buildholdscron">Build Holds Queue cron job</link> running.
27951 This cron job is a script that should be run periodically if your
27952 library system allows borrowers to place on-shelf holds. This script
27953 decides which library should be responsible for fulfilling a given
27954 hold request.</para>
27956 <para>It's behavior is controlled by the system preferences <link linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
27958 <para>If you do not want all of your libraries to participate in the
27959 on-shelf holds fulfillment process, you should list the the libraries
27960 that *do* participate in the process here by inputting all the
27961 participating library's branchcodes, separated by commas ( e.g.
27962 "MPL,CPL,SPL,BML" etc. ).</para>
27964 <para>By default, the holds queue will be generated such that the
27965 system will first attempt to hold fulfillment using items already at
27966 the pickup library if possible. If there are no items available at the
27967 pickup library to fill a hold, build_holds_queue.pl will then use the
27968 list of libraries defined in StaticHoldsQueueWeight. If
27969 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
27970 script will assign fulfillment requests in the order the branches are
27971 placed in the StaticHoldsQueueWeight system preference.</para>
27973 <para>For example, if your system has three libraries, of varying
27974 sizes ( small, medium and large ) and you want the burden of holds
27975 fulfillment to be on larger libraries before smaller libraries, you
27976 would want StaticHoldsQueueWeight to look something like
27977 "LRG,MED,SML".</para>
27979 <para>If you want the burden of holds fulfillment to be spread out
27980 equally throughout your library system, simply enable
27981 RandomizeHoldsQueueWeight. When this system preference is enabled, the
27982 order in which libraries will be requested to fulfill an on-shelf hold
27983 will be randomized each time the list is regenerated.</para>
27985 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
27986 time. Doing so will cause the build_holds_queue script to ignore
27987 RandomizeHoldsQueueWeight, causing the script to request hold
27988 fulfillment not randomly, but by alphabetical order.</para>
27991 <section id="holdspull">
27992 <title>Holds to pull</title>
27994 <para>This report will show you all of the items that have holds on
27995 them that are available at the library for pulling. If the items are
27996 available at multiple branches then all branches with that item
27997 available will see the hold to pull until one library triggers the
28001 <screeninfo>Holds to Pull</screeninfo>
28005 <imagedata fileref="images/circ/holdstopull.png"/>
28010 <para>You can limit the results you see by using the Refine box on the
28011 left side of the page:</para>
28014 <screeninfo>Refine Holds to Pull Report</screeninfo>
28018 <imagedata fileref="images/circ/refineholdstopull.png"/>
28024 <section id="holdspickup">
28025 <title>Holds awaiting pickup</title>
28027 <para>This report will show all of the holds that are waiting for
28028 patrons to pick them up.</para>
28031 <screeninfo>Holds Awaiting Pickup</screeninfo>
28035 <imagedata fileref="images/circ/holdspickup.png"/>
28040 <para>Items that have been on the hold shelf longer than you normally
28041 allow (based on the <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
28042 preference value) will appear on the 'Holds Over' tab, they will not
28043 automatically be cancelled unless you have set the <link linkend="expiredholdscron">cron job</link> to do that for you, but you
28044 can cancel all holds using the button at the top of the list.</para>
28047 <screeninfo>Items waiting on the hold shelf too long</screeninfo>
28051 <imagedata fileref="images/circ/holdspickupover.png"/>
28057 <section id="holdratios">
28058 <title>Hold ratios</title>
28060 <para>Hold ratios help with collection development. Using this report
28061 you will be able to see how many of your patrons have holds on items
28062 and whether you should buy more. By default it will be set to the
28063 library needing 3 items per hold that has been placed. The report will
28064 tell you how many additional items need to be purchased to meet this
28068 <screeninfo>Hold Ratios</screeninfo>
28072 <imagedata fileref="images/circ/holdratio.png"/>
28078 <section id="transferstoreceive">
28079 <title>Transfers to receive</title>
28081 <para>This report will list all of the items that Koha thinks are in
28082 transit to your library.</para>
28085 <screeninfo>Transfers to Receive</screeninfo>
28089 <imagedata fileref="images/circ/transitreceive.png"/>
28094 <para>If your transfers are late in arriving at your library you will
28095 see a message stating how late your items are.</para>
28098 <screeninfo>Late transfers include warning messages</screeninfo>
28102 <imagedata fileref="images/circ/transferlate.png"/>
28108 <para>An item is considered late based on the number of days you
28109 have entered in the <link linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
28110 system preference.</para>
28114 <section id="overduesreport">
28115 <title>Overdues</title>
28118 <para>For libraries with a large patron base, this report may take a
28119 significant amount of time to run.</para>
28123 <para>Large libraries can choose to filter the report before it runs
28124 by setting the <link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
28125 system preference to 'Require'.</para>
28128 <para>This report will list all items that are overdue at your
28132 <screeninfo>Overdues List</screeninfo>
28136 <imagedata fileref="images/circ/overdues.png"/>
28141 <para>The report can be filtered using the menu options found on the left of the report.<tip>
28142 <para>The 'Show any items currently checked out' checkbox basically switches this from a
28143 report of overdues to a report of checkouts. It will show all titles checked out
28144 regardless of due date.</para>
28148 <section id="overduesfines">
28149 <title>Overdues with fines</title>
28151 <para>This report will show you any overdues at your library that have
28152 accrued fines on them.</para>
28155 <screeninfo>Overdues with fines</screeninfo>
28159 <imagedata fileref="images/circ/overduewfines.png"/>
28164 <para>If you would like to limit the report you can use the pull down
28165 menu at the top to limit to a specific shelving location at your
28166 branch. To see overdues with fines at other branches you will have to
28167 <link linkend="setlibrary">change your branch</link> or log in at that
28169 <para>If you do not charge fines and/or don't have the <link linkend="finescronjob">fines cron job</link> running you will see
28170 no data on this report.</para>
28171 </important></para>
28175 <section id="trackinhouse">
28176 <title>Tracking In house Use</title>
28178 <para>Many libraries track the use of items within the library. This can
28179 be done in Koha one of two ways. The first is to create one or more
28180 <link linkend="addstatspatron">Statistical Patrons</link>. When
28181 collecting items that have been used within the library, you will want
28182 to check them out to your statistical patron:</para>
28185 <screeninfo>Check Out Items to Stats Patron</screeninfo>
28189 <imagedata fileref="images/circ/checkoutinhouse.png"/>
28194 <para>Instead of marking the item as 'checked out' the system will
28195 record that the item was used in house:</para>
28198 <screeninfo>Local Use Recorded</screeninfo>
28202 <imagedata fileref="images/circ/localuserecorded.png"/>
28207 <para>Repeat these steps for all items that have been used within the
28208 library to keep accurate statistics for item use.</para>
28210 <para>The other way to record local use of items is to set your <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
28211 preference to 'Record.' Then whenever you check an item in that is not
28212 checked out and not on hold a local use will be recorded.</para>
28215 <screeninfo>Local Use Recorded</screeninfo>
28219 <imagedata fileref="images/circ/localusecheckin.png"/>
28225 <para>If you have <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
28226 'Record' you can still use your statistical patrons to record local
28227 use as well.</para>
28231 <section id="processinglocations">
28232 <title>In Processing / Book Cart Locations</title>
28234 <para>Koha allows for handling temporary locations like the processing
28235 center and/or book carts throughout the library. For this feature to
28236 work you must first make sure you have <link linkend="authorizedvalues">authorized values</link> set in the <link linkend="shelvelocvals">LOC</link> category for PROC (Processing Center)
28237 and CART (Book Cart).</para>
28240 <screeninfo>CART & PROC values in LOC</screeninfo>
28244 <imagedata fileref="images/circ/LOCvalues.png"/>
28249 <para>Next you need to set the <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
28250 preference to PROC. This will set the new items to the Processing Center
28251 as their default location.</para>
28253 <para>Create items with their desired final shelving location.</para>
28257 <para>These newly cataloged items will be temporarily set to the
28258 PROC location and will display with whatever description PROC has.
28259 The original location code entered at item creation is stored in the
28260 new items column 'permanent_location', for future use. Items will
28261 stay in the PROC location until they are checked in. To have those
28262 items then move to the shelving cart:</para>
28266 <para>Turn on the <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
28267 system preference</para>
28271 <para>Check in those newly-created items and they will be moved
28272 to the location code of CART and display with whatever
28273 description CART has.</para>
28277 <para>A <link linkend="proccartcron">cron job</link> runs at
28278 specified intervals to age items from CART to the permanent
28279 shelving location. (For example, an hourly cron entry of
28280 cart_to_shelf.pl --hours 3 where --hours is the amount of time
28281 an item should spend on the cart before aging to its permanent
28287 <para>If the <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
28288 system preference is turned on, any newly checked-in item
28289 is also automatically put into the shelving cart, to be
28290 covered by the same script run.</para>
28296 <para>Checkins with confirmed holds will not go into the
28297 shelving cart. If items on the shelving cart are checked
28298 out, the cart location will be cleared.</para>
28308 <section id="selfcheckout">
28309 <title>Self Checkout</title>
28311 <para>Koha comes with a very basic self checkout module. To enable this
28312 module you need to set the <link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
28313 'Enable.' To use this module you have to log in as a <link linkend="addstaffpatron">staff member</link> with <link linkend="patronpermissions">circulation permissions</link>.</para>
28316 <para>Create a <link linkend="addstaffpatron">staff patron</link>
28317 specifically for this action so that you don't leave a real staff
28318 client logged into a computer all day</para>
28321 <para>There is no link to the Self Checkout module, but a simple
28322 addition to the <link linkend="intranetuserjs">intranetuserjs</link>
28323 system preference can add one.</para>
28325 <programlisting>$(document).ready(function(){ $("#login
28326 #submit").parent().after("<p><a
28327 href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
28328 target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
28331 <para>The code above has line breaks added to make it more readable,
28332 please be sure to enter the above as one line in when putting it in
28333 the system preference.</para>
28336 <para>The link will then appear at the bottom of the log in page:</para>
28339 <screeninfo>Self Checkout Link on Staff Login</screeninfo>
28343 <imagedata fileref="images/circ/selfcheckoutlink.png"/>
28348 <para>You can also access this module by going to :
28349 http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
28351 <para>When on the self checkout page depending on your value in the
28352 <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
28353 preference you will be asked to enter you cardnumber</para>
28356 <screeninfo>Self Checkout Patron Card Number</screeninfo>
28360 <imagedata fileref="images/circ/selfcheckout.png"/>
28365 <para>or your username and password:</para>
28368 <screeninfo>Shelf checkout by login</screeninfo>
28372 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
28377 <para>Once you're logged in to the self check module you will be asked
28378 to scan the items you are checking out</para>
28381 <screeninfo>Self Checkout</screeninfo>
28385 <imagedata fileref="images/circ/selfcheckoutuser.png"/>
28390 <para>As you scan items they will appear below the barcode box</para>
28393 <screeninfo>Self Checkout Summary</screeninfo>
28397 <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
28402 <para>When you are finished scanning items it is important to click the 'Finish' button. This
28403 will prompt you to print a receipt and log you out of the self check module.</para>
28405 <screeninfo>Self Checkout Receipt</screeninfo>
28408 <imagedata fileref="images/circ/selfreceiptprint.png"/>
28413 <para>When attempting to check items out there are some instances where
28414 error messages will appear and the patron will be directed to the
28415 librarian. This will happen even if you are allowing overrides on
28416 circulation functions. Only a librarian can override a circulation block
28417 and so patrons must go to the librarian for help in these
28421 <screeninfo>Self Checkout Error Message</screeninfo>
28425 <imagedata fileref="images/circ/selfcheckoutfines.png"/>
28431 <section id="offlinecirc">
28432 <title>Offline Circulation Utilities</title>
28433 <para>Koha allows for you to continue circulation actions while offline by using any one of
28434 three utilities.</para>
28435 <section id="kohaofflinecirc">
28436 <title>Offline Circulation in Koha</title>
28437 <para>If the <link linkend="AllowOfflineCirculation">AllowOfflineCirculation</link>
28438 preference is set to 'Enable' the library staff can continue to perform circulation
28439 actions within Koha when the system is offline. You will want to visit
28440 http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least once while online
28441 and bookmark that page. That is the page you will go to when you are offline.</para>
28443 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
28444 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems will
28445 not be able to syncronize their data and are recommended to use either the <link
28446 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
28447 >Windows</link> application for offline circulation.</para>
28449 <section id="kohaofflinesetup">
28450 <title id="offlinesetup">Setup</title>
28451 <para>Before the first time the system goes offline go to Circulation and choose 'Built-in
28452 offline circulation interface'</para>
28454 <screeninfo>Built-in offline circulation interface</screeninfo>
28457 <imagedata fileref="images/circ/offlinecirc.png"/>
28461 <para>And synchronize your data on every circulation computer by clicking the
28462 'Synchronize' link on the right of the screen.</para>
28464 <screeninfo>Synchronize data</screeninfo>
28467 <imagedata fileref="images/circ/syncoffline.png"/>
28472 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
28473 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems
28474 will not be able to syncronize their data and are recommended to use either the <link
28475 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
28476 >Windows</link> application for offline circulation.</para>
28478 <para>This will allow you download a local copy of your patrons and circulation data.
28479 Click the 'Download records' link at the top of the page to synchronize your data.</para>
28481 <screeninfo>Download records for offline use</screeninfo>
28484 <imagedata fileref="images/circ/downloadoffline.png"/>
28488 <para>Once your data is downloaded you will see the dates your data was last synced to the
28489 right of each data set.<screenshot>
28490 <screeninfo>Synced offline data</screeninfo>
28493 <imagedata fileref="images/circ/syncedoffline.png"/>
28496 </screenshot>This should be done regularly in preparation for any unexpected connection
28499 <section id="kohaofflinecirculating">
28500 <title id="offlinecirculating">Circulating</title>
28501 <para>When your system goes offline visit the Offline Circulation page
28502 (http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl) in Koha and click
28503 'Check out' or 'Check in' to perform offline actions.</para>
28504 <para>Checking out is done by searching for the patron by barcode or name at the top of
28505 the 'Check out' screen. After selecting a patron you will be presented with the synced
28506 patron info, including fines and check outs.</para>
28508 <screeninfo>Check out offline</screeninfo>
28511 <imagedata fileref="images/circ/offlinecheckout.png"/>
28515 <para>Scan the barcode of the item you would like to check out and enter a due date. If
28516 you don't enter a due date Koha will prompt you for one.</para>
28518 <screeninfo>Offline due date</screeninfo>
28521 <imagedata fileref="images/circ/offlineduedate.png"/>
28525 <para>Once the item is checked out it will appear below the patron's info.</para>
28527 <screeninfo>Offline checkouts</screeninfo>
28530 <imagedata fileref="images/circ/offlinecheckouts.png"/>
28536 <section id="kohaofflineupload">
28537 <title>Koha Offline Uploading</title>
28538 <para>Once the system is back online visit the Synchronize page on the Offline Circulation
28539 module and click 'Upload transactions'</para>
28541 <screeninfo>Upload transactions</screeninfo>
28544 <imagedata fileref="images/circ/offlineupload.png"/>
28548 <para>After the files are uploaded you can click 'View pending offline circulation
28549 actions' on the right.</para>
28551 <screeninfo>View pending offline circulation actions</screeninfo>
28554 <imagedata fileref="images/circ/viewkohaoffline.png"/>
28558 <para>After clicking 'View pending offline circulation actions' you will be brought to a
28559 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
28561 <screeninfo>Offline Circulation</screeninfo>
28564 <imagedata fileref="images/circ/offlinecirclog.png"/>
28570 <para>Once all of the logs from all of the circulation computers are loaded you will
28571 be able to check them all or select just those you want to process into Koha.</para>
28574 <para>Click on the Process button and Koha will record every stored transaction one by
28575 one. For each transaction, the status will change to:<itemizedlist>
28577 <para>"Success." if the transaction was processed correctly</para>
28580 <para>"Borrower not found." if the borrower card number is incorrect</para>
28583 <para>"Item not found." if the item barcode is wrong</para>
28586 <para>"Item not issued." if you checked in an available item</para>
28588 </itemizedlist></para>
28591 <para>Once finished you will have a summary of all of your transactions</para>
28593 <screeninfo>Offline Circulation Summary</screeninfo>
28596 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
28603 <section id="firefoxofflinecirc">
28607 <firstname>Franois</firstname>
28608 <surname>Charbonnier</surname>
28610 <orgname>BibLibre</orgname>
28615 <firstname>Nicole C.</firstname>
28616 <surname>Engard</surname>
28617 <contrib>Changed/edited content where necessary.</contrib>
28621 <pubdate>2012</pubdate>
28623 <title>Firefox Plugin</title>
28625 <para>There is an offline circulation tool that you can add to your
28626 Firefox browser as a plugin/addon. To do so, just go to <ulink url="https://addons.mozilla.org/en/firefox/addon/koct/">https://addons.mozilla.org/en/firefox/addon/koct/</ulink>
28627 page and click on the "install now" button. You may have to confirm
28628 the installation, just click on "install now" and then restart Firefox
28629 to complete the installation.</para>
28631 <para>Once you have installed the plugin and restarted Firefox, you
28632 will see the Koha logo in the add-on bar at the bottom right of
28636 <screeninfo>Koha Icon on Add-on Bar</screeninfo>
28640 <imagedata fileref="images/circ/koctstatusbar.png"/>
28645 <para>A click on the logo will open the tool in its own window.</para>
28648 <screeninfo>Koha Offline Circ Tool</screeninfo>
28652 <imagedata fileref="images/circ/koct.png"/>
28657 <para>The plugin consists of four tabs:</para>
28661 <para>The Check Out tab is where you check out items</para>
28665 <para>The Check In tab is where you check in items</para>
28669 <para>The Log tab keeps track of every transaction done while in
28670 offline mode</para>
28674 <para>The log will keep information until you empty it. Each
28675 time you open the plugin and it contains data in the log it
28676 will warn you</para>
28679 <screeninfo>Koha Offline Circ Warning</screeninfo>
28683 <imagedata fileref="images/circ/koctwarn.png"/>
28688 <para>If you'd like to clear the log, check the 'I want to
28689 delete rows' box before hitting the 'OK' button. Otherwise
28690 clicking 'OK' will keep the items in the log and let you
28691 continue working with the tool.</para>
28697 <para>The Param tab is to set up the plugin</para>
28701 <para>The first thing you want to do then is to set up the plugin. Go
28702 to the Param tab to set up the plugin</para>
28705 <screeninfo>Koha Offline CIrc Params</screeninfo>
28709 <imagedata fileref="images/circ/koctparam.png"/>
28714 <para>Answer the 4 questions presented:</para>
28718 <para>Server = the URL of the librarian interface</para>
28722 <para>Branch Code = the code for the branch where you are
28727 <para>Username = your staff account login</para>
28731 <para>Password = your staff account password</para>
28736 <para>To save the settings, you will have to close the plugin
28737 window and re-open it by clicking again on the Koha logo in the
28740 <para>You can create a staff account dedicated to the offline
28741 circulation. So that, no matter who is at the circulation desk,
28742 they can all use the same login. Along those lines, you can use a
28743 group login that you already have in place for circulation as
28745 </tip>Once you have everything set up you can start checking items
28748 <para>Checking out:</para>
28751 <screeninfo>Koha Offline Circulation Check Out</screeninfo>
28755 <imagedata fileref="images/circ/koct.png"/>
28762 <para>Go to the Check Out tab</para>
28766 <para>Scan the patron barcode</para>
28770 <para>Scan the item barcode</para>
28774 <para>Click 'Save'</para>
28778 <para>Checking in:</para>
28781 <screeninfo>Koha Offline Circulation Check In</screeninfo>
28785 <imagedata fileref="images/circ/koctcheckin.png"/>
28792 <para>Go to the Check In tab</para>
28796 <para>Scan the item barcode</para>
28800 <para>Click Save</para>
28804 <para>Each time, you check out or check in an item, a new transaction
28805 is recorded in the local plugin database and you will see, at the
28806 bottom of the plugin how many transactions has been made during the
28807 offline circulation. For example, "10 Row(s) Added" means you did 10
28808 transactions.</para>
28811 <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
28815 <imagedata fileref="images/circ/koctcount.png"/>
28820 <para>Then, if you want an overview of every transaction, go to the
28821 Log tab. This tab will show you the transactions in the plugin
28825 <screeninfo>Koha Offline Circulation Log</screeninfo>
28829 <imagedata fileref="images/circ/koctlog.png"/>
28835 <para>The status will be "Local." as long as you are offline and
28836 don't process the transactions into Koha.</para>
28837 </tip>When your Internet connection comes back up you will want to
28838 get these transactions in to Koha. Before processing these
28839 transactions you should be aware of a few issues.</para>
28841 <para>Because you are not connected to your Koha database when using
28842 this plugin holds will need additional processing. If an item you
28843 check in while offline has a hold, the hold is kept on the item.
28844 Since, you can't confirm holds found during the processing of every
28845 check in, the holds stay on the item and will need to be managed
28846 later. If you only checked in a few items you can just keep a record
28847 of them all. If you checked in a lot of items you can use the Holds
28848 Queue once it rebuilds to see what holds made it to the shelf
28849 erroneously.</para>
28851 <para>Similarly, if an patron card was expired, the offline
28852 circulation tool won't know about it, so the checkout will be recorded
28853 regardless of the patron's account being blocked normally.</para>
28855 <para>You have two options for adding this data to Koha</para>
28859 <para>Commit to Koha</para>
28863 <para>If you checked in/out on more than one computer at the
28864 same time, what you want is to process every transaction
28865 consistently. Let's say for instance that one patron checked a
28866 book out on one computer and then checked the same book in on
28867 another computer. To be consistent, you need to record the
28868 check out first and then the check in. Not the opposite! To do
28869 so, you need to group every transaction in one place, sort
28870 them all and then, process everything. So, you need to use the
28871 "Commit to Koha" option from every plugin/computer you worked
28872 with. This way, the log will go to Koha and be accessible from
28873 the Offline Circulation page.</para>
28876 <screeninfo>Circulation Menu</screeninfo>
28880 <imagedata fileref="images/circ/offlinecirclink.png"/>
28887 <para><emphasis>Get there:</emphasis> Circulation > Pending offline circulation
28891 <screeninfo>Offline Circulation</screeninfo>
28895 <imagedata fileref="images/circ/offlinecirclog.png"/>
28902 <para>Once all of the logs from all of the circulation
28903 computers are loaded you will be able to check them all or
28904 select just those you want to process into Koha.</para>
28908 <para>Click on the Process button and Koha will record every stored transaction one
28909 by one. For each transaction, the status will change to:</para>
28913 <para>"Success." if the transaction was processed
28918 <para>"Borrower not found." if the borrower card number is
28923 <para>"Item not found." if the item barcode is
28928 <para>"Item not issued." if you checked in an available
28935 <para>Once finished you will have a summary of all of your
28936 transactions</para>
28939 <screeninfo>Offline Circulation Summary</screeninfo>
28943 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
28952 <para>Apply directly</para>
28956 <para>If you performed all of the circulation actions on one
28957 computer then everything is sorted already so you can choose
28958 to "Apply directly"</para>
28962 <para>The status column will be updated to let you know if the
28963 transactions were applied</para>
28967 <para>"Success." if the transaction was processed
28972 <para>"Borrower not found." if the borrower card number is
28977 <para>"Item not found." if the item barcode is
28982 <para>"Item not issued." if you checked in an available
28989 <para>Once you're finished you can review all of the items
28990 right in the Log tab</para>
28993 <screeninfo>Koha Offline Circulation Apply
28994 Directly</screeninfo>
28998 <imagedata fileref="images/circ/koctdirectly.png"/>
29007 <para>Once you are done you can clear the log by clicking Clear. If
29008 you don't you will be warned the next time you open the Offline
29009 Circulation tool.</para>
29012 <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
29016 <imagedata fileref="images/circ/koctwarn.png"/>
29022 <section id="windowsofflinecirc">
29023 <title>Offline Circ Tool for Windows</title>
29025 <para>The Offline Circulation Utility can be downloaded at: <ulink url="http://kylehall.info/index.php/projects/koha/koha-offline-circulation/">http://kylehall.info/index.php/projects/koha/koha-offline-circulation/</ulink></para>
29026 <para>To generate a borrowers.db file for loading in to the Windows tool you will need to
29027 run the <link linkend="offlinecirccron">file generator via a cron job</link>.</para>
29028 <section id="uploadofflinecirc">
29029 <title>Upload Offline Circ File</title>
29030 <para>The <link linkend="windowsofflinecirc">offline circulation tool for Windows</link>
29031 will generate a KOC file that you can upload into Koha once your system comes back
29033 <para>On the Circulation menu click 'Upload offline circulation file (.koc)'</para>
29035 <screeninfo>Circulation menu</screeninfo>
29038 <imagedata fileref="images/circ/offlinecirclink.png"/>
29042 <para>Browse your computer for the *.koc file</para>
29044 <screeninfo>Upload KOC File</screeninfo>
29047 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
29051 <para>Once the file is uploaded, click the process the file</para>
29053 <screeninfo>Process offline circulation file</screeninfo>
29056 <imagedata fileref="images/circ/processoffline.png"/>
29060 <para>When this is complete you'll be able to upload another file or tend to pending
29061 offline circulation actions.</para>
29063 <screeninfo>Summary of offline actions</screeninfo>
29066 <imagedata fileref="images/circ/offlinesummary.png"/>
29070 <para>After clicking 'View pending offline circulation actions' you will be brought to a
29071 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
29073 <screeninfo>Offline Circulation</screeninfo>
29076 <imagedata fileref="images/circ/offlinecirclog.png"/>
29082 <para>Once all of the logs from all of the circulation computers are loaded you will
29083 be able to check them all or select just those you want to process into Koha.</para>
29086 <para>Click on the Process button and Koha will record every stored transaction one by
29087 one. For each transaction, the status will change to:<itemizedlist>
29089 <para>"Success." if the transaction was processed correctly</para>
29092 <para>"Borrower not found." if the borrower card number is incorrect</para>
29095 <para>"Item not found." if the item barcode is wrong</para>
29098 <para>"Item not issued." if you checked in an available item</para>
29100 </itemizedlist></para>
29103 <para>Once finished you will have a summary of all of your transactions</para>
29105 <screeninfo>Offline Circulation Summary</screeninfo>
29108 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
29117 <chapter id="cataloging">
29118 <title>Cataloging</title>
29120 <para>Before you start cataloging in Koha you're going to want to do some
29121 basic setup. Refer to the <link linkend="implementation">Implementation
29122 Checklist</link> for a full list of these things. Most importantly you're
29123 going to want to make sure that your <link linkend="marcbibframeworks">Frameworks</link> are all defined the way you
29124 want. Once in the cataloging module you will not be able to add or remove
29125 fields and subfields so your frameworks must be ready before you start
29127 <para>You can also use OCLC Connexion to send records directly in to Koha. For more information
29128 on that please review the <link linkend="oclcappendix">OCLC Connexion Setup
29129 appendix</link>.</para>
29133 <para><emphasis>Get there:</emphasis> More > Cataloging</para>
29137 <section id="catbibs">
29138 <title>Bibliographic Records</title>
29140 <para>In Koha the bibliographic record contains the main information
29141 related to the material. This includes things like the title, author,
29142 ISBN, etc. This information is stored in Koha in Marc (different flavors
29143 of Marc are supported in Koha). Once this information is saved, <link linkend="catitems">items or holdings</link> can be attached.</para>
29145 <section id="addbibrec">
29146 <title>Adding Records</title>
29148 <para>Records can be added to Koha via original or copy cataloging. If
29149 you would like to catalog a record using a blank template</para>
29153 <para>Click 'New Record'</para>
29156 <screeninfo>New Record Menu</screeninfo>
29160 <imagedata fileref="images/cataloging/newfromframework.png"/>
29167 <para>Choose the framework you would like to base your record
29174 <para>If you want to catalog a record based on an existing record at
29175 another library</para>
29179 <para>Click 'Z39.50 Search'</para>
29182 <screeninfo>Z39.50 Search</screeninfo>
29186 <imagedata fileref="images/cataloging/zsearch.png"/>
29193 <para>Search for the item you would like to catalog</para>
29198 <para>If no results are found, try searching for fewer
29199 fields, not all Z39.50 targets can search all of the
29200 fields above.</para>
29207 <para>Search targets can be altered by using the <link linkend="z3950admin">Z39.50 Admin</link> area.</para>
29211 <para>From the results you can view the MARC or Card view for
29212 the records or choose to Import them into Koha</para>
29215 <screeninfo>Z39.50 Search Results</screeninfo>
29219 <imagedata fileref="images/cataloging/zsearchresults.png"/>
29226 <para>In addition to the Import link to the right of each
29227 title, you can click on the title you're interested in and
29228 a menu will pop up with links to preview the record and
29232 <screeninfo>Import Link Popup on Z39.50 Search
29233 Results</screeninfo>
29237 <imagedata fileref="images/cataloging/importz39.png"/>
29244 <para>If you don't find the title you need in your Z39.50
29245 search results you can click the 'Try Another Search'
29246 button at the bottom left of your results</para>
29249 <screeninfo>Try another search</screeninfo>
29253 <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
29264 <para>Once you've opened a blank framework or imported a record via
29265 Z39.50 you will be presented with the form to continue
29269 <screeninfo>Add MARC Record</screeninfo>
29273 <imagedata fileref="images/cataloging/addmarc.png"/>
29280 <para>If you would rather not see the MARC tag numbers you can change the value in your
29281 <link linkend="hide_marc">hide_marc</link> system preference or each user can check
29282 the box next to 'Show tags' at the top of the editor.</para>
29285 <para>To expand a collapsed tag click on the tag description</para>
29289 <para>To get help from the Library of Congress on a Marc tag click
29290 the question mark (?) to the right of each field number</para>
29294 <para>If you feel that this clutters the screen you can hide
29295 the question marks by unchecking the box next to the 'Show
29296 MARC tag documentation links' note at the top right of the
29300 <screeninfo>Show MARC tag documentation links
29301 checkbox</screeninfo>
29305 <imagedata fileref="images/cataloging/marcdoclinks.png"/>
29314 <para>Sometimes fields may not be editable due to the value in
29315 your <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
29316 system preference. If you have this preference set to not allow
29317 catalogers to type in fields controlled by authorities you may see
29318 a lock symbol to the left of the field.</para>
29321 <screeninfo>Authority fields locked against editing</screeninfo>
29325 <imagedata fileref="images/cataloging/lockedauthority.png"/>
29332 <para>If this icon appears you must click the icon to the
29333 right of the field to search for an existing authority.</para>
29336 <screeninfo>Search for authority</screeninfo>
29340 <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
29347 <para>From the results list click 'Choose authority' to bring
29348 that into your catalog record</para>
29351 <screeninfo>Authority search results</screeninfo>
29355 <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
29364 <para>To duplicate a field click on the 'repeat this tag' icon to
29365 the right of the tag</para>
29368 <screeninfo>Duplicate a Field</screeninfo>
29372 <imagedata fileref="images/cataloging/dupfield.png"/>
29379 <para>To move subfields in to the right order, click the up
29380 arrow to the left of the field</para>
29384 <para>To duplicate a subfield click on the clone icon (to
29385 remove a copied field, click the delete clone icon) to the
29386 right of the field</para>
29389 <screeninfo>Clone Subfield</screeninfo>
29393 <imagedata fileref="images/cataloging/clonesubfield.png"/>
29400 <para>To remove a subfield (if there is more than one of the
29401 same type), click the - (minus sign) to the right of the
29408 <para>To use a plugin click on the icon to the right of the
29412 <screeninfo>Leader Builder Plugin</screeninfo>
29416 <imagedata fileref="images/cataloging/leaderbuilder.png"/>
29423 <para>Some fixed fields have editors that will change based on
29424 the material type you're cataloging (for example the 006 and
29425 the 008 fields)</para>
29428 <screeninfo>008 Plugin</screeninfo>
29432 <imagedata fileref="images/cataloging/008plugin.png"/>
29441 <para>Once you've finished, click the 'Save' button at the top and
29442 choose whether you want to save and view the bib record you have
29443 created or continue on to add/edit items attached to the
29447 <screeninfo>Record save options</screeninfo>
29451 <imagedata fileref="images/cataloging/savecataloging.png"/>
29457 <para>Choosing 'Save and view record' will bring you right to the record you just
29461 <para>Choosing 'Save and edit items' will bring you to the add/edit item form after
29462 saving the bib record so that you can attach holdings</para>
29465 <para>Choosing 'Save and continute editing' will allow you to save your work so far
29466 and keep you in the editor to continue working</para>
29471 <para>If you are about to add a duplicate record to the system you will be warned before
29474 <screeninfo>Duplicate Record Warning</screeninfo>
29477 <imagedata fileref="images/cataloging/duprecordwarn.png"/>
29485 <section id="cataloganalytics">
29486 <title>Adding Analytic Records</title>
29488 <para>Libraries sometimes make journal articles and articles within
29489 monographs and serials accessible to library patrons through analytics
29490 cataloging. Analytics cataloging creates separate bibliographic
29491 records for these articles, chapters, sections, etc. found within a
29492 larger resource such as a book, an article within a journal, newspaper
29493 or serial. In analytics cataloging, although a separate bib record is
29494 created for the title, it is not physically separated from the host
29495 item. Learn more about Analytics in Chapter 13 of AACR2.</para>
29497 <para>If you would like to catalog analytic records there are two options. One is to use the
29498 <link linkend="catalogeasyanalytics">Easy Analytics</link> funtion; the other is the
29499 <link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow</link>.</para>
29500 <section id="catalogeasyanalytics">
29501 <title>Easy Analytics</title>
29502 <para>The Easy Analytics feature makes linking analytic records together easier. The
29503 first thing you need to do is set the <link linkend="EasyAnalyticalRecords"
29504 >EasyAnalyticalRecords</link> preference to 'Display' and the <link
29505 linkend="UseControlNumber">UseControlNumber</link> preference to 'Don't use.' </para>
29506 <para>After cataloging your analytic record (see <link linkend="addbibrec">Adding
29507 Records</link> for more on creating records) click 'Edit' from the normal view and
29508 choose to 'Link to Host Item'</para>
29510 <screeninfo>Link to Host Item</screeninfo>
29513 <imagedata fileref="images/cataloging/analyticslink.png"/>
29517 <para>This will prompt you to enter the barcode for the item this record should be linked
29520 <screeninfo>Barcode for Analytic Linking</screeninfo>
29523 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
29527 <para>After entering the item's barcode and clicking 'Select' you will receive a
29528 confirmation message.</para>
29530 <screeninfo>Analytic Link Success</screeninfo>
29533 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
29537 <para>The record will now have the 773 field filled in properly to complete the
29540 <screeninfo>773</screeninfo>
29543 <imagedata fileref="images/cataloging/analytics773.png"/>
29547 <para>To view all of the items tied to the host record, do a search for the record, click
29548 the Analytics tab on the left and the analytics tied to each barcode will be shown under
29549 the "Used in" column.</para>
29551 <screeninfo>Analytics Tab</screeninfo>
29554 <imagedata fileref="images/cataloging/analyticstab.png"/>
29559 <para>It is also possible to create analytic records from this screen by clicking on
29560 "Create Analytics"</para>
29562 <para>You can also see the analytics attached to this record by clicking the 'Show
29563 Analytic' link towards the top of the record in the normal view.</para>
29565 <screeninfo>Show Analytics on Bib Record</screeninfo>
29568 <imagedata fileref="images/cataloging/anayticbib.png"/>
29572 <para>When looking at the anaytic record you will also see a link to the host item under
29573 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
29575 <screeninfo>Host Record</screeninfo>
29578 <imagedata fileref="images/cataloging/hostrecords.png"/>
29583 <section id="catalogenhanceanalytics">
29584 <title>Analytics Enhanced Workflow </title>
29585 <para>To use the Enhanced Workflow method of adding analytics, the first thing you need to
29586 do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
29587 preference to 'Don't display' and the <link linkend="UseControlNumber"
29588 >UseControlNumber</link> preference to 'Use.' </para>
29589 <para>After cataloging your original record (see <link linkend="addbibrec">Adding
29590 Records</link> for more on creating records) click 'New' from the normal view and
29591 choose to 'New child record.'</para>
29593 <screeninfo>New child record</screeninfo>
29596 <imagedata fileref="images/cataloging/analyticschildlink.png"/>
29600 <para>This will open a new blank record for cataloging. The blank record will only have
29601 the 773 field filled in properly to complete the link once the record is saved.</para>
29603 <screeninfo>773</screeninfo>
29606 <imagedata fileref="images/cataloging/analytics773child.png"/>
29610 <para>To view all of the items tied to the host record, do a search for the record, click
29611 the Analytics tab on the left and the analytics tied to each barcode will be shown under
29612 the "Used in" column.</para>
29614 <screeninfo>Analytics Tab</screeninfo>
29617 <imagedata fileref="images/cataloging/analyticstab.png"/>
29621 <para>You can also see the analytics attached to this record by clicking the 'Show
29622 Analytic' link towards the top of the record in the normal view.</para>
29624 <screeninfo>Show Analytics on Bib Record</screeninfo>
29627 <imagedata fileref="images/cataloging/anayticbib.png"/>
29631 <para>When looking at the anaytic record you will also see a link to the host item under
29632 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
29634 <screeninfo>Host Record</screeninfo>
29637 <imagedata fileref="images/cataloging/hostrecords.png"/>
29642 <section id="analyticediting">
29643 <title>Editing Analytics</title>
29644 <para>If you have linked an analytic record incorrectly you can remove that link by
29645 editing the item on the analytic record (not the host record). To do this, go to the
29646 analytic record and click the 'Edit' button and choose to 'Edit items'. To the left of
29647 each item you will see two options.</para>
29649 <screeninfo>Edit Analytic Item Record</screeninfo>
29652 <imagedata fileref="images/cataloging/analyticdelink.png"/>
29658 <para>Clicking 'Edit in Host' will allow you to edit the item on the host
29662 <para>Clicking 'Delink' will remove the 773 field and the link between the analytic
29663 and the host.</para>
29669 <section id="editbibrec">
29670 <title>Editing Records</title>
29672 <para>To edit a record you can click 'Edit Biblio' from the search
29673 results on the cataloging page</para>
29676 <screeninfo>Edit Biblio Option on Search Results</screeninfo>
29680 <imagedata fileref="images/cataloging/catalogsearch.png"/>
29685 <para>or by clicking the Edit button on the Bibliographic Record and
29686 choosing 'Edit Record'</para>
29689 <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
29693 <imagedata fileref="images/cataloging/editrecord.png"/>
29698 <para>The record will open in the MARC editor</para>
29701 <screeninfo>Editing MARC Record</screeninfo>
29705 <imagedata fileref="images/cataloging/editingrecord.png"/>
29710 <para>The alternative is to search via Z39.50 to overlay your record
29711 with a fuller record found at another library. You can do this by
29712 choosing 'Replace Record via Z39.50' from the Edit menu.</para>
29715 <screeninfo>Replace via Z39.50</screeninfo>
29719 <imagedata fileref="images/cataloging/replaceviaz39.png"/>
29724 <para>Once you choose that you will be brought to a Z39.50 search
29725 window to search other libraries for the record in question.</para>
29727 <para>Once you have made your edits (via either method) you can click
29728 'Save' at the top left of the editor.</para>
29730 <para>You can also use the edit menu to add your own custom cover
29731 image if you have either <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
29732 <link linkend="LocalCoverImages">LocalCoverImages</link> set to
29733 'Display' by choosing 'Upload Image' from the menu.</para>
29736 <screeninfo>Upload Image</screeninfo>
29740 <imagedata fileref="images/cataloging/uploadimage.png"/>
29745 <para>Choosing to 'Upload Image' will take you to the <link linkend="uploadlocalimages">Upload Local Cover Image
29746 Tool</link>.</para>
29749 <section id="dupbibrec">
29750 <title>Duplicating Records</title>
29752 <para>Sometimes a copy of the record you need to catalog can't be
29753 found via Z39.50. In these cases you can create a duplicate of similar
29754 record and edit the necessary pieces to create a new record. To
29755 duplicate an existing record click 'Edit as New (Duplicate)' from the
29756 Edit menu on the Bibliographic Record</para>
29759 <screeninfo>Edit as New (Duplicate) Bibliographic
29760 Record</screeninfo>
29764 <imagedata fileref="images/cataloging/createduplicate.png"/>
29769 <para>This will open a new MARC record with the fields filled in with
29770 the values from the original Bibliographic Record.</para>
29773 <screeninfo>New Duplicate Record</screeninfo>
29777 <imagedata fileref="images/cataloging/newduprecord.png"/>
29783 <section id="mergebibs">
29784 <title>Merging Records</title>
29786 <para>If you would like to merge together multiple records you can do
29787 that via the <link linkend="lists">Lists</link> tool. <link linkend="mergebibrecs">Learn more here</link>.</para>
29789 <section id="deleterecord">
29790 <title>Deleting Records</title>
29791 <para>To delete a bibliographic record simply choose the 'Edit' button and select 'Delete record'</para>
29793 <screeninfo>Delete record</screeninfo>
29796 <imagedata fileref="images/cataloging/deleterecord.png"/>
29800 <para>Bibliographic records can only be deleted one all items have been deleted. If you try
29801 to delete a bibliographic record with items still attached you will see that the delete
29802 option is grayed out.</para>
29804 <screeninfo>Record with items still attached</screeninfo>
29807 <imagedata fileref="images/cataloging/nodeleterecord.png"/>
29814 <section id="catitems">
29815 <title>Item Records</title>
29817 <para>In Koha each bibliographic record can have one or more items
29818 attached. These items are sometimes referred to as holdings. Each item
29819 includes information to the physical copy the library has.</para>
29821 <section id="addingitems">
29822 <title>Adding Items</title>
29824 <para>After saving a new bibliographic record, you will be redirected
29825 to a blank item record so that you can attach an item to the
29826 bibliographic record. You can also click 'Add/Edit Items' from the
29827 cataloging search results</para>
29830 <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
29834 <imagedata fileref="images/cataloging/catalogsearch.png"/>
29839 <para>or you can add new item at any time by clicking 'New' on the
29840 bibliographic record and choosing 'New Item'</para>
29843 <screeninfo>New Item Button</screeninfo>
29847 <imagedata fileref="images/cataloging/newitem.png"/>
29852 <para>The item edit form will appear:</para>
29855 <screeninfo>Add item form</screeninfo>
29859 <imagedata fileref="images/cataloging/additem.png"/>
29864 <para>At the very least, if you plan on circulating the item, the
29865 following fields should be entered for new items:</para>
29869 <para>2 - Source of classification</para>
29873 <para>a - Permanent location</para>
29877 <para>b - Current location</para>
29881 <para>o - Full call number</para>
29885 <para>p - Barcode</para>
29889 <para>v - Cost, replacement price</para>
29893 <para>This value will be charged to patrons when you mark an
29894 item they have checked out as 'Lost'</para>
29900 <para>y - Koha item type</para>
29904 <para>To make sure that these values are filled in you can mark them
29905 as mandatory in the <link linkend="marcbibframeworks">framework</link>
29906 you're using and then they will appear in red with a 'required' label.
29907 The item will not save until the required fields are filled in.</para>
29910 <screeninfo>Required Item Subfield</screeninfo>
29914 <imagedata fileref="images/cataloging/requireditemfields.png"/>
29922 <para>To make item subfields required in a framework you'll want
29923 to edit the 952 field in the <link linkend="marcbibframeworks">framework editor</link>.</para>
29928 <para>Below the add form there are 3 buttons for adding the
29932 <screeninfo>Add Item Buttons</screeninfo>
29936 <imagedata fileref="images/cataloging/additembuttons.png"/>
29943 <para>Add Item will add just the one item</para>
29947 <para>Add & Duplicate will add the item and fill in a new form
29948 with the same values for your to alter</para>
29952 <para>Add Multiple items will ask how many items and will then add that number of items
29953 adding +1 to the barcode so each barcode is unique</para>
29957 <para>Your added items will appear above the add form once
29961 <screeninfo>Items</screeninfo>
29965 <imagedata fileref="images/cataloging/items.png"/>
29970 <para>Your items will also appear below the bibliographic details on
29971 the bib record display.</para>
29974 <screeninfo>List of Items on the Bib Record</screeninfo>
29978 <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
29983 <para>If you have <link linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
29984 set to 'Display' then there will also be a link to print a quick spine
29985 label next to each item.</para>
29988 <screeninfo>List of Items on the Bib Record with a Print Label
29993 <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
29997 <para>You can also filter the contents of your holdings table by clicking the 'Activate
29998 filters' links. This will show a row at the top where you can type in any column to
29999 filter the results in the table.</para>
30001 <screeninfo>Filter holdings</screeninfo>
30004 <imagedata fileref="images/cataloging/items-activatefilters.png"/>
30010 <section id="editingitems">
30011 <title>Editing Items</title>
30013 <para>Items can be edited in several ways.</para>
30017 <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
30021 <screeninfo>Edit Items Menu Option</screeninfo>
30025 <imagedata fileref="images/cataloging/edititem.png"/>
30030 <para>Which will open up a list of items where you can click
30031 'Edit' to the left of the specific item you would like to
30035 <screeninfo>Edit individual items</screeninfo>
30039 <imagedata fileref="images/cataloging/edititemlink.png"/>
30046 <para>Clicking 'Edit Items' beside the item on the 'Items'
30050 <screeninfo>Items Tab</screeninfo>
30054 <imagedata fileref="images/cataloging/itemstab.png"/>
30059 <para>Which will open up the editor on the item you'd like to edit</para>
30062 <screeninfo>Edit individual items</screeninfo>
30066 <imagedata fileref="images/cataloging/edititemlinkfromtab.png"/>
30073 <para>Clicking 'Edit' and then 'Edit items in batch'</para>
30076 <screeninfo>Edit items in a batch</screeninfo>
30080 <imagedata fileref="images/cataloging/editinbatch.png"/>
30085 <para>This will open up the <link linkend="batchmodifyitems">batch
30086 item modification tool</link> where you can edit all of the items
30087 on this record as a batch.</para></listitem>
30088 <listitem><para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection
30089 </link> to have checkboxes appear to the left of each item
30090 on the detail display. You can then check off the items you would like to edit and
30091 click 'Modify selected items' at the top of the list.</para>
30093 <screeninfo>Editing selected items</screeninfo>
30096 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
30102 <para>You can click 'Edit' to the right of each item in the Holdings tab<screenshot>
30103 <screeninfo>Edit individual items</screeninfo>
30106 <imagedata fileref="images/cataloging/editindividual.png"/>
30109 </screenshot></para>
30112 <para>Finally you can use the <link linkend="batchmodifyitems">Batch Item
30113 Modification</link> tool</para>
30117 <section id="itemquickedit">
30118 <title>Quick Item Status Updates</title>
30120 <para>Often circulation staff need to change the status of an item
30121 to Lost or Damaged. This doesn't require you to edit the entire item
30122 record. Instead clicking on the item barcode on the checkout summary
30123 or checkin history will bring you to an item summary. You can also
30124 get to the item summary by clicking on the Items tab to the left of
30125 the bib detail page.</para>
30128 <screeninfo>Item Edit</screeninfo>
30132 <imagedata fileref="images/cataloging/quickitemedit.png"/>
30137 <para>From this view you can mark an item lost by choosing a lost
30138 status from the pull down and clicking the 'Set Status'
30142 <screeninfo>Edit Lost Status</screeninfo>
30146 <imagedata fileref="images/cataloging/editloststatus.png"/>
30151 <para>You can also mark an item as damaged by choosing a damaged
30152 status from the pull down and clicking the 'Set Status'
30156 <screeninfo>Edit Damaged Status</screeninfo>
30160 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
30167 <section id="iteminfo">
30168 <title>Item Information</title>
30170 <para>To the left of every bibliographic record there is a tab to view
30174 <screeninfo>Items Tab</screeninfo>
30178 <imagedata fileref="images/cataloging/quickitemedit.png"/>
30183 <para>Clicking that tab will give you basic information about the items. From here you can
30184 see basic information about the item such as the home library, item type, collection code,
30185 call number and replacement price. You can also see and edit the status information. If
30186 an item is marked lost or withdrawn you will also see the date that status was applied.<screenshot>
30190 <imagedata fileref="images/cataloging/itemstatuses.png"/>
30193 </screenshot></para>
30194 <para>In the History section you will see infomration about the check out history of the
30195 item and if you ordered the item via the acquisitions module then this section will
30196 include information about the order.</para>
30199 <screeninfo>History with order info</screeninfo>
30203 <imagedata fileref="images/cataloging/itemorderinfo.png"/>
30208 <para>If the Order or Accession date is linked, clicking it will bring
30209 you to the acquisitions information for that item.</para>
30212 <section id="moveitemrec">
30213 <title>Moving Items</title>
30215 <para>Items can be moved from one bibliographic record to another
30216 using the Attach Item option</para>
30219 <screeninfo>Attach Item Option</screeninfo>
30223 <imagedata fileref="images/cataloging/attachitem.png"/>
30228 <para>Visit the bibliographic record you want to attach the item to
30229 and choose 'Attach Item' from the 'Edit' menu.</para>
30232 <screeninfo>Attach Item Form</screeninfo>
30236 <imagedata fileref="images/cataloging/attachitemform.png"/>
30241 <para>Simply enter the barcode for the item you want to move and click
30244 <para>If you want to move all items to a new record creating only one
30245 bibliographic record you can use the <link linkend="mergebibrecs">Merge Records tool</link> instead.</para>
30248 <section id="deleteitems">
30249 <title>Deleting Items</title>
30251 <para>There are many ways to delete item records. If you only need to
30252 delete one item you can do this by opening up the detail page for the
30253 bib record and clicking the 'Edit' button at the top. From there you
30254 can choose to 'Edit items'.</para>
30257 <screeninfo>'Edit Items' menu option</screeninfo>
30261 <imagedata fileref="images/cataloging/edititemstodelete.png"/>
30266 <para>You will be presented with a list of items and next to each one
30267 will be a link labeled 'Delete'. Click that link and if the item is
30268 not checked out it will delete that item.</para>
30271 <screeninfo>Delete link on the left</screeninfo>
30275 <imagedata fileref="images/cataloging/deleteitemlink.png"/>
30280 <para>If you know that all of the items attached to your record are
30281 not currently checked out you can use the 'Delete all items' option
30282 under the 'Edit menu' and it will remove all items from the
30284 <para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection</link>
30285 to have checkboxes appear to the left of each item on
30286 the detail display. You can then check off the items you would like to delete and click
30287 'Delete selected items' at the top of the list.</para>
30289 <screeninfo>Deleting selected items</screeninfo>
30292 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
30297 <para>Finally you can use the <link linkend="batchdeleteitems">batch
30298 delete tool</link> to delete a batch of items.</para>
30301 <section id="itemcirchistory">
30302 <title>Item Specific Circulation History</title>
30304 <para>Each bibliographic record keeps a circulation history (with or
30305 without the patron information depending on your settings), but each
30306 item also has its own circulation history page. To see this, click on
30307 the 'Items' tab to the left of the record you are viewing.</para>
30310 <screeninfo>Items tab</screeninfo>
30314 <imagedata fileref="images/cataloging/itemstab-long.png"/>
30319 <para>Below the 'History' heading is a link to 'View item's checkout
30320 history,' clicking that will open up the item's history which will
30321 look slightly different from the bibliographic record's history
30325 <screeninfo>Item Specific Circulation History</screeninfo>
30329 <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
30336 <section id="catauthorities">
30337 <title>Authorities</title>
30339 <para>Authority records are a way of controlling fields in your MARC
30340 records. Using authority records will provide you with control over
30341 subject headings, personal names and places.</para>
30343 <section id="addauthorities">
30344 <title>Adding Authorities</title>
30346 <para>To add a new authority record you can either choose the authority type from the 'New
30347 Authority' button or search another library by clicking the 'New from Z39.50'
30351 <screeninfo>New Authority Record Options</screeninfo>
30355 <imagedata fileref="images/cataloging/newauthtypes.png"/>
30360 <para>If you choose to enter a new authority from scratch, the form that appears will allow
30361 you to enter all of the necessary details regarding your authority record.</para>
30364 <screeninfo>New Authority Record</screeninfo>
30368 <imagedata fileref="images/cataloging/newauthrec.png"/>
30373 <para>To expand collapsed values simply click on the title and the
30374 subfields will appear. To duplicate a field or subfield just click the
30375 plus sign (+) to the right of the label. To use field helper plugins
30376 simply click the ellipsis (...) to the right of the field.</para>
30378 <para>When linking authorities to other headings, you can use the
30379 authority finder plugin by clicking the ellipsis (...) to the right of
30383 <screeninfo>Authority search plugin</screeninfo>
30387 <imagedata fileref="images/cataloging/creatnewauthfromlink.png"/>
30392 <para>From there you can search your authority file for the authority
30393 to link. If you can't find the authority to link, you can click the
30394 'Create new' button and add the necessary authority for the link. This
30395 plugin also allows for you to choose the link relationship between the
30396 authorities.</para>
30399 <screeninfo>Authority relationships</screeninfo>
30403 <imagedata fileref="images/cataloging/authrelationships.png"/>
30407 <para>If you choose to search another library for the authority record you will be presented
30408 with a search box</para>
30410 <screeninfo>Authority Z39.50 Search</screeninfo>
30413 <imagedata fileref="images/cataloging/authzsearch.png"/>
30417 <para>From the results you can choose the 'Import' link to the right of the record you would
30418 like to add to Koha</para>
30420 <screeninfo>Authority Z39.50 Results</screeninfo>
30423 <imagedata fileref="images/cataloging/authimport.png"/>
30427 <para>You will then be presented with the form to edit the authority before saving it to
30430 <screeninfo>Imported Authority</screeninfo>
30433 <imagedata fileref="images/cataloging/authorityimported.png"/>
30439 <section id="searchauthorities">
30440 <title>Searching Authorities</title>
30442 <para>From the authorities page you can search for existing terms and
30443 the bibliographic records they are attached to.</para>
30446 <screeninfo>Authority Search</screeninfo>
30450 <imagedata fileref="images/cataloging/authoritysearch.png"/>
30455 <para>From the results you will see the authority record, how many bibliographic records it
30456 is attached to, an <link linkend="editauthorities">edit</link> link, a <link
30457 linkend="authoritymerge">merge</link> link and a <link linkend="editauthorities"
30458 >delete</link> link (if there are no bibliographic records attached).</para>
30461 <screeninfo>Authority Search Results</screeninfo>
30465 <imagedata fileref="images/cataloging/authorityresults.png"/>
30470 <para>Clicking on the Details link to the right of the authority
30471 record summary will open the full record and the option to edit the
30475 <screeninfo>Authority Record</screeninfo>
30479 <imagedata fileref="images/cataloging/authrecord.png"/>
30484 <para>If the authority has See Alsos in it you will see those broken
30485 out on the search results, clicking the linked headings will run a
30486 search for that heading instead.</para>
30489 <screeninfo>See Also in Authorities</screeninfo>
30493 <imagedata fileref="images/cataloging/authoritiesseealso.png"/>
30499 <section id="editauthorities">
30500 <title>Editing Authorities</title>
30502 <para>Authorities can be edited by clicking on the authority summary from the search results
30503 and then clicking the 'Edit' button above the record. Or by clicking on the 'Edit' link to
30504 the left of the authority on the search results.</para>
30507 <screeninfo>Edit Authority Record</screeninfo>
30511 <imagedata fileref="images/cataloging/editauthority.png"/>
30516 <para>Once you've made the necessary edits, simply click 'Save' and if you have the <link
30517 linkend="dontmerge">dontmerge</link> system preference set to 'Do' the next time the
30518 <link linkend="mergeauthcron">merge_authority.pl cronjob</link> runs it will update all
30519 of the bib records that use that authority.</para>
30521 <para>To delete an authority record you first must make sure it's not
30522 linked to any bibliographic records. If it is not used by any
30523 bibliographic records a 'Delete' link will appear to the right of the
30524 record on the search results and as a button that appears after
30525 clicking on the summary of the authority record.</para>
30527 <section id="authoritymerge">
30528 <title>Merging Authorities</title>
30529 <para>If you have duplicate authority records you can merge them together by clicking the
30530 'Merge' link next to two results on an authority search. After clicking 'Merge' on the
30531 first result you will see that authority listed at the top of the results.</para>
30533 <screeninfo>Merging authorities results</screeninfo>
30536 <imagedata fileref="images/cataloging/authmergesearch.png"/>
30540 <para>You will be asked which of the two records you would like to keep as your primary
30541 record and which will be deleted after the merge.</para>
30543 <screeninfo>Merging authorities</screeninfo>
30546 <imagedata fileref="images/cataloging/authmergechoice.png"/>
30550 <para>You will be presented with the MARC for both of the records (each accessible by tabs
30551 labeled with the authority numbers for those records). By default the entire first record
30552 will be selected, uncheck the fields you don't want in the final (destination) record and
30553 then move on to the second tab to choose which fields should be in the final (destination)
30556 <screeninfo>Authorities to merge</screeninfo>
30559 <imagedata fileref="images/cataloging/authmerging.png"/>
30563 <para>Once you have completed your selections click the 'Merge' button. The primary record
30564 will now contain the data you chose for it and the second record will be deleted.</para>
30566 <screeninfo>Merged authority</screeninfo>
30569 <imagedata fileref="images/cataloging/authmerged.png"/>
30576 <section id="catguides">
30577 <title>Cataloging Guides</title>
30581 <section id="bibcatcheatsheet">
30585 <firstname>Jared</firstname>
30586 <surname>Camins-Esakov</surname>
30588 <orgname>American Numismatic Society</orgname>
30593 <firstname>Nicole C.</firstname>
30594 <surname>Engard</surname>
30595 <contrib>Changed/edited content where necessary.</contrib>
30599 <pubdate>2010</pubdate>
30601 <title>Bibliographic Record Cataloging Cheat Sheet</title>
30603 <table cellpadding="4" cellspacing="4" frame="all">
30604 <title>Cataloging Guide</title>
30606 <tgroup align="left" cols="4" colsep="1" rowsep="1">
30609 <entry><para>Tag</para></entry>
30611 <entry><para>Label</para></entry>
30613 <entry><para>Description</para></entry>
30615 <entry><para>Instructions</para></entry>
30621 <entry><para>000</para></entry>
30623 <entry><para>LEADER</para></entry>
30625 <entry><para>Describes the record(i.e. surrogate) -- is it a
30626 record for a monograph? A serial?</para></entry>
30628 <entry><para>Click in this field to fill it in. Then set
30629 "Bibliographic level" to 'a' for articles or 's' for serials.
30630 Otherwise, leave everything as is.</para></entry>
30634 <entry><para>001</para></entry>
30636 <entry><para>CONTROL NUMBER</para></entry>
30638 <entry><para>Accession number.</para></entry>
30640 <entry><para>Enter the accession number written inside the
30641 item here. For articles and items which do not have accession
30642 numbers, leave blank.</para></entry>
30646 <entry><para>003</para></entry>
30648 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
30650 <entry><para>Your MARC Organizational Code</para></entry>
30652 <entry><para>Click in this field to fill it in (will auto fill
30653 if you have your <link linkend="MARCOrgCode">MARCOrgCode</link> preference
30654 set).</para></entry>
30658 <entry><para>005</para></entry>
30660 <entry><para>D & T LATEST TRANSACTION</para></entry>
30662 <entry><para>Current date and time.</para></entry>
30664 <entry><para>Click in this field to fill it in.</para></entry>
30668 <entry><para>008</para></entry>
30670 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
30672 <entry><para>Field containing computer-readable
30673 representations of a number of things.</para></entry>
30675 <entry><para>Generally you will only use 's' (single) or 'm'
30676 (multiple) options for position 06- use the former when the
30677 item was published in a single year, the latter when it was
30678 published over the course of several. If there is a single
30679 date, only enter a date in the first date field (positions
30680 07-10). Enter the three-digit country code in positions 15-17,
30681 being sure to add spaces if the country code is fewer than
30682 three characters long. If there is an index, note that fact in
30683 position 31. Enter the three-letter language code in positions
30684 35-37.</para></entry>
30688 <entry><para>010</para></entry>
30690 <entry><para>LCCN</para></entry>
30692 <entry><para>A number assigned by the Library of Congress to
30693 uniquely identify the work.</para></entry>
30695 <entry><para>Check on the copyright page of the book (if it
30696 was published in the US) or the LC catalog for this number. If
30697 you can't find it, don't worry about it.</para></entry>
30701 <entry><para>020</para></entry>
30703 <entry><para>ISBN</para></entry>
30705 <entry><para>Unique number used by publishers to identify
30706 books.</para></entry>
30708 <entry><para>If this number isn't listed on the book, there
30709 probably isn't one.</para></entry>
30713 <entry><para>022</para></entry>
30715 <entry><para>ISSN</para></entry>
30717 <entry><para>Unique number used by publishers to identify
30718 serials.</para></entry>
30720 <entry><para>If this number isn't listed on the book, there
30721 probably isn't one.</para></entry>
30725 <entry><para>033</para></entry>
30727 <entry><para>DATE/TIME OF EVENT</para></entry>
30729 <entry><para>Used for auction dates. Required for auction
30730 catalogs.</para></entry>
30732 <entry><para>For auctions that took place on only one day,
30733 enter the date of the auction in the format YYYYMMDD in the
30734 subfield 'a' and a '0' in the first indicator. For auctions
30735 that took place over two consecutive days or any number of
30736 non-consecutive days, create a subfield 'a' for each day with
30737 the date in the format YYYYMMDD, and put a '1' in the first
30738 indicator. For auctions that took place over more than two
30739 consecutive days, create a subfield 'a' (in format YYYYMMDD)
30740 for the first day and a subfield 'a' (also in format YYYYMMDD)
30741 for the last day, and put a '2' in the first
30742 indicator.</para></entry>
30746 <entry><para>040</para></entry>
30748 <entry><para>CATALOGING SOURCE</para></entry>
30750 <entry><para>Identifies which libraries created and modified
30751 the record.</para></entry>
30753 <entry><para>For imported records, add a subfield 'd' with
30754 your OCLC code as the value. For new records, make sure that
30755 the subfield 'c' with your OCLC code as the
30756 value.</para></entry>
30760 <entry><para>041</para></entry>
30762 <entry><para>LANGUAGE CODE</para></entry>
30764 <entry><para>Identifies all the languages used in an item,
30765 when two or more languages are present.</para></entry>
30767 <entry><para>For significant portions of a text in a given
30768 language, there should be a subfield 'a' with that language
30769 code. If there are only summaries or abstracts in a specific
30770 language, create a subfield 'b' with that language
30771 code.</para></entry>
30775 <entry><para>100</para></entry>
30777 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
30779 <entry><para>Authorized form of the main author's
30780 name</para></entry>
30782 <entry><para>See Authorized headings sheet and AACR2. The
30783 first indicator should generally be a '1', to indicate that
30784 the entry is surname first. If the name consists only of a
30785 forename, however, the first indicator should be
30786 '0'.</para></entry>
30790 <entry><para>110</para></entry>
30792 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
30794 <entry><para>Authorized form of the name of the main corporate
30795 author. Required for auction catalogs.</para></entry>
30797 <entry><para>Auction catalogs should use a 110 field rather
30798 than a 100 field. See Authorized headings sheet and AACR2. Set
30799 the first indicator to '2'.</para></entry>
30803 <entry><para>111</para></entry>
30805 <entry><para>MAIN ENTRY--MEETING</para></entry>
30807 <entry><para>Authorized form of the name of a meeting which
30808 acted as a main offer (e.g. conference
30809 proceedings)</para></entry>
30811 <entry><para>See Authorized headings sheet and AACR2. Set the
30812 first indicator to '2'.</para></entry>
30816 <entry><para>245</para></entry>
30818 <entry><para>TITLE STATEMENT</para></entry>
30820 <entry><para>Transcription of the title statement from the
30821 title page (or chief source of information)</para></entry>
30823 <entry><para>Enter the title in subfield 'a', the subtitle in
30824 subfield 'b', and the statement of responsibility in subfield
30825 'c'. If you are creating a record for a single volume or part
30826 of a multi-part item, you should put the part number in
30827 subfield 'n' and the part title in subfield 'p.' For auction
30828 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
30829 in square brackets in subfield 'f'. See ISBD punctuation
30830 sheet. Set the first indicator to '0' if there is no author,
30831 otherwise set it to '1'. Set the second indicator to the
30832 number of non-filing characters (i.e. characters in an initial
30833 articles plus the space... for "The " set the second indicator
30834 to '4').</para></entry>
30838 <entry><para>246</para></entry>
30840 <entry><para>VARYING FORM OF TITLE</para></entry>
30842 <entry><para>Alternate form of title for searching and filing
30843 purposes</para></entry>
30845 <entry><para>If the patron might look for the work under a
30846 different title, enter it here. Do not include initial
30847 articles. The first indicator should be '3', unless the title
30848 is merely a variant spelling, in which case the first
30849 indicator should be '1'.</para></entry>
30853 <entry><para>250</para></entry>
30855 <entry><para>EDITION STATEMENT</para></entry>
30857 <entry><para>Transcription of the edition statement from the
30858 title page (or chief source of information)</para></entry>
30860 <entry><para>Transcribe the edition statement exactly as it
30861 appears on the title-page. You may abbreviate if the edition
30862 statement is very long.</para></entry>
30866 <entry><para>260</para></entry>
30868 <entry><para>PUBLICATION (IMPRINT)</para></entry>
30870 <entry><para>Publication information.</para></entry>
30872 <entry><para>Put the location of publication in subfield 'a',
30873 the publisher in subfield 'b', and the year (or probable year)
30874 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
30878 <entry><para>300</para></entry>
30880 <entry><para>PHYSICAL DESCRIPTION</para></entry>
30882 <entry><para>Physical description</para></entry>
30884 <entry><para>Enter the pagination statement in subfield 'a', a
30885 brief description of "special" contents such as illustrations
30886 or maps in subfield 'b' (see AACR2), and the size of the item
30887 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
30891 <entry><para>490</para></entry>
30893 <entry><para>SERIES STATEMENT</para></entry>
30895 <entry><para>Shows the series statement exactly as it appears
30896 on the item.</para></entry>
30898 <entry><para>Transcribe the series statement into subfield 'a'
30899 with the volume number in subfield 'v'. See ISBD punctuation
30900 sheet. Set the first indicator to '1' if you are using an 830.
30901 As a general rule, you should do so.</para></entry>
30905 <entry><para>500</para></entry>
30907 <entry><para>GENERAL NOTE</para></entry>
30909 <entry><para>Notes that don't fit anywhere
30910 else.</para></entry>
30912 <entry><para>Enter notes as full sentences, with a separate
30913 500 field for each distinct topic.</para></entry>
30917 <entry><para>501</para></entry>
30919 <entry><para>WITH NOTE</para></entry>
30921 <entry><para>Notes whether the work is bound with the works
30922 described by other records.</para></entry>
30924 <entry><para>Put description of relationship in subfield
30925 'a'.</para></entry>
30929 <entry><para>504</para></entry>
30931 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
30933 <entry><para>Indicates whether the work includes a
30934 bibliography.</para></entry>
30936 <entry><para>If the work includes a bibliography and index,
30937 put the text "Includes bibliographical references (p. XXX-XXX)
30938 and index." in subfield 'a'. If the work does not include an
30939 index, remove that part of the sentence. If the references are
30940 scattered throughout the work and not gathered into a distinct
30941 sentence, remove the parenthetical statement.</para></entry>
30945 <entry><para>505</para></entry>
30947 <entry><para>FORMATTED CONTENTS</para></entry>
30949 <entry><para>List of contents in a standard format.
30950 Unformatted contents can be listed in a 500 (General Note)
30951 field.</para></entry>
30953 <entry><para>See ISBD punctuation sheet. Set the first
30954 indicator to '0'. If you are separately coding authors and
30955 titles, set the second indicator to '0'. Otherwise, leave the
30956 second indicator blank.</para></entry>
30960 <entry><para>518</para></entry>
30962 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
30964 <entry><para>Used for auction dates.</para></entry>
30966 <entry><para>For auction catalogs, enter the date of the
30967 auction in the format 'January 2, 1984' in the subfield
30972 <entry><para>520</para></entry>
30974 <entry><para>SUMMARY, ETC.</para></entry>
30976 <entry><para>A brief summary or abstract of the book or
30977 article.</para></entry>
30979 <entry><para>In general you do not need to write a summary. A
30980 summary might be called for, however, with items that cannot
30981 be easily reviewed by a patron, such as books with highly
30982 acidic paper or CD-ROMs.</para></entry>
30986 <entry><para>546</para></entry>
30988 <entry><para>LANGUAGE NOTE</para></entry>
30990 <entry><para>Note describing the languages used in the
30991 work</para></entry>
30993 <entry><para>Only needed for works in multiple languages. See
30994 ISBD punctuation sheet.</para></entry>
30998 <entry><para>561</para></entry>
31000 <entry><para>PROVENANCE INFORMATION</para></entry>
31002 <entry><para>Describes the previous ownership of the
31003 item.</para></entry>
31005 <entry><para>Used only for rare books.</para></entry>
31009 <entry><para>563</para></entry>
31011 <entry><para>BINDING INFORMATION</para></entry>
31013 <entry><para>Describes the binding of the item.</para></entry>
31015 <entry><para>Used only for rare books.</para></entry>
31019 <entry><para>590</para></entry>
31021 <entry><para>LOCAL NOTE</para></entry>
31023 <entry><para>Local notes. Required for auction
31024 catalogs.</para></entry>
31026 <entry><para>Used for auction catalogs to indicate what types
31027 of coins are sold in the auction- Roman, Greek,
31028 etc.</para></entry>
31032 <entry><para>600</para></entry>
31034 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
31036 <entry><para>Authorized form of personal names for people
31037 discussed in the work</para></entry>
31039 <entry><para>See Authorized headings sheet and AACR2. The
31040 first indicator should generally be a '1', to indicate that
31041 the entry is surname first. If the name consists only of a
31042 forename, however, the first indicator should be '0'. If you
31043 found the name in the LC authority file, set the second
31044 indicator to '0'. Otherwise set the second indicator to
31045 '4'.</para></entry>
31049 <entry><para>610</para></entry>
31051 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
31053 <entry><para>Authorized form of corporate names for
31054 organizations discussed in the work</para></entry>
31056 <entry><para>See Authorized headings sheet and AACR2. Set the
31057 first indicator to '2'. If you found the name in the LC
31058 authority file, set the second indicator to '0'. Otherwise set
31059 the second indicator to '4'.</para></entry>
31063 <entry><para>611</para></entry>
31065 <entry><para>SUBJECT ADDED--MEETING</para></entry>
31067 <entry><para>Authorized form of meeting names for meetings
31068 discussed in the work</para></entry>
31070 <entry><para>See Authorized headings sheet and AACR2. Set the
31071 first indicator to '2'. If you found the name in the LC
31072 authority file, set the second indicator to '0'. Otherwise set
31073 the second indicator to '4'.</para></entry>
31077 <entry><para>630</para></entry>
31079 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
31081 <entry><para>Authorized form of titles for other works
31082 discussed in the work</para></entry>
31084 <entry><para>See Authorized headings sheet and AACR2. Set the
31085 first indicator to the number of non-filing characters (i.e.
31086 characters in an initial articles plus the space... for "The "
31087 set the first indicator to '4'). If you found the name in the
31088 LC authority file, set the second indicator to '0'. Otherwise
31089 set the second indicator to '4'.</para></entry>
31093 <entry><para>650</para></entry>
31095 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
31097 <entry><para>Library of Congress Subject Heading terms
31098 describing the subject of the work</para></entry>
31100 <entry><para>See Authorized headings sheet and AACR2. If you
31101 found the name in the LC authority file, set the second
31102 indicator to '0'. Otherwise set the second indicator to
31103 '4'.</para></entry>
31107 <entry><para>651</para></entry>
31109 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
31111 <entry><para>Library of Congress Subject Heading geographical
31112 terms describing the subject of the work</para></entry>
31114 <entry><para>See Authorized headings sheet and AACR2. If you
31115 found the name in the LC authority file, set the second
31116 indicator to '0'. Otherwise set the second indicator to
31117 '4'.</para></entry>
31121 <entry><para>655</para></entry>
31123 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
31125 <entry><para>Describes what an item is as opposed to what the
31126 item is about.</para></entry>
31128 <entry><para>Generally used only for auction catalogs, which
31129 should have the genre heading "Auction catalogs." (make sure
31130 to find the authorized heading!) If you found the name in the
31131 LC authority file, set the second indicator to '0'. If you are
31132 using a term from a specific thesaurus, set the second
31133 indicator to '7' and put the code for the thesaurus in
31134 subfield '2'. Otherwise set the second indicator to
31135 '4'.</para></entry>
31139 <entry><para>690</para></entry>
31141 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
31143 <entry><para>Used for headings from any custom subject
31144 authority file.</para></entry>
31146 <entry><para>If there is no appropriate LCSH term, you can use
31147 a 690 with subject headings you find on other items in the
31148 catalog.</para></entry>
31152 <entry><para>691</para></entry>
31154 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
31156 <entry><para>Used for headings from any custom subject
31157 authority file.</para></entry>
31159 <entry><para>If there is no appropriate LCSH term, you can use
31160 a 691 with subject headings you find on other items in the
31161 catalog.</para></entry>
31165 <entry><para>700</para></entry>
31167 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
31169 <entry><para>Used for second authors and other persons related
31170 to the production of the work.</para></entry>
31172 <entry><para>See Authorized headings sheet and AACR2. The
31173 first indicator should generally be a '1', to indicate that
31174 the entry is surname first. If the name consists only of a
31175 forename, however, the first indicator should be
31176 '0'.</para></entry>
31180 <entry><para>710</para></entry>
31182 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
31184 <entry><para>Used for corporate bodies related to the
31185 production of the work (e.g. publishers).</para></entry>
31187 <entry><para>See Authorized headings sheet and AACR2. Set the
31188 first indicator to '2'.</para></entry>
31192 <entry><para>711</para></entry>
31194 <entry><para>ADDED ENTRY--MEETING</para></entry>
31196 <entry><para>Used for meetings related to the production of
31197 the work (e.g. symposia that contributed to the
31198 work).</para></entry>
31200 <entry><para>See Authorized headings sheet and AACR2. Set the
31201 first indicator to '2'.</para></entry>
31205 <entry><para>730</para></entry>
31207 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
31209 <entry><para>Used for uniform titles related to the production
31210 of the work (e.g. a work that inspired the present
31211 work)</para></entry>
31213 <entry><para>See Authorized headings sheet and AACR2. Set the
31214 first indicator to the number of non-filing characters (i.e.
31215 characters in an initial articles plus the space... for "The "
31216 set the first indicator to '4').</para></entry>
31220 <entry><para>773</para></entry>
31222 <entry><para>HOST ITEM ENTRY</para></entry>
31224 <entry><para>Describes the larger bibliographic unit that
31225 contains the work (e.g. book or journal containing the article
31226 being described in the current record)</para></entry>
31228 <entry><para>If the host publication is author main entry,
31229 enter the authorized form of the author's name in subfield
31230 'a'. Put the title in subfield 't'. If the host publication is
31231 an independent work, put publication information in subfield
31232 'd'. When available, ISSN and ISBN should always be used in,
31233 in subfields 'x' and 'z' respectively. Relationship
31234 information (e.g. volume number, page number, etc.) goes in
31235 subfield 'g'. Subfield 'q' contains an encoded representation
31236 of the location of the item: volume, issue, and section
31237 numbers are separated by colons, and the first page is entered
31238 following a '<' at the end of the subfield. See ISBD
31239 punctuation sheet. Set the first indicator to '0'. If you want
31240 the label "In:" to be generated, leave the second indicator
31241 blank. If you want something else displayed before the 773
31242 text, set the second indicator to '8' and add a subfield 'i'
31243 with the label you want at the beginning of the field (e.g.
31244 "$iOffprint from:").</para></entry>
31248 <entry><para>830</para></entry>
31250 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
31252 <entry><para>Authorized form of the series name transcribed in
31253 the 490 field. Often this will just be the same as the
31254 490.</para></entry>
31256 <entry><para>See Authorized headings sheet and AACR2. Set the
31257 second indicator to the number of non-filing characters (i.e.
31258 characters in an initial articles plus the space... for "The "
31259 set the second indicator to '4').</para></entry>
31263 <entry><para>852</para></entry>
31265 <entry><para>LOCATION/CALL NUMBER</para></entry>
31267 <entry><para>Provides the section name for pre-barcode books,
31268 pamphlets, and some articles and serials.</para></entry>
31270 <entry><para>Do not put anything in this field if you are
31271 cataloging a volume which gets only one record and a barcode.
31272 If the item does not get a barcode, or you are currently
31273 creating a record for an article in a volume, put the section
31274 in subfield 'a' (see ANS cataloging documentation), and the
31275 call number in subfield 'i'. Set the first indicator to
31276 '8'.</para></entry>
31280 <entry><para>856</para></entry>
31282 <entry><para>ELECTRONIC ACCESS</para></entry>
31284 <entry><para>Links to material available
31285 online.</para></entry>
31287 <entry><para>Put the URL of any electronic copies or
31288 summaries, etc. in subfield 'u' and a link title in subfield
31289 'y'. Set the first indicator to '4'.</para></entry>
31293 <entry><para>942</para></entry>
31295 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
31297 <entry><para>Used for Koha-specific data.</para></entry>
31299 <entry><para>Set the subfield 'c' to the appropriate item
31300 type.</para></entry>
31307 <section id="itemcatguide">
31308 <title>Item/Holdings Record Cataloging Guide</title>
31310 <para>This table represents the default embedded holdings data in Koha. This information can
31311 be used for migration or importing data purposes</para>
31313 <table cellpadding="4" cellspacing="4" frame="all">
31314 <title>Koha Embedded Holdings Data</title>
31316 <tgroup align="left" cols="4" colsep="1" rowsep="1">
31317 <colspec colname="tag" colnum="1"/>
31319 <colspec colname="data" colnum="2"/>
31321 <colspec colname="desc" colnum="3"/>
31323 <colspec colname="note" colnum="4"/>
31327 <entry><para>MARC21 Tag/subfield</para></entry>
31329 <entry><para>Data Element</para></entry>
31331 <entry><para>Description</para></entry>
31333 <entry><para>Notes</para></entry>
31339 <entry><para>952$0</para></entry>
31341 <entry><para>Withdrawn status</para></entry>
31343 <entry><para>Default values: </para> <itemizedlist>
31345 <para>0 = Not withdrawn</para>
31349 <para>1 = Withdrawn</para>
31351 </itemizedlist></entry>
31353 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31354 ('WITHDRAWN' in default installation)</para></entry>
31358 <entry><para>952$1</para></entry>
31360 <entry><para>Lost status</para></entry>
31362 <entry><para>Default values:</para> <itemizedlist>
31364 <para>0 = Available</para>
31368 <para>1 = Lost</para>
31372 <para>2 = Long Overdue (Lost)</para>
31376 <para>3 = Lost and Paid For</para>
31380 <para>4 = Missing in Inventory</para>
31384 <para>5 = Missing in Hold Queue</para>
31386 </itemizedlist></entry>
31388 <entry><para>It's possible to configure OPAC so that lost
31389 items don't display with the <link linkend="hidelostitems">hidelostitems</link> system
31390 preference. </para> <para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31391 ('LOST' in default installation)</para></entry>
31395 <entry><para>952$2</para></entry>
31397 <entry><para>Classification</para></entry>
31399 <entry><para>Classification scheme that defines filing rules
31400 used for sorting call numbers.</para></entry>
31402 <entry><para>A choice of <link linkend="classificationsources">classification sources</link>
31403 as they are defined in administration. If no classification
31404 scheme is entered, the system will use the value entered in
31405 the <link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
31406 preference.</para></entry>
31410 <entry><para>952$3</para></entry>
31412 <entry><para>Materials specified</para></entry>
31414 <entry><para>Specific issues of serials or multi-part
31415 items.</para></entry>
31417 <entry><para>Displayed when items are checked out and in to
31418 tell the staff how many pieces the item has. Copy/volume data
31419 is stored in 952$h and $t for display in Normal
31420 views.</para></entry>
31424 <entry><para>952$4</para></entry>
31426 <entry><para>Damaged status</para></entry>
31428 <entry><para>Default values: </para> <itemizedlist>
31430 <para>0 = Not damaged</para>
31434 <para>1 = Damaged</para>
31436 </itemizedlist></entry>
31438 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31439 ('DAMAGE' in default installation)</para></entry>
31443 <entry><para>952$5</para></entry>
31445 <entry><para>Use restrictions</para></entry>
31447 <entry><para>Default values:</para> <itemizedlist>
31449 <para>0 = No use restrictions</para>
31453 <para>1 = Restricted Access</para>
31455 </itemizedlist></entry>
31457 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31458 ('RESTRICT' in default installation). This value has no effect
31459 on circulation.</para></entry>
31463 <entry><para>952$7</para></entry>
31465 <entry><para>Not for loan</para></entry>
31467 <entry><para>Default values:</para> <itemizedlist>
31469 <para>-1 = Ordered</para>
31473 <para>0 = Available for loans</para>
31477 <para>1 = Not for Loan</para>
31481 <para>2 = Staff Collection</para>
31483 </itemizedlist></entry>
31485 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31486 ('NOT_LOAN' in default installation). Negative number values
31487 can still be placed on hold.</para></entry>
31491 <entry><para>952$8</para></entry>
31493 <entry><para>Collection code</para></entry>
31495 <entry><para>Coded value</para></entry>
31497 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31498 ('CCODE' in default installation)</para></entry>
31502 <entry><para>952$9</para></entry>
31504 <entry><para>Item number</para></entry>
31506 <entry><para>System-generated item number.</para></entry>
31508 <entry><para>Does not display in the item
31509 record.</para></entry>
31513 <entry><para>952$a</para></entry>
31515 <entry><para>Owning Library **</para></entry>
31517 <entry><para>Branch code</para></entry>
31519 <entry><para><emphasis role="bold">Required</emphasis>. Code
31520 must be defined in <link linkend="libsgroups">Libraries,
31521 Branches and Groups</link></para></entry>
31525 <entry><para>952$b</para></entry>
31527 <entry><para>Holding library ** (usually the same as 952$a
31530 <entry><para>Branch code</para></entry>
31532 <entry><para><emphasis role="bold">Required</emphasis>. Code
31533 must be defined in <link linkend="libsgroups">Libraries,
31534 Branches and Groups</link></para></entry>
31538 <entry><para>952$c</para></entry>
31540 <entry><para>Shelving location code</para></entry>
31542 <entry><para/></entry>
31544 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
31545 ('LOC' in default installation)</para></entry>
31549 <entry><para>952$d</para></entry>
31551 <entry><para>Date acquired</para></entry>
31553 <entry><para>YYYY-MM-DD</para></entry>
31555 <entry><para>Date formats in the 952 subfields are required to
31556 be in the system internal format for data loading and
31557 subsequent item editing: YYYY-MM-DD</para></entry>
31561 <entry><para>952$e</para></entry>
31563 <entry><para>Source of acquisition</para></entry>
31565 <entry><para>Coded value or vendor string</para></entry>
31567 <entry><para>Filled in automatically with the Koha assigned
31568 vendor id by Acquisitions when an item is
31569 received.</para></entry>
31573 <entry><para>952$g</para></entry>
31575 <entry><para>Purchase price</para></entry>
31577 <entry><para>Decimal number, no currency symbol (ex.
31578 10.00)</para></entry>
31580 <entry><para>Filled in automatically by Acquisitions when an
31581 item is received.</para></entry>
31585 <entry><para>952$h</para></entry>
31587 <entry><para>Serial enumeration</para></entry>
31589 <entry><para/></entry>
31591 <entry><para>Filled in automatically by Serials if the issue
31592 is received there.</para></entry>
31596 <entry><para>952$o</para></entry>
31598 <entry><para>Koha full call number</para></entry>
31600 <entry><para/></entry>
31602 <entry><para>Can be filled in automatically based on the <link linkend="itemcallnumber">itemcallnumber</link> system
31603 preference.</para></entry>
31607 <entry><para>952$p</para></entry>
31609 <entry><para>Barcode *</para></entry>
31611 <entry><para>Max 20 characters</para></entry>
31613 <entry><para/></entry>
31617 <entry><para>952$t</para></entry>
31619 <entry><para>Copy number</para></entry>
31621 <entry><para>Max 32 characters</para></entry>
31623 <entry><para/></entry>
31630 <para>Uniform Resource Identifier </para>
31633 <para>Item specific URL</para>
31636 <para>Full URL starting with http:// Only needed if your item has its own URL, not
31637 necessary if the bib record has a 856$u that applies to all items on the record.
31646 <para>Replacement price</para>
31649 <para>Decimal number, no currency symbol (ex. 10.00)</para>
31652 <para>Filled in automatically by Acquisitions when an item is received.</para>
31657 <entry><para>952$w</para></entry>
31659 <entry><para>Price effective from</para></entry>
31661 <entry><para>YYYY-MM-DD</para></entry>
31663 <entry>Date formats in the 952 subfields are required to be in
31664 the system internal format for data loading and subsequent
31665 item editing: YYYY-MM-DD. Filled in automatically by
31666 Acquisitions when an item is received.</entry>
31673 <para>Nonpublic note</para>
31678 <entry>This is a note field for notes that will not appear in the OPAC. Right now
31679 this note does not appear anywhere but in the item edit screen in the staff
31684 <entry><para>952$y</para></entry>
31686 <entry><para>Koha item type **</para></entry>
31688 <entry><para>Coded value, required field for
31689 circulation</para></entry>
31691 <entry><para><emphasis role="bold">Required</emphasis>. Coded
31692 value, must be defined in <link linkend="itemtypeadmin">Item
31693 types</link></para></entry>
31697 <entry><para>952$z</para></entry>
31699 <entry><para>Public note</para></entry>
31701 <entry><para/></entry>
31703 <entry><para/></entry>
31709 <para>* - required for circulation</para>
31711 <para>** - required by Koha</para>
31714 <section id="onorderitemholds">
31716 <corpauthor>VOKAL</corpauthor>
31719 <firstname>Nicole C.</firstname>
31721 <surname>Engard</surname>
31724 <pubdate>2010</pubdate>
31726 <bibliosource><ulink 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>
31729 <title>Handling On Order Items and Holds</title>
31731 <para>If you tend to import your MARC records when you have ordered
31732 the book (as opposed to when you receive the books), and allow patrons
31733 to place holds on those books, you may need to add item records to the
31734 *.mrc file before importing.</para>
31736 <para>The easiest way to import your latest order is to first run your records through
31737 <ulink url="http://marcedit.reeset.net/">MARCEdit</ulink>. Download your MARC records,
31738 saving them to your desktop or some other location you use/will remember. If you have
31739 MARCEdit already installed you should simply have to double click on your MARC records,
31740 and they will automatically open in MARCEdit.<important>
31741 <para>This tutorial was written with MARCEdit version 5.2.3769.41641 on Windows XP,
31742 instructions may be different if your version or operating system is different.</para>
31743 </important></para>
31747 <para>Your original file will automatically be in the input;
31748 ensure MarcBreaker is chosen, and then click "Execute"</para>
31751 <screeninfo>MarcBreaker</screeninfo>
31755 <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
31762 <para>You will be presented with a summary of the records
31763 processed at the bottom of the screen</para>
31766 <screeninfo>MarcBreaker Summary</screeninfo>
31770 <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
31777 <para>Click 'Edit Records' to continue on to adding item
31782 <para>Your screen will be replaced with a larger screen containing
31783 the MARC records</para>
31786 <screeninfo>MARC file for editing</screeninfo>
31790 <imagedata fileref="images/appendix-onorder/editrecords.png"/>
31797 <para>Click on Tools > Add/Edit Field</para>
31800 <screeninfo>Add/Delete Field</screeninfo>
31804 <imagedata fileref="images/appendix-onorder/addfield.png"/>
31811 <para>Enter in the Koha specific item info</para>
31814 <screeninfo>Add 942 Field</screeninfo>
31818 <imagedata fileref="images/appendix-onorder/add942.png"/>
31825 <para>In the Field box, type 942</para>
31829 <para>In the Field Data box, type \\$c and the item type code
31830 (\\$cBOOK in this example)</para>
31834 <para>Check the 'Insert last' option</para>
31838 <para>Click 'Add Field'</para>
31844 <para>Enter in the item record data</para>
31847 <screeninfo>Add 952 Field</screeninfo>
31851 <imagedata fileref="images/appendix-onorder/add952.png"/>
31858 <para>In the Field box, type 952</para>
31862 <para>In the Field Data box, type
31863 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
31867 <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
31871 <para>In a default install of Koha -1 is the value for
31872 the Ordered status</para>
31878 <para>You may want to look at other subfields you would
31879 like data in -- for example, changing the collection code
31880 to put all the items in the same collection (8),
31881 automatically fill in the acquisition date (d), or put in
31882 a public note (z).</para>
31886 <para>Be sure you use the $ to separate subfields; adding
31887 each subfield on a separate line will cause that many
31888 items to be imported with your MARC record (in the example
31889 above, four items, each with one of those subfields
31894 <para>Make sure you look at the Administration >
31895 Authorized Values in Koha to put the correct code into the
31902 <para>Check the 'Insert last' option</para>
31906 <para>Click 'Add Field'</para>
31912 <para>Close the field editor window</para>
31916 <para>Click on File > Compile into MARC</para>
31919 <screeninfo>Compile into MARC</screeninfo>
31923 <imagedata fileref="images/appendix-onorder/compile.png"/>
31930 <para>Choose where to save your file</para>
31934 <para>Now you want to go into your Koha system and follow the
31935 instructions for <link linkend="stagemarc">importing MARC
31936 records</link>.</para>
31938 <para>Once the item has come in, you will need to go to the item
31939 record and individually change the item to have the correct barcode,
31940 and manually change the status from Ordered to the blank line in the
31941 Not for Loan field.</para>
31944 <para>If you purchase your cataloged item records, you may want to
31945 request your vendor put in the information you need into the MARC
31946 records for you; that way, you could import the edited-by-the-vendor
31947 file, overwriting the current record, automatically replacing the
31948 data with what you need.</para>
31953 <chapter id="coursereserves">
31954 <title>Course Reserves</title>
31955 <para>The course reserves module in Koha allows you to temporarily move items to 'reserve' and
31956 assign different circulation rules to these items while they are being used for a specific
31958 <section id="coursesetup">
31959 <title>Course Reserves Setup</title>
31960 <para>Before using Course Reserves you will need to do some set up. </para>
31961 <para>First you will need to enable course reserves by setting the <link
31962 linkend="UseCourseReserves">UseCourseReserves</link> preference to 'Use'.</para>
31963 <para>Next you will need to have all of your course instructors <link linkend="addnewpatron"
31964 >added as patrons</link>.</para>
31965 <para>Next you will want to add a couple of new <link linkend="newauthval">authorized
31966 values</link> for Departments and Terms. </para>
31967 <para>You may also want to create new <link linkend="additemtype">item types</link>, <link
31968 linkend="ccode">collection codes</link> and/or <link linkend="shelvelocvals">shelving
31969 locations</link> to make it clear that the items are on reserve to your patrons. You will
31970 also want to be sure to confirm that your <link linkend="circfinerules">circulation and fine
31971 rules</link> are right for your new item types (whether they be hourly or daily
31974 <section id="addingcourses">
31975 <title>Adding Courses</title>
31976 <para>Once you have completed your set up for Course Reserves you can start creating courses
31977 and adding titles to the reserve list.</para>
31979 <screeninfo>Course Reserves Admin</screeninfo>
31982 <imagedata fileref="images/coursereserves/coursesblank.png"/>
31986 <para>From the main course reserves page you can add a new course by clicking the 'New course'
31987 button at the top left.</para>
31989 <screeninfo>Add a new course</screeninfo>
31992 <imagedata fileref="images/coursereserves/newcourse.png"/>
31996 <para>Your new course will need a Department, Number and Name at the bare minimum. You can
31997 also add in additional details like course section number and term. To link an instructor to
31998 this course simply start typing their name and Koha will search your patron database to find
31999 you the right person.</para>
32001 <screeninfo>Instrcutor search</screeninfo>
32004 <imagedata fileref="images/coursereserves/instructorsearch.png"/>
32008 <para>Once the instructor you want appears just click their name and they will be added. You
32009 can repeat this for all instructors on this course. Each instructor will appear above the
32010 search box and can be removed by clicking the 'Remove' link to the right of their name.</para>
32012 <screeninfo>Instructors</screeninfo>
32015 <imagedata fileref="images/coursereserves/instructorremove.png"/>
32019 <para>If you would like your course to show publicly you'll want to be sure to check the
32020 'Enabled?' box before saving your new course.</para>
32021 <para>Once your course is saved it will show on the main course reserves page and be
32022 searchable by any field in the course.</para>
32024 <screeninfo>Courses</screeninfo>
32027 <imagedata fileref="images/coursereserves/courses.png"/>
32032 <section id="addreserves">
32033 <title>Adding Reserve Materials </title>
32034 <para>Before adding reserve materials you will need at least one course to add them to. To
32035 add materials visit the Course Reserves module.</para>
32037 <screeninfo>Courses</screeninfo>
32040 <imagedata fileref="images/coursereserves/courses.png"/>
32044 <para>Click on the title of the course you would like to add materials to.</para>
32046 <screeninfo>Course administration</screeninfo>
32049 <imagedata fileref="images/coursereserves/courseadmin.png"/>
32053 <para>At the top of the course description click the 'Add reserves' button to add titles to
32054 this reserve list. You will be asked to enter the barcode for the reserve item.</para>
32056 <screeninfo>Add item to reserve</screeninfo>
32059 <imagedata fileref="images/coursereserves/addbarcode.png"/>
32063 <para>After you are done scanning the barcodes to add to the course you can see them on the
32066 <screeninfo>Course with reserves</screeninfo>
32069 <imagedata fileref="images/coursereserves/coursewithreserves.png"/>
32074 <section id="opaccoursereserves">
32075 <title>Course Reserves in the OPAC</title>
32076 <para>Once you have enabled Course Reserves and added courses you will see a link to Course
32077 Reserves below your search box in the OPAC.</para>
32079 <screeninfo>Course Reserves Link</screeninfo>
32082 <imagedata fileref="images/coursereserves/courselinkopac.png"/>
32086 <para>Clicking that link will show you your list of enabled courses (if you have only one
32087 course you will just see the contents of that one course).</para>
32089 <screeninfo>Course list in the OPAC</screeninfo>
32092 <imagedata fileref="images/coursereserves/coursesopac.png"/>
32096 <para>You can search course reserves by any field (course number, course name, instructor
32097 name, department) that is visbile in the list of courses. Clicking a course name will show
32098 you the details and reserve items.</para>
32100 <screeninfo>Course listing</screeninfo>
32103 <imagedata fileref="images/coursereserves/courseopac.png"/>
32110 <chapter id="serials">
32111 <title>Serials</title>
32113 <para>Serials actions can be accessed by going to the More menu at the top
32114 of your screen and choosing Serials or by clicking Serials on the main
32115 Koha staff client page. The Serials module in Koha is used for keeping
32116 track of journals, newspapers and other items that come on a regular
32117 schedule. As with all modules, make sure you go through the related <link linkend="impserials">Implementation Checklist</link> before using the
32118 Serials module.</para>
32122 <para><emphasis>Get there:</emphasis> More > Serials</para>
32125 <section id="serialfreq">
32126 <title>Manage Serial Frequencies</title>
32127 <para>Koha keeps a record of publication frequencies for easy management and
32128 duplication.</para>
32131 <para><emphasis>Get there:</emphasis> More > Serials > Manage frequencies</para>
32134 <para>From this page you can view all of the existing frequencies in your system</para>
32136 <screeninfo>Frequencies</screeninfo>
32139 <imagedata fileref="images/serials/frequencies.png"/>
32143 <para>and create new ones.</para>
32145 <screeninfo>New frequency</screeninfo>
32148 <imagedata fileref="images/serials/newfrequency.png"/>
32153 <section id="serialpatterns">
32154 <title>Manage Serial Numbering Patterns</title>
32155 <para>Everytime you create a new numbering pattern in serials you can save it for later use.
32156 These patters are accessible via the Manage numbering patterns page.</para>
32159 <para><emphasis>Get there:</emphasis> More > Serials > Manage numbering patterns</para>
32162 <para>This page will list for you the numbering patterns you have saved in the past as well as
32163 a few canned patterns.</para>
32165 <screeninfo>Number patterns</screeninfo>
32168 <imagedata fileref="images/serials/numpatterns.png"/>
32173 <para>If you have upgraded from a previous version of Koha you will see 'Backup patterns'
32174 listed for patterns used in version before Koha 3.14. This is how Koha saved your old
32175 numbering patterns. You can edit these to give them more meaningful names from
32177 </tip>It will also allow you to create a new numbering pattern without first adding a
32178 subscription. To add new new pattern click 'New numbering pattern' at the top of the list of
32181 <screeninfo>New number pattern</screeninfo>
32184 <imagedata fileref="images/serials/newnumpattern.png"/>
32190 <section id="newsubscription">
32191 <title>Add a subscription</title>
32193 <para>Subscriptions can be added by clicking the 'New' button on any
32194 bibliographic record</para>
32197 <screeninfo>New Subscription Button</screeninfo>
32201 <imagedata fileref="images/serials/newsubfrombib.png"/>
32206 <para>Or by visiting the Serials module and clicking 'New
32207 Subscription'</para>
32210 <screeninfo>New Subscription Button</screeninfo>
32214 <imagedata fileref="images/serials/newsubbutton.png"/>
32219 <para>If you are entering a new subscription from the Serials module you
32220 will be presented with a blank form (if creating new from a
32221 bibliographic record the form will include the bib info).</para>
32224 <screeninfo>Add a new subscription (1/2)</screeninfo>
32228 <imagedata fileref="images/serials/addsub.png"/>
32235 <para>'Librarian' field will show the logged in librarian's
32240 <para>'Vendor' can be found by either searching vendors entered via
32241 the <link linkend="acqmodule">Acquisitions module</link> or entering
32242 the vendor ID number</para>
32246 <para>Vendor information is not required</para>
32250 <para>In order to claim missing and late issues you need to
32251 enter vendor information</para>
32254 <screeninfo>Vendor Missing Warning</screeninfo>
32258 <imagedata fileref="images/serials/vendorwarning.png"/>
32267 <para>'Biblio' is the MARC record you'd like to link this
32268 subscription to</para>
32272 <para>This can be done by searching for an existing record by
32273 clicking on the 'Search for Biblio' link below the boxes or by
32274 entering the bib number for a record in the first box. Only if
32275 you search with the field between the parenthesis.</para>
32281 <para>Next you can choose whether a new item is created when receiving an issue (if you
32282 barcode issues you'll want to create an item at this time)</para>
32285 <para>In order to determine how to handle irregularities in your subscription answer 'When
32286 there is an irregular issue', if the numbers are always sequential you'll want to pick
32287 'Keep issue number'</para>
32290 <para>Checking the 'Manual history' box will allow you to enter serials outside the
32291 prediction pattern once the subscription is saved by going to the 'Planning' tab on the
32292 subscription detail page.<screenshot>
32293 <screeninfo>Manual History</screeninfo>
32296 <imagedata fileref="images/serials/manualhistory.png"/>
32299 </screenshot></para>
32302 <para>'Call Number' is for your item's call number or call number prefix</para>
32305 <para>'Library' is the branch that owns this subscription.</para>
32308 <para>If more than one library subscribes to this serial you will need to create a
32309 subscription for each library</para>
32312 <para>This can be done easily by using the 'Edit as New (Duplicate)' option found on
32313 the subscription information page and changing only the 'Library' field</para>
32315 <screeninfo>New Duplicate Subscription</screeninfo>
32318 <imagedata fileref="images/serials/newasdup.png"/>
32326 <para>Use the 'Public Note' for any notes you would like to appear in the OPAC for the
32330 <para>'Nonpublic Note' should be used for notes that are only visible to the librarians
32331 via the staff client</para>
32334 <para>The 'Patron notification' option lets you pick a notice to send to patrons who
32335 subscribe to updates on this serial via the OPAC.</para>
32338 <para>For this option to appear you need to make sure that you have a Routing List
32339 notice set up in the <link linkend="notices">Notices Tool</link></para>
32345 <para>'Location' is for the shelving location</para>
32349 <para>The 'Grace period' is the number of days before an issue is automatically moved from
32350 'Expected' status to 'Waiting' and how many days before an issue is automatically moved
32351 from 'Waiting' status to 'Late'</para>
32355 <para>The Staff and OPAC Display options allow you to control how
32356 many issues appear by default on bibliographic records in the Staff
32357 Client and the OPAC</para>
32361 <para>If no values are entered in these fields, they will use
32362 the <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
32363 and <link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
32364 system preference values</para>
32369 <para>Once that data is filled in you can click 'Next' to enter the prediction pattern information.</para>
32371 <screeninfo>Add a new subscription (2/2)</screeninfo>
32374 <imagedata fileref="images/serials/addsub2.png"/>
32380 <para>In 'First issue publication date' you want to enter the date
32381 of the issue you have in your hand, the date from which the
32382 prediction pattern will start</para>
32386 <para>There are several pre-defined options for the 'Frequency' of publication all of
32387 which are visible alongside your own custom frequencies by visiting '<link
32388 linkend="serialfreq">Manage frequencies</link>'</para>
32392 <para>Without periodicy: some very specific (usually high level
32393 science journals) don't have a true periodicity. When you
32394 subscribe to the title, you subscribe for 6 issues, which can
32395 arrive in 1 year... or 2... There is no regularity or known
32400 <para>Unknown select this if none of the other choices are
32405 <para>Irregular: The journal is not "regular" but has a
32406 periodicity. You know that it comes out on January, then in
32407 October and December, it is irregular, but you know when it's
32408 going to arrive.</para>
32412 <para>2/day: Twice daily</para>
32416 <para>1/day: Daily</para>
32420 <para>3/week: Three times a week</para>
32424 <para>1/week: Weekly</para>
32428 <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
32432 <para>1/ 3 weeks: Tri-weekly</para>
32436 <para>1/month: Monthly</para>
32440 <para>1/ 2 months (6/year): Bi-monthly</para>
32444 <para>1/ 3 months (1/quarter): Quarterly</para>
32448 <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
32449 Summer, Autumn, Winter, Spring)</para>
32453 <para>2/year: Half yearly</para>
32457 <para>1/year: Annual</para>
32461 <para>1/ 2 years: Bi-annual</para>
32466 <para>'Subscription length' is the number of issues or months in the subscription. This is
32467 also used for setting up renewal alerts</para>
32470 <para>'Subscription start date' is the date at which the subscription begins. This is used
32471 for setting up renewal alerts</para>
32474 <para>'Subscription end date' should only be entered for subscriptions that have ended (if
32475 you're entering in a backlog of serials)</para>
32479 <para>'Numbering pattern' will help you determine how the numbers are printed for each
32480 issue. Patterns entered here are saved and editable at any time by visiting '<link
32481 linkend="serialpatterns">Manage numbering patterns</link>'</para>
32485 <para>Start with the numbering on the issue you have in hand,
32486 the numbering that matches the date you entered in the 'First
32487 issue publication' field</para>
32491 <para>You can choose to create your own numbering pattern by choosing 'None of the
32492 above' and clicking the 'Show/Hide Advanced Pattern' button at the bottom of the form</para>
32494 <screeninfo>Advanced prediction pattern</screeninfo>
32497 <imagedata fileref="images/serials/advancedpattern.png"/>
32505 <para>The 'Locale' option is useful when you want to display days, month or season. For
32506 example, if you have a German serial, you can use the German locale option to display
32507 days, etc. in German.</para>
32511 <para>Once a 'Numbering pattern' is chosen the number formula will appear.<screenshot>
32512 <screeninfo>Numbering Forumla</screeninfo>
32515 <imagedata fileref="images/serials/numberonly.png"/>
32518 </screenshot><itemizedlist>
32520 <para>The 'Begins with' number is the number of the issue you're holding in your
32524 <para>The 'Inner counter' is used to tell Koha where the "receiving cycle" starts<itemizedlist>
32526 <para>For example: If the first issue to receive is "vol. 4, no. 1, iss. 796",
32527 you need to set up "inner counter = 0" But if it's "vol. 4, no. 2, iss.
32528 797", the inner counter should be "1".</para>
32530 </itemizedlist></para>
32533 <para>After filling in this data click the 'Test prediction pattern' button to see
32534 what issues the system will generate, if there are irregularities you can choose
32535 which issues don't exist from the list presented.</para>
32537 <screeninfo>Prediction pattern</screeninfo>
32540 <imagedata fileref="images/serials/predictionpattern.png"/>
32545 </itemizedlist></para>
32549 <para>Click 'Save Subscription' to save the information you have
32550 entered. <link linkend="sampleserialsapp">Find sample serial examples in
32551 the appendix</link>.</para>
32554 <section id="receiveissues">
32555 <title>Receive Issues</title>
32557 <para>Issues can be marked as received from several locations. To find a
32558 subscription, use the search box at the top of the Serials page to
32559 search for the serial you'd like to receive issues for:</para>
32562 <screeninfo>Subscription Search</screeninfo>
32566 <imagedata fileref="images/serials/subsearch.png"/>
32571 <para>From the search results you can click the 'Serial Receive' link or
32572 you can click on the subscription title and then click the 'Receive'
32576 <screeninfo>Subscription Buttons</screeninfo>
32580 <imagedata fileref="images/serials/subbuttons.png"/>
32585 <para>The final way to receive serials is from the 'Serial Collection'
32586 page. To the left of the Subscription summary page there is a menu with
32587 a link to 'Serial Collection'</para>
32590 <screeninfo>Serial Subscription Menu</screeninfo>
32594 <imagedata fileref="images/serials/serialcolllink.png"/>
32599 <para>From the page that opens up you can click 'Edit Serial' with the
32600 issue you want to receive checked.</para>
32603 <screeninfo>Edit Issues</screeninfo>
32607 <imagedata fileref="images/serials/editissue.png"/>
32612 <para>All three of these options will open up the issue receive
32616 <screeninfo>Receive Serials</screeninfo>
32620 <imagedata fileref="images/serials/receiveissue.png"/>
32627 <para>Choose 'Arrived' from the status pull down to mark a serial as
32632 <para>If you have decided to have an item record created for each issue an <link linkend="addingitems">item add form</link>
32633 will appear after choosing 'Arrived'</para>
32635 <screeninfo>Serial item record</screeninfo>
32638 <imagedata fileref="images/serials/serialitem.png"/>
32645 <para>If your issue has a supplemental issue with it, fill in the
32646 Supplemental Issue information.</para>
32650 <para>If you have decided to have an item record created for each
32651 issue an <link linkend="addingitems">item add form</link> will
32652 appear for your supplement and for the issue itself</para>
32656 <para>Once you have entered your info you can click 'Save'</para>
32660 <para>If you are receiving multiple issues at once, or have marked an
32661 issue as 'Late' or 'Missing' there you can click the 'Generate Next'
32662 button below the list of issues.</para>
32665 <screeninfo>Generate Next Button</screeninfo>
32669 <imagedata fileref="images/serials/editissue.png"/>
32674 <para>Clicking this button will generate the next issue for you and mark
32675 the previously expected issue as 'Late' automatically. You can then
32676 check the 'Edit' box to the right of each issue and edit the status on
32677 multiple issues at once.</para>
32680 <section id="routinglist">
32681 <title>Create a Routing List</title>
32683 <para>A routing list is a list of people who receive the serial before it goes to the shelf.
32684 To enable routing lists you want to set your <link linkend="RoutingSerials"
32685 >RoutingSerials</link> preference to 'Add'.</para>
32687 <para>When on the subscription page you will see a link to the left that
32688 reads 'Create Routing List' or 'Edit Routing List'</para>
32691 <screeninfo>Subscription Routing List Link</screeninfo>
32695 <imagedata fileref="images/serials/createroutinglink.png"/>
32700 <para>Clicking that link will bring you to the menu to add a new routing
32704 <screeninfo>Routing List Creation</screeninfo>
32708 <imagedata fileref="images/serials/createroutinglist.png"/>
32713 <para>From here you want to click 'Add recipients' in order to add
32714 people to the routing list. In the menu that appears you can filter
32715 patrons by part of their name, their library and/or patron
32719 <screeninfo>Add Members to Routing List</screeninfo>
32723 <imagedata fileref="images/serials/addtorouting.png"/>
32728 <para>Clicking 'Add' to the right of each name will add them to the
32729 routing list. When you have chosen all of the people for the list, click
32730 the 'Close' link to be redirected to the routing list.</para>
32733 <screeninfo>Routing List</screeninfo>
32737 <imagedata fileref="images/serials/editroutinglist.png"/>
32742 <para>If the list looks the way you expect it to, then click 'Save'.
32743 Next you will be brought to a preview of the routing list. To print the
32744 list click 'Save and preview routing slip.' This will open a printable
32745 version of the list.</para>
32748 <screeninfo>Preview Routing List</screeninfo>
32752 <imagedata fileref="images/serials/previewroutinglist.png"/>
32757 <para>If <link linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
32758 on then patrons listed in the routing list will automatically be added
32759 to the holds list for the issue.</para>
32761 <para>To see a list of all of the routing lists a specific patron is on visit the <link
32762 linkend="patronroutingtab">Routing Lists tab</link> on their patron record.</para>
32765 <section id="serialsubinstaff">
32766 <title>Subscriptions in Staff Client</title>
32768 <para>Subscription information will appear on bibliographic records
32769 under the 'Subscriptions' tab</para>
32772 <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
32776 <imagedata fileref="images/serials/subinfoonbib.png"/>
32781 <para>Clicking the 'Subscription Details' link will take you to the
32782 Subscription summary page in the staff client.</para>
32785 <screeninfo>Subscription Detail</screeninfo>
32789 <imagedata fileref="images/serials/subscriptiondetail.png"/>
32793 <para>If you are using the <link linkend="acqmodule">Acquisitions</link> module to keep <link
32794 linkend="ordersubscription">track of serial subscriptions</link> you will see that info
32795 before your subscription details.</para>
32797 <screeninfo>Acquisitions information for subscription</screeninfo>
32800 <imagedata fileref="images/acquisitions/subdetails.png"/>
32806 <section id="serialsubinopac">
32807 <title>Subscriptions in OPAC</title>
32809 <para>When viewing the subscription in the OPAC there will be several
32812 <para>Like in the staff client, there will be a Subscriptions tab on the
32813 bibliographic record.</para>
32816 <screeninfo>Subscriptions Tab in OPAC</screeninfo>
32820 <imagedata fileref="images/serials/subopac.png"/>
32825 <para>Under this tab will appear the number of issues you chose when
32826 setting up the subscription or in your <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
32827 system preference. Clicking the 'More details' link will provide you
32828 with additional information about the serial history. You can set the
32829 default view of a serial in the OPAC with the <link linkend="SubscriptionHistory">SubscriptionHistory</link> system
32832 <para>There are two views, compact and full. The compact serial
32833 subscription will show basic information regarding the
32834 subscription</para>
32837 <screeninfo>Compact Serial View</screeninfo>
32841 <imagedata fileref="images/serials/compactopac.png"/>
32846 <para>From this compact display patrons can subscribe to be notified of new issues as they are
32847 released by clicking the 'Subscribe to email notifications of new issues' button. For this
32848 link to appear you will want to have chosen to notify patrons <link
32849 linkend="newsubscription">on the subscription</link> itself.</para>
32852 <screeninfo>Subscribe link in the OPAC</screeninfo>
32856 <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
32860 <para>You can see thos who subscribe to new issue alerts by going to the subscription page in
32861 the staff client and looking on the right of the 'Information' tab.<screenshot>
32862 <screeninfo>Serial notification subscribers</screeninfo>
32865 <imagedata fileref="images/serials/subscribers.png"/>
32868 </screenshot></para>
32870 <para>Whereas the full view shows extensive details, broken out by year,
32871 regarding the subscription</para>
32874 <screeninfo>Full Serial View</screeninfo>
32878 <imagedata fileref="images/serials/fullopac.png"/>
32884 <section id="serialclaims">
32885 <title>Claim Late Serials</title>
32887 <para>Koha can send email messages to your serial vendors if you have
32888 late issues. To the left of the main serials page there is a link to
32892 <screeninfo>Link to Claims on Serials Menu</screeninfo>
32896 <imagedata fileref="images/serials/serialclaimmenu.png"/>
32901 <para>The links to claims also appears to the left of the subscription
32905 <screeninfo>Link to Claims on the Serials Menu</screeninfo>
32909 <imagedata fileref="images/serials/serialclaimmenu1.png"/>
32914 <para>If you don't have a claim notice defined yet you will see a
32915 warning message that you need to first define a notice.</para>
32918 <screeninfo>Missing Claims Notice Warning</screeninfo>
32922 <imagedata fileref="images/serials/noserialclaim.png"/>
32927 <para>Clicking 'Claims' will open a report that will ask you to choose
32928 from your various serial vendors to generate claims for late
32932 <screeninfo>Serial Claims</screeninfo>
32936 <imagedata fileref="images/serials/serialclaims.png"/>
32941 <para>From the list of late issues you can choose which ones you want to
32942 send a claim email to by clicking the checkbox to the left of late
32943 issue, choosing the notice template to use and clicking the 'Send
32944 notification' button.</para>
32947 <section id="serialexpiration">
32948 <title>Check Serial Expiration</title>
32950 <para>When adding serials you enter a subscription length, using the
32951 check expiration tool you can see when your subscriptions are about to
32952 expire. To use the tool click the link to 'Check expiration' on the
32953 serials menu.</para>
32956 <screeninfo>Check Serial Expiration</screeninfo>
32960 <imagedata fileref="images/serials/serialexpiresearch.png"/>
32965 <para>In the form that appears you need to enter at least a date to
32968 <para>In your results you will see all subscriptions that will expire
32969 before the date you entered. From there you can choose to view the
32970 subscription further or renew it in one click.</para>
32973 <screeninfo>Serial Expiration Search Results</screeninfo>
32977 <imagedata fileref="images/serials/serialexpire.png"/>
32983 <section id="serialrenew">
32984 <title>Renewing Serials</title>
32986 <para>If your serial subscription has expired you won't be able to
32987 receive issues. To renew your subscription you can click the 'Renew'
32988 button at the top of your subscription detail page.</para>
32991 <screeninfo>Renew option on subscription detail</screeninfo>
32995 <imagedata fileref="images/serials/renewsubscription.png"/>
33000 <para>Another option is to click the 'Renew' link to the right of the
33001 subscription on the Serial Collection page.</para>
33004 <screeninfo>Renew option on serial collection</screeninfo>
33008 <imagedata fileref="images/serials/collectionrenew.png"/>
33013 <para>Once you click the 'Renew' link or button you will be presenting
33014 with renewal options.</para>
33017 <screeninfo>Subscription renewal form</screeninfo>
33021 <imagedata fileref="images/serials/serialrenew.png"/>
33028 <para>The start date should be the date your subscription period
33033 <para>For the subscription length you'll want to fill in one of the
33034 three fields presented: Number of num (issues), Number of months or
33035 Number of weeks.</para>
33039 <para>Finally enter any notes you might have about this
33045 <section id="serialsearch">
33046 <title>Searching Serials</title>
33048 <para>Once in the Serials module there is basic search box at the top
33049 that you can use to find subscriptions using any part of the ISSN and/or
33053 <screeninfo>Basic Serials Search</screeninfo>
33057 <imagedata fileref="images/serials/serialsearch.png"/>
33062 <para>You can also click the 'Advanced Search' link to the right of the
33063 'Submit' button to do a more thorough search of your serials.</para>
33066 <screeninfo>Advanced Serials Search</screeninfo>
33070 <imagedata fileref="images/serials/advanceserialsearch.png"/>
33075 <para>From your results you can filter by using the search boxes at the
33076 bottom of each column and adjust the number of resutls using the toolbar
33077 at the top of the results set.</para>
33080 <screeninfo>Serial Search Results</screeninfo>
33084 <imagedata fileref="images/serials/serialsearchresults.png"/>
33091 <chapter id="acqmodule">
33092 <title>Acquisitions</title>
33094 <para>The Koha Acquisitions module provides a way for the library to
33095 record orders placed with vendors and manage purchase budgets.</para>
33099 <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
33103 <section id="acqsetup">
33104 <title>Setup</title>
33106 <para>Before using the Acquisitions Module you will want to make sure
33107 that you have completed all of the set up.</para>
33109 <para>First, set your <link linkend="acqprefs">Acquisitions System
33110 Preferences</link> and <link linkend="acqadmin">Acquisitions
33111 Administration</link> to match your library's workflow.</para>
33113 <para>On the main acquisitions page you will see your library's funds
33117 <screeninfo>Acquisitions Funds Summary</screeninfo>
33121 <imagedata fileref="images/acquisitions/acqfunds.png"/>
33127 <para>If the total line is confusing for the funds you have set up
33128 you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
33130 <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
33134 <para>To see all active funds you can click the checkbox next to 'Show active and inactive'
33135 above the funds table.</para>
33137 <para>To see a history of all orders in a fund you can click on the
33138 linked amount and it will run a search for you.</para>
33141 <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
33145 <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
33150 <para>Learn more in the <link linkend="fundtracking">Budget/Fund
33151 Tracking</link> section of this manual.</para>
33154 <section id="acqvendors">
33155 <title>Vendors</title>
33157 <para>Before any orders can be places you must first enter at least one
33160 <section id="addacqvendor">
33161 <title>Add a Vendor</title>
33163 <para>To add a vendor click the 'New Vendor' button on the
33164 Acquisitions page</para>
33167 <screeninfo>New Vendor Button on Acquisitions</screeninfo>
33171 <imagedata fileref="images/acquisitions/newvendbutton.png"/>
33176 <para>The vendor add form is broken into three pieces</para>
33180 <para>The first section is for basic information about the
33184 <screeninfo>Basic Vendor Information</screeninfo>
33188 <imagedata fileref="images/acquisitions/newvendor1.png"/>
33195 <para>Of these fields, only the Vendor name is required, the
33196 rest of the information should be added to help with
33197 generating claim letters and invoices</para>
33203 <para>The second section is for information regarding your contact
33204 at the Vendor's office</para>
33207 <screeninfo>Vendor Contact Details</screeninfo>
33211 <imagedata fileref="images/acquisitions/newvendor2.png"/>
33218 <para>None of these fields are required, they should only be
33219 entered if you want to keep track of your contact's
33220 information within Koha</para>
33226 <para>The final section is for billing information</para>
33229 <screeninfo>Vendor Ordering/Billing Information</screeninfo>
33233 <imagedata fileref="images/acquisitions/newvendor3.png"/>
33240 <para>To be able to order from a vendor you must make them
33245 <para>For List Prices and Invoice Prices choose the
33250 <para>Currencies are assigned in the <link linkend="currexchangeadmin">Currencies & Exchange
33251 Rates</link> admin area</para>
33257 <para>If your library is charged tax mark your Tax Number as
33262 <para>Note if you list prices and/or invoice prices include
33267 <para>If the vendor offers a consistent blank discount, enter
33268 that in the 'Discount' field</para>
33272 <para>You can enter item specific discounts when placing
33279 <para>Enter your tax rate if your library is charged taxes on
33284 <para>If you know about how long it usually takes orders to
33285 arrive from this vendor you can enter a delivery time. This
33286 will allow Koha to estimate when orders will arrive at your
33287 library on the late orders report.</para>
33291 <para>Notes are for internal use</para>
33298 <section id="editacqvendor">
33299 <title>View/Edit a Vendor</title>
33301 <para>To view a vendor's information page you must search for the
33302 vendor from the Acquisitions home page. Your search can be for any
33303 part of the Vendor's name:</para>
33306 <screeninfo>Vendor Search Results</screeninfo>
33310 <imagedata fileref="images/acquisitions/vendorsearch.png"/>
33315 <para>From the results, click on the name of the vendor you want to
33316 view or edit</para>
33319 <screeninfo>Vendor Information Page</screeninfo>
33323 <imagedata fileref="images/acquisitions/vendorpage.png"/>
33328 <para>To make changes to the vendor, simply click the 'Edit vendor' button.</para>
33330 <para>If the vendor has no baskets attached to it then a 'Delete vendor' button will also be
33331 visible and the vendor can be deleted. Otherwise you will see a 'Receive shipment'
33335 <screeninfo>Receive shipment button</screeninfo>
33339 <imagedata fileref="images/acquisitions/receivebutton.png"/>
33345 <section id="vendorcontracts">
33346 <title>Vendor Contracts</title>
33348 <para>You can define contracts (with a start and end date) and attach
33349 them to a vendor. This is used so that at the end of the year you can
33350 see how much you spent on a specific contract with a vendor. In some
33351 places, contracts are set up with a minimum and maximum yearly
33354 <section id="addvendorcontract">
33355 <title>Add a Contract</title>
33357 <para>At the top of a Vendor Information Page, you will see a 'New
33358 Contract' button.</para>
33361 <screeninfo>New Contract Button</screeninfo>
33365 <imagedata fileref="images/acquisitions/newcontract.png"/>
33370 <para>The contract form will ask for some very basic information
33371 about the contract</para>
33374 <screeninfo>New Contract Form</screeninfo>
33378 <imagedata fileref="images/acquisitions/newcontractform.png"/>
33384 <para>You cannot enter a contract retrospectively. The end date
33385 must not be before today's date.</para>
33388 <para>Once the contract is saved it will appear below the vendor
33389 information.</para>
33392 <screeninfo>Vendor with contracts</screeninfo>
33396 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
33401 <para>It will also be an option when creating a basket</para>
33404 <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
33408 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
33416 <section id="managesuggest">
33417 <title>Managing Suggestions</title>
33419 <para>Purchase suggestions can be generated in one of two ways. You can create suggestions via
33420 the staff client either for the library or <link linkend="patronsuggestions">on the patron's
33421 behalf</link> from their record. Depending on your settings in the <link
33422 linkend="suggestionspref">suggestion</link> system preference, patrons may also be able to
33423 make purchase suggestions via the OPAC. When a suggestion is waiting for library review, it
33424 will appear on the Acquisitions home page under the vendor search.</para>
33427 <screeninfo>Pending suggestions on Acquisitions</screeninfo>
33431 <imagedata fileref="images/acquisitions/suggestonacq.png"/>
33436 <para>It will also appear on the main staff dashboard under the module
33440 <screeninfo>Pending suggestions on main page</screeninfo>
33444 <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
33449 <para>Clicking 'Manage suggestions' will take you to the suggestion
33450 management tool. If there are no pending suggestions you can access the
33451 suggestion management tool by clicking the 'Manage suggestions' link on
33452 the menu on the left of the Acquisitions page.</para>
33455 <screeninfo>Suggestion Management</screeninfo>
33459 <imagedata fileref="images/acquisitions/suggestmanage.png"/>
33464 <para>Your suggestions will be sorted into several tabs: Accepted,
33465 Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
33466 suggestion will show the name of the librarian who managed the
33467 suggestion and the reason they gave for accepting or rejecting it (found
33468 under 'Status').</para>
33469 <para>An 'Accepted' suggestion is one that you have marked as 'Accepted' using the form below
33470 the suggestions. A 'Pending' suggestion is one that is awaiting action from the library. A
33471 'Checked' suggestion is one that has been marked as 'Checked' using the form before the
33472 suggestions. An 'Ordered' suggestion is on that has been ordered using the '<link linkend="orderfromsuggestion">From a purchase suggestion</link>' link in your basket. A
33473 'Rejected' suggestion is one that you have marked at 'Rejected' using the form below the
33474 list of suggestions.</para>
33476 <para>For libraries with lots of suggestions, there are filters on the
33477 left hand side of the Manage Suggestions page to assist in limiting the
33478 number of titles displayed on the screen.</para>
33481 <screeninfo>Suggestion Filtering</screeninfo>
33485 <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
33490 <para>Clicking on the blue headings will expand the filtering options
33491 and clicking '[clear]' will clear all filters and show all
33493 <para>The suggestions page will automatically be limited to
33494 suggestions for your library. To see information for all (or any
33495 other) libraries click on the 'Acquisition information' filter and
33496 change the library.</para>
33499 <screeninfo>Branch filter</screeninfo>
33503 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
33509 <para>When reviewing 'Pending' suggestions you can choose to check the
33510 box next to the item(s) you want to approve/reject and then choose the
33511 status and reason for your selection. You can also choose to completely
33512 delete the suggestion by checking the 'Delete selected' box.</para>
33515 <screeninfo>Pending Suggestions</screeninfo>
33519 <imagedata fileref="images/acquisitions/suggestpending.png"/>
33524 <para>Another option for libraries with long lists of suggestions is to
33525 approve or reject suggestions one by one by clicking on the title of the
33526 suggestion to open a summary of the suggestion, including information if
33527 the item was purchased.</para>
33530 <screeninfo>Suggestion Information</screeninfo>
33534 <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
33539 <para>Clicking 'edit' to the right of the suggested title or at the to pof the suggestion
33540 detail page will open a suggestion editing page.</para>
33543 <screeninfo>Edit Purchase Suggestion</screeninfo>
33547 <imagedata fileref="images/acquisitions/editsuggestion.png"/>
33552 <para>From this form you can make edits to the suggestion (adding more
33553 details or updating incorrect information provided by the patron). You
33554 can also choose to accept or reject the suggestion on an individual
33559 <para>Choosing to mark a request as 'Pending' will move the request
33560 back to the 'Pending' tab.</para>
33564 <para>Reasons for accepting and rejecting suggestions are defined by the
33565 <link linkend="suggestauthorized">SUGGEST</link> authorized
33569 <screeninfo>Reasons for approving or rejecting
33570 suggestions</screeninfo>
33574 <imagedata fileref="images/acquisitions/suggestreasons.png"/>
33579 <para>If you choose 'Others...' as your reason you will be prompted to
33580 enter your reason in a text box. Clicking 'Cancel' to the right of the
33581 box will bring back the pull down menu with authorized reasons.</para>
33584 <screeninfo>Enter reason for 'Others...'</screeninfo>
33588 <imagedata fileref="images/acquisitions/suggestothers.png"/>
33593 <para>Once you have clicked 'Submit' the suggestion will be moved to the
33594 matching tab. The status will also be updated on the patron's account in
33595 the OPAC and an <link linkend="notices">email notice</link> will be sent
33596 to the patron using the template that matches the status you have
33600 <screeninfo>Purchase suggestions in the OPAC</screeninfo>
33604 <imagedata fileref="images/acquisitions/mysuggestions.png"/>
33610 <section id="placingacqorder">
33611 <title>Placing Orders</title>
33613 <para>To place an order you must first search for the vendor or
33614 bookseller you want to send the order to.</para>
33616 <section id="createacqbasket">
33617 <title>Create a basket</title>
33619 <para>To create a basket you must first search for the vendor you're
33620 ordering from:</para>
33623 <screeninfo>New Basket / Add Basket Options</screeninfo>
33627 <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
33632 <para>And click the 'New basket' button to the right of the vendor name.<tip>
33633 <para>You can also add to an existing basket by clicking the 'Add to basket' link to the
33634 far right of each basket's information in the results table. </para>
33636 <para>After clicking 'New basket' you will be asked to enter some information about the
33640 <screeninfo>Add Basket Form</screeninfo>
33644 <imagedata fileref="images/acquisitions/addbasket.png"/>
33651 <para>When adding a basket you want to give it a name that will
33652 help you identify it later</para>
33656 <para>Enter in the Billing Place and Delivery Place (this will
33657 default the library you're logged in at)</para>
33661 <para>If you would like to change the vendor you're ordering from
33662 you can use the Vendor pull down menu</para>
33666 <para>The notes fields are optional and can contain any type of
33671 <para>If you have <link linkend="addvendorcontract">added
33672 contracts</link> to the vendor you're ordering from, you will also
33673 have an option to choose which contract you're ordering these items
33677 <screeninfo>Basket with contract options</screeninfo>
33681 <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
33686 <para>When finished, click 'Save'</para>
33689 <screeninfo>New Empty Basket</screeninfo>
33693 <imagedata fileref="images/acquisitions/basket.png"/>
33698 <para>Once your basket is created you are presented with several
33699 options for adding items to the order.</para>
33703 <para>If you are ordering another copy of an existing item, you
33704 can simply search for the record in your system.</para>
33707 <screeninfo>Search for existing records</screeninfo>
33711 <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
33718 <para>From the results, simply click 'Order' to be brought to
33719 the order form.</para>
33722 <screeninfo>Order form</screeninfo>
33726 <imagedata fileref="images/acquisitions/existingitemorder.png"/>
33733 <para>All of the details associated with the item will
33734 already be listed under 'Catalog details.'</para>
33741 <listitem id="orderfromsuggestion">
33742 <para>If you allow patrons to make purchase suggestions (learn more in the <link linkend="managesuggest">Managing Suggestions</link> section of this manual), then
33743 you can place orders from those suggestions. In order to keep track of suggestions
33744 that have been ordered and received you must place the order using this link. </para>
33746 <screeninfo>Approved Suggestions to Order From</screeninfo>
33749 <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
33755 <para>From the results, click 'Order' next to the item you want to order and you
33756 will be presented with the order form including a link to the suggestion</para>
33758 <screeninfo>Order from a Suggestion</screeninfo>
33761 <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
33767 <para>From this form you can make changes to the Catalog Details if
33771 <para>When the item appears in your basket it will include a link to the
33774 <screeninfo>Suggestion Link in basket</screeninfo>
33777 <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
33785 <para>Orders added to the basket in this way will notify the patron via email that
33786 their suggestion has been ordered and will update the patron's '<link linkend="opacmysuggestions">My purchase suggestions</link>' page in the
33791 <listitem id="ordersubscription">
33792 <para>If you're using the <link linkend="serials">Serials</link> module you can link
33793 your subscription order information to acquisitions by choosing to order 'From a susbscription'<itemizedlist>
33795 <para>After clicking the order link you will be brought to a search page that will
33796 help you find your subscription</para>
33798 <screeninfo>Subscription order search</screeninfo>
33801 <imagedata fileref="images/acquisitions/subordersearch.png"/>
33807 <para>Your results will appear to the right of the form and each subscription will
33808 have an 'Order' link to the right</para>
33810 <screeninfo>Subscription results</screeninfo>
33813 <imagedata fileref="images/acquisitions/suborderresults.png"/>
33819 <para>Clicking 'Order' will bring the subscription info in to the order form
33820 without an 'Add item' section since you are just ordering a subscription and an
33821 item isn't needed</para>
33823 <screeninfo>Order from subscription</screeninfo>
33826 <imagedata fileref="images/acquisitions/suborder.png"/>
33831 </itemizedlist></para>
33835 <para>To order from a record that can't be found anywhere else,
33836 choose the 'From a new (empty) record.'</para>
33839 <screeninfo>Order a new record</screeninfo>
33843 <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
33850 <para>You will be presented with an empty form to fill in all
33851 of the necessary details about the item you are
33858 <para>If you want to search other libraries for an item to
33859 purchase, you can use the 'From an external source' option that
33860 will allow you to order from a MARC record found via a Z39.50
33864 <screeninfo>Search for record to add</screeninfo>
33868 <imagedata fileref="images/acquisitions/orderz39.png"/>
33875 <para>From the results, click the Order link next to the item
33876 you want to purchase.</para>
33879 <screeninfo>Search Results to Order From</screeninfo>
33883 <imagedata fileref="images/acquisitions/orderz39results.png"/>
33890 <para>If the item you're ordering from an external source
33891 looks like it might be a duplicate, Koha will warn you and
33892 give you options on how to proceed.</para>
33895 <screeninfo>Duplicate order warning</screeninfo>
33899 <imagedata fileref="images/acquisitions/dupwarning.png"/>
33906 <para>From the warning, you can choose to order another
33907 copy on the existing bib record, create a new bib record,
33908 or cancel your order of this item.</para>
33914 <para>In the order form that pops up, you will not be able to
33915 edit the catalog details.</para>
33918 <screeninfo>New order from Z39.50 Search</screeninfo>
33922 <imagedata fileref="images/acquisitions/orderz39form.png"/>
33930 <listitem id="orderfromstagedfile">
33931 <para>The next option for ordering is to order from a staged record (<link
33932 linkend="stagemarc">learn more about staging records</link>).</para>
33934 <screeninfo>Staged Files to Order From</screeninfo>
33937 <imagedata fileref="images/acquisitions/stagedfiles.png"/>
33943 <para>From the list of files you are presented with, choose the 'Add orders' link to
33944 add the records in the staged file to your order. <screenshot>
33945 <screeninfo>Staged records</screeninfo>
33948 <imagedata fileref="images/acquisitions/importallstaged.png"/>
33951 </screenshot></para>
33954 <para>Next to each title is a checkbox, check the items you would like to order, or
33955 choose 'Check all' at the top. Depending on your settings in the <link
33956 linkend="MarcFieldsToOrder">MarcFieldsToOrder</link> preference Koha will
33957 populate the next screen with with the relevant Quantity, Price, Fund, Statistic
33958 1, and Statistic 2 found within the staged file.<screenshot>
33959 <screeninfo>Add orders from staged file</screeninfo>
33962 <imagedata fileref="images/acquisitions/selecttoimport.png"/>
33965 </screenshot></para>
33968 <para>In the 'Item Information' tab you can enter information that will be added to
33969 every ordered item such as item type, collection code and not for loan status.<screenshot>
33970 <screeninfo>Item information</screeninfo>
33973 <imagedata fileref="images/acquisitions/itemfromstaged.png"/>
33976 </screenshot></para>
33979 <para>If no information is imported from the MARC record regarding fund information
33980 the 'Default accounting details' tab can be used to apply values related to the accounting.<screenshot>
33981 <screeninfo>Accounting details</screeninfo>
33984 <imagedata fileref="images/acquisitions/stagedaccounting.png"/>
33987 </screenshot></para>
33992 <para>The final option for ordering is to order from a list of titles with the highest
33993 hold ratios<itemizedlist>
33995 <para>This option will take you to the Holds Ratio report where you can find items
33996 with a high hold ratio and order additional copies. Next to each title will be
33997 a link with the number of items to order, click that and it will add the item to
33998 your basket.<screenshot>
33999 <screeninfo>Holds Ratio Order</screeninfo>
34002 <imagedata fileref="images/acquisitions/highestholdratio.png"/>
34005 </screenshot></para>
34007 </itemizedlist></para>
34011 <para>After bringing in the bib information (for all import methods except for the staged
34012 file), if your <link linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
34013 to add an item when ordering you will enter the item info next. You need to fill out at
34014 least one item record and then click the 'Add' button at the bottom left of the item
34018 <screeninfo>Item order</screeninfo>
34022 <imagedata fileref="images/acquisitions/itemonorder.png"/>
34027 <para>After clicking the 'Add item' button below the item record the item will appear above
34028 the form and then you can enter your next item the same way (if ordering more than one
34032 <screeninfo>Item ordered</screeninfo>
34036 <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
34041 <para>Once you have entered the info about the item, you need to enter
34042 the Accounting information.</para>
34045 <screeninfo>Accounting Details</screeninfo>
34049 <imagedata fileref="images/acquisitions/accounting.png"/>
34056 <para>Quantity is populated by the number of items you've added to the order above.<itemizedlist>
34059 <para>You cannot edit the quantity manually, you must click 'Add' below the item
34060 form to add as many items as you're ordering.</para>
34063 </itemizedlist></para>
34067 <para>The list of funds is populated by the <link linkend="funds">funds</link> you have assigned in the Acquisitions
34068 Administration area.</para>
34072 <para>The currency pull down will have the <link linkend="currexchangeadmin">currencies</link> you set up in the
34073 <link linkend="acqadmin">Acquisitions Administration</link>
34078 <para>The vendor price is the price before any taxes or discounts
34079 are applied.</para>
34083 <para>If the price is uncertain, check the uncertain price
34088 <para>A basket with at least one uncertain price can't be
34095 <para>If you are charged sales tax, choose that from the gstrate
34100 <para>Enter the percentage discount you're receiving on this
34101 order, once you enter this, hit tab and Koha will populate the
34102 rest of the cost fields below.</para>
34106 <para>If you added Planning Values when <link linkend="addbudgetfund">creating the Fund</link>, those values
34107 will appear in the two Planning Value fields.</para>
34110 <para>Once you have filled in all of the fields click 'Save' to add the item to your basket.
34111 If your price goes over the amount availalbe in the fund you will be presented with a
34112 confirmation.</para>
34114 <screeninfo>Fund warning</screeninfo>
34117 <imagedata fileref="images/acquisitions/fundconfirmation.png"/>
34121 <para>The confirmation warning will allow you order past your fund amount if you so
34124 <para>After an item is added to the basket you will be presented with a basket
34128 <screeninfo>Basket with item info</screeninfo>
34132 <imagedata fileref="images/acquisitions/finalbasket.png"/>
34137 <para>If you would like to see more details you can check the 'Show
34138 all details' checkbox</para>
34141 <screeninfo>Show all details</screeninfo>
34145 <imagedata fileref="images/acquisitions/showalldetails.png"/>
34150 <para>From here, you can edit or remove the items that you have
34155 <para>Choosing to 'Delete the order' will delete the order line
34156 but leave the record in the catalog.</para>
34160 <para>Choosing to 'Delete order and catalog record' removes both
34161 the order line and the record in the catalog.</para>
34165 <para>The catalog record cannot always be deleted. You might
34166 see notes explaining why.</para>
34169 <screeninfo>Can't delete order line</screeninfo>
34173 <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
34182 <para>On the summary page, you also have the option to edit the
34183 information that you entered about the basket by clicking the 'Edit
34184 basket header information' button, to delete the basket altogether by
34185 clicking the 'Delete this basket' button, or to export your basket as
34186 a CSV file by clicking the 'Export this basket as CSV' button.</para>
34189 <screeninfo>Basket Buttons</screeninfo>
34193 <imagedata fileref="images/acquisitions/basketbuttons.png"/>
34198 <para>Once you're sure your basket is complete, you can click 'Close
34199 this basket' button to indicate that this basket is complete and has
34200 been sent to the vendor. If you have your <link linkend="BasketConfirmations">BasketConfirmations</link> preference
34201 set to show a confirmation, you will be asked if you are sure about
34202 closing the basket.</para>
34205 <screeninfo>Basket Closure Confirmation</screeninfo>
34209 <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
34214 <para>When closing the basket you can choose to add the basket to a
34215 group for easy printing and retrieval. If you check the box to 'Attach
34216 this basket to a new basket group' you will be brought to the group
34217 list where you can print a PDF of the order.</para>
34220 <screeninfo>Closed Baskets</screeninfo>
34224 <imagedata fileref="images/acquisitions/basketgroup.png"/>
34230 <para>A basket with at least one item marked as 'uncertain price'
34231 will not be able to be closed.</para>
34234 <screeninfo>A basket with items where the price is
34235 uncertain</screeninfo>
34239 <imagedata fileref="images/acquisitions/basketuncertain.png"/>
34243 </important></para>
34245 <para>Clicking the 'Uncertain Prices' button will call up a list of
34246 items with uncertain prices to quick editing. From that list, you can
34247 quickly edit the items by entering new prices and quantities.</para>
34250 <screeninfo>Uncertain Prices</screeninfo>
34254 <imagedata fileref="images/acquisitions/uncertainprices.png"/>
34260 <para>The Uncertain Prices page is independent of the basket. It is
34261 linked to the vendor so you will see all items on order with
34262 uncertain prices for that vendor.</para>
34264 <para>Once your order is entered you can search for it through acquisitions or view the
34265 information on the biblio detail page in the staff client (if the <link
34266 linkend="AcquisitionDetails">AcquisitionDetails</link> preference is set to 'Display).<screenshot>
34267 <screeninfo>Acquisitions details</screeninfo>
34270 <imagedata fileref="images/acquisitions/AcquisitionDetails.png"/>
34273 </screenshot></para>
34276 <section id="acqbasketgroup">
34277 <title>Create a basket group</title>
34279 <para>A basket group is simply a group of baskets. In some libraries,
34280 you have several staff members that create baskets, and, at the end of
34281 a period of time, someone then groups them together to send to the
34282 vendor in bulk. That said, it is possible to have one basket in a
34283 basket group if that's the workflow used in your library.</para>
34286 <section id="printacqbasket">
34287 <title>Printing baskets</title>
34289 <para>When you are finished adding items to your basket, click 'Close
34290 this Basket.'</para>
34293 <screeninfo>Close Basket</screeninfo>
34297 <imagedata fileref="images/acquisitions/closebasket.png"/>
34302 <para>You will be asked if you want to 'Attach this basket to a new basket group with the
34303 same name'. A basket group is necessary if you want to be able to print PDFs of your
34307 <screeninfo>Create Purchase Order</screeninfo>
34311 <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
34316 <para>Your completed order will be listed on the Basket Grouping page
34317 for printing or further modification.</para>
34320 <screeninfo>Basket Grouping</screeninfo>
34324 <imagedata fileref="images/acquisitions/basketgroup.png"/>
34329 <para>Clicking the 'Print' button next to your order will generate a PDF for printing, which
34330 will have all of your library information followed by the items in your order.</para>
34333 <screeninfo>Order found on PDF</screeninfo>
34337 <imagedata fileref="images/acquisitions/pdforder.png"/>
34344 <section id="receiveacqorder">
34345 <title>Receiving Orders</title>
34347 <para>Orders can be received from the vendor information page</para>
34350 <screeninfo>Receive from Vendor Information</screeninfo>
34354 <imagedata fileref="images/acquisitions/receivebutton.png"/>
34359 <para>or the vendor search results page</para>
34362 <screeninfo>Vendor Search Results</screeninfo>
34366 <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
34371 <para>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a
34372 shipment received date, a shipping cost and a budget to subtract that shipping amount
34376 <screeninfo>Receive Shipment</screeninfo>
34380 <imagedata fileref="images/acquisitions/receive.png"/>
34385 <para>The receive page will list all items still on order with the
34386 vendor regardless of the basket the item is from.</para>
34389 <screeninfo>Receipt Summary</screeninfo>
34393 <imagedata fileref="images/acquisitions/receiptsummary.png"/>
34398 <para>To receive a specific item, click the 'Receive' link to the right
34399 of the item.</para>
34402 <screeninfo>Receive Item Form</screeninfo>
34406 <imagedata fileref="images/acquisitions/receiveitem.png"/>
34411 <para>From this form you can alter the cost information. You can also
34412 choose to mark only part of the order as received if the vendor didn't
34413 send your entire order by checking only the boxes next to the items on
34414 the left that you want to receive. The values you enter in the
34415 'Replacement cost' and 'Actual cost' will automatically populate the
34416 item record by filling in subfield v (Cost, replacement price) and
34417 subfield g (Cost, normal purchase price) on the item record after
34421 <screeninfo>Item record after receipt</screeninfo>
34425 <imagedata fileref="images/acquisitions/receiveditem.png"/>
34430 <para>You can also make edits to the item record from this form by clicking the 'Edit' link
34431 next to each item. This will allow you to enter in accurate call numbers and barcodes if
34432 you'd like to do that at the point of receipt. Once you have made any changes necessary (to
34433 the order and/or items, click 'Save' to mark the item(s) as received.<tip>
34434 <para>If you have your <link linkend="AcqItemSetSubfieldsWhenReceived"
34435 >AcqItemSetSubfieldsWhenReceived</link> preference set to add or change values on
34436 received items those changes will take place after you hit 'Save'. </para>
34440 <screeninfo>Already Received Items</screeninfo>
34444 <imagedata fileref="images/acquisitions/received.png"/>
34448 <para>If the item is no longer available from this vendor you can transfer the order to
34449 another vendor's basket by clicking the 'Transfer' link to the right of the title. This will
34450 pop up a vendor search box.</para>
34452 <screeninfo>Transfer search</screeninfo>
34455 <imagedata fileref="images/acquisitions/transfersearch.png"/>
34459 <para>From the results you can click 'Choose' to the right of the vendor you would like to
34460 reorder this item from.</para>
34462 <screeninfo>Transfer vendor</screeninfo>
34465 <imagedata fileref="images/acquisitions/transfervendor.png"/>
34469 <para>You will then be presented with the open baskets for that vendor to choose from. To move
34470 the item simply click 'Choose' to the right of the basket you would like to add the item
34473 <screeninfo>Basket choice</screeninfo>
34476 <imagedata fileref="images/acquisitions/transferbasket.png"/>
34480 <para>Once you have chosen you will be presented with a confirmation message.</para>
34482 <screeninfo>Confirm transfer</screeninfo>
34485 <imagedata fileref="images/acquisitions/transferconfirm.png"/>
34490 <para>When you're finished receiving items you can navigate away from
34491 this page or click the 'Finish receiving' button at the bottom of the
34494 <para>You will also see that the item is received and/or cancelled if
34495 you view the basket.</para>
34498 <screeninfo>One item marked (rcvd) in basket</screeninfo>
34502 <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
34507 <section id="acqinvoices">
34508 <title>Invoices</title>
34509 <para>When orders are received invoices are generated. Invoices can be searched by clicking
34510 on 'Invoices' in the left of the Acquisitions page.</para>
34512 <screeninfo>Invoices page</screeninfo>
34515 <imagedata fileref="images/acquisitions/invoicesearch.png"/>
34519 <para>After searching, your results will appear to the right of the search options.</para>
34521 <screeninfo>Invoice search results</screeninfo>
34524 <imagedata fileref="images/acquisitions/invoices.png"/>
34528 <para>From the results you can click the 'Details' link to see the full invoice or 'Close' to
34529 note that the invoice is closed/paid for.</para>
34531 <screeninfo>Invoice details</screeninfo>
34534 <imagedata fileref="images/acquisitions/invoice.png"/>
34538 <para>From the results you can also merge together two invoices should you need to. Simply
34539 click the checkbox to the left of the invoices you would like to merge and click the 'Merge
34540 selected invoices' button at the bottom of the page. You will be presented with a
34541 confirmation screen:</para>
34543 <screeninfo>Merge invoices</screeninfo>
34546 <imagedata fileref="images/acquisitions/mergeinvoices.png"/>
34550 <para>Click on the row of the invoice number you would like to keep and it will be highlighted
34551 in yellow. Enter any different billing information in the fields provided and click
34552 'Merge'. The two invoices will become one.</para>
34555 <section id="acqclaims">
34556 <title>Claims & Late Orders</title>
34558 <para>If you have entered in an email address for the vendors in your
34559 system you can send them claim emails when an order is late. Before you
34560 can send claims you will need to set up an <link linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
34562 <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
34563 page you will be presented with a series of filter options on the left
34564 hand side. These filters will be applied only closed baskets.</para>
34567 <screeninfo>Acquisitions Late Order Filters</screeninfo>
34571 <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
34577 <para>The vendor pull down only shows vendors with closed baskets that
34581 <para>Once you filter your orders to show you the things you consider to
34582 be late you will be presented with a list of these items.</para>
34585 <screeninfo>Late Orders</screeninfo>
34589 <imagedata fileref="images/acquisitions/lateorders.png"/>
34594 <para>To the right of each late title you will be see a checkbox. Check
34595 off the ones you want a claim letter sent to and click 'Claim Order' at
34596 the bottom right of the list. This will automatically send an email to
34597 the vendor at the email address you have on file.<note>
34598 <para>The Estimated Delivery Date is based on the Delivery time
34599 value entered on the vendor record.</para>
34602 <para>If you would rather use a different acquisition claim letter
34603 (other than the default) you can <link linkend="addnotices">create that
34604 in the notices module</link> and choose it from the menu above the list
34605 of late items.</para>
34608 <screeninfo>Choose a Claim Letter</screeninfo>
34612 <imagedata fileref="images/acquisitions/claimletter.png"/>
34618 <section id="acqsearch">
34619 <title>Acquisition Searches</title>
34621 <para>At the top of the various Acquisition pages there is a quick
34622 search box where you can perform either a Vendor Search or an Order
34626 <screeninfo>Acquisition Searches</screeninfo>
34630 <imagedata fileref="images/acquisitions/acqsearches.png"/>
34635 <para>In the Vendor Search you can enter any part of the vendor name to
34636 get results.</para>
34639 <screeninfo>Vendor Search Results</screeninfo>
34643 <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
34648 <para>Using the Orders Search you can search for items that have been
34649 ordered with or without the vendor.</para>
34652 <screeninfo>Order Search Box</screeninfo>
34656 <imagedata fileref="images/acquisitions/ordersearch.png"/>
34661 <para>You can enter info in one or both fields and you can enter any
34662 part of the title and/or vendor name.</para>
34665 <screeninfo>Order Search Results</screeninfo>
34669 <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
34674 <para>Clicking the plus sign to the right of the Vendor search box will
34675 expand the search and allow you to search for additional fields.</para>
34678 <screeninfo>Expanded Orders Search</screeninfo>
34682 <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
34687 <para>Clicking Advanced Search to the right of the search button will
34688 give you all of the order search options available.</para>
34691 <screeninfo>Full Order Search</screeninfo>
34695 <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
34701 <section id="fundtracking">
34702 <title>Budget/Fund Tracking</title>
34704 <para>On the main acquisitions page there will be a table showing you all of your active funds
34705 and a breakdown of what has been ordered or spent against them.</para>
34708 <screeninfo>Fund Table</screeninfo>
34712 <imagedata fileref="images/acquisitions/acqfunds.png"/>
34717 <para>Clicking on the linked amounts under spent or ordered will show you a summary of the
34718 titles ordered/received on that budget.</para>
34721 <screeninfo>Titles Spent</screeninfo>
34725 <imagedata fileref="images/acquisitions/spent.png"/>
34732 <chapter id="stafflists">
34733 <title>Lists & Cart</title>
34735 <para>Lists are a way to save a collection of content on a specific topic
34736 or for a specific purpose. The Cart is a session specific storage
34741 <para><emphasis>Get there:</emphasis> More > Lists</para>
34745 <section id="lists">
34746 <title>Lists</title>
34750 <section id="createlist">
34751 <title>Create a List</title>
34753 <para>A list can be created by visiting the Lists page and clicking
34757 <screeninfo>New List Button</screeninfo>
34761 <imagedata fileref="images/lists/newlistbutton.png"/>
34766 <para>The new list form offers several options for creating your
34770 <screeninfo>New List Form</screeninfo>
34774 <imagedata fileref="images/lists/newlistform.png"/>
34781 <para>The name is what will appear on the list of Lists</para>
34785 <para>You can also choose how to sort the list</para>
34788 <para>Next decide if your list is going to be private or public</para>
34791 <para>A Private List is managed by you and can be seen only by you (depending on
34792 your permissions settings below)</para>
34795 <para>A Public List can be seen by everybody, but managed only by you (depending on
34796 your permissions settings below)</para>
34801 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
34803 <para>anyone else to add entries</para>
34806 <para>anyone to remove his own contributed entries<itemizedlist>
34809 <para>The owner of a list is always allowed to add entries, but needs
34810 permission to remove.</para>
34813 </itemizedlist></para>
34816 <para>anyone to remove other contributed entries </para>
34818 </itemizedlist></para>
34822 <para>A list can also be created from the catalog search
34826 <screeninfo>New list from catalog search</screeninfo>
34830 <imagedata fileref="images/lists/newlistsearch.png"/>
34837 <para>Check the box to the left of the titles you want to add to
34838 the new list</para>
34842 <para>Choose [New List] from the 'Add to:' pull down menu</para>
34845 <screeninfo>New List from Search Results</screeninfo>
34849 <imagedata fileref="images/lists/newlistfromsearch.png"/>
34856 <para>Name the list and choose what type of list this
34861 <para>A Private List is managed by you and can be seen
34866 <para>A Public List can be seen by everybody, but managed
34875 <para>Once the list is saved it will accessible from the Lists page
34876 and from the 'Add to' menu at the top of the search results.</para>
34879 <section id="addtolist">
34880 <title>Add to a List</title>
34882 <para>To add titles to an existing list click on the list name from
34883 the page of lists</para>
34886 <screeninfo>List of Lists</screeninfo>
34890 <imagedata fileref="images/lists/listslist.png"/>
34895 <para>From the List page you can add titles by scanning barcodes into
34896 the box at the bottom of the page</para>
34899 <screeninfo>Content of a List</screeninfo>
34903 <imagedata fileref="images/lists/listcontents.png"/>
34908 <para>A title can also be added to a list by selecting titles on the
34909 search results page and choosing the list from the 'Add to'
34913 <screeninfo>Add to List</screeninfo>
34917 <imagedata fileref="images/lists/addtolist.png"/>
34923 <section id="viewlist">
34924 <title>Viewing Lists</title>
34926 <para>To see the contents of a list, visit the Lists page on the staff
34930 <screeninfo>List of Lists</screeninfo>
34934 <imagedata fileref="images/lists/listslist.png"/>
34939 <para>Clicking on the 'List Name' will show the contents of the
34943 <screeninfo>Content of a List</screeninfo>
34947 <imagedata fileref="images/lists/listcontents.png"/>
34951 <para>From this list of items you can perform several actions</para>
34954 <para>'New list' will allow you to create another list</para>
34957 <para>'Edit' will allow you to edit the description and permissions for this list</para>
34960 <para>'Send list' will send the list to the email address you enter (<link
34961 linkend="examplelistemail">view sample List email</link>)</para>
34964 <para>'Download list' will allow you to download the cart using one of 3 default formats
34965 or your <link linkend="csvprofiles">CSV Profiles</link></para>
34968 <para>'Print list' will present you with a printable version of the list</para>
34973 <section id="mergebibrecs">
34974 <title>Merging Bibliographic Records Via Lists</title>
34976 <para>The easiest way to merge together duplicate bibliographic
34977 records is to add them to a list and use the Merge Tool from
34981 <screeninfo>List of Duplicate Records</screeninfo>
34985 <imagedata fileref="images/lists/listofdups.png"/>
34990 <para>From the list, check the two items you want to merge. If you
34991 choose more than or fewer than 2, you will be presented with an
34995 <screeninfo>Merge Items Error</screeninfo>
34999 <imagedata fileref="images/lists/merge2rec.png"/>
35004 <para>Once you have selected the records you want to merge, click the 'Merge selected'
35005 button at the top of the list. You will be asked which of the two records you would like
35006 to keep as your primary record and which will be deleted after the merge. If the records
35007 were created using different frameworks, Koha will also ask you what Framework you would
35008 like the newly merged record to use.</para>
35011 <screeninfo>Choose Primary Record for Merge</screeninfo>
35015 <imagedata fileref="images/lists/mergeprimary.png"/>
35020 <para>You will be presented with the MARC for both of the records
35021 (each accessible by tabs labeled with the bib numbers for those
35022 records). By default the entire first record will be selected, uncheck
35023 the fields you don't want in the final (destination) record and then
35024 move on to the second tab to choose which fields should be in the
35025 final (destination) record.</para>
35028 <screeninfo>Merging Records</screeninfo>
35032 <imagedata fileref="images/lists/mergerecs.png"/>
35037 <para>Should you try to add a field that is not repeatable two times
35038 (like choosing the 245 field from both record #1 and #2) you will be
35039 presented with an error</para>
35042 <screeninfo>Non-repeatable Error</screeninfo>
35046 <imagedata fileref="images/lists/nondupfield.png"/>
35051 <para>Once you have completed your selections click the 'merge'
35052 button. The primary record will now CONTAIN the data you chose for it
35053 as well as all of the items/holdings from both bib records, and the
35054 second record will be deleted.<important>
35055 <para>It is important to rebuild your zebra index immediately
35056 after merging records. If a search is performed for a record which
35057 has been deleted Koha will present the patrons with an error in
35059 </important></para>
35063 <section id="cart">
35064 <title>Cart</title>
35066 <para>The cart is a temporary holding place for items in the OPAC and/or
35067 staff client. The cart will be emptied once the session is ended (by
35068 closing the browser or logging out). The cart is best used for
35069 performing batch operations (holds, printing, emailing) or for getting a
35070 list of items to be printed or emailed to yourself or a patron.</para>
35072 <para>If you would like to enable the cart in the staff client, you need
35073 to set the <link linkend="intranetbookbag">intranetbookbag</link> system
35074 preference to 'Show.' To add things to the cart, search the catalog and
35075 select the items you would like added to your cart and choose 'Cart'
35076 from the 'Add to' menu</para>
35079 <screeninfo>Add to Cart</screeninfo>
35083 <imagedata fileref="images/lists/addtocart.png"/>
35088 <para>A confirmation will appear below the cart button at the top of the
35089 staff client</para>
35092 <screeninfo>Items added to Cart</screeninfo>
35096 <imagedata fileref="images/lists/itemsaddedcart.png"/>
35101 <para>Clicking on the Cart icon will provide you with the contents of
35105 <screeninfo>Cart Contents</screeninfo>
35109 <imagedata fileref="images/lists/cart.png"/>
35113 <para>From this list of items you can perform several actions</para>
35117 <para>'More details' will show more information about the items in the cart</para>
35121 <para>'Send' will send the list to the email address you enter (<link
35122 linkend="examplecartemail">view sample Cart email</link>)</para>
35126 <para>'Download' will allow you to download the cart using one of 3
35127 default formats or your <link linkend="csvprofiles">CSV
35128 Profiles</link></para>
35132 <para>'Print' will present you with a printable version of the
35137 <para>'Empty and Close' will empty the list and close the
35142 <para>'Hide Window' will close the window</para>
35148 <chapter id="reports">
35149 <title>Reports</title>
35151 <para>Reports in Koha are a way to gather data. Reports are used to
35152 generate statistics, member lists, shelving lists, or any list of data in
35153 your database.</para>
35157 <para><emphasis>Get there:</emphasis> More > Reports</para>
35161 <section id="customreports">
35162 <title>Custom Reports</title>
35164 <para>Koha's data is stored in a MySQL database which means that
35165 librarians can generate nearly any report they would like by either
35166 using the <link linkend="quidedreportwizard">Guided Reports
35167 Wizard</link> or writing their own <link linkend="reportfromsql">SQL
35168 query</link>.</para>
35170 <section id="customreport">
35171 <title>Add Custom Report</title>
35175 <section id="quidedreportwizard">
35176 <title>Guided Report Wizard</title>
35178 <para>The guided report wizard will walk you through a six step
35179 process to generate a report.</para>
35181 <para>Step 1: Choose the module you want to report on. This will
35182 determine what tables and fields are available for you to
35185 <para>'Report is public' should be left to the default of 'No' in
35186 most cases. A report can be made public if you intend to allow
35187 access to it through the JSON webservice interface. This is a system
35188 that can be used by developers to make custom presentations of the
35189 data from the report, for example displaying it using a graphing
35190 API. To learn more speak to your local developer.</para>
35194 <para>A public report is accessible via a URL that looks like
35195 this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
35200 <screeninfo>Chose Module for Report</screeninfo>
35204 <imagedata fileref="images/reports/report1.png"/>
35209 <para>If your system administrator has set up memcache on your server you might see one
35210 more option for the Cache expiry. This is related to your public reports. If you make
35211 the report public then it's constantly running and will cause a large load on your
35212 system. Setting this value prevents that.<screenshot>
35213 <screeninfo>Cache expiry</screeninfo>
35216 <imagedata fileref="images/reports/cacheexiprywizard.png"/>
35219 </screenshot></para>
35221 <para>Step 2: Choose a report type. For now, Tabular is the only option available.</para>
35224 <screeninfo>Report Type</screeninfo>
35228 <imagedata fileref="images/reports/report2.png"/>
35233 <para>Step 3: Choose the fields you want in your report. You can
35234 select multiple fields and add them all at once by using CTRL+Click
35235 on each item you want to add before clicking the Add button.</para>
35238 <screeninfo>Select database fields to query</screeninfo>
35242 <imagedata fileref="images/reports/report3.png"/>
35247 <para>Step 4: Choose any limits you might want to apply to your
35248 report (such as item types or branches). If you don't want to apply
35249 any limits, simply click Next instead of making an option.</para>
35252 <screeninfo>Choose limits</screeninfo>
35256 <imagedata fileref="images/reports/report4.png"/>
35261 <para>Step 5: Perform math functions. If you don't want to do any
35262 calculations, simply click Next instead of making an option.</para>
35265 <screeninfo>Choose math functions</screeninfo>
35269 <imagedata fileref="images/reports/report5.png"/>
35274 <para>Step 6: Choose data order. If you want the data to print out
35275 in the order it's found in the database, simply click Finish.</para>
35278 <screeninfo>Choose ordering</screeninfo>
35282 <imagedata fileref="images/reports/report6.png"/>
35287 <para>When you are finished you will be presented with the SQL
35288 generated by the report wizard. From here you can choose to save the
35289 report by clicking 'Save' or copy the SQL and make edits to it by
35293 <screeninfo>Custom Report Confirmation</screeninfo>
35297 <imagedata fileref="images/reports/reportconfirm.png"/>
35302 <para>If you choose to save the report you will be asked to name your report, sort it in
35303 to groups and subgroups and enter any notes regarding it.</para>
35306 <screeninfo>Save custom report</screeninfo>
35310 <imagedata fileref="images/reports/reportsave.png"/>
35315 <para>Once your report is saved it will appear on the 'Use Saved'
35316 page with all other saved reports.</para>
35319 <screeninfo>Saved Reports list</screeninfo>
35323 <imagedata fileref="images/reports/savedreports.png"/>
35328 <para>From here you can make edits, run the report, or schedule a time to have the report
35329 run. To find the report you created you can sort by any of the columns by clicking the
35330 on the column header (creation date is the best bet for finding the report you just
35331 added). You can also filter your results using the filter menu on the left or use the
35332 tabs to find reports based on your custom groups.</para>
35335 <section id="reportfromsql">
35336 <title>Report from SQL</title>
35338 <para>In addition to the report wizard, you have the option to write
35339 your own queries using SQL. To find reports written by other Koha
35340 users, visit the Koha Wiki: <ulink url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink>.
35341 You can also find your database structure in
35342 /installer/data/mysql/kohastructure.sql or online at: <ulink url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
35344 <para>To add your query, click the link to 'Create from SQL' on the main reports module or
35345 the 'New report' button at the top of the 'Saved reports' page.</para>
35348 <screeninfo>New SQL Report</screeninfo>
35352 <imagedata fileref="images/reports/newsql.png"/>
35357 <para>Fill in the form presented</para>
35360 <screeninfo>Create Report from SQL</screeninfo>
35364 <imagedata fileref="images/reports/reportfromsql.png"/>
35371 <para>The 'Name' is what will appear on the Saved Reports page
35372 to help you identify the report later. It will also be
35373 searchable using the filters found the left of the Saved Reports
35378 <para>You can use the 'Report group' to organize your reports so that you can easily
35379 filter reports by groups. Report groups are set in the <link linkend="reportgroup">REPORT_GROUP</link> authorized value category or can be added on the fly when
35380 creating the report by choosing the 'or create' radio button.<screenshot>
35381 <screeninfo>Report group</screeninfo>
35384 <imagedata fileref="images/reports/reportgroup.png"/>
35387 </screenshot><itemizedlist>
35391 <para>If you're adding a report group on the fly, remember that you code
35392 should be fewer than 10 characters and should not include special
35393 characters or spaces.</para>
35397 </itemizedlist></para>
35401 <para>You can use 'Report subgroup' to further organize your reports so that you can
35402 easily filter reports by groups and subgroups. Report subgroups are set in the <link linkend="reportsubgroup">REPORT_SUBGROUP</link> authorized value category or can
35403 be added on the fly when creating the report by choosing the 'or create' radio
35406 <screeninfo>Report subgroup</screeninfo>
35409 <imagedata fileref="images/reports/reportsubgroup.png"/>
35417 <para>If you're adding a report subgroup on the fly, remember that you code
35418 should be fewer than 10 characters and should not include special characters
35426 <listitem id="publicreport">
35427 <para>'Report is public' should be left to the default of 'No' in most cases. A report
35428 can be made public if you intend to allow access to it through the JSON webservice
35429 interface. This is a system that can be used by developers to make custom
35430 presentations of the data from the report, for example displaying it using a
35431 graphing API. To learn more speak to your local developer.</para>
35434 <para>A public report is accessible via a URL that looks like this:
35435 http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
35441 <para>'Notes' will also appear on the Saved Reports page, this
35442 can be used to provide more details about the report or tips on
35443 how to enter values when it runs</para>
35447 <para>The type should always be 'Tabular' at this time since the
35448 other formats have not been implemented</para>
35452 <para>In the 'SQL' box you will type or paste the SQL for the
35457 <para>If you feel that your report might be too resource
35458 intensive you might want to consider using runtime parameters to
35459 your query. Runtime parameters basically make a filter appear
35460 before the report is run to save your system resources.</para>
35462 <para>There is a specific syntax that Koha will understand as
35463 'ask for values when running the report'. The syntax is
35464 <<Question to ask|authorized_value>>.</para>
35468 <para>The << and >> are just delimiters. You
35469 must put << at the beginning and >> at the end
35470 of your parameter</para>
35474 <para>The 'Question to ask' will be displayed on the left of
35475 the string to enter.</para>
35479 <para>The authorized_value can be omitted if not applicable.
35480 If it contains an authorized value category, or branches or
35481 itemtype or categorycode, a list with the Koha authorized
35482 values will be displayed instead of a free field Note that
35483 you can have more than one parameter in a given SQL Note
35484 that entering nothing at run time won't probably work as you
35485 expect. It will be considered as "value empty" not as
35486 "ignore this parameter". For example entering nothing for :
35487 "title=<<Enter title>>" will display results
35488 with title='' (no title). If you want to have to have
35489 something not mandatory, use "title like <<Enter
35490 title>>" and enter a % at run time instead of
35495 <para>Examples:</para>
35499 <para>SELECT surname,firstname FROM borrowers WHERE
35500 branchcode=<<Enter patrons library|branches>>
35501 AND surname like <<Enter filter for patron surname (%
35502 if none)>></para>
35506 <para>SELECT * FROM items WHERE homebranch = <<Pick
35507 your branch|branches>> and barcode like
35508 <<Partial barcode value here>></para>
35513 <para>To generate a date picker calendar to the right of the
35514 field when running a report you can use the 'date' keyword
35515 like this: <<Enter Date|date>></para>
35518 <screeninfo>Date Picker</screeninfo>
35522 <imagedata fileref="images/reports/datepicker.png"/>
35529 <para>You have to put "%" in a text box to 'leave it blank'.
35530 Otherwise, it literally looks for "" (empty string) as the
35531 value for the field.</para>
35535 <para>In addition to using any authorized value code to
35536 generate a dropdown, you can use the following values as
35537 well: Branches (branches), Item Types (itemtypes) and Patron
35538 Categories (categorycode). For example a branch pull down
35539 would be generated like this
35540 <<Branch|branches>></para>
35543 <screeninfo>Branch pull down</screeninfo>
35547 <imagedata fileref="images/reports/branchpulldown.png"/>
35551 </important></para>
35556 <para>There is a limit of 10,000 records put on SQL statements entered in Koha. To get
35557 around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any
35558 other number above 10,000).</para>
35561 <para>If your system administrator has set up memcache on your server you might see one
35562 more option for the Cache expiry. This is related to your public reports. If you make
35563 the report public then it's constantly running and will cause a large load on your
35564 system. Setting this value prevents that.<screenshot>
35565 <screeninfo>Cache expiry</screeninfo>
35568 <imagedata fileref="images/reports/cacheexpiry.png"/>
35571 </screenshot></para>
35574 <para>Once everything is entered click the 'Save Report' button and
35575 you'll be presented with options to run it. Once a report is saved
35576 you do not have to recreate it you can simply find it on the Saved
35577 Reports page and <link linkend="runcustomreport">run</link> or <link linkend="editcustomreports">edit</link> it.</para>
35579 <section id="duplicatereport">
35580 <title>Duplicate Report</title>
35581 <para>Reports can also be added by duplicating an existing report. Visit the 'Saved
35582 reports' page to see all of the reports listed on your system already.</para>
35584 <screeninfo>Saved Reports</screeninfo>
35587 <imagedata fileref="images/reports/duplicatereport.png"/>
35591 <para>To the right of every report there is an 'Actions' pull down. Clickin that and
35592 choose 'Duplicate' to use an existing report as the basis for your new report. That will
35593 populate the new report form with the existing SQL for easy editing and resaving.</para>
35597 <section id="editcustomreports">
35598 <title>Edit Custom Reports</title>
35600 <para>Every report can be edited from the reports lists. To see the
35601 list of reports already stored in Koha, click 'Use Saved.'</para>
35604 <screeninfo>Saved Reports</screeninfo>
35608 <imagedata fileref="images/reports/savedreports.png"/>
35613 <para>To find the report you'd like to edit you can sort by any of the columns by clicking
35614 the on the column header. You can also filter your results using the filter menu on the
35615 left or use the tabs to find reports based on your custom groups.</para>
35617 <para>From this list you can edit any custom report by clicking 'Actions' to the right of
35618 the report and choosing 'Edit' from the menu that appears.</para>
35620 <screeninfo>Edit Report Option</screeninfo>
35623 <imagedata fileref="images/reports/editreportoption.png"/>
35627 <para>The form to edit the report will appear.</para>
35630 <screeninfo>Edit SQL Form</screeninfo>
35634 <imagedata fileref="images/reports/editreport.png"/>
35640 <section id="runcustomreport">
35641 <title>Running Custom Reports</title>
35643 <para>Once custom reports are saved to Koha, you can run them by going to the Saved Reports
35644 page and clicking the 'Actions' button to the right of the report and choosing
35648 <screeninfo>Run Report</screeninfo>
35652 <imagedata fileref="images/reports/runreport.png"/>
35657 <para>When you report runs you will either be asked for some
35661 <screeninfo>Enter report parameters</screeninfo>
35665 <imagedata fileref="images/reports/reportparameters.png"/>
35670 <para>or you will see the results right away</para>
35673 <screeninfo>Report results</screeninfo>
35677 <imagedata fileref="images/reports/reportresults.png"/>
35682 <para>From the results you can choose to rerun the report by clicking
35683 'Run report' at the top, edit the report by clicking the 'Edit' button
35684 or starting over and creating a new report by using the 'New' button.
35685 You can also download your results by choosing a file type at the
35686 bottom of the results next to the 'Download the report' label and
35687 clicking 'Download.'<tip>
35688 <para>A Comma Separated Text file is a CSV file and it can be
35689 opened by any spreadsheet application.</para>
35694 <section id="statsreports">
35695 <title>Statistics Reports</title>
35697 <para>Statistic reports will show you counts and sums. These reports are
35698 all about numbers and statistics, for reports that return more detailed
35699 data, use the <link linkend="quidedreportwizard">Guided Report
35700 Wizard</link>. These reports are limited in what data they can look at,
35701 so it's often recommended to use <link linkend="customreports">custom
35702 reports</link> for official end of the year statistics.</para>
35704 <section id="acqstats">
35705 <title>Acquisitions Statistics</title>
35708 <para>These reports are limited in what data they can look at, so
35709 it's often recommended to use <link linkend="customreports">custom
35710 reports</link> for official end of the year statistics.</para>
35713 <para>Using the form provided, choose which value you would like to
35714 appear in the Column and which will appear in the Row.</para>
35717 <screeninfo>Acquisitions Statistics</screeninfo>
35721 <imagedata fileref="images/reports/acqform.png"/>
35726 <para>If you choose to output to the browser your results will print
35727 to the screen.</para>
35730 <screeninfo>Acquisitions Statistics Results</screeninfo>
35734 <imagedata fileref="images/reports/acqnumbers.png"/>
35739 <para>You can also choose to export to a file that you can manipulate
35740 to your needs.</para>
35742 <para>When generating your report, note that you get to choose between
35743 counting or summing the values.</para>
35746 <screeninfo>Acquisitions Stats Options</screeninfo>
35750 <imagedata fileref="images/reports/acqtotal.png"/>
35755 <para>Choosing amount will change your results to appear as the sum of
35756 the amounts spent.</para>
35759 <screeninfo>Acquisitions statistics with totals</screeninfo>
35763 <imagedata fileref="images/reports/acqamounts.png"/>
35769 <section id="patstats">
35770 <title>Patron Statistics</title>
35773 <para>These reports are limited in what data they can look at, so
35774 it's often recommended to use <link linkend="customreports">custom
35775 reports</link> for official end of the year statistics.</para>
35778 <para>Using the form provided, choose which value you would like to
35779 appear in the Column and which will appear in the Row.</para>
35782 <screeninfo>Patron Statistics Options</screeninfo>
35786 <imagedata fileref="images/reports/patronform.png"/>
35791 <para>If you choose to output to the browser your results will print
35792 to the screen.</para>
35795 <screeninfo>Patron Statistics Results</screeninfo>
35799 <imagedata fileref="images/reports/patronresults.png"/>
35804 <para>Based on your selections, you may see some query information
35805 above your results table. You can also choose to export to a file that
35806 you can manipulate to your needs.</para>
35809 <section id="catstats">
35810 <title>Catalog Statistics</title>
35813 <para>These reports are limited in what data they can look at, so
35814 it's often recommended to use <link linkend="customreports">custom
35815 reports</link> for official end of the year statistics.</para>
35818 <para>Using the form provided, choose which value you would like to
35819 appear in the Column and which will appear in the Row.</para>
35822 <screeninfo>Catalog Statistics Form</screeninfo>
35826 <imagedata fileref="images/reports/catalogform.png"/>
35831 <para>If you choose to output to the browser your results will print
35832 to the screen.</para>
35835 <screeninfo>Catalog Statistic Results</screeninfo>
35839 <imagedata fileref="images/reports/catalogresults.png"/>
35844 <para>You can also choose to export to a file that you can manipulate
35845 to your needs.</para>
35848 <section id="circstats">
35849 <title>Circulation Statistics</title>
35852 <para>These reports are limited in what data they can look at, so
35853 it's often recommended to use <link linkend="customreports">custom
35854 reports</link> for official end of the year statistics.</para>
35857 <para>Using the form provided, choose which value you would like to
35858 appear in the Column and which will appear in the Row.</para>
35861 <screeninfo>Circulation Statistics</screeninfo>
35865 <imagedata fileref="images/reports/circform.png"/>
35870 <para>If you choose to output to the browser your results will print
35871 to the screen.</para>
35874 <screeninfo>Circulation Statistic Results</screeninfo>
35878 <imagedata fileref="images/reports/circresults.png"/>
35883 <para>You can also choose to export to a file that you can manipulate
35884 to your needs.<tip>
35885 <para>To get a complete picture of your monthly or daily
35886 circulation, you can run the report twice, once for 'Type' of
35887 'Checkout' and again for 'Renewal.'</para>
35889 <para>This report uses 'Period,' or date, filtering that allows
35890 you to limit to a month by simply selecting the first day of the
35891 first month through the first day of the next month. For example,
35892 10/1 to 11/1 to find statistics for the month of October.</para>
35896 <para>To find daily statistics, set your date
35897 range.</br> Example: "I want circulation data starting
35898 with date XXX up to, but not including, date XXX."</para>
35902 <para>For a whole month, an example range would be: 11/01/2009
35903 to 12/01/2009</para>
35907 <para>For a whole year, an example range would be: 01/01/2009
35908 to 01/01/2010</para>
35912 <para>For a single day, an example would be: 11/15/2009 to
35913 11/16/2009 to find what circulated on the 15th</para>
35918 <section id="inhouseuse">
35919 <title>Tracking in house use</title>
35921 <para>Using the Circulation statistics reporting wizard you can run
35922 reports on in house usage of items simply by choosing 'Local Use'
35923 from the 'Type' pull down:</para>
35926 <screeninfo>In House Use Stats</screeninfo>
35930 <imagedata fileref="images/reports/inhouse.png"/>
35937 <section id="serialstats">
35938 <title>Serials Statistics</title>
35941 <para>These reports are limited in what data they can look at, so
35942 it's often recommended to use <link linkend="customreports">custom
35943 reports</link> for official end of the year statistics.</para>
35946 <para>Using the form provided, choose how you would like to list the
35947 serials in your system.</para>
35950 <screeninfo>Serials Statistics</screeninfo>
35954 <imagedata fileref="images/reports/serialsform.png"/>
35959 <para>If you choose to output to the browser your results will print
35960 to the screen.</para>
35963 <screeninfo>Serials Results</screeninfo>
35967 <imagedata fileref="images/reports/serialsresults.png"/>
35972 <para>You can also choose to export to a file that you can manipulate
35973 to your needs.</para>
35976 <section id="holdstats">
35977 <title>Holds Statistics</title>
35980 <para>These reports are limited in what data they can look at, so
35981 it's often recommended to use <link linkend="customreports">custom
35982 reports</link> for official end of the year statistics.</para>
35985 <para>Using the form provided you can see statistics for holds placed,
35986 filled, cancelled and more at your library. From the form choose what
35987 value you want to display in the column and what value to show in the
35988 row. You can also choose from the filters on the far right of the
35992 <screeninfo>Hold Statistics Form</screeninfo>
35996 <imagedata fileref="images/reports/holdstatsform.png"/>
36001 <para>If you choose to output to the browser your results will print
36002 to the screen.</para>
36005 <screeninfo>Hold Stats Results</screeninfo>
36009 <imagedata fileref="images/reports/holdstatsresults.png"/>
36014 <para>You can also choose to export to a file that you can manipulate
36015 to your needs.</para>
36018 <section id="mostcheckouts">
36019 <title>Patrons with the most checkouts</title>
36021 <para>This report will simply list the patrons who have the most
36025 <screeninfo>Patrons with the most checkouts form</screeninfo>
36029 <imagedata fileref="images/reports/topcheckoutsform.png"/>
36034 <para>If you choose to output to the browser your results will print
36035 to the screen.</para>
36038 <screeninfo>Top checkouts results</screeninfo>
36042 <imagedata fileref="images/reports/topcheckoutsresult.png"/>
36047 <para>You can also choose to export to a file that you can manipulate
36048 to your needs.</para>
36051 <section id="mostcirculated">
36052 <title>Most Circulated Items</title>
36054 <para>This report will simply list the items that have the been
36055 checked out the most.</para>
36058 <screeninfo>Most Circulation Items Form</screeninfo>
36062 <imagedata fileref="images/reports/topcircform.png"/>
36067 <para>If you choose to output to the browser your results will print
36068 to the screen.</para>
36071 <screeninfo>Top Circulation Items Results</screeninfo>
36075 <imagedata fileref="images/reports/topcircresults.png"/>
36080 <para>You can also choose to export to a file that you can manipulate
36081 to your needs.</para>
36084 <section id="patnocheckouts">
36085 <title>Patrons with no checkouts</title>
36087 <para>This report will list for you the patrons in your system who
36088 haven't checked any items out.</para>
36091 <screeninfo>Patrons with no Checkouts</screeninfo>
36095 <imagedata fileref="images/reports/patnocheckout.png"/>
36100 <para>If you choose to output to the browser your results will print
36101 to the screen.</para>
36104 <screeninfo>Results for Patrons with no Checkouts</screeninfo>
36108 <imagedata fileref="images/reports/patnocheckout-results.png"/>
36113 <para>You can also choose to export to a file that you can manipulate
36114 to your needs.</para>
36117 <section id="itemnocheckouts">
36118 <title>Items with no checkouts</title>
36120 <para>This report will list items in your collection that have never
36121 been checked out.</para>
36124 <screeninfo>Items with No Checkouts</screeninfo>
36128 <imagedata fileref="images/reports/nocheckoutsform.png"/>
36133 <para>If you choose to output to the browser your results will print
36134 to the screen.</para>
36137 <screeninfo>Items with no checkouts results</screeninfo>
36141 <imagedata fileref="images/reports/nocheckoutsresults.png"/>
36146 <para>You can also choose to export to a file that you can manipulate
36147 to your needs.</para>
36150 <section id="catbyitem">
36151 <title>Catalog by Item Type</title>
36153 <para>This report will list the total number of items of each item
36154 type per branch.</para>
36157 <screeninfo>Catalog by Item Type</screeninfo>
36161 <imagedata fileref="images/reports/itemtotals.png"/>
36166 <para>If you choose to output to the browser your results will print
36167 to the screen.</para>
36170 <screeninfo>Total of Items by Type and Branch</screeninfo>
36174 <imagedata fileref="images/reports/itemtotalsresults.png"/>
36179 <para>You can also choose to export to a file that you can manipulate
36180 to your needs.</para>
36183 <section id="lostreport">
36184 <title>Lost Items</title>
36186 <para>This report will allow you to generate a list of items that have
36187 been marked as Lost within the system</para>
36190 <screeninfo>Lost Items Report</screeninfo>
36194 <imagedata fileref="images/reports/lostitems.png"/>
36200 <section id="avloantime">
36201 <title>Average Loan Time</title>
36203 <para>This report will list the average time items are out on loan
36204 based on the criteria you enter:</para>
36207 <screeninfo>Average Checkout Period Form</screeninfo>
36211 <imagedata fileref="images/reports/averloanform.png"/>
36216 <para>If you choose to output to the browser your results will print
36217 to the screen.</para>
36220 <screeninfo>Average Checkout Period Results</screeninfo>
36224 <imagedata fileref="images/reports/avercheckout.png"/>
36229 <para>You can also choose to export to a file that you can manipulate
36230 to your needs.</para>
36234 <section id="reportdic">
36235 <title>Report Dictionary</title>
36237 <para>The report dictionary is a way to pre-define common filters you'd
36238 like to apply to your reports. This is a good way to add in filters that
36239 the report wizard doesn't include by default. To add a new definition,
36240 or filter, click 'New Definition' on the Reports Dictionary page and
36241 follow the 4 step process.</para>
36243 <para>Step 1: Name the definition and provide a description if
36247 <screeninfo>Create a Definition</screeninfo>
36251 <imagedata fileref="images/reports/dict1.png"/>
36256 <para>Step 2: Choose the module that the will be queried.</para>
36259 <screeninfo>Select Koha Module</screeninfo>
36263 <imagedata fileref="images/reports/dict2.png"/>
36268 <para>Step 3: Choose columns to query from the tables presented.</para>
36271 <screeninfo>Choose columns</screeninfo>
36275 <imagedata fileref="images/reports/dict3.png"/>
36280 <para>Step 4: Choose the value(s) from the field(s). These will be
36281 automatically populated with options available in your database.</para>
36284 <screeninfo>Choose fields and values</screeninfo>
36288 <imagedata fileref="images/reports/dict4.png"/>
36293 <para>Confirm your selections to save the definition.</para>
36296 <screeninfo>Confirm Definition</screeninfo>
36300 <imagedata fileref="images/reports/dictconfirm.png"/>
36305 <para>Your definitions will all appear on the Reports Dictionary
36309 <screeninfo>Reports Dictionary Listing</screeninfo>
36313 <imagedata fileref="images/reports/dictlist.png"/>
36318 <para>Then when generating reports on the module you created the value
36319 for you will see an option to limit by the definition at the bottom of
36320 the usual filters.</para>
36323 <screeninfo>Dictionary Limit Option</screeninfo>
36327 <imagedata fileref="images/reports/dictionarylimit.png"/>
36334 <chapter id="opac">
36335 <title>OPAC</title>
36337 <para>This chapter assumes that you have the following preferences set as
36342 <para><link linkend="opacthemes">opacthemes</link> = bootstrap</para>
36345 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> = default</para>
36349 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
36354 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
36359 <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
36363 <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
36368 <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
36373 <para><link linkend="reviewson">reviewson</link> = Allow</para>
36377 <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
36381 <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
36386 <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
36391 <para><link linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
36396 <para><link linkend="XISBN">XISBN</link> = Use</para>
36400 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
36401 = Default set of links</para>
36405 <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
36406 = Don't show</para>
36410 <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
36415 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
36420 <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
36425 <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
36430 <para><link linkend="OPACShowBarcode">OPACShowBarcode</link> = Don't show</para>
36433 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldings</link> = Don't
36437 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldingsBranch</link> = home
36441 <para><link linkend="DisplayLibraryFacets">DisplayLibraryFacets</link> = holding
36446 <para>If your system preferences are set differently your displays may
36449 <section id="opacsearchresults">
36450 <title>Search Results</title>
36452 <para>To search the OPAC you can either choose to enter your search
36453 words in the box at the top of the OPAC or click on the 'Advanced
36454 Search' link to perform a more detailed search.</para>
36457 <screeninfo>OPAC Search Box</screeninfo>
36461 <imagedata fileref="images/opac/searchbox.png"/>
36466 <para>For more on searching check the '<link linkend="searching">Searching</link>' chapter in this manual.</para>
36468 <section id="opacresultsoverview">
36469 <title>Results Overview</title>
36471 <para>After performing a search the number of results found for your
36472 search will appear above the results</para>
36475 <screeninfo>Total Results</screeninfo>
36479 <imagedata fileref="images/opac/totalresults-rss.png"/>
36484 <para>By default your search results will be sorted based on your
36485 <link linkend="opacdefaultsort">OPACdefaultSortField and
36486 OPACdefaultSortOrder</link> system preference values. To change this
36487 you can choose another sorting method from the pull down on the
36491 <screeninfo>Results Sorting Options</screeninfo>
36495 <imagedata fileref="images/opac/sortingresults.png"/>
36500 <para>Under each title on your results list a series of values from your leader will appear.
36501 It is important to note that this has nothing to do with the item types or collection
36502 codes you have applied to your records, this data is all pulled from your fixed fields.
36503 This can be turned on or off with the <link linkend="DisplayOPACiconsXSLT"
36504 >DisplayOPACiconsXSLT</link> system preference.</para>
36507 <screeninfo>Leader Visualization</screeninfo>
36511 <imagedata fileref="images/opac/leader.png"/>
36516 <para>Below each title you will see the availability for the items attached to the record. <note>
36517 <para>Even if you filtered on one library location all locations that hold the item will
36518 appear on the search results.</para>
36520 <para>An item's hold status doesn't not affect whether or not the item is 'available'
36521 until the item is in 'waiting' status. Items with on-shelf holds will show as
36522 available until a librarian has pulled them from the shelf and checked the item in
36523 make it show 'waiting'.</para>
36524 </important></para>
36527 <screeninfo>Holdings Information</screeninfo>
36531 <imagedata fileref="images/opac/holdings-results.png"/>
36536 <para>If you have turned on <link linkend="enhancedcontent">Enhanced
36537 Content</link> preferences you may have book jackets on your search
36541 <screeninfo>Book Jacket on Results</screeninfo>
36545 <imagedata fileref="images/opac/coverresults.png"/>
36549 <para>If you have set your <link linkend="didyoumean">Did you mean?</link> options you will
36550 see a yellow bar across the top of your results will other related searches.</para>
36552 <screeninfo>Did you mean?</screeninfo>
36555 <imagedata fileref="images/opac/didyoumeanopac.png"/>
36561 <section id="opacfilter">
36562 <title>Filters</title>
36564 <para>To filter your results click on the links below the 'Refine Your
36565 Search' menu on the left of your screen</para>
36568 <screeninfo>Refine Your Results</screeninfo>
36572 <imagedata fileref="images/opac/refineresults.png"/>
36576 <para>Depending on your setting for the <link linkend="DisplayLibraryFacets"
36577 >DisplayLibraryFacets</link> system preference you will see filters for your home,
36578 holding or both libraries.<screenshot>
36579 <screeninfo>Library Facet</screeninfo>
36582 <imagedata fileref="images/opac/locationfacet.png"/>
36585 </screenshot></para>
36586 <para>After clicking a facet you can remove that filter from your results by clicking the
36587 small 'x' that appears to the right of the facet.<screenshot>
36588 <screeninfo>Remove library facet</screeninfo>
36591 <imagedata fileref="images/opac/removefilter.png"/>
36594 </screenshot></para>
36597 <section id="searchrss">
36598 <title>Search RSS Feeds</title>
36600 <para>You will be able to subscribe to your search results as an RSS
36601 feed by clicking the RSS icon in your address bar or next to the
36602 number of results. To learn more about what RSS feeds are check out
36603 <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
36604 video</ulink>.</para>
36607 <screeninfo>RSS Feed Icon</screeninfo>
36611 <imagedata fileref="images/opac/totalresults-rss.png"/>
36616 <para>Subscribing to search results as RSS feeds will allow you to see
36617 when a new item is added to the catalog in your area of
36622 <section id="opacbibrec">
36623 <title>Bibliographic Record</title>
36625 <para>When you click on a title from the search results, you're brought
36626 to the bibliographic detail of the record. This page is broken down in
36627 several different areas.</para>
36629 <para>At the top of your screen will be the title and the GMD:</para>
36632 <screeninfo>Title</screeninfo>
36636 <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
36641 <para>Below the title the authors will be listed. These come from your
36642 1xx and 7xx fields. Clicking the author will run a search for other
36643 titles with that author.</para>
36646 <screeninfo>Author Display</screeninfo>
36650 <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
36655 <para>If you have an authority file you will see a magnifying glass to
36656 the right of author (and other) authorities. Clicking that magnifying
36657 glass will take you directly to the authority record.</para>
36660 <screeninfo>Authority link</screeninfo>
36664 <imagedata fileref="images/opac/bibdetail/authoritylink.png"/>
36669 <para>If you have your <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
36670 set to 'show' you will see a material type that is determined by values
36671 in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
36672 Item Types</link> Appendix).</para>
36675 <screeninfo>XSLT Item Type</screeninfo>
36679 <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
36684 <para>Next you'll see the description of the record you're
36688 <screeninfo>Basic Details</screeninfo>
36692 <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
36697 <para>Following that information you'll find the subject headings which
36698 can be clicked to search for other titles on similar topics</para>
36701 <screeninfo>Bibliographic Subjects</screeninfo>
36705 <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
36710 <para>If your record has a table of contents or summary it will appear
36711 next to the 'Summary' or 'Table of Contents' label</para>
36714 <screeninfo>Summary</screeninfo>
36718 <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
36723 <para>If your record has data in the 856 fields you'll see the links to
36724 the right of the 'Online Resources' label</para>
36727 <screeninfo>Online Resources</screeninfo>
36731 <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
36736 <para>If the title you're viewing is in a public list then you'll see a
36737 list of those to the right of the 'List(s) this item appears in' label
36738 and if it has tags they will appear below the 'Tags from this library'
36742 <screeninfo>Tags</screeninfo>
36746 <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
36751 <para>In the tabs below the details you will find your holdings
36759 <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
36764 <para>Any notes (5xx fields) that have been cataloged will appear under
36765 'Title Notes'</para>
36768 <screeninfo>Title notes</screeninfo>
36772 <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
36777 <para>If you're allowing comments they will appear in the next
36781 <screeninfo>Comments</screeninfo>
36785 <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
36790 <para>And finally if you have enabled FRBR and you have other editions
36791 of the title in your collection you will see the 'Editions' tab.</para>
36794 <screeninfo>Editions</screeninfo>
36798 <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
36803 <para>To the right of the details you'll find a series of boxes. The
36804 first box is a list of buttons to help navigate the search results. From
36805 there you can see the next or previous result from your search or return
36806 to the results.</para>
36809 <screeninfo>Search Options</screeninfo>
36813 <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
36818 <para>Clicking Browse Results at the top of the right column will open
36819 up your search results on the detail page</para>
36822 <screeninfo>Search Results</screeninfo>
36826 <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
36831 <para>Below the search buttons you'll find the links to place a hold,
36832 print the record, save the record to your lists, or add it to your
36836 <screeninfo>More options</screeninfo>
36840 <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
36845 <para>Clicking 'More Searches' will show the list of libraries you
36846 entered in your <link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
36850 <screeninfo>More Searches</screeninfo>
36854 <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
36859 <para>Under the 'Save Record' label you will find a series of file
36860 formats you can save the record as. This list can be customized by
36861 altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
36862 system preference.</para>
36865 <screeninfo>Save Record</screeninfo>
36869 <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
36874 <para>If at any time you want to change the view from the 'Normal' view
36875 to see the Marc or the ISBD you can click the tabs across the top of the
36879 <screeninfo>Record Views</screeninfo>
36883 <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
36889 <section id="opaclistscart">
36890 <title>Lists & Cart</title>
36892 <para>A cart is a temporary holding place for records you're interested
36893 in finding during this session. That means that once you log out of the
36894 OPAC or close the browser you lose the items in your cart. A list is a
36895 more permanent location for saving items. To learn more about lists,
36896 check the <link linkend="stafflists">Lists in the Staff Client</link>
36897 chapter of this manual.</para>
36899 <section id="opaclists">
36900 <title>Lists</title>
36902 <para>Patrons can manage their own private lists by visiting the 'my
36903 lists' section of their account.</para>
36906 <screeninfo>Lists Management</screeninfo>
36910 <imagedata fileref="images/opac/nolists.png"/>
36915 <section id="opacaddlists">
36916 <title>Creating Lists</title>
36918 <para>Lists can also be created by choosing the 'New List' option in
36919 the 'Add to' menu on the search results</para>
36922 <screeninfo>Add to New List</screeninfo>
36926 <imagedata fileref="images/opac/addtonewlist.png"/>
36931 <para>To create a list the patron simply needs to click the 'New
36932 List' link and populate the form that appears</para>
36935 <screeninfo>Create a new list</screeninfo>
36939 <imagedata fileref="images/opac/publiclistpermissions.png"/>
36944 <para>The only field required is the 'List Name,' but the patron can also choose how they
36945 want the list sorted and if the list is public or private.<itemizedlist>
36947 <para>A Private List is managed by you and can be seen only by you (depending on
36948 your permissions settings below)</para>
36951 <para>A Public List can be seen by everybody, but managed only by you (depending on
36952 your permissions settings below)</para>
36954 </itemizedlist><important>
36955 <para>If you aren't allowing patrons to create public lists with the <link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
36956 preference then patrons will only be able to create private lists.</para>
36958 <screeninfo>Create a new private list</screeninfo>
36961 <imagedata fileref="images/opac/newlist.png"/>
36965 </important></para>
36968 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
36970 <para>anyone else to add entries</para>
36973 <para>anyone to remove his own contributed entries<itemizedlist>
36976 <para>The owner of a list is always allowed to add entries, but needs
36977 permission to remove.</para>
36980 </itemizedlist></para>
36983 <para>anyone to remove other contributed entries </para>
36985 </itemizedlist></para>
36990 <section id="opacaddtolists">
36991 <title>Adding titles to Lists</title>
36993 <para>Titles can be added to lists from the search results and/or
36994 from the bibliographic record. On the search results options to add
36995 items to the list appear below each result and across the top of the
36996 results page</para>
36999 <screeninfo>Add to Lists from Results</screeninfo>
37003 <imagedata fileref="images/opac/addtolistcart.png"/>
37008 <para>To add a single title to a list, click the 'Save to Lists'
37009 option and then choose the list you'd like to add the title to. To
37010 add multiple titles to a list check the boxes on the left of the
37011 titles you want to add and then choose the list you want to add the
37012 titles to from the 'Add too' pull down at the top of the
37016 <section id="listscontent">
37017 <title>Viewing Lists Contents</title>
37019 <para>To view the contents of a list, click on the list name under
37020 the Lists button.</para>
37023 <screeninfo>Lists</screeninfo>
37027 <imagedata fileref="images/opac/chooselist.png"/>
37032 <para>The contents of the list will look similar to your search
37033 results pages except that there will be different menu options
37034 across the top of the list.</para>
37037 <screeninfo>List View</screeninfo>
37041 <imagedata fileref="images/opac/listview.png"/>
37046 <para>Using the menu options above the list you can place multiple
37047 items on hold, download the list contents, email the list or print
37048 the list out.</para>
37052 <para>To place a hold on one or more list items check the box to
37053 the left of the item and click the 'Place Hold' link at the
37058 <para>To download the list contents click the 'Download List'
37059 link and choose the format you'd like to download the list
37065 <para>iso2079 is MARC format</para>
37072 <para>To email the list contents to someone, click the 'Send List' link and enter in
37073 your email details in the form that pops up (<link linkend="examplelistemail">view a
37074 sample Lists email</link>)</para>
37077 <screeninfo>Email List Contents</screeninfo>
37081 <imagedata fileref="images/opac/emailist.png"/>
37088 <para>To print the contents of your list out click the 'Print List' link</para>
37093 <section id="opacmanagelists">
37094 <title>Managing Lists</title>
37096 <para>Once the list is saved patrons can begin adding items to it.
37097 From the 'my lists' tab on the patron record the patron can edit and
37098 delete the lists they have created by clicking the appropriate link
37099 to the right of the list name.</para>
37102 <screeninfo>My Lists</screeninfo>
37106 <imagedata fileref="images/opac/mylists.png"/>
37111 <para>To edit the list's title or sorting patrons click the 'Edit'
37112 link to the right of the list description.</para>
37115 <screeninfo>Editing List</screeninfo>
37119 <imagedata fileref="images/opac/editlist.png"/>
37124 <para>When clicking 'Delete' next to a list you will be asked to
37125 confirm that you want to delete the list.</para>
37128 <screeninfo>Delete list confirmation</screeninfo>
37132 <imagedata fileref="images/opac/deletelist.png"/>
37137 <para>The list will not be deleted until the 'Confirm' button is
37138 clicked to the right of the list you'd like to delete.</para>
37140 <para>If the library is allowing you to share private lists with the <link
37141 linkend="OpacAllowSharingPrivateLists">OpacAllowSharingPrivateLists</link> preference
37142 then you will see the 'Share' link on your list of lists and the 'Share list' link at
37143 the top of each individual list. Clicking this will ask you to enter the email address
37144 of a patron.<screenshot>
37145 <screeninfo>Share list</screeninfo>
37148 <imagedata fileref="images/opac/sharelist.png"/>
37151 </screenshot></para>
37152 <para>Once the email address is entered Koha will present you with a confirmation message </para>
37154 <screeninfo>Share list confirmation</screeninfo>
37157 <imagedata fileref="images/opac/shareconfirmation.png"/>
37161 <para>and will send a message to that patron.</para>
37165 <section id="opaccart">
37166 <title>Cart</title>
37170 <section id="opacaddtocart">
37171 <title>Adding titles to the Cart</title>
37173 <para>Titles can be added to the cart from the search results and/or
37174 from the bibliographic record. On the search results options to add
37175 items to the cart appear below each result and across the top of the
37176 results page</para>
37179 <screeninfo>Add to Cart on Search Results</screeninfo>
37183 <imagedata fileref="images/opac/addtolistcart.png"/>
37188 <para>Clicking the 'Add to Cart' button will add the one title to
37189 your cart. To add multiple titles at once, check the box to the left
37190 of each result and then choose 'Cart' from the 'Add to' pull down at
37191 the top of the screen. Once titles are added to the cart you will be
37192 presented with a confirmation</para>
37195 <screeninfo>Items added to Cart</screeninfo>
37199 <imagedata fileref="images/opac/addedtocart.png"/>
37203 <para>From the results you will see which items are in your cart and will be able to
37204 remove those items by clicking '(remove)'.<screenshot>
37205 <screeninfo>Item in your cart</screeninfo>
37208 <imagedata fileref="images/opac/iteminyourcart.png"/>
37211 </screenshot></para>
37214 <section id="manageopaccart">
37215 <title>Managing the Cart</title>
37217 <para>Once you have titles in your cart you can manage the contents by clicking on the
37218 'Cart' button usually found at the top of the screen. Your cart will open in a new
37222 <screeninfo>Contents of your cart</screeninfo>
37226 <imagedata fileref="images/opac/cartcontents.png"/>
37231 <para>From this window you are presented with several options.
37232 Across the top of the cart are several buttons.</para>
37234 <para>First is the 'More details' button. Clicking this will show you additional
37235 information about the titles in your cart (ISBNs, Subjects, Publisher Info, Notes and more).<screenshot>
37236 <screeninfo>More details in the cart</screeninfo>
37239 <imagedata fileref="images/opac/cartmoredetails.png"/>
37242 </screenshot></para>
37244 <para>Next is the option to send the contents of your cart to an email address. This is
37245 handy if you want to send the resources you found at the library to your home email
37246 account to refer to later or to send to a patron researching a specific topic. Clicking
37247 this link will open up a new window that asks for the email address and message to send.
37248 <link linkend="examplecartemail">View a sample Cart email</link>.</para>
37251 <screeninfo>Email Cart</screeninfo>
37255 <imagedata fileref="images/opac/emailcart.png"/>
37260 <para>The cart can only be emailed by logged in users. This will prevent your cart email
37261 function from being used for spamming.</para>
37264 <para>In addition to sending your cart you can download the contents
37265 of your cart in several pre-defined formats or using a <link linkend="csvprofiles">CSV Profile</link> that you defined in the
37266 Tools module.</para>
37269 <screeninfo>Download Cart</screeninfo>
37273 <imagedata fileref="images/opac/downloadcart.png"/>
37278 <para>Finally you can print out the contents of your cart by
37279 choosing the 'Print' link.</para>
37281 <para>In addition to the various different ways to save the contents
37282 of your cart, there are ways to add value to the data in your cart.
37283 By selecting one or more titles from the cart you can add them to a
37284 list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
37285 tag them (click 'Tag'). All of these operations follow the same
37286 procedure as they do when performing them in the OPAC.</para>
37291 <section id="opacplacehold">
37292 <title>Placing Holds</title>
37294 <para>Patrons can place holds on items via the OPAC if they're logged in
37295 and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
37296 preference set to 'Allow'. If the item can be placed on hold the option
37297 to place it on hold will appear in several different places.</para>
37301 <para>When viewing a list or search results page you'll see the
37302 option to place hold on multiple items by checking the boxes to the
37303 left of the results and clicking 'Place Hold' at the top</para>
37306 <screeninfo>Place Hold from Results</screeninfo>
37310 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
37317 <para>When viewing a list or search results page you'll see the
37318 option to place the item on hold below the basic information about
37322 <screeninfo>Place Hold</screeninfo>
37326 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
37333 <para>When viewing an individual title you'll see the option to
37334 place a hold in the box on the right side of the screen</para>
37337 <screeninfo>Place Hold</screeninfo>
37341 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
37348 <para>No matter which of the above links you click to place your hold
37349 you'll be brought to the same hold screen.</para>
37352 <screeninfo>Place Hold Form</screeninfo>
37356 <imagedata fileref="images/opac/opacplacehold.png"/>
37363 <para>Check the box to the left of the items you'd like to place on
37368 <para>The title includes a link back to the detail page for the
37373 <para>The priority shows where in the holds queue this hold will
37377 <para>If allowed by your <link linkend="OPACAllowUserToChooseBranch"
37378 >OPACAllowUserToChooseBranch</link> preference the patron can choose where they'd like
37379 to pick up their hold</para>
37382 <para>If you would like to see more options you can click 'Show more options'</para>
37387 <screeninfo>Place Hold Form with More Options</screeninfo>
37390 <imagedata fileref="images/opac/opacplaceholdmore.png"/>
37397 <para>If allowed by your <link linkend="OPACAllowHoldDateInFuture"
37398 >OPACAllowHoldDateInFuture</link> preference, the 'Hold Starts on Date' column will
37399 show. This field allows the patron to have their hold start on a future date.</para>
37403 <para>By default holds placed in the system remain until canceled,
37404 but if the patron fills in a 'Hold Not Needed After' date then the
37405 hold has an expiration date.</para>
37410 <para>Expired holds are removed by the <link linkend="expiredholdscron">Expired Holds Cron Job</link>, this
37411 is not an automatic process and must be set up by your system
37412 administrator</para>
37419 <para>If allowed by the <link linkend="OpacHoldNotes">OpacHoldNotes</link> preference then
37420 patrons can leave notes about their holds for the library by clicking the 'Edit notes' button</para>
37422 <screeninfo>Hold notes</screeninfo>
37425 <imagedata fileref="images/opac/holdnote.png"/>
37431 <para>If allowed by your <link linkend="OPACItemHolds">OPACItemHolds</link> preference the
37432 patron will be allowed to choose whether to place the hold on the next available copy or
37433 a specific copy</para>
37435 <screeninfo>Specific Copy Hold</screeninfo>
37438 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
37445 <para>After clicking the Place Hold button the patron will be brought to
37446 their account page where they'll see all of the items they have on
37450 <section id="opacenhancedcontent">
37451 <title>Enhanced Content</title>
37455 <section id="opactagging">
37456 <title>Tagging</title>
37458 <para>Depending on your settings for the <link linkend="TagsEnabled">TagsEnabled</link>, <link linkend="TagsInputOnList">TagsInputOnList</link> and <link linkend="TagsInputOnDetail">TagsInputOnDetail</link> preferences you
37459 may be able to add tags to bibliographic records from the search
37460 results and/or bibliographic records. If you are allowing patrons to
37461 add tags from the search results screen you will see an input box
37462 below each result and a 'Tag' option at the top of the screen.</para>
37465 <screeninfo>Tagging Options on Results</screeninfo>
37469 <imagedata fileref="images/opac/tags-results.png"/>
37474 <para>To add a tag to one item, type the tabs (separated by commas) in
37475 the 'New tag' box and click 'Add'. You will be presented with a
37476 confirmation of your tags being added.</para>
37479 <screeninfo>Tags Added on Results</screeninfo>
37483 <imagedata fileref="images/opac/tagsadded-results.png"/>
37488 <para>From the results you can also tag items in bulk by clicking the
37489 checkboxes on the left and then clicking the 'Tag' button at the top.
37490 After clicking the button it will change into an input box for you to
37491 add tags to all of the items you have selected.</para>
37494 <screeninfo>Add Tags to Multiple Items</screeninfo>
37498 <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
37504 <section id="opaccomments">
37505 <title>Comments</title>
37507 <para>Patrons can leave comments in the OPAC if you have the <link linkend="reviewson">reviewson</link> preference set to allow this.
37508 Each bibliographic record has a comments tab below the bibliographic
37509 information.</para>
37512 <screeninfo>Comments Tab</screeninfo>
37516 <imagedata fileref="images/opac/commentstab.png"/>
37521 <para>If the patron is logged in they will see a link to add a comment
37522 to the item. Clicking this link will open a pop up window with a box
37523 for their comments.</para>
37526 <screeninfo>Add a Comment</screeninfo>
37530 <imagedata fileref="images/opac/addcomment.png"/>
37535 <para>Once the comment has been typed and the 'Submit' button clicked,
37536 the patron will see their comment as pending and other patrons will
37537 simply see that there are no comments on the item.</para>
37540 <screeninfo>Pending Comment</screeninfo>
37544 <imagedata fileref="images/opac/commentpending.png"/>
37549 <para>Once the comment is approved the patron will see the number of comments on the
37550 'Comments' tab and their comment labeled amongst the other comments. If you have set your
37551 <link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link> preference to 'Show' then
37552 you'll see the patron's photo pulled from the <ulink url="https://www.libravatar.org"
37553 >Libravatar</ulink> library.</para>
37556 <screeninfo>Your Comments</screeninfo>
37560 <imagedata fileref="images/opac/yourcomment.png"/>
37565 <para>Other patrons will see the comment with the name of the patron
37566 who left the comment (unless you have set the <link linkend="ShowReviewer">ShowReviewer</link> preference to not show
37567 patron names).</para>
37570 <screeninfo>Comment by other patron</screeninfo>
37574 <imagedata fileref="images/opac/commentby.png"/>
37579 <para>If you have your <link linkend="OpacShowRecentComments">OpacShowRecentComments</link>
37580 set to show then you'll see the approved comments on that page.</para>
37583 <screeninfo>Recent Comments List</screeninfo>
37587 <imagedata fileref="images/opac/recentcomments.png"/>
37593 <section id="zotero">
37594 <title>Zotero</title>
37596 <para>Zotero is a Firefox add on that allows for the saving and
37597 generating of a bibliography. Learn more about and download Zotero at
37598 <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
37600 <para>When on the search results in the Koha OPAC, if you have Zotero
37601 installed, you will see a folder icon in the address bar to the right
37602 of the URL. Clicking that folder will open up a list of titles on the
37603 page for you to pick from to add to Zotero.</para>
37606 <screeninfo>Zotero pop up</screeninfo>
37610 <imagedata fileref="images/opac/zoteroaddressbar.png"/>
37615 <para>Select the titles you want to add to Zotero and then click the
37616 'OK' button. This will add the title to Zotero. You can see the title
37617 by opening your Zotero library.</para>
37620 <screeninfo>Title in the Zotero Library</screeninfo>
37624 <imagedata fileref="images/opac/zoterotitle.png"/>
37630 <section id="customrss">
37631 <title>Custom RSS Feeds</title>
37633 <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
37634 any SQL query (for example a new acquisitions RSS feed). rss.pl is run
37635 on the command line to produce an RSS XML document.</para>
37637 <para>The output should be placed in a directory accessible to the
37638 OPAC (or staff) web interface so that users can download the RSS
37641 <para>An example of usage can be found at: misc/cronjobs/rss.pl
37642 lastAcquired.conf</para>
37644 <para>Normally rss.pl should be run periodically (e.g., daily) to keep
37645 the feed up-to-date.</para>
37647 <para>The configuration file (e.g., lastAcquired.conf) lists</para>
37651 <para>name of the template file to use</para>
37655 <para>path of output file</para>
37659 <para>SQL query</para>
37663 <para>rss.pl runs the SQL query, then feeds the output of the query
37664 through the template to produce the output file.</para>
37667 <para>To use custom RSS feeds you need to turn on the rss.pl cron job.</para>
37668 </important></para>
37671 <section id="selfregistration">
37672 <title>OPAC Self Registration</title>
37673 <para>If you allow it, patrons can register for their own accounts via the OPAC. If you have
37674 the <link linkend="PatronSelfRegistration">PatronSelfRegistration</link> preference set to
37675 'Allow' then patrons will see a link to register below the log in box on the right of the
37676 main OPAC page.</para>
37678 <screeninfo>Registration link in OPAC</screeninfo>
37681 <imagedata fileref="images/opac/PatronSelfRegistration.png"/>
37685 <para>When the patron clicks the 'Register here' link they will be brough to a registration
37686 page. The options on the registration page can be conrolled by editing the <link
37687 linkend="PatronSelfRegistrationBorrowerMandatoryField"
37688 >PatronSelfRegistrationBorrowerMandatoryField</link> and the <link
37689 linkend="PatronSelfRegistrationBorrowerUnwantedField"
37690 >PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
37692 <screeninfo>Registration form</screeninfo>
37695 <imagedata fileref="images/opac/patronregistration.png"/>
37699 <para>Once the patron has confirmed submitted their registration they will either be sent an
37700 email to confirm their account (if you have the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link>
37701 preference to require this) or presented with their new username and password.</para>
37703 <screeninfo>New account confirmation</screeninfo>
37706 <imagedata fileref="images/opac/patronregistrationcomplete.png"/>
37710 <para>Patrons registered in this way will not have a cardnumber until assigned one by the
37711 library, but will have access to all OPAC functionality immediately. For this reason it is
37712 recommended that you:<itemizedlist>
37714 <para>set up a provisional <link linkend="addingpatroncat">patron category</link> for
37715 self registered patrons (such as 'Self Registered) instead of using an existing patron
37716 category and set that value in the <link
37717 linkend="PatronSelfRegistrationDefaultCategory"
37718 >PatronSelfRegistrationDefaultCategory</link> preference</para>
37721 <para>give this patron category minimal circulation privileges in the <link
37722 linkend="circfinerules">Circulation and Fine Rules</link> (such as allowing a couple
37723 holds, but no check outs)</para>
37725 </itemizedlist>That way patrons will either have to come in to the library to verify their
37726 identity before given a cardnumber and the ability to check items out or the library will
37727 have to come up with internal policy on generating cardnumbers before providing them to self
37728 registered patrons. Once this is done the library can change the category to one that is
37729 more appropriate (be it an adult, resident, non resident, student, etc) and add a
37730 cardnumber/barcode.</para>
37733 <section id="opacmyaccount">
37734 <title>My Account</title>
37736 <para>From the OPAC patrons can log in and access their account if you
37737 have set the <link linkend="opacuserlogin">opacuserlogin</link>
37738 preference to 'Allow'. Once logged in patrons are brought to their
37739 account summary. If you would like to get to your account in the OPAC,
37740 you can click on your name in the top right of any page in the
37743 <section id="opacmysummary">
37744 <title>My Summary</title>
37747 <screeninfo>My Summary</screeninfo>
37751 <imagedata fileref="images/opac/myaccount.png"/>
37756 <para>From the 'my summary' tab, patrons will see all of the items
37757 they have checked out with the overdue items highlighted in red. If
37758 you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
37759 set to 'Allow' then your patrons will be able to renew their books
37760 right from the OPAC. If you have HTML entered in the <link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
37761 you will see that to the right of the 'Fines' column.</para>
37764 <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
37768 <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
37773 <para>If your patrons would like to see the items barcodes on their
37774 list of checked out items you can set up a <link linkend="patronattributetypes">patron attribute</link> with the value
37775 of SHOW_BCODE and <link linkend="authorizedvalues">authorized
37776 value</link> of YES_NO.</para>
37779 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
37783 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
37788 <para>Then on the <link linkend="editpatrons">patron's record set the
37789 value</link> for SHOW_BCODE to yes.</para>
37792 <screeninfo>Setting value for SHOW_BCODE on patron
37793 record</screeninfo>
37797 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
37802 <para>This will add a column to the check out summary in the OPAC that
37803 shows the patrons the barcodes of the items they have checked
37807 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
37811 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
37816 <para>Clicking on the 'Overdue' tab will show only the items that are
37820 <screeninfo>Overdue Items</screeninfo>
37824 <imagedata fileref="images/opac/myoverdues.png"/>
37829 <para>The 'Fines' tab will show just a total of what the patron owes.
37830 Clicking on the total will take them to the 'my fines' tab where they
37831 will see a complete breakdown of their fines and bills. If you don't
37832 charge fines at your library you can turn the display of these tabs
37833 off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
37834 preference to 'Don't Allow.'</para>
37837 <screeninfo>Patron Fines</screeninfo>
37841 <imagedata fileref="images/opac/myfines.png"/>
37846 <para>Finally, clicking on the 'Holds' tab will show the patron the status of all of the
37847 items they have on hold. </para>
37850 <screeninfo>Patron holds status</screeninfo>
37854 <imagedata fileref="images/opac/myholds.png"/>
37859 <para>Patrons can cancel or suspend (depending on the value of your <link
37860 linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference) their own holds if
37861 they are not in transit or already waiting for them. When they click 'Suspend' they will
37862 be presented with the option to choose a date for their hold to resume.<screenshot>
37863 <screeninfo>Suspend until</screeninfo>
37866 <imagedata fileref="images/opac/suspenduntil.png"/>
37869 </screenshot></para>
37870 <para>They can also suspend all of their holds indefinitely or until a specific date if they
37871 choose by filling in the suspend options at the bottom of the page.</para>
37874 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
37875 preference set to "Don't allow" then you will not have the option to
37876 put an end date on the hold suspension</para>
37880 <section id="opacmyaccount-flags">
37881 <title>Patron Flags</title>
37883 <para>If you have <link linkend="patronflags">flagged your patron's
37884 account</link> they may see one of the following error messages at the
37885 top of their account.</para>
37889 <para>Card marked as lost</para>
37892 <screeninfo>Library card lost</screeninfo>
37896 <imagedata fileref="images/opac/nocard.png"/>
37903 <para>Patron address in question</para>
37906 <screeninfo>Patron address in question</screeninfo>
37910 <imagedata fileref="images/opac/noaddress.png"/>
37918 <para>this error message will not include a link to the
37919 update form if you have <link linkend="OPACPatronDetails">OPACPatronDetails</link> set to
37920 'Don't allow'</para>
37927 <para>Patron marked restricted</para>
37930 <screeninfo>Patron restricted</screeninfo>
37934 <imagedata fileref="images/opac/debarred.png"/>
37942 <section id="opacmyfines">
37943 <title>My Fines</title>
37945 <para>If your library charges fines the next tab on the left is 'my
37946 fines.' Opening this tab will show the patron an entire history of
37947 their accounting at the library.</para>
37950 <screeninfo>Library Fines & Charges</screeninfo>
37954 <imagedata fileref="images/opac/mybilling.png"/>
37960 <section id="opacmydetails">
37961 <title>My Details</title>
37963 <para>If you have your <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference
37964 set to 'Allow', your patrons will see a form filled in with their contacting information
37965 by clicking on the 'my personal details' tab. You can control what fields patrons see and
37966 can modify via the OPAC by setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
37967 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
37970 <screeninfo>Patron's personal details</screeninfo>
37974 <imagedata fileref="images/opac/myprofile.png"/>
37979 <para>Patrons can edit their details in this form and click 'Submit Changes' to have their
37980 edits sent to the library for review before their record is updated. Staff will see all
37981 patrons requesting modification to their record listed below the modules on the main
37982 dashboard along with anything else awaiting library attention.</para>
37984 <screeninfo>Patron requests waiting review</screeninfo>
37987 <imagedata fileref="images/opac/patronrequestwaiting.png"/>
37992 <para>If the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set to
37993 'Don't allow' then patrons will simply see their details and a message stating that they
37994 should contact the library for changes.</para>
37997 <screeninfo>Patron's personal details with no edits</screeninfo>
38001 <imagedata fileref="images/opac/myprofile-noedit.png"/>
38007 <section id="opacmytags">
38008 <title>My Tags</title>
38010 <para>If your library has <link linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
38011 next tab on the left will be 'my tags.' This tab will show patrons all
38012 of the tags in the system as a cloud and then all of the tags they
38013 have applied in a list format. From here patrons have the ability to
38014 remove tags that they have added if they want.</para>
38017 <screeninfo>Patron's tags</screeninfo>
38021 <imagedata fileref="images/opac/mytags.png"/>
38027 <section id="opacmypassword">
38028 <title>Change My Password</title>
38030 <para>Next, if you have <link linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
38031 the next tab will be 'change my password,' where patrons can change
38032 their password for logging into the OPAC. Patrons will be presented
38033 with a standard form asking them to enter their old password and then
38034 their new password twice.</para>
38037 <screeninfo>Change my password</screeninfo>
38041 <imagedata fileref="images/opac/mypassword.png"/>
38047 <section id="opacmysearchistory">
38048 <title>My Search History</title>
38050 <para>If you have your <link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
38051 preference set to 'Allow' then your patrons can access their search
38052 history via the 'my search history' tab.</para>
38055 <screeninfo>my search history tab</screeninfo>
38059 <imagedata fileref="images/opac/mysearchhistory.png"/>
38064 <para>The search history is a record of all searches run by the
38065 patron. Clicking on any of the search phrases will re-run the search
38066 for the patron. The search history can be deleted by the patron at any
38067 time by clicking the 'Delete your search history' link found at the
38068 top of this tab or by clicking the little red 'x' next to the 'Search
38069 history' link at the top right of the OPAC.</para>
38072 <screeninfo>Search history link at the top right of the
38077 <imagedata fileref="images/opac/searchistory.png"/>
38083 <section id="opacmyhistory">
38084 <title>My Reading History</title>
38086 <para>Depending on your library's setting for <link linkend="opacreadinghistory">opacreadinghistory</link> your patrons
38087 may see the 'my reading history' tab next. This will show the patron
38088 their entire reading history unless they have asked the library to not
38089 keep that information via the 'my privacy' tab which will appear if
38090 you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
38091 set to 'Allow.'</para>
38094 <screeninfo>Patron reading history</screeninfo>
38098 <imagedata fileref="images/opac/myhistory.png"/>
38102 <para>If you have HTML entered in the <link linkend="OPACMySummaryHTML"
38103 >OPACMySummaryHTML</link> preference then you will see that to the right of the 'Date'
38107 <section id="opacmyprivacy">
38108 <title>My Privacy</title>
38110 <para>The 'my privacy' tab will appear if you have both the <link linkend="opacreadinghistory">opacreadinghistory</link> and the <link linkend="OPACPrivacy">OPACPrivacy</link> preferences set to 'Allow.'
38111 This tab will allow the patrons to decide how the library keeps their
38112 circulation history data.</para>
38115 <screeninfo>my privacy tab</screeninfo>
38119 <imagedata fileref="images/opac/myprivacy.png"/>
38124 <para>The patron can choose from three options:</para>
38128 <para>Forever: keep my reading history without limit. This is the
38129 option for users who want to keep track of what they are
38134 <para>Default: keep my reading history according to local laws.
38135 This is the default option : the library will keep your reading
38136 history for the duration permitted by local laws.</para>
38140 <para>Never: Delete my reading history immediately. This will
38141 delete all record of the item that was checked-out upon
38146 <para>Depending on the patron's suggestions the contents of the '<link linkend="opacmyhistory">my reading history</link>' tab and the '<link linkend="circhistory">Circulation History</link>' tab in the staff
38147 client may change.</para>
38149 <para>Regardless of the patron's choice they can delete their reading
38150 history in bulk at any time by clicking the 'Immediate deletion'
38154 <screeninfo>Delete Circulation History</screeninfo>
38158 <imagedata fileref="images/opac/deletecirchistory.png"/>
38163 <para>Clicking this button will not delete items that are currently
38164 checked out, but will clear the patron's past reading history.</para>
38167 <section id="opacmysuggestions">
38168 <title>My Purchase Suggestions</title>
38170 <para>If your library allows patrons to make purchase suggestions the
38171 next tab will show all suggestions that the patron made to the library
38172 and their statuses. To disable this tab and the suggestion
38173 functionality set the <link linkend="suggestionspref">suggestion</link> preference to 'Don't
38177 <screeninfo>Patron purchase suggestions</screeninfo>
38181 <imagedata fileref="images/opac/mysuggestions.png"/>
38185 <para>If you have <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
38186 set to 'Show' then patrons will be able to search suggestions from the top of this
38190 <section id="opacmymsgs">
38191 <title>My Messaging</title>
38193 <para>If your library has the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
38194 preference set to 'Allow' then your patrons will be able to choose
38195 which messages they receive from the library (with the exception of
38196 overdue notices which the library controls).</para>
38199 <screeninfo>Patron messaging preferences</screeninfo>
38203 <imagedata fileref="images/opac/mymessages.png"/>
38208 <para>If you also allow SMS messages with the <link linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
38209 an additional column to receive these messages as SMS (or text
38210 messages) and a field for a cell (or SMS) number.</para>
38213 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
38217 <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
38223 <para>These notices are:</para>
38226 <para>Advanced Notice : A notice in advance of the patron's items being due (The
38227 patron can choose the number of days in advance)</para>
38230 <para>Item Checkout : A notice that lists all the of the items the patron has just
38231 checked out and/or renewed, this is an electronic form of the checkout
38235 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
38239 <para>Item Due : A notice on the day and item is due back at the library</para>
38242 <para>Item Checkin : A notice that lists all the of the items the patron has just
38250 <section id="opacmylists">
38251 <title>My Lists</title>
38253 <para>Finally, if your library has the <link linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
38254 last tab will by 'my lists.' From here your patrons can review public
38255 lists and create or edit their own private lists.</para>
38258 <screeninfo>Patron lists</screeninfo>
38262 <imagedata fileref="images/opac/mylists.png"/>
38269 <section id="purchasesuggest">
38270 <title>Purchase Suggestions</title>
38272 <para>If your library has the <link linkend="suggestionspref">suggestion</link> preference set to 'Allow'
38273 then patrons will have the option to make purchase suggestions in
38274 several areas in the OPAC.</para>
38276 <para>If you are allowing everyone to see the purchase suggestions made by others with the
38277 <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> preference,
38278 then there will be a link at the top of your OPAC under the search box.</para>
38281 <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
38285 <imagedata fileref="images/opac/suggestfromsearch.png"/>
38290 <para>There will be a link when the patron finds nothing for their
38294 <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
38298 <imagedata fileref="images/opac/suggestfromnoresults.png"/>
38303 <para>And there will be a link on the patron's <link linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
38306 <screeninfo>Purchase Suggestion from My Purchase Suggestions
38311 <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
38316 <para>Clicking any one of these links will open the purchase suggestion
38320 <screeninfo>New Purchase Suggestion</screeninfo>
38324 <imagedata fileref="images/opac/newsuggestion.png"/>
38331 <para>From the form on the 'Title' is required by the
38336 <para>If you would like the 'Reason for suggestion' menu shown in
38337 the screenshot above to appear on your suggestions list you need to
38338 add an <link linkend="authorizedvalues">authorized value</link>
38339 category titled 'OPAC_SUG' and include reasons as values in that
38344 <para>If you would like the patron to be able to choose which branch
38345 they are making a suggestion for you need to set the <link linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
38346 preference to 'Allow'</para>
38350 <para>Once the form is submitted the data will be saved to the <link linkend="managesuggest">Acquisitions</link> module for the librarians to
38353 <section id="mobileopac">
38354 <title>Mobile OPAC</title>
38355 <para>If you have chosen to use the CCSR theme (set in the <link linkend="opacthemes">opacthemes</link> preference) then you also have a mobile specific view for your OPAC. </para>
38356 <para>The main page of your OPAC will be customized per your <link linkend="opacprefs">OPAC
38357 system preferences</link> (always be sure to test in customizations on the desktop in
38358 multiple browsers and on as many mobile devices as possible. Your main page will look
38359 something like this:</para>
38362 <screeninfo>Mobile OPAC</screeninfo>
38365 <imagedata fileref="images/opac/mobile/mobileccsr.png"/>
38370 <para>Your search results will look something like this:</para>
38373 <screeninfo>Mobile search results</screeninfo>
38376 <imagedata fileref="images/opac/mobile/mobilesearchccsr.png"/>
38381 <para>A detail page will show more info along with the place hold link in the top right</para>
38386 <imagedata fileref="images/opac/mobile/mobiledetail.png"/>
38390 <para>Clicking the place hold link on the search results or detail page will open up the holds
38391 screen for placing holds</para>
38396 <imagedata fileref="images/opac/mobile/mobilehold.png"/>
38400 <para>Patrons will be able to log in to their account and see what they have checked out</para>
38405 <imagedata fileref="images/opac/mobile/mobilemyaccount.png"/>
38409 <para>Once logged in they can click the menu button in the top left to see the usualy patron
38410 account menu</para>
38415 <imagedata fileref="images/opac/mobile/mobilemenu.png"/>
38419 <para>They will be able to renew items (if you allow renewals via the OPAC)</para>
38424 <imagedata fileref="images/opac/mobile/mobilerenew.png"/>
38431 <chapter id="searching">
38432 <title>Searching</title>
38436 <section id="searchprefixes">
38437 <title>Advanced Search Prefixes</title>
38439 <para>The following prefixes can be added to search terms in the keyword
38440 search box to limit items returned</para>
38444 <para>ti: title search</para>
38448 <para>ex. ti:hamlet</para>
38454 <para>su: subject search</para>
38458 <para>ex. su:cooking</para>
38464 <para>pb: publisher search</para>
38468 <para>ex. pb:penguin</para>
38474 <para>au: author search</para>
38478 <para>ex. au:rowling</para>
38484 <para>su-geo: geographic subjects</para>
38488 <para>ex. su-geo:wales and kw:description and kw:travel</para>
38494 <para>bc: barcode</para>
38498 <para>ex. bc:502326000912</para>
38504 <para>lex: lexile</para>
38508 <para>levels lex:510</para>
38517 <section id="searchguide">
38521 <firstname>Becky</firstname>
38522 <surname>Bell</surname>
38524 <orgname>WALDO</orgname>
38529 <firstname>Nicole C.</firstname>
38530 <surname>Engard</surname>
38531 <contrib>Fixed typos, changed content where necessary and added new
38532 screenshots.</contrib>
38536 <pubdate>October 2008</pubdate>
38538 <title>Guide to Searching</title>
38540 <para>This brief guide will explain a chart that shows a sample of how a
38541 MARC21 database can be configured, as well as a brief introductory
38542 searching guide. The indexing fields described in this document relate
38543 to the bibliographic data and does not address authority database
38546 <section id="searchguide-indexing">
38547 <title>Indexing and Searching Description</title>
38549 <para>Koha's databases are indexed by the Zebra open-source software.
38550 The overview to the documentation describes Zebra as:</para>
38553 <para>"...Zebra is a high-performance, general-purpose structured
38554 text indexing and retrieval engine. It reads records in a variety of
38555 input formats (eg. email, XML, MARC) and provides access to them
38556 through a powerful combination of Boolean search expressions and
38557 relevance-ranked free-text queries.</para>
38559 <para>Zebra supports large databases (tens of millions of records,
38560 tens of gigabytes of data). It allows safe, incremental database
38561 updates on live systems. Because Zebra supports the
38562 industry-standard information retrieval protocol, Z39.50, you can
38563 search Zebra databases using an enormous variety of programs and
38564 toolkits, both commercial and free, which understands this
38565 protocol..." Zebra - User's Guide and Reference, p. 1, <ulink url="http://www.indexdata.dk/zebra/doc/zebra.pdf">http://www.indexdata.dk/zebra/doc/zebra.pdf</ulink></para>
38568 <para>This brief guide will explain a chart that shows a sample of how
38569 a MARC21 database can be configured, as well as a brief introductory
38570 searching guide. The indexing fields described in this document relate
38571 to the bibliographic data and does not address authority database
38575 <para>The indexing described in this document is the set used by
38576 SouthEastern University. Your local indexing may vary.</para>
38580 <section id="searchguide-indexconfig">
38581 <title>Indexing Configuration</title>
38583 <para>There are three configuration files that Koha uses while
38586 <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
38587 contains the Z39.50 bib-1 attribute list, plus the Koha local use
38588 attributes for Biblio Indexes, Items Index, and Fixed Fields and other
38589 special indexes. The Z39.50 Bib-1 profile is made up of several
38590 different types of attributes: Use, Relation, Position, Structure,
38591 Truncation, and Completeness. The bib-1 'Use' attribute is represented
38592 on the chart; the other attributes are used primarily when doing
38593 searches. While there are over 150+ use attributes that could be used
38594 to define your indexing set, it's unlikely that you will choose to use
38595 them all. The attributes you elect to use are those that become the
38596 indexing rules for your database. The other five attribute sets define
38597 the various ways that a search can be further defined, and will not
38598 specifically be addressed in this document. For a complete list of the
38599 standard Bib-1 attributes, go to <ulink url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
38601 <para>The second file
38602 (etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs) contains
38603 the abstract syntax which maps the MARC21 tags to the set of Use
38604 Attributes you choose to use. The rules established in this file
38605 provides a passable Bath level 0 and 1 service, which includes author,
38606 title, subject, keyword and exact services such as standard
38607 identifiers (LCCN, ISBN, ISSN, etc.)</para>
38609 <para>The third file (etc/zebradb/ccl.properties) is the Common
38610 Command Language (CCL) field mappings. This file combines the bib-1
38611 attribute set file and the abstract file and adds the qualifiers,
38612 usually known as index names. The qualifiers, or indexes, for this
38613 database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
38614 su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
38615 mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
38617 <para>The <link linkend="kohasearchindexes">Koha Indexing Chart</link> summarizes the
38618 contents of all three of these files in a more readable format. The first two columns
38619 labeled Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes file. The
38620 third column labeled MARC tags indexed is where you find which MARC tags are mapped to an
38621 attribute. The fourth column labeled Qualifiers identifies the search abbreviations used
38622 in the internal CCL query. The following description provides a definition for the word
38623 'qualifiers'.</para>
38625 <para><emphasis>Qualifiers are used to direct the search to a
38626 particular searchable index, such as title (ti) and author indexes
38627 (au). The CCL standard itself doesn't specify a particular set of
38628 qualifiers, but it does suggest a few shorthand notations. You can
38629 customize the CCL parser to support a particular set of qualifiers to
38630 reflect the current target profile. Traditionally, a qualifier would
38631 map to a particular use-attribute within the BIB-1attribute set. It is
38632 also possible to set other attributes, such as the structure
38633 attribute.</emphasis></para>
38635 <para>In the MARC tags indexed column, there are some conventions used
38636 that have specific meanings. They are:</para>
38640 <para>A three digit tag (100) means that all subfields in the tag
38641 can be used in a search query. So, if you enter a search for
38642 'Jackson' as an author, you will retrieve records where Jackson
38643 could be the last name or the first name.</para>
38647 <para>A three digit tag that has a '$' followed by a letter
38648 (600$a) means that a search query will only search the 'a'
38653 <para>A three digit tag that is followed by a ':' and a letter
38654 (240:w) means that a search query can be further qualified. The
38655 letter following the ':' identifies how to conduct the search. The
38656 most common values you'll see are 'w' (word), 'p' (phrase), 's'
38657 (sort), and 'n' (numeric).</para>
38661 <para>The contents of the MARC tags, subfields, and/or fixed field
38662 elements that are listed in this chart are all indexed. You'll see
38663 that every attribute line is not mapped to a specific qualifier
38664 (index)-LC card number, line 9 is one example. However, every indexed
38665 word (a string of characters preceded and succeeded by a space) can be
38666 searched using a keyword (kw) search. So, although an LC card number
38667 specific index doesn't exist, you can still search by the LCCN since
38668 tag 010 is assigned to the LC-card-number attribute. To verify this,
38669 enter 72180055 in the persistent search box. You should retrieve The
38670 gods themselves, by Isaac Asimov.</para>
38672 <para>Examples of fixed field elements indexing can be seen on the
38673 chart between Attribute 8822 and Attribute 8703. These attributes are
38674 most commonly used for limiting. The fixed field attributes currently
38675 represent the BK codes. Other format codes, if needed, could be
38679 <section id="searchguide-basics">
38680 <title>Basic Searching</title>
38682 <para>The search box that library staff and library patrons will see
38683 most often is the persistent search box at the top of the page. Koha
38684 interprets the searches as keyword searches.</para>
38687 <screeninfo>Koha search box</screeninfo>
38691 <imagedata fileref="images/searching/searchbox.png"/>
38696 <para>To start a search, you enter a word or multiple words in the
38697 search box. When a single word is entered, a keyword search is
38698 performed. You can check this out by typing one word into the form and
38699 note the number of results located. Then, repeat the search with a
38700 minor change. In front of the search word, type 'kw=' followed by the
38701 same search term. The results will be identical.</para>
38703 <para>When you have more than one word in the search box, Koha will
38704 still do a keyword search, but a bit differently. Each word will be
38705 searched on its own, then the Boolean connector 'and' will narrow your
38706 search to those items with all words contained in matching
38709 <para>Suppose you want to find material about how libraries are using
38710 mashups. You'll select the major words and enter them into the
38711 persistent search box.</para>
38714 <screeninfo>Keyword Search</screeninfo>
38718 <imagedata fileref="images/searching/searchterms.png"/>
38723 <para>The response to this search is:</para>
38726 <screeninfo>Results</screeninfo>
38730 <imagedata fileref="images/searching/resultssummary.png"/>
38735 <para>The order of the words does not affect the retrieval results, so
38736 you could also enter the search as "mashups library". The response to
38737 this search is results</para>
38740 <screeninfo>Results</screeninfo>
38744 <imagedata fileref="images/searching/resultssummary2.png"/>
38749 <para>Too many words in the search box will find very few matches, as
38750 the following example illustrates:</para>
38753 <screeninfo>No results found</screeninfo>
38757 <imagedata fileref="images/searching/noresults.png"/>
38763 <section id="searchguide-advanced">
38764 <title>Advanced Searching</title>
38766 <para>When you can't find the most appropriate material with a general
38767 search, you can move to the Advanced Search page by clicking on the
38768 Search option on the persistent toolbar.</para>
38771 <screeninfo>Koha Menu</screeninfo>
38775 <imagedata fileref="images/searching/menubar.png"/>
38780 <para>The Advanced Search page offers many ways to limit the results
38781 of your search. You can search using the Boolean operators AND, OR,
38782 and NOT; limit by item type; limit by year and language; limit by
38783 subtypes audience, content, format, or additional content types; by
38784 location and by availability.</para>
38786 <para>The first limiting section on the Advanced Search page provides
38787 a quick and simple way to use the Boolean operators in your search.
38788 Note that this display depends on a system preference setting. This
38789 option can be found on the Administration > System Preferences >
38790 Searching page. The option called <link linkend="expandedSearchOption">expandedSearchOption</link> must be set
38791 to 'show' to see the following display.</para>
38794 <screeninfo>Advanced Search Options</screeninfo>
38798 <imagedata fileref="images/searching/searchoptions.png"/>
38803 <para>In this section you can choose among the many indexes by
38804 clicking on the arrow in the first box. The blank box that follows is
38805 where you enter your first search term or terms. On the second line,
38806 you can choose the Boolean operator you want to use in your search.
38807 The options are 'and', 'or', and 'not'. Then, you would again choose
38808 the index to search, followed by the second term or terms. If you have
38809 more concepts you want to include in your search, you can click the
38810 [+] to add another line for your search.</para>
38812 <para>A sample search is shown next, followed by its results:</para>
38815 <screeninfo>Advanced Search</screeninfo>
38819 <imagedata fileref="images/searching/advsearch.png"/>
38825 <screeninfo>Results from Advanced Search</screeninfo>
38829 <imagedata fileref="images/searching/numresults.png"/>
38834 <para>When you use the Boolean operators to broaden or narrow a
38835 search, remember the action of each operator. The 'and' operator
38836 narrows the results you'll retrieve because the search will retrieve
38837 the records that include all your search terms. The 'or' operator
38838 expands the results because the search will look for occurrences of
38839 all of your search terms. The 'not' operator excludes records with the
38840 term that follows the operator.</para>
38842 <para>Note: If you leave this <link linkend="expandedSearchOption">expandedSearchOption</link> set to
38843 'don't show', this is the display you will see:</para>
38846 <screeninfo>Fewer Search Options</screeninfo>
38850 <imagedata fileref="images/searching/feweropts.png"/>
38855 <para>The Advanced Search page then shows the multiple kinds of limits
38856 that can be applied to your search results. Either check a box or
38857 select from the drop down menus to narrow your search. You will type
38858 the year, year range, or a 'greater than (>)' or 'less than (<)'
38862 <screeninfo>Other Advanced Search Options</screeninfo>
38866 <imagedata fileref="images/searching/advoptions.png"/>
38871 <para>Finally, you can choose how the results will be sorted. The
38872 pre-defined sort options are in the final area of the Advanced Search
38876 <screeninfo>Sort Results By</screeninfo>
38880 <imagedata fileref="images/searching/advsortby.png"/>
38885 <para>The default sort is by relevance, although you can choose to sort by author, by title,
38886 by call number, by dates, or by popularity (which uses the information on total issues
38887 found in the items table). If you would prefer a different default sort, you can set <link
38888 linkend="defaultSortField">defaultSortField</link> to one of the other choices in
38889 Administration > System Preferences > Searching.</para>
38892 <section id="searchguide-ccl">
38893 <title>Common Command Language Searching</title>
38895 <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
38896 internal search protocol. Searches initiated in the graphical
38897 interface use this protocol as well, although the searcher doesn't
38898 know which indexes, operators and limiters are available and being
38899 used to conduct their search. The searcher can use the Advanced Search
38900 when more precise results set are desired and where the search indexes
38901 are somewhat known. However, some library users and many library staff
38902 prefer using a command based structure. This part of the document will
38903 present and explain the use of the Koha command based structure. The
38904 indexes, operators, and limiters used are identical to those used in
38905 the graphical interface.</para>
38907 <section id="searchguide-indexes">
38908 <title>Indexes</title>
38910 <para>The CCL standard itself doesn't specify a particular set of
38911 qualifiers (indexes), but it does suggest a few short-hand notations
38912 such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
38913 it's possible to customize that set by adding needed indexes based
38914 on local requirements. A qualifier (index) maps to a particular
38915 use-attribute within the Z39.50 BIB-1 attribute set. The complete
38916 Z39.50 Bib-1 Attribute can be viewed at <ulink url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
38918 <para>The standard Koha set of indexes is a fairly common example of
38919 MARC21 indexing rules. The indexes that are defined in Koha are
38920 indexes typically used by other integrated library systems. The
38921 defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
38923 <table cellpadding="4" cellspacing="4" frame="all">
38924 <title>Attributes</title>
38926 <tgroup align="left" cols="2" colsep="1" rowsep="1">
38929 <entry>Bib-1 Attribute</entry>
38931 <entry>Qualifier (index)</entry>
38937 <entry>Personal-name</entry>
38943 <entry>Corporate-name</entry>
38949 <entry>Conference-name</entry>
38955 <entry>Title</entry>
38961 <entry>Title-series</entry>
38967 <entry>Title-uniform</entry>
38973 <entry>ISBN</entry>
38979 <entry>ISSN</entry>
38985 <entry>Local number</entry>
38991 <entry>Local-classification</entry>
38993 <entry>lcn and callnum</entry>
38997 <entry>Subject</entry>
38999 <entry>su, su-to, su-geo, su-ut</entry>
39003 <entry>Pubdate</entry>
39005 <entry>yr,pubdate</entry>
39009 <entry>Date-of-Acquisition</entry>
39011 <entry>acqdate</entry>
39015 <entry>Language</entry>
39021 <entry>Place-of-publication</entry>
39027 <entry>Abstract</entry>
39033 <entry>Notes</entry>
39039 <entry>Record-type</entry>
39041 <entry>rtype, mc-rtype, mus</entry>
39045 <entry>Author</entry>
39047 <entry>au, aut</entry>
39051 <entry>Subject-person-name</entry>
39053 <entry>su-na</entry>
39057 <entry>Any (keyword)</entry>
39063 <entry>Publisher</entry>
39069 <entry>Content-type</entry>
39071 <entry>ctype</entry>
39075 <entry>Koha-Auth-Number</entry>
39081 <entry>Author-personal-bibliography</entry>
39087 <entry>Author-in-order</entry>
39095 <para>Refer to the <link linkend="kohasearchindexes">Koha Indexing Chart</link> for the
39096 MARC21 tags mapped to each Bib-1 Attribute and index combination.</para>
39098 <section id="search-audexamp">
39099 <title>Audience Examples</title>
39103 <para>aud:a Preschool</para>
39106 <para>aud:b Primary</para>
39109 <para>aud:c Pre-Adolescent</para>
39112 <para>aud:d Adolescent</para>
39116 <para>aud:e Adult</para>
39119 <para>aud:f Specialized</para>
39122 <para>aud:g General</para>
39125 <para>aud:j Juvenile</para>
39130 <section id="search-contentsexamp">
39131 <title>Contents Examples</title>
39135 <para>fic:1 Fiction</para>
39139 <para>fic:0 Non Fiction</para>
39143 <para>bio:b Biography</para>
39147 <para>mus:j Musical recording</para>
39151 <para>mus:I Non musical record</para>
39157 <section id="searchguide-syntax">
39158 <title>Search Syntax</title>
39160 <para>In the persistent search box, single words generally retrieve
39161 large sets. To narrow a search, you can use multiple words. Koha
39162 automatically uses the 'and' Boolean operator to create a set of
39163 records matching your input. When you want to narrow the search to
39164 an author or a title or a subject or some other specific field or
39165 use a Boolean operator, there isn't an obvious way to accomplish
39166 that specificity. The library user can, of course, go to the
39167 Advanced Search page; however, if you know how to construct a CCL
39168 search, you can achieve more specificity while using the persistent
39169 search box on any page.</para>
39171 <para>There is a specific order to the CCL search syntax. Although
39172 it can be used for simple searches, it is an especially effective
39173 way to perform complex searches, as it affords you a great deal of
39174 control over your search results. To construct a CCL search, first
39175 enter a desired index code, then an equal sign, followed by your
39176 search word(s). Following are examples of simple CCL
39181 <para>ti=principles of accounting</para>
39185 <para>au=brown joseph</para>
39189 <para>su=poetry</para>
39193 <para>su-na=Shakespeare</para>
39197 <para>kw=marlin</para>
39201 <para>You can refine your search by combining search terms with
39202 Boolean operators 'and', 'or', or 'not'. Following are examples of
39203 searches using Boolean operators.</para>
39207 <para>ti=principles of accounting and au=brown joseph</para>
39211 <para>su=poetry not su-na=Shakespeare</para>
39215 <para>kw=communication and su=debate</para>
39219 <para>You can also choose to search for things that start with a
39220 character or series of characters</para>
39224 <para>ti,first-in-subfield=C (will show you all titles that
39225 start with the letter 'C')</para>
39229 <para>Other string location searches can be performed with the
39230 following keywords:</para>
39234 <para>rtrn : right truncation</para>
39238 <para>ltrn : left truncation</para>
39242 <para>lrtrn : left and right truncation</para>
39246 <para>st-date : type date</para>
39250 <para>st-numeric : type number (integer)</para>
39254 <para>ext : exact search on whole subfield (does not work with
39259 <para>phr : search on phrase anywhere in the subfield</para>
39263 <para>startswithnt : subfield starts with</para>
39267 <para>Using specific indexes and Boolean operators are not the only
39268 way a search can be refined. You can also refine your search as a
39269 phrase when looking for a title, author, or subject. The syntax for
39270 this search is <emphasis>index,phr=search words</emphasis>.</para>
39272 <para>To illustrate the results of various search types, a search
39273 was done for the words 'supreme court'. The results illustrate that
39274 the search index and the word order make a difference in search
39275 results. Only the results count and the search itself is in these
39276 examples. The search executed will always be between the single
39280 <screeninfo>Sample Search 1</screeninfo>
39284 <imagedata fileref="images/searching/ex1.png"/>
39290 <screeninfo>Sample Search 2</screeninfo>
39294 <imagedata fileref="images/searching/ex2.png"/>
39300 <screeninfo>Sample Search 3</screeninfo>
39304 <imagedata fileref="images/searching/ex3.png"/>
39310 <screeninfo>Sample Search 4</screeninfo>
39314 <imagedata fileref="images/searching/ex4.png"/>
39320 <screeninfo>Sample Search 5</screeninfo>
39324 <imagedata fileref="images/searching/ex5.png"/>
39330 <screeninfo>Sample Search 6</screeninfo>
39334 <imagedata fileref="images/searching/ex6.png"/>
39340 <screeninfo>Sample Search 7</screeninfo>
39344 <imagedata fileref="images/searching/ex7.png"/>
39350 <screeninfo>Sample Search 8</screeninfo>
39354 <imagedata fileref="images/searching/ex8.png"/>
39360 <screeninfo>Sample Search 9</screeninfo>
39364 <imagedata fileref="images/searching/ex9.png"/>
39369 <para>You can also choose to use limiters in your search query. Some
39370 common limiters include dates, languages, record types, and item
39371 types. In the Advance Search, you can either click a box or key in
39372 data to limit your search. You can also apply the same limits with
39373 CCL by using the syntax in the following examples. In all</para>
39375 <para><emphasis>By Date: su=supreme court and
39376 yr,st-numeric=>2000</emphasis></para>
39379 <screeninfo>Sample Search 10</screeninfo>
39383 <imagedata fileref="images/searching/ex10.png"/>
39388 <para>When you limit by date, you can use the '>' (greater than),
39389 '<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
39392 <para><emphasis>By Item Type: su=nursing and
39393 itype:BK</emphasis></para>
39396 <screeninfo>Sample Search 11</screeninfo>
39400 <imagedata fileref="images/searching/ex11.png"/>
39405 <para>Each library will have a different set of item types defined
39406 in their circulation configuration. When you set up item types, you
39407 define a code and a name for each one. The name will appear on the
39408 Advance Search page. The code you assigned is used as a CCL search
39409 limit, formatted as 'itype:x', where 'x' is the assigned code. The
39410 initial set of item types in Koha will usually be edited to reflect
39411 your collections, so your item type limiters may be different than
39412 the initial ones. The initial item type limiters follow.</para>
39416 <para>itype:BKS Books, Booklets, Workbooks</para>
39420 <para>itype:SR Audio Cassettes, CDs</para>
39424 <para>itype:IR Binders</para>
39428 <para>itype:CF CD-ROMs, DVD-ROMs, General Online
39433 <para>itype:VR DVDs, VHS</para>
39437 <para>itype:KT Kit</para>
39441 <para>itype:AR Models</para>
39445 <para>itype:SER Serials</para>
39449 <para><emphasis>By format: su=supreme court not
39450 l-format:sr</emphasis></para>
39453 <screeninfo>Sample Search 12</screeninfo>
39457 <imagedata fileref="images/searching/ex12.png"/>
39462 <para>The format limiters are derived from a combination of LDR, 006
39463 and 007 positions. The formats that are currently defined are the
39468 <para>l-format:ta Regular print</para>
39472 <para>l-format:tb Large print</para>
39476 <para>l-format:fk Braille</para>
39480 <para>l-format:sd CD audio</para>
39484 <para>l-format:ss Cassette recording</para>
39488 <para>l-format:vf VHS tape</para>
39492 <para>l-format:vd DVD video</para>
39496 <para>l-format:co CD software</para>
39500 <para>l-format:cr Website</para>
39504 <para><emphasis>By content type: su=supreme court not
39505 ctype:l</emphasis></para>
39508 <screeninfo>Sample Search 13</screeninfo>
39512 <imagedata fileref="images/searching/ex13.png"/>
39517 <para>The content types are taken from the 008 MARC tag, positions
39520 <para>There are two other limiter types that are not described in
39521 this document. They are: Audience and Content. The only difference
39522 in the syntax of the CCL is the actual limiter. They are reproduced
39523 here just in case you would like to use these limiters.</para>
39528 <section id="kohasearchindexes">
39529 <title>Koha Search Indexes</title>
39531 <para>By default, not all fields are indexed in the Zebra search engine,
39532 but many are. Below are the MARC21 fields that are indexed in
39535 <table cellpadding="4" cellspacing="4" frame="all">
39536 <title>Indexes</title>
39538 <tgroup align="left" cols="2" colsep="1" rowsep="1">
39541 <entry><para>Field</para></entry>
39543 <entry><para>Description</para></entry>
39549 <entry><para>001</para></entry>
39551 <entry><para>Control-number</para></entry>
39555 <entry><para>005</para></entry>
39557 <entry><para>Date/time-last-modified</para></entry>
39561 <entry><para>007</para></entry>
39563 <entry><para>Microform-generation:n:range(data,11,1),
39564 Material-type,ff7-00:w:range(data,0,1),
39565 ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
39566 ff7-01-02:w:range(data,0,2)</para></entry>
39570 <entry><para>008</para></entry>
39572 <entry><para>date-entered-on-file:n:range(data,0,5),
39573 date-entered-on-file:s:range(data,0,5),
39574 pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
39575 pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
39576 pl:w:range(data,15,3), ta:w:range(data,22,1),
39577 ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
39578 lf:w:range(data,33,1), bio:w:range(data,34,1),
39579 ln:n:range(data,35,3), ctype:w:range(data,24,4),
39580 Record-source:w:range(data,39,0)</para></entry>
39584 <entry><para>010</para></entry>
39586 <entry><para>LC-card-number, Identifier-standard</para></entry>
39590 <entry><para>011</para></entry>
39592 <entry><para>LC-card-number, Identifier-standard</para></entry>
39596 <entry><para>015</para></entry>
39598 <entry><para>BNB-card-number, BGF-number, Number-db,
39599 Number-natl-biblio, Identifier-standard</para></entry>
39603 <entry><para>017</para></entry>
39605 <entry><para>Number-legal-deposit,
39606 Identifier-standard</para></entry>
39610 <entry><para>018</para></entry>
39612 <entry><para>Identifier-standard</para></entry>
39616 <entry><para>020$a</para></entry>
39618 <entry><para>ISBN:w, Identifier-standard:w</para></entry>
39622 <entry><para>020</para></entry>
39624 <entry><para>Identifier-standard</para></entry>
39628 <entry><para>022$a</para></entry>
39630 <entry><para>ISSN:w, Identifier-standard:w</para></entry>
39634 <entry><para>022</para></entry>
39636 <entry><para>Identifier-standard</para></entry>
39640 <entry><para>023</para></entry>
39642 <entry><para>Identifier-standard</para></entry>
39646 <entry><para>024$a</para></entry>
39648 <entry><para>Identifier-other</para></entry>
39652 <entry><para>024</para></entry>
39654 <entry><para>Identifier-standard</para></entry>
39658 <entry><para>025</para></entry>
39660 <entry><para>Identifier-standard</para></entry>
39664 <entry><para>027</para></entry>
39666 <entry><para>Report-number, Identifier-standard</para></entry>
39670 <entry><para>028</para></entry>
39672 <entry><para>Number-music-publisher,
39673 Identifier-standard</para></entry>
39677 <entry><para>030</para></entry>
39679 <entry><para>CODEN, Identifier-standard</para></entry>
39683 <entry><para>034</para></entry>
39685 <entry><para>Map-scale</para></entry>
39689 <entry><para>037</para></entry>
39691 <entry><para>Identifier-standard, Stock-number</para></entry>
39695 <entry><para>040</para></entry>
39697 <entry><para>Code-institution, Record-source</para></entry>
39701 <entry><para>041</para></entry>
39703 <entry><para>ln</para></entry>
39707 <entry><para>043</para></entry>
39709 <entry><para>Code-geographic</para></entry>
39713 <entry><para>050$b</para></entry>
39715 <entry><para>LC-call-number:w, LC-call-number:p,
39716 LC-call-number:s</para></entry>
39720 <entry><para>050</para></entry>
39722 <entry><para>LC-call-number:w, LC-call-number:p,
39723 LC-call-number:s</para></entry>
39727 <entry><para>052</para></entry>
39729 <entry><para>Geographic-class</para></entry>
39733 <entry><para>060</para></entry>
39735 <entry><para>NLM-call-number</para></entry>
39739 <entry><para>070</para></entry>
39741 <entry><para>NAL-call-number</para></entry>
39745 <entry><para>080</para></entry>
39747 <entry><para>UDC-classification</para></entry>
39751 <entry><para>082</para></entry>
39753 <entry><para>Dewey-classification:w,
39754 Dewey-classification:s</para></entry>
39758 <entry><para>086</para></entry>
39760 <entry><para>Number-govt-pub</para></entry>
39764 <entry><para>100$9</para></entry>
39766 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
39770 <entry><para>100$a</para></entry>
39772 <entry><para>Author,Author:p, Author:s, Editor,
39773 Author-personal-bibliography, Author-personal-bibliography:p,
39774 Author-personal-bibliography:s</para></entry>
39778 <entry><para>100</para></entry>
39780 <entry><para>Author, Author-title, Author-name-personal, Name,
39781 Name-and-title, Personal-name</para></entry>
39785 <entry><para>110$9</para></entry>
39787 <entry><para>Koha-Auth-Number</para></entry>
39791 <entry><para>110</para></entry>
39793 <entry><para>Author, Author-title, Author-name-corporate, Name,
39794 Name-and-title, Corporate-name</para></entry>
39798 <entry><para>111$9</para></entry>
39800 <entry><para>Koha-Auth-Number</para></entry>
39804 <entry><para>111</para></entry>
39806 <entry><para>Author, Author-title, Author-name-corporate, Name,
39807 Name-and-title, Conference-name</para></entry>
39811 <entry><para>130$n</para></entry>
39813 <entry><para>Thematic-number</para></entry>
39817 <entry><para>130$r</para></entry>
39819 <entry><para>Music-key</para></entry>
39823 <entry><para>130$9</para></entry>
39825 <entry><para>Koha-Auth-Number</para></entry>
39829 <entry><para>130</para></entry>
39831 <entry><para>Title, Title-uniform</para></entry>
39835 <entry><para>210</para></entry>
39837 <entry><para>Title, Title-abbreviated</para></entry>
39841 <entry><para>211</para></entry>
39843 <entry><para>Title, Title-abbreviated</para></entry>
39847 <entry><para>212</para></entry>
39849 <entry><para>Title, Title-other-variant</para></entry>
39853 <entry><para>214</para></entry>
39855 <entry><para>Title, Title-expanded</para></entry>
39859 <entry><para>222</para></entry>
39861 <entry><para>Title, Title-key</para></entry>
39865 <entry><para>240$r</para></entry>
39867 <entry><para>Music-key</para></entry>
39871 <entry><para>240$n</para></entry>
39873 <entry><para>Thematic-number</para></entry>
39877 <entry><para>240</para></entry>
39879 <entry><para>Title:w, Title:p, Title-uniform</para></entry>
39883 <entry><para>243$n</para></entry>
39885 <entry><para>Thematic-number</para></entry>
39889 <entry><para>243$r</para></entry>
39891 <entry><para>Music-key</para></entry>
39895 <entry><para>243</para></entry>
39897 <entry><para>Title:w, Title:p, Title-collective</para></entry>
39901 <entry><para>245$a</para></entry>
39903 <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
39904 Title:w, Title:p, Title:s</para></entry>
39908 <entry><para>245$c</para></entry>
39910 <entry><para>Author, Author-in-order:w, Author-in-order:p,
39911 Author-in-order:s</para></entry>
39915 <entry><para>245$9</para></entry>
39917 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
39921 <entry><para>245</para></entry>
39923 <entry><para>Title:w, Title:p</para></entry>
39927 <entry><para>246</para></entry>
39929 <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
39930 Title-former</para></entry>
39934 <entry><para>247</para></entry>
39936 <entry><para>Title, Title:p, Title-former, Title-other-variant,
39937 Related-periodical</para></entry>
39941 <entry><para>260$a</para></entry>
39943 <entry><para>pl:w, pl:p</para></entry>
39947 <entry><para>260$b</para></entry>
39949 <entry><para>Publisher:w, Publisher:p</para></entry>
39953 <entry><para>260$c</para></entry>
39955 <entry><para>copydate, copydate:s</para></entry>
39959 <entry><para>260</para></entry>
39961 <entry><para>pl</para></entry>
39965 <entry><para>300</para></entry>
39967 <entry><para>Extent:w, Extent:p</para></entry>
39971 <entry><para>400$a</para></entry>
39973 <entry><para>Name-and-title</para></entry>
39977 <entry><para>400$t</para></entry>
39979 <entry><para>Author-title, Name-and-title, Title,
39980 Title-series</para></entry>
39984 <entry><para>400$9</para></entry>
39986 <entry><para>Koha-Auth-Number</para></entry>
39990 <entry><para>400</para></entry>
39992 <entry><para>Author, Author-name-personal, Name,
39993 Personal-name</para></entry>
39997 <entry><para>410</para></entry>
39999 <entry><para>Author, Corporate-name</para></entry>
40003 <entry><para>410$a</para></entry>
40005 <entry><para>Name-and-title</para></entry>
40009 <entry><para>410$t</para></entry>
40011 <entry><para>Author-title, Title, Title-series</para></entry>
40015 <entry><para>410$9</para></entry>
40017 <entry><para>Koha-Auth-Number</para></entry>
40021 <entry><para>410</para></entry>
40023 <entry><para>Author-name-corporate, Name</para></entry>
40027 <entry><para>411</para></entry>
40029 <entry><para>Author, Conference-name</para></entry>
40033 <entry><para>411$a</para></entry>
40035 <entry><para>Name-and-title</para></entry>
40039 <entry><para>411$t</para></entry>
40041 <entry><para>Author-title, Title-series</para></entry>
40045 <entry><para>411</para></entry>
40047 <entry><para>Author-name-corporate, Name</para></entry>
40051 <entry><para>440$a</para></entry>
40053 <entry><para>Title-series:w, Title-series:p</para></entry>
40057 <entry><para>440$9</para></entry>
40059 <entry><para>Koha-Auth-Number</para></entry>
40063 <entry><para>440</para></entry>
40065 <entry><para>Title-series:w, Title-series:p, Title,
40066 Title-series</para></entry>
40070 <entry><para>490$a</para></entry>
40072 <entry><para>Title-series:w, Title-series:p</para></entry>
40076 <entry><para>490</para></entry>
40078 <entry><para>Title, Title-series</para></entry>
40082 <entry><para>490$9</para></entry>
40084 <entry><para>Koha-Auth-Number</para></entry>
40088 <entry><para>500</para></entry>
40090 <entry><para>Note:w, Note:p</para></entry>
40094 <entry><para>502</para></entry>
40096 <entry><para>Material-type</para></entry>
40100 <entry><para>505$r</para></entry>
40102 <entry><para>Author</para></entry>
40106 <entry><para>505$t</para></entry>
40108 <entry><para>Title</para></entry>
40112 <entry><para>505</para></entry>
40114 <entry><para>Note:w, Note:p</para></entry>
40118 <entry><para>510</para></entry>
40120 <entry><para>Indexed-by</para></entry>
40124 <entry><para>520</para></entry>
40126 <entry><para>Abstract:w, Abstract:p</para></entry>
40130 <entry><para>521$a</para></entry>
40132 <entry><para>lex:n</para></entry>
40136 <entry><para>526$c</para></entry>
40138 <entry><para>arl, arl:n</para></entry>
40142 <entry><para>526$d</para></entry>
40144 <entry><para>arp, arp:n</para></entry>
40148 <entry><para>590</para></entry>
40150 <entry><para>Note:w, Note:p</para></entry>
40154 <entry><para>600$a</para></entry>
40156 <entry><para>Name-and-title, Name, Personal-name,
40157 Subject-name-personal, Subject</para></entry>
40161 <entry><para>600$t</para></entry>
40163 <entry><para>Name-and-title, Title, Subject</para></entry>
40167 <entry><para>600$9</para></entry>
40169 <entry><para>Koha-Auth-Number</para></entry>
40173 <entry><para>600</para></entry>
40175 <entry><para>Name, Personal-name, Subject-name-personal,
40176 Subject</para></entry>
40180 <entry><para>610$a</para></entry>
40182 <entry><para>Name-and-title</para></entry>
40186 <entry><para>610$t</para></entry>
40188 <entry><para>Name-and-title, Title</para></entry>
40192 <entry><para>610$9</para></entry>
40194 <entry><para>Koha-Auth-Number</para></entry>
40198 <entry><para>610</para></entry>
40200 <entry><para>Name, Subject, Corporate-name</para></entry>
40204 <entry><para>611</para></entry>
40206 <entry><para>Conference-name</para></entry>
40210 <entry><para>611$a</para></entry>
40212 <entry><para>Name-and-title</para></entry>
40216 <entry><para>611$t</para></entry>
40218 <entry><para>Name-and-title, Title</para></entry>
40222 <entry><para>611$9</para></entry>
40224 <entry><para>Koha-Auth-Number</para></entry>
40228 <entry><para>611</para></entry>
40230 <entry><para>Name, Subject</para></entry>
40234 <entry><para>630$n</para></entry>
40236 <entry><para>Thematic-number</para></entry>
40240 <entry><para>630$r</para></entry>
40242 <entry><para>Music-key</para></entry>
40246 <entry><para>630$9</para></entry>
40248 <entry><para>Koha-Auth-Number</para></entry>
40252 <entry><para>630</para></entry>
40254 <entry><para>Subject</para></entry>
40258 <entry><para>650$9</para></entry>
40260 <entry><para>Koha-Auth-Number</para></entry>
40264 <entry><para>650</para></entry>
40266 <entry><para>Subject, Subject:p</para></entry>
40270 <entry><para>651$9</para></entry>
40272 <entry><para>Koha-Auth-Number</para></entry>
40276 <entry><para>651</para></entry>
40278 <entry><para>Name-geographic, Subject,Subject:p</para></entry>
40282 <entry><para>652$9</para></entry>
40284 <entry><para>Koha-Auth-Number</para></entry>
40288 <entry><para>653$9</para></entry>
40290 <entry><para>Koha-Auth-Number</para></entry>
40294 <entry><para>653</para></entry>
40296 <entry><para>Subject, Subject:p</para></entry>
40300 <entry><para>654$9</para></entry>
40302 <entry><para>Koha-Auth-Number</para></entry>
40306 <entry><para>654</para></entry>
40308 <entry><para>Subject</para></entry>
40312 <entry><para>655$9</para></entry>
40314 <entry><para>Koha-Auth-Number</para></entry>
40318 <entry><para>655</para></entry>
40320 <entry><para>Subject</para></entry>
40324 <entry><para>656$9</para></entry>
40326 <entry><para>Koha-Auth-Number</para></entry>
40330 <entry><para>656</para></entry>
40332 <entry><para>Subject</para></entry>
40336 <entry><para>657$9</para></entry>
40338 <entry><para>Koha-Auth-Number</para></entry>
40342 <entry><para>657</para></entry>
40344 <entry><para>Subject</para></entry>
40348 <entry><para>690$9</para></entry>
40350 <entry><para>Koha-Auth-Number</para></entry>
40354 <entry><para>690</para></entry>
40356 <entry><para>Subject, Subject:p</para></entry>
40360 <entry><para>700$9</para></entry>
40362 <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
40366 <entry><para>700$a</para></entry>
40368 <entry><para>Author, Author:p</para></entry>
40372 <entry><para>700$n</para></entry>
40374 <entry><para>Thematic-number</para></entry>
40378 <entry><para>700$r</para></entry>
40380 <entry><para>Music-key</para></entry>
40384 <entry><para>700$t</para></entry>
40386 <entry><para>Author-title, Name-and-title, Title,
40387 Title-uniform</para></entry>
40391 <entry><para>700</para></entry>
40393 <entry><para>Author, Author-name-corporate,
40394 Author-name-personal, Name, Editor, Personal-name</para></entry>
40398 <entry><para>710</para></entry>
40400 <entry><para>Author, Corporate-name</para></entry>
40404 <entry><para>710$t</para></entry>
40406 <entry><para>Author-title, Name-and-title, Title,
40407 Title-uniform</para></entry>
40411 <entry><para>710$a</para></entry>
40413 <entry><para>Name-and-title</para></entry>
40417 <entry><para>710$9</para></entry>
40419 <entry><para>Koha-Auth-Number</para></entry>
40423 <entry><para>710</para></entry>
40425 <entry><para>Author, Name</para></entry>
40429 <entry><para>711$a</para></entry>
40431 <entry><para>Name-and-title</para></entry>
40435 <entry><para>711$t</para></entry>
40437 <entry><para>Author-title, Title, Title-uniform</para></entry>
40441 <entry><para>711$9</para></entry>
40443 <entry><para>Koha-Auth-Number</para></entry>
40447 <entry><para>711</para></entry>
40449 <entry><para>Author-name-corporate, Name,
40450 Conference-name</para></entry>
40454 <entry><para>730$n</para></entry>
40456 <entry><para>Thematic-number</para></entry>
40460 <entry><para>730$r</para></entry>
40462 <entry><para>Music-key</para></entry>
40466 <entry><para>730$9</para></entry>
40468 <entry><para>Koha-Auth-Number</para></entry>
40472 <entry><para>730</para></entry>
40474 <entry><para>Title, Title-uniform</para></entry>
40478 <entry><para>740</para></entry>
40480 <entry><para>Title, Title-other-variant</para></entry>
40484 <entry><para>773$t</para></entry>
40486 <entry><para>Host-item</para></entry>
40490 <entry><para>780$t</para></entry>
40492 <entry><para>Title</para></entry>
40496 <entry><para>780</para></entry>
40498 <entry><para>Title, Title-former,
40499 Related-periodical</para></entry>
40503 <entry><para>785</para></entry>
40505 <entry><para>Related-periodical</para></entry>
40509 <entry><para>800$a</para></entry>
40511 <entry><para>Name-and-title</para></entry>
40515 <entry><para>800$t</para></entry>
40517 <entry><para>Author-title, Name-and-title, Title,
40518 Title-series</para></entry>
40522 <entry><para>800$9</para></entry>
40524 <entry><para>Koha-Auth-Number</para></entry>
40528 <entry><para>800</para></entry>
40530 <entry><para>Author, Author-name-personal, Name,
40531 Personal-name</para></entry>
40535 <entry><para>810$a</para></entry>
40537 <entry><para>Name-and-title</para></entry>
40541 <entry><para>810$t</para></entry>
40543 <entry><para>Author-title, Name-and-title, Title,
40544 Title-series</para></entry>
40548 <entry><para>810$9</para></entry>
40550 <entry><para>Koha-Auth-Number</para></entry>
40554 <entry><para>810</para></entry>
40556 <entry><para>Author, Corporate-name, Author-name-corporate,
40557 Name</para></entry>
40561 <entry><para>811$a</para></entry>
40563 <entry><para>Name-and-title</para></entry>
40567 <entry><para>811$9</para></entry>
40569 <entry><para>Koha-Auth-Number</para></entry>
40573 <entry><para>811$t</para></entry>
40575 <entry><para>Author-title, Name-and-title, Title,
40576 Title-series</para></entry>
40580 <entry><para>811</para></entry>
40582 <entry><para>Author, Author-name-corporate, Name,
40583 Conference-name</para></entry>
40587 <entry><para>830$9</para></entry>
40589 <entry><para>Koha-Auth-Number</para></entry>
40593 <entry><para>830</para></entry>
40595 <entry><para>Title, Title-series</para></entry>
40599 <entry><para>840</para></entry>
40601 <entry><para>Title, Title-series</para></entry>
40605 <entry><para>999$c</para></entry>
40607 <entry><para>Local-Number:n, Local-Number:w,
40608 Local-Number:s</para></entry>
40612 <entry><para>999$d</para></entry>
40614 <entry><para>biblioitemnumber:n, biblioitemnumber:w,
40615 biblioitemnumber:s</para></entry>
40619 <entry><para>942$0</para></entry>
40621 <entry><para>totalissues:n, totalissues:s</para></entry>
40625 <entry><para>942$2</para></entry>
40627 <entry><para>cn-bib-source</para></entry>
40631 <entry><para>942$6</para></entry>
40633 <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
40637 <entry><para>942$c</para></entry>
40639 <entry><para>itemtype:w</para></entry>
40643 <entry><para>942$n</para></entry>
40645 <entry><para>Suppress:w, Suppress:n</para></entry>
40649 <entry><para>942$h</para></entry>
40651 <entry><para>cn-class</para></entry>
40655 <entry><para>942$i</para></entry>
40657 <entry><para>cn-item</para></entry>
40661 <entry><para>942$k</para></entry>
40663 <entry><para>cn-prefix</para></entry>
40667 <entry><para>942$m</para></entry>
40669 <entry><para>cn-suffix</para></entry>
40673 <entry><para>952$0</para></entry>
40675 <entry><para>withdrawn:n, withdrawn:w</para></entry>
40679 <entry><para>952$1</para></entry>
40681 <entry><para>lost, lost:n</para></entry>
40685 <entry><para>952$2</para></entry>
40687 <entry><para>classification-source</para></entry>
40691 <entry><para>952$3</para></entry>
40693 <entry><para>materials-specified</para></entry>
40697 <entry><para>952$4</para></entry>
40699 <entry><para>damaged:n, damaged:w</para></entry>
40703 <entry><para>952$5</para></entry>
40705 <entry><para>restricted:n, restricted:w</para></entry>
40709 <entry><para>952$6</para></entry>
40711 <entry><para>cn-sort:n, cn-sort:s</para></entry>
40715 <entry><para>952$7</para></entry>
40717 <entry><para>notforloan:n, notforloan:w</para></entry>
40721 <entry><para>952$8</para></entry>
40723 <entry><para>ccode</para></entry>
40727 <entry><para>952$9</para></entry>
40729 <entry><para>itemnumber:n, itemnumber:s</para></entry>
40733 <entry><para>952$a</para></entry>
40735 <entry><para>homebranch</para></entry>
40739 <entry><para>952$b</para></entry>
40741 <entry><para>holdingbranch</para></entry>
40745 <entry><para>952$c</para></entry>
40747 <entry><para>location</para></entry>
40751 <entry><para>952$d</para></entry>
40753 <entry><para>Date-of-acquisition, Date-of-acquisition:d,
40754 Date-of-acquisition:s</para></entry>
40758 <entry><para>952$e</para></entry>
40760 <entry><para>acqsource</para></entry>
40764 <entry><para>952$f</para></entry>
40766 <entry><para>coded-location-qualifier</para></entry>
40770 <entry><para>952$g</para></entry>
40772 <entry><para>price</para></entry>
40776 <entry><para>952$j</para></entry>
40778 <entry><para>stack:n, stack:w</para></entry>
40782 <entry><para>952$l</para></entry>
40784 <entry><para>issues:n, issues:w, issues:s</para></entry>
40788 <entry><para>952$m</para></entry>
40790 <entry><para>renewals:n, renewals:w</para></entry>
40794 <entry><para>952$n</para></entry>
40796 <entry><para>reserves:n, reserves:w</para></entry>
40800 <entry><para>952$o</para></entry>
40802 <entry><para>Local-classification:w, Local-classification:p,
40803 Local-classification:s</para></entry>
40807 <entry><para>952$p</para></entry>
40809 <entry><para>barcode, barcode:n</para></entry>
40813 <entry><para>952$q</para></entry>
40815 <entry><para>onloan:n, onloan:w</para></entry>
40819 <entry><para>952$r</para></entry>
40821 <entry><para>datelastseen</para></entry>
40825 <entry><para>952$s</para></entry>
40827 <entry><para>datelastborrowed</para></entry>
40831 <entry><para>952$t</para></entry>
40833 <entry><para>copynumber</para></entry>
40837 <entry><para>952$u</para></entry>
40839 <entry><para>uri:u</para></entry>
40843 <entry><para>952$v</para></entry>
40845 <entry><para>replacementprice</para></entry>
40849 <entry><para>952$w</para></entry>
40851 <entry><para>replacementpricedate</para></entry>
40855 <entry><para>952$y</para></entry>
40857 <entry><para>itype:w</para></entry>
40861 <entry><para>952$z</para></entry>
40863 <entry><para>Note:w, Note:p</para></entry>
40870 <chapter id="pluginsystem">
40871 <title>Plugin System</title>
40872 <para>Koha's Plugin System allows for you to add additional tools and reports to Koha that are
40873 specific to your library. Plugins are installed by uploading KPZ ( Koha Plugin Zip ) packages.
40874 A KPZ file is just a zip file containing the perl files, template files, and any other files
40875 necessary to make the plugin work.</para>
40876 <para>The plugin system needs to be turned on by a system administrator. </para>
40877 <section id="pluginsetup">
40878 <title>Set up</title>
40879 <para>To set up the Koha plugin system you must first make some changes to your install.<itemizedlist>
40881 <para>Create the directory /var/lib/koha/plugins</para>
40884 <para>Add the lines <pluginsdir>/var/lib/koha/plugins</pluginsdir>
40885 <enable_plugins>1</enable_plugins>" to your koha-conf.xml file</para>
40888 <para>Add the line Alias /plugin/ "/var/lib/koha/plugins/" to your koha-httpd.conf
40892 <para>Restart your webserver</para>
40894 </itemizedlist>Once set up is complete you will need to alter your <link linkend="UseKohaPlugins">UseKohaPlugins</link> system preference to be able to see a
40895 Plugins option under the More menu on your toolbar. On the Tools page you will see the
40896 Tools Plugins and on the Reports page you will see the Reports Plugins.</para>
40900 <chapter id="aboutkoha">
40901 <title>About Koha</title>
40903 <para>The 'About Koha' area will give you important server information as
40904 well as general information about Koha.</para>
40908 <para><emphasis>Get there:</emphasis> More > About Koha</para>
40912 <section id="aboutserver">
40913 <title>Server Information</title>
40915 <para>Under the 'Server Information' tab you will find information about
40916 the Koha version and the machine you have installed Koha on. This
40917 information is very important for debugging problems. When reporting
40918 issues to your support provider or to the various other support avenues
40919 (mailing lists, chat room, etc), it's always good to give the
40920 information from this screen.</para>
40923 <screeninfo>Server Information on Koha</screeninfo>
40927 <imagedata fileref="images/about/aboutserver.png"/>
40933 <section id="aboutserverperl">
40934 <title>Perl Modules</title>
40936 <para>In order to take advantage of all of the functionalities of Koha,
40937 you will need to keep your Perl modules up to date. The 'Perl Modules'
40938 tab will show you all of the modules required by Koha, the version you
40939 have installed and whether you need to upgrade certain modules.</para>
40942 <screeninfo>Perl Modules</screeninfo>
40946 <imagedata fileref="images/about/aboutperlmodules.png"/>
40951 <para>Items listed in bold are required by Koha, items highlighed in red
40952 are missing completely and items highlighted in yellow simply need to be
40956 <section id="aboutsystem">
40957 <title>System Information</title>
40959 <para>This tab will provide you with warnings if you are using system
40960 preferences that have since been deprecated or system preferences that
40961 you have set without other required preferences</para>
40964 <screeninfo>System Information</screeninfo>
40968 <imagedata fileref="images/about/systeminfo.jpg"/>
40975 <chapter id="implementation">
40976 <title>Implementation Checklist</title>
40978 <para>The following guide will walk you through the areas of Koha you need
40979 to look at in order to prepare to start using the system.</para>
40981 <section id="imp-migration">
40982 <title>Data Migration</title>
40984 <para>Before you can start using Koha you'll need to have some data.
40985 This can be done by entering it all by hand, but most people already
40986 have their data in electronic format of some sort and just need to
40987 reformat it a bit for importing into Koha.</para>
40991 <para>Create a list of libraries and enter their info and codes into
40992 <link linkend="libsgroups">Libraries & Groups</link></para>
40996 <para>Define your list of <link linkend="itemtypeadmin">Item
40997 Types</link></para>
41001 <para>Define you patron categories and enter the categories and
41002 their codes into <link linkend="patcats">Patron
41003 Categories</link></para>
41007 <para>Enter any additional patron information fields you use in your
41008 library in the <link linkend="patronattributetypes">Patron
41009 Attributes</link></para>
41013 <para>Requires that you first set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
41014 system preference if you have custom fields</para>
41020 <para>Define all of your <link linkend="authorizedvalues">Authorized
41021 Values</link></para>
41025 <para><link linkend="ccode">Collection codes</link></para>
41029 <para><link linkend="shelvelocvals">Shelving
41030 locations</link></para>
41034 <para>Item statuses (<link linkend="lost">lost</link>, <link linkend="notforloan">not
41035 for loan</link>, <link linkend="damageauth">damaged</link>, <link linkend="withdrawnauth">withdrawn</link>)</para>
41039 <para>Plus any others that are needed in your library</para>
41045 <para>Optionally define <link linkend="citytowns">City/State/Postal Code</link> combos </para>
41049 <para><link linkend="kohamarcmapping">Map your bibliographic
41050 data</link> from your legacy system to Koha fields and migrate
41051 (remembering to use the collection, shelving, item type and library
41052 codes you entered in the above setting areas)</para>
41056 <para><link linkend="patronimport">Map your patron data</link> from
41057 your legacy system to the Koha fields and migrate (remembering to
41058 use the patron and library codes you defined above)</para>
41062 <para>Test your migrated data to be sure that everything is as you
41063 expect it to be, some things to test include:</para>
41067 <para>Check some of your titles with diacritics and make sure
41068 that they migrated properly.</para>
41072 <para>Check titles in a series and make sure that series
41073 information migrated properly.</para>
41077 <para>Make sure that your patrons have their contact information
41078 in the right fields.</para>
41082 <para>If your serials data was migrated search for these records
41083 in the catalog and confirm that they look right.</para>
41087 <para>If your serials data was migrated search for these records
41088 in the serials module and confirm that they look right.</para>
41092 <para>Check marc records to verify a variety of items are
41093 cataloged correctly</para>
41097 <para>Check cataloging process to see if all necessary fields
41098 are available</para>
41102 <para>If fines are migrated, check to see that they are applied
41107 <para>If holds are migrated, check to see they are accurate in
41108 catalog and patron record</para>
41115 <section id="impadmin">
41116 <title>Admin Configuration</title>
41118 <para>Most of these preferences won't need to be changed to use your
41119 Koha system, but there are a few that you might want to
41124 <para>If your library uses CAS Authentication, you'll want to set
41125 the various <link linkend="casauthentication">CAS system
41126 preferences</link></para>
41130 <para>Administration System Preferences</para>
41134 <para><link linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
41135 This is the email address that will be used by the system in
41136 'from' lines and to send errors to if there is no email set for
41141 <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
41142 Decide if you want to show item type icons in the staff client
41147 <para><link linkend="delimiter">delimiter</link> : This value
41148 will be put in between fields when exporting data from
41153 <para><link linkend="virtualshelves">virtualshelves</link> :
41154 Decide if you want the staff and/or patrons to use lists in
41159 <para><link linkend="AutoLocation">AutoLocation</link> : Require
41160 staff to log in to the staff client from a specific IP
41165 <para><link linkend="IndependentBranches">IndependentBranches</link> : Prevent
41166 librarians from editing content that belongs to other branches</para>
41172 <para>Go through the <link linkend="logs">Log System
41173 Preferences</link> and decide which actions you want to keep track
41174 of in the logs</para>
41179 <section id="implocal">
41180 <title>Localization Configuration</title>
41182 <para>Koha is used worldwide and so you need to make sure you set your
41183 localization preferences so that options throughout Koha appear properly
41184 for your location/language.</para>
41188 <para>Localization/Internationalization System Preferences</para>
41192 <para><link linkend="dateformat">dateformat</link> : Decide how
41193 dates are displayed throughout Koha</para>
41197 <para><link linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
41198 Decide if patrons can choose what language the OPAC appears
41203 <para><link linkend="opaclanguages">opaclanguages</link> :
41204 Decide which languages the patrons can choose from</para>
41210 <para><link linkend="languagepref">language</link> : Decide
41211 which languages appear in the staff client</para>
41215 <para><link linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
41216 Define your first day of the week</para>
41223 <section id="impcirc">
41224 <title>Circulation Configuration</title>
41226 <para>Before you start circulating your collection you'll need to set up
41227 your rules and preferences for circulation.</para>
41231 <para>Define you <link linkend="circfinerules">Circulation/Fine
41232 rules</link></para>
41236 <para>Enter the <link linkend="calholidays">days your library is
41237 closed</link> for fines and due date calculations</para>
41241 <para>Circulation System Preferences</para>
41245 <para><link linkend="CircControl">CircControl</link> : Define
41246 whether circ rules are based on item's location, patron's
41247 location or transaction location</para>
41251 <para><link linkend="useDaysMode">useDaysMode</link> : Define
41252 how due dates are calculated</para>
41256 <para><link linkend="finesCalendar">finesCalendar</link> :
41257 Define how fines are calculated (for every late date or only for
41258 days the library is open)</para>
41262 <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> : Decide if staff are
41263 allowed to override due dates on checkout</para>
41266 <para><link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link> :
41267 Decide if you want staff to be able to checkout using a keyword search (title, call
41268 number, etc)</para>
41272 <para><link linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
41273 Decide if items are sent back to the owning branch when checked
41278 <para><link linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
41279 : Decide how items checked out today display on the patron
41284 <para><link linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
41285 : Decide how items checked out prior to today display on the
41286 patron record</para>
41290 <para><link linkend="noissuescharge">noissuescharge</link> :
41291 Define the maximum amount a patron can owe before checkouts are
41296 <para><link linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
41297 if patrons need to return items before their accounts
41302 <para><link linkend="AllowOnShelfHolds">AllowOnShelfHolds</link>
41303 : Decide if patrons can place holds on items that are marked as
41304 being available</para>
41308 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41309 : Decide if you want the staff to be able to override the
41310 setting for the above at checkout</para>
41316 <para><link linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
41317 : Decide if patrons can place holds on items that are marked as
41322 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41323 : Decide if you want the staff to be able to override the
41324 setting for the above at checkout</para>
41330 <para><link linkend="maxreserves">maxreserves</link> : Decide
41331 how many items a patron can have on hold at once</para>
41335 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41336 : Decide if you want the staff to be able to override the
41337 setting for the above at checkout</para>
41343 <para><link linkend="maxoutstanding">maxoutstanding</link> :
41344 Define the maximum amount a patron can owe before holds are
41349 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
41350 : Decide if you want the staff to be able to override the
41351 setting for the above at checkout</para>
41357 <para><link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
41358 Define the number of days before a hold expires</para>
41362 <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
41363 : Decide if you want to use the built in web-based self-checkout
41368 <para><link linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
41369 Decide if the self-checkout system requires login</para>
41373 <para><link linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
41374 : Decide if you want patron images to show on the self
41375 checkout screen</para>
41381 <para><link linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
41382 : Decide if you want the staff to be able to checkout items
41383 marked as 'not for loan'</para>
41387 <para><link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
41388 : Decide if you want staff to override the limit put on
41393 <para><link linkend="AllowFineOverride">AllowFineOverride</link> : Decide if you want
41394 staff to be able to override fine limits</para>
41397 <para><link linkend="AllowTooManyOverride">AllowTooManyOverride</link> : Descide if
41398 you want staff to be able to check out more than the limit to a patron</para>
41402 <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
41403 : Decide what date renewals are based on</para>
41407 <para><link linkend="finesMode">finesMode</link> : Switch to
41408 'Calculate and Charge' before go live if you charge fines</para>
41412 <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
41413 If you want to receive a copy of every overdue notice sent out,
41414 enter your email address here</para>
41418 <para><link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
41419 : Decide if you want an email every time a hold is placed</para>
41423 <para><link linkend="ReservesControlBranch">ReservesControlBranch</link> :
41424 Decide which branch's hold rules are considered first</para>
41428 <para><link linkend="soundon">soundon</link> : Decide if you
41429 want to have sounds on for circulation actions</para>
41433 <para><link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
41434 : If you have a large amount of overdues, you might want to turn
41435 this preference on so as to allow you to filter before results
41440 <para><link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
41441 : If you have a lot of staff members sharing one circ computer
41442 you might want to enable this so that staff can clear the screen
41443 in between checkouts to protect patron's privacy</para>
41447 <para><link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
41448 Decide how you want Koha to react if you scan in a blank barcode
41449 on the checkout screen</para>
41453 <para><link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
41454 and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
41455 : Decide if you want patrons and/or staff to be able to suspend
41460 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
41461 : If you allow holds to be suspended decide if you want them
41462 to automatically resume on the date entered by the staff
41463 and/or patron</para>
41471 <para>Customize your <link linkend="notices">Notices &
41472 Slips</link></para>
41476 <para>Define your <link linkend="noticetriggers">Overdue Notice
41477 Triggers</link></para>
41481 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
41485 <para>Populate <link linkend="buildholdscron">your holds
41486 queue</link> (every 1-4 hours)</para>
41490 <para>Decide <link linkend="expiredholdscron">when holds
41491 expire</link> (daily)</para>
41495 <para><link linkend="finescronjob">Calculate fines due</link>
41500 <para>Fines on hourly loans will calculate when you check
41501 the items in</para>
41507 <para><link linkend="longoverduecron">Mark long overdue items as
41508 lost</link> (daily)</para>
41512 <para>Decide when the system <link linkend="msgqueuecron">sends
41513 out messages</link> (1-4 hours)</para>
41517 <para>Decide when the system <link linkend="overduenoticecron">queues overdue notices</link>
41522 <para>Set up <link linkend="printholdcron">hold notices that
41523 didn't send for printing</link> (daily after overdues and
41524 message queue)</para>
41528 <para>Decide when the system <link linkend="advnoticecron">queues the advanced notice of items
41529 due</link> (daily)</para>
41533 <para>Find holds that need to be <link linkend="unsuspendholdcron">resumed and remove suspension</link>
41541 <section id="imppratrons">
41542 <title>Patron Configuration</title>
41544 <para>You have already imported patron data from your old system, but
41545 there are plenty of options available to you regarding patrons and their
41550 <para>Enter your <link linkend="addstaffpatron">staff members as
41551 patrons</link></para>
41555 <para>Define <link linkend="patronpermissions">staff members
41556 access permissions</link></para>
41562 <para>Patron System Preferences</para>
41566 <para><link linkend="AddPatronLists">AddPatronLists</link> :
41567 Decide how patron categories appear when creating a new
41572 <para><link linkend="autoMemberNum">autoMemberNum</link> :
41573 Decide if the patrons barcodes are auto-generated or if you
41574 enter them yourself</para>
41578 <para><link linkend="MaxFine">MaxFine</link> : Determine the
41579 maximum amount that people can owe in fines</para>
41583 <para><link linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
41584 : Decide when to warn staff that the patron account is about to
41589 <para><link linkend="intranetreadinghistory">intranetreadinghistory</link> :
41590 Decide if the staff can see the patron's reading/checkout
41595 <para><link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
41596 List fields that you want to appear as mandatory on the patron
41597 add/edit form</para>
41601 <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
41602 Add or change the titles for your patrons</para>
41606 <para><link linkend="borrowerRelationship">borrowerRelationship</link> : Add
41607 or change borrower relationships (child to adult and
41608 professional to organization)</para>
41612 <para><link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
41613 : Determine if the patrons get an email confirming the creation
41614 of their account</para>
41618 <para><link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
41619 : Decide if patrons can choose from a series of notices (other
41620 than overdues)</para>
41624 <para><link linkend="patronimages">patronimages</link> : Decide
41625 if you want to save patron images in your system</para>
41629 <para><link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
41630 : Decide if you want to enable custom patron fields</para>
41634 <para><link linkend="minPasswordLength">minPasswordLength</link>
41635 : Enter the minimum number of characters you want passwords to
41640 <para><link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
41641 Decide what fields your library doesn't need to see on the
41642 patron entry form</para>
41649 <section id="impcatalog">
41650 <title>Cataloging Configuration</title>
41652 <para>Before you start cataloging in Koha you'll want to set up your
41653 preferences and other rules.</para>
41657 <para>Define your cataloging templates aka <link linkend="marcbibframeworks">MARC Bibliographic
41658 Frameworks</link></para>
41662 <para>Run the <link linkend="marcbibframeworkstest">MARC
41663 Bibliographic Framework Test</link> to be sure your changes are
41670 <para>Define any <link linkend="authorizedvalues">authorized
41671 values</link> you might want to use in cataloging</para>
41675 <para>Set up <link linkend="classificationsources">custom
41676 classification sources</link> (if you use something other than the
41681 <para>Set up <link linkend="recordmatchingrules">MARC matching rules</link> for importing
41682 records from mrc files or Z39.50</para>
41686 <para>Set up <link linkend="keywordmapping">Koha to Keyword
41687 mapping</link> for deciding how to display marc fields to the screen
41688 (still in beta - only one field)</para>
41692 <para>Set up the <link linkend="z3950admin">Z39.50 targets</link> you want to search for
41693 cataloging (and acquisitions)</para>
41697 <para>Cataloging System Preferences</para>
41701 <para><link linkend="URLLinkText">URLLinkText</link> : Enter
41702 text to display when 856 fields do not have pre-defined
41707 <para><link linkend="hide_marc">hide_marc</link> : If you are
41708 unfamiliar with MARC you can have the MARC fields number
41713 <para><link linkend="LabelMARCView">LabelMARCView</link> :
41714 Choose how you want duplicate fields to appear on the
41719 <para><link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
41720 : Choose which classification source is the default in your
41725 <para><link linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
41726 if you need labels to appear on your MARC editor</para>
41730 <para><link linkend="marcflavour">marcflavour</link> : Choose
41731 your MARC format</para>
41735 <para><link linkend="itemcallnumber">itemcallnumber</link> :
41736 Enter which field and subfields to look into for the call
41741 <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
41742 your MARC Organizational Code (not the same as your OCLC
41747 <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
41748 Koha generates item barcodes for you</para>
41752 <para><link linkend="OpacSuppression">OpacSuppression</link> :
41753 Decide if you want to hide items marked as suppressed from the
41754 OPAC search results</para>
41760 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
41764 <para>Decide when the system <link linkend="checkurlcron">checks
41765 URLs in catalog records</link> to see if they are still
41773 <section id="impauthorities">
41774 <title>Authorities Configuration</title>
41776 <para>Koha has the ability to keep track of your authority records and
41777 how they're linked to your bibliographic records. Before using
41778 authorities you should configure several preferences.</para>
41782 <para>Set <link linkend="authoritiesadmin">Authority
41783 Frameworks</link> aka templates</para>
41787 <para>Authority System Preferences</para>
41791 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
41792 Decide if Koha creates authorities when cataloging</para>
41796 <para><link linkend="dontmerge">dontmerge</link> : Decide if
41797 updates to authorities trigger updates to the bibliographic
41798 records that link to them</para>
41802 <para><link linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
41803 Decide when authorities are created</para>
41807 <para><link linkend="LinkerModule">LinkerModule</link> : Decide
41808 which match the authority linker should use</para>
41812 <para><link linkend="LinkerOptions">LinkerOptions</link> :
41813 Decide if you want authority linking to be broader or more
41818 <para><link linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
41819 Decide if you want to enable authority linking while
41826 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
41830 <para>Choose when the system looks for authorities updates to
41831 <link linkend="mergeauthcron">merge changes into bibliographic
41832 records</link></para>
41839 <section id="impsearching">
41840 <title>Searching Configuration</title>
41842 <para>There are several system preferences related to searching, it is
41843 not always recommended to make too many changes to these preferences
41844 since they are set to get you the most relevant results. If you would
41845 like to change the default way that Koha handles searching, view the
41846 <link linkend="searchingprefs">Searching system preferences</link>
41851 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
41855 <para>Decide how often your <link linkend="rebuildsearchcron">system rebuilds the search
41856 index</link> (4-10 min)</para>
41862 <para>Searching System Preferences</para>
41866 <para><link linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> : Decide which
41867 authorized value fields you want patrons and staff to be able to limit their
41868 advanced searches by</para>
41871 <para><link linkend="AdvancedSearchLanguages">AdvancedSearchLanguages</link> : Decide
41872 which languages you want people to be able to limit to via the search engine</para>
41876 <para><link linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
41877 : Decide how you want Koha to handle subject searches in the
41882 <para><link linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
41883 : Decide how you want Koha to handle subject searches in the
41888 <para><link linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
41889 : Decide how you want Koha to handle subject searches in the
41896 <para><link linkend="displayFacetCount">displayFacetCount</link>
41897 : Decide whether to show facet counts on search results</para>
41904 <section id="impopac">
41905 <title>OPAC Configuration</title>
41907 <para>There are a lot of ways you can customize your OPAC in
41912 <para>Decide how you want your OPAC to look & what content you
41913 want on the main page</para>
41917 <para>Create a library branded stylesheet using CSS</para>
41922 <para>Do not edit the default CSS files, instead create a new
41923 one, that way the system can always fall back on the original
41931 <para>Create a custom XSLT stylesheet to change the way search
41932 results and bib records appear in the OPAC</para>
41936 <para>OPAC System preferences</para>
41940 <para><link linkend="opacuserlogin">opacuserlogin</link> :
41941 Decide if you want to allow patrons to login to the OPAC to
41942 access customized functionality (searching will be allowed
41943 without logging in)</para>
41947 <para><link linkend="RequestOnOpac">RequestOnOpac</link> :
41948 Decide if patrons can place holds via the OPAC</para>
41952 <para><link linkend="OPACItemHolds">OPACItemHolds</link> :
41953 Decide if patrons can place holds on specific items (instead
41954 of just the next available item)</para>
41958 <para><link linkend="OpacPasswordChange">OpacPasswordChange</link> :
41959 Decide if patrons can change their password (don't allow
41960 this if you're using LDAP)</para>
41964 <para><link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> :
41965 Decide if patrons can renew their checked out items via the
41970 <para><link linkend="opacreadinghistory">opacreadinghistory</link> :
41971 Decide if patrons can view their reading/checkout history
41972 via the OPAC</para>
41976 <para><link linkend="reviewson">reviewson</link> : Decide if
41977 you want to allow patrons to comment on bib records via the
41982 <para><link linkend="OpacStarRatings">OpacStarRatings</link>
41983 : Decide if patrons can leave star ratings</para>
41987 <para><link linkend="virtualshelves">virtualshelves</link> :
41988 Decide if you want patrons to be able to create Lists</para>
41992 <para><link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
41993 : If patrons can create lists then decide if they are
41994 allowed to create public lists</para>
41998 <para><link linkend="suggestionspref">suggestion</link> :
41999 Decide if you want patrons to be able to submit purchase
42004 <para><link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
42005 : Decide if you want patrons to be able to see purchase
42006 suggestions made by other patrons</para>
42012 <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
42013 patrons can save items into their cart</para>
42017 <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
42018 Decide if you want non logged in users to be able to make
42019 purchase suggestions</para>
42023 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> :
42024 Decide if you want to use the XSLT stylesheets on the OPAC
42025 search results</para>
42029 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> :
42030 Decide if you want to use the XSLT stylesheets on the bib
42031 records in the OPAC</para>
42035 <para><link linkend="LibraryName">LibraryName</link> : Enter
42036 your library name for display in the <title> tag and on
42037 the top of the OPAC</para>
42041 <para><link linkend="opacsmallimage">opacsmallimage</link> :
42042 Choose a logo to replace the Koha logo</para>
42046 <para><link linkend="opaccredits">opaccredits</link> : Enter
42047 HTML to appear at the bottom of every page in the OPAC</para>
42051 <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
42052 : Enter HTML that will appear in the center of the main OPAC
42057 <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
42058 will appear to the left on the main OPAC page</para>
42062 <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
42063 HTML that will appear below OpacNav</para>
42067 <para><link linkend="OpacNavRight">OpacNavRight</link> : Enter
42068 HTML that will appear below the login box on the right</para>
42072 <para><link linkend="opacheader">opacheader</link> : Enter the
42073 HTML that will appear above the search box on the OPAC</para>
42077 <para><link linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
42078 the HTML that will appear when no results are found</para>
42082 <para><link linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
42083 the HTML that will appear below the facets on your search
42088 <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
42089 : Enter the HTML that will appear in the far right of the
42090 circulation summary in the OPAC</para>
42094 <para>Customize your stylesheets:</para>
42098 <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
42099 any additional fields you want to define styles for</para>
42103 <para><link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
42104 Point to a CSS file on your Koha server</para>
42108 <para><link linkend="opaccolorstylesheet">opaccolorstylesheet</link> :
42109 Point to a CSS file on your Koha server</para>
42115 <para><link linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
42116 Decide if you want search terms to be highlighted on the search
42121 <para><link linkend="hidelostitems">hidelostitems</link> :
42122 Decide if you want to show patrons items you have marked as
42127 <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
42128 : Decide what view is the default for bib records on the
42133 <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> : Decide if you want to
42134 enable the shelf browse functionality</para>
42137 <para><link linkend="opacthemes">opacthemes</link> : Choose which theme you would like
42138 to use. If you would like a responsive theme pick 'bootstrap'.</para>
42142 <para><link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
42143 Decide if URLs clicked in the OPAC are opened in a new
42148 <para><link linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
42149 you have a multi-branch system decide if you want patrons to
42150 search their library first</para>
42154 <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
42155 Decide if you want patrons to be able to search your authority
42160 <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if
42161 you want patrons to browse your authority file</para>
42165 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
42166 Choose which libraries you want patrons to be able to re-run
42167 their search in</para>
42171 <para><link linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
42172 : If you're a multi-branch system you can add a pull down to the
42173 search bar for patrons to search which library to search</para>
42177 <para><link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
42178 : Decide if you want the system to keep a search history</para>
42184 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
42188 <para>If you have the <link linkend="OpacBrowser">OpacBrowser</link> preference set decide
42189 <link linkend="authbrowsercron">when you want the contents to
42190 rebuild</link></para>
42194 <para>If you have <link linkend="customrss">custom RSS
42195 feeds</link>, decide when you want the <link linkend="customrssfeedcron">feed to be populated</link></para>
42201 <section id="editableopac">
42202 <title>Editable OPAC Regions</title>
42204 <para>Using the OPAC system preferences you can customize various regions, the following
42205 graphic will define what preferences update each of the regions in the Bootstrap
42209 <screeninfo>OPAC Editable Regions</screeninfo>
42213 <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
42220 <section id="impenhanced">
42221 <title>Enhanced Content Configuration</title>
42223 <para>Koha allows you to pull in content from outside sources to enhance
42224 your bib records. All of this content can be toggled on and off using
42225 the enhanced content system preferences.</para>
42229 <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
42233 <para>If you would like to have your OPAC and/or staff client
42234 show an 'Editions' tab on the bib record, you want to enable one
42235 or the other FRBR preferences and then either one or both of the
42236 ISBN services (XISBN and ThingISBN).</para>
42242 <para><link linkend="amazonprefs">Amazon</link> : This service is
42243 free and just requires that you visit <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
42248 <para>Using the Amazon preferences you can choose to show cover
42249 images from Amazon.</para>
42255 <para><link linkend="Babelthequeprefs">Babelthèque</link></para>
42259 <para>This is a pay service. Contact Babelthèque to learn how to
42260 enable this content in the OPAC.</para>
42266 <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
42270 <para>This is a pay service from Baker & Taylor. Contact
42271 Baker & Taylor for the information to enter into these
42272 preferences.</para>
42278 <para><link linkend="googleprefs">Google</link></para>
42282 <para>This service is free and does not require registration,
42283 simply enable GoogleJackets and you're set to go.</para>
42289 <para><link linkend="IDreamLibraries">I Deam Books</link><itemizedlist>
42291 <para>This is a free service that compiles reviews for popular titles from many
42292 different sources.</para>
42294 </itemizedlist></para>
42297 <para><link linkend="librarythingprefs">LibraryThing</link></para>
42300 <para>With the exception of ThingISBN, you will need to contact LibraryThing for the
42301 information to enter into these preferences</para>
42304 <para>Enabling ThingISBN will help to populate the editions tab on the bib record
42305 display if you have enabled FRBR.</para>
42311 <para><link linkend="novelistselect">Novelist</link></para>
42315 <para>This is a pay service from Ebsco. Contact Ebsco for the
42316 information to enter into these preferences</para>
42322 <para><link linkend="oclcprefs">OCLC</link></para>
42325 <para>XISBN is used to populate the editions tab on the bib record display if you have
42326 enabled FRBR. This service is free for up to 999 queries a day.</para>
42331 <para><link linkend="OpenLibraryPrefs">Open Library</link><itemizedlist>
42333 <para>Open Library project is an open system that you can pull cover images (and in
42334 the future additional content) from</para>
42336 </itemizedlist></para>
42340 <para><link linkend="Syndeticsprefs">Syndetics</link></para>
42344 <para>This is a pay service from Syndetics to add content for
42345 your bib records. Contact Syndetics for the information to enter
42346 into these preferences.</para>
42352 <para><link linkend="taggingprefs">Tagging</link></para>
42356 <para>Choose whether or not you want to allow patrons to add
42357 tags to records in Koha.</para>
42364 <section id="impacq">
42365 <title>Acquisitions Configuration</title>
42367 <para>When using acquisitions in Koha you first need to define some
42372 <para>Set up your <link linkend="budgetplanning">funds &
42373 budgets</link></para>
42377 <para>Choose your <link linkend="currexchangeadmin">default
42378 currency</link> and enter others if you order from multiple
42383 <para>Enter in your <link linkend="acqvendors">vendor
42384 information</link></para>
42388 <para>Create an <link linkend="marcbibframeworks">Framework with the
42389 code ACQ</link> (if you're going to enter item records at the time
42390 of ordering or receiving)</para>
42394 <para>Acquisitions System preferences</para>
42398 <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
42399 Decide if an item record is created during acquisition</para>
42403 <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
42404 Decide how you want monetary amounts to display</para>
42408 <para><link linkend="gist">gist</link> : Enter your sales tax
42409 (if you are billed for tax)</para>
42413 <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
42414 Decide what format you want your print orders to use</para>
42421 <section id="impserials">
42422 <title>Serials Configuration</title>
42424 <para>When you use serials there are a few options you can set before
42429 <para>Serials System Preferences</para>
42433 <para><link linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
42434 : Decide if you want renewing serials to add a suggestion for
42435 easy purchasing</para>
42439 <para><link linkend="RoutingSerials">RoutingSerials</link> :
42440 Decide if you want to route serials around your library</para>
42444 <para><link linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
42445 Decide if holds are placed on serials when there is a routing
42446 list in place</para>
42452 <para>Cataloging System Preferences</para>
42456 <para><link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
42457 : Decide how many of the most recent issues to display in the
42458 staff client</para>
42462 <para><link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
42463 : Decide how many of the most recent issues to display in the
42468 <para><link linkend="SubscriptionHistory">SubscriptionHistory</link> :
42469 Decide how you want the subscription information to display in
42477 <section id="impgolive">
42478 <title>Planning for Go-Live</title>
42480 <para>Once you have all of your settings ready, you need to prepare for
42481 making your system live:</para>
42485 <para>Decide if you need training by an outside service or if your
42486 staff can do the training themselves.</para>
42490 <para>Make sure that there is time for your staff to play with your
42491 test system and get comfortable with it</para>
42495 <para>If this is a migration, work with your previous company to
42496 extract data right before you go live</para>
42500 <para>Come up with URLs for your new Koha OPAC & Staff
42505 <para>Make sure that if you're hosting your own system you have a
42512 <chapter id="sopac">
42513 <title>SOPAC2 Installation</title>
42515 <section id="sopacintro">
42519 <firstname>Jean-André</firstname>
42520 <surname>Santoni</surname>
42522 <orgname>BibLibre</orgname>
42527 <firstname>Nicole C.</firstname>
42528 <surname>Engard</surname>
42529 <contrib>Translation and minor edits.</contrib>
42533 <pubdate>August 2009</pubdate>
42535 <title>Introduction</title>
42537 <para>This is an installation guide for SOPAC2 and its Koha connector. It
42538 has been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
42539 3.0.x. It does not cover the installation of Koha and Drupal, only
42540 SOPAC, its dependencies and the connector.</para>
42543 <section id="sopacinstall">
42544 <title>Installation of Locum and Insurge</title>
42546 <para>Locum and Insurge are the two libraries used primarily by SOPAC.
42547 They serve as a layer of abstraction to the data. Insurge manages the
42548 social aspect (tags, reviews, ratings), while Locum manages the
42549 connection to the ILS via the connector. Both libraries use a different
42550 database from that of Drupal.</para>
42552 <section id="sopacdepend">
42553 <title>Dependencies</title>
42555 <para>There are no packages for Debian MDB2 yet, you can install it
42558 <programlisting># apt-get install php-pear
42559 # pear install MDB2
42560 # pear install MDB2#mysql</programlisting>
42563 <section id="sopacdownload">
42564 <title>Download</title>
42566 <para>Download the Locum and Insurge libraries from SVN:</para>
42568 <programlisting># cd /usr/local/lib
42569 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
42570 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
42573 <section id="sopaccreatedb">
42574 <title>Creation of the Database</title>
42576 <programlisting>$ mysql -u root
42577 mysql> create database scas;
42578 mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
42579 mysql> flush privileges;
42580 mysql> exit</programlisting>
42583 <section id="sopacdsn">
42584 <title>Sync DSN</title>
42586 <para>This file will provide the connection information to a DB
42589 <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
42591 <para>It should contain:</para>
42593 <programlisting><?php
42594 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
42597 <section id="sopacinstallinsurge">
42598 <title>Installation of Insurge</title>
42600 <para>If you customize the name of the database, remember to edit the
42603 <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
42605 <para>Import Insurge:</para>
42607 <programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
42609 <para>Configure Insurge:</para>
42611 <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
42613 <para>The variables in insurge.ini are empty. The default values are
42614 too long and cause MySQL errors.</para>
42616 <para>Here is a sample of insurge.ini</para>
42618 <programlisting>; This is the Locum configuration file
42619 ; General configuration options for your installation of Insurge.
42621 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
42622 ; This is where you configure your repository membership information.
42624 ; parent_server is the server name of the repository parent server you have been
42626 ; group_id = The group ID you have been given by your repository admin.
42627 ; These configuration points are OPTIONAL and are only necessary if you are
42628 ; participating in a repository relationship.
42632 group_key = ""</programlisting>
42635 <section id="sopacinstallocum">
42636 <title>Installation of Locum</title>
42638 <para>The same procedure applies to Locum</para>
42640 <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
42641 # mysql < /usr/local/lib/locum/sql/scas_locum.sql
42642 # nano /usr/local/lib/locum/sql/locum_init.sql
42643 # mysql < /usr/local/lib/locum/sql/locum_init.sql
42644 # nano /usr/local/lib/locum/config/locum.ini
42645 # mkdir /usr/local/var
42646 # mkdir /usr/local/var/log</programlisting>
42648 <para>Configure the DSN:</para>
42650 <programlisting>[locum_config]
42651 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
42653 <para>And the information for your Koha installation:</para>
42655 <programlisting>[ils_config]
42657 ils_version = "30x"
42658 ils_server = "localhost"
42659 ils_harvest_port = "80"</programlisting>
42661 <para>The rest depends on your Koha configuration.</para>
42665 <section id="sopackoha">
42666 <title>Installation of Koha Connector</title>
42668 <para>Download the Koha connector using SVN:</para>
42670 <programlisting># cd /usr/local/lib/locum/connectors/
42671 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
42674 <section id="sopacharvest">
42675 <title>Harvest Records</title>
42677 <para>Now that the connector is in place, we will be able to launch
42678 harvest.php, a tool that will reap Locum DB Koha and fill the
42681 <para>Start by configuring harvest.php:</para>
42683 <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
42685 <para>Here are the variables you must change:</para>
42687 <programlisting>$first_record = 1;
42688 $last_record = 30;</programlisting>
42690 <para>These are the minimum and maximum biblionumbers from your Koha
42693 <para>Then start the harvest:</para>
42695 <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
42696 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
42699 <section id="sopacphinx">
42700 <title>Installation of Sphinx</title>
42702 <para>Sphinx is the indexer for the database used by Locum and
42705 <section id="sphinxdepend">
42706 <title>Dependencies</title>
42708 <para>There is no Debian package for Sphinx so you'll have to compile
42709 the source directly:</para>
42711 <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
42714 <section id="sphinxdownload">
42715 <title>Download and Compile</title>
42717 <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
42718 $ tar zxvf sphinx-0.9.8.tar.gz
42720 $ ./configure --prefix=/usr/local/sphinx
42723 # mkdir /usr/local/sphinx
42724 # mkdir /usr/local/sphinx/lib
42725 # cp api/sphinxapi.php /usr/local/sphinx/lib/
42726 $ rm -R sphinx-0.9.8*</programlisting>
42729 <section id="sphinxuser">
42730 <title>Creation of User and Group</title>
42732 <para>Creating a Sphinx user and change the owner:</para>
42734 <programlisting># adduser sphinx
42736 # usermod -G sphinx sphinx
42737 # mkdir /usr/local/sphinx/var/run
42738 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
42741 <section id="demonsphinx">
42742 <title>The Sphinx daemon</title>
42744 <para>Download:</para>
42746 <programlisting># cd /etc/init.d
42747 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
42748 # chmod +x /etc/init.d/sphinx</programlisting>
42750 <para>Add Sphinx to the default boot services:</para>
42752 <programlisting># update-rc.d sphinx defaults</programlisting>
42755 <section id="sphinxconfig">
42756 <title>Configuration</title>
42758 <para>Copy the configuration file supplied with the source of Sphinx
42759 before the change:</para>
42761 <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
42762 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
42763 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
42764 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
42766 <para>And if you personalize the name of the database:</para>
42768 <programlisting># sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
42771 <section id="sphinxindexing">
42772 <title>Indexing documents</title>
42774 <para>Indexing is necessary if you want to use the search features of
42777 <para>You must first complete the Insurge table index</para>
42779 <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
42780 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
42782 <para>Then start indexing Sphinx</para>
42784 <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
42786 <para>Finally, we must start the daemon:</para>
42788 <programlisting># /etc/init.d/sphinx start</programlisting>
42790 <para>When the daemon is running, you can update the index with:</para>
42792 <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
42796 <section id="installsopac">
42797 <title>Installation of SOPAC2</title>
42799 <para>Now to the SOPAC software itself:</para>
42801 <section id="downloadsopac">
42802 <title>Download</title>
42804 <para>Download from SVN:</para>
42806 <programlisting>$ cd /chemin/vers/drupal/sites/all/
42809 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
42812 <section id="sopacinstallation">
42813 <title>Installation</title>
42815 <para>In Drupal's administration settings, activate the module.
42816 Also, enable the dependencies:</para>
42820 <para>Profile</para>
42824 <para>PHP Filter</para>
42832 <para>The Drupal menu should now list these entries.</para>
42835 <section id="configsopac">
42836 <title>Configuration</title>
42838 <para>Then go into the settings of SOPAC.</para>
42842 <para>Configure the paths to the Locum and Insurge
42847 <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
42848 with content like:</para>
42852 <programlisting><?php
42853 print sopac_search_form('both');
42854 print theme('pages_catalog');</programlisting>
42858 <para>Check the Input Format "PHP Code"</para>
42862 <para>Check Move to front page</para>
42866 <para>In URL path settings, set the SOPAC URL prefix you have
42871 <para>Go to the root of Drupal, a search form will appear.</para>
42873 <para>Remember to empty Drupal's cache when something does not
42876 <para>Drupal offers a few blocks, which are not configured by default.
42877 You must specify on which page they should appear.</para>
42882 <chapter id="cronjobsch">
42883 <title>Cron Jobs</title>
42885 <para>A cron job is a Linux command for scheduling a command or script on your server to
42886 complete repetitive tasks automatically. Scripts executed as a cron job are typically used to
42887 modify files or databases; however, they can perform other tasks that do not modify data on
42888 the server, like sending out email notifications. Koha has many cron jobs in place that you
42889 can enable (search engine indexing, overdue notice generation, data cleanup and more), this
42890 chapter will explain those for you.</para>
42892 <section id="cronjobs">
42893 <title>Cron Jobs</title>
42895 <para>The locations below assume a dev install which puts the crons in
42896 misc/, if you have a standard install you may want to look in bin/ for
42897 these files if you cannot find them in misc/</para>
42899 <section id="searchcron">
42900 <title>Search</title>
42904 <section id="rebuildsearchcron">
42905 <title>Rebuild Index</title>
42907 <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
42909 <para>Does: Updates Zebra indexes with recently changed data.</para>
42911 <para>Required by: Zebra</para>
42913 <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
42914 depending on performance needs</para>
42918 <section id="circcron">
42919 <title>Circulation</title>
42921 <section id="buildholdscron">
42922 <title>Holds Queue</title>
42924 <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
42926 <para>Does: Updates holds queue report</para>
42928 <para>Required by: <link linkend="holdsqueue">Holds Queue
42929 Report</link></para>
42931 <para>Frequency suggestion: every 1-4 hours</para>
42933 <para>Description:</para>
42937 <para>A script that should be run periodically if your library
42938 system allows borrowers to place on-shelf holds. This script
42939 decides which library should be responsible for fulfilling a
42940 given hold request.</para>
42942 <para>It's behavior is controlled by the system preferences
42943 <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
42944 and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
42946 <para>If you do not want all of your libraries to participate in
42947 the on-shelf holds fulfillment process, you should list the the
42948 libraries that *do* participate in the process here by inputting
42949 all the participating library's branchcodes, separated by commas
42950 ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
42952 <para>By default, the holds queue will be generated such that
42953 the system will first attempt to hold fulfillment using items
42954 already at the pickup library if possible. If there are no items
42955 available at the pickup library to fill a hold,
42956 build_holds_queue.pl will then use the list of libraries defined
42957 in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
42958 disabled ( which it is by default ), the script will assign
42959 fulfillment requests in the order the branches are placed in the
42960 StaticHoldsQueueWeight system preference.</para>
42962 <para>For example, if your system has three libraries, of
42963 varying sizes ( small, medium and large ) and you want the
42964 burden of holds fulfillment to be on larger libraries before
42965 smaller libraries, you would want StaticHoldsQueueWeight to look
42966 something like "LRG,MED,SML".</para>
42968 <para>If you want the burden of holds fulfillment to be spread
42969 out equally throughout your library system, simply enable
42970 RandomizeHoldsQueueWeight. When this system preference is
42971 enabled, the order in which libraries will be requested to
42972 fulfill an on-shelf hold will be randomized each time the list
42973 is regenerated.</para>
42975 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
42976 this time. Doing so will cause the build_holds_queue script to
42977 ignore RandomizeHoldsQueueWeight, causing the script to request
42978 hold fulfillment not randomly, but by alphabetical order.</para>
42982 <section id="buildholdscronperl">
42983 <title>Perl Documentation</title>
42985 <para><emphasis role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
42987 <para>my $biblionumber_aref =
42988 GetBibsWithPendingHoldRequests();</para>
42990 <para>Return an arrayref of the biblionumbers of all bibs that
42991 have one or more unfilled hold requests.</para>
42993 <para><emphasis role="bold">GetPendingHoldRequestsForBib</emphasis></para>
42995 <para>my $requests =
42996 GetPendingHoldRequestsForBib($biblionumber);</para>
42998 <para>Returns an arrayref of hashrefs to pending, unfilled hold
43001 <para>the bib identified by $biblionumber. The following keys are
43002 present in each hashref:</para>
43006 <para>biblionumber</para>
43010 <para>borrowernumber</para>
43014 <para>itemnumber</para>
43018 <para>priority</para>
43022 <para>branchcode</para>
43026 <para>reservedate</para>
43030 <para>reservenotes</para>
43034 <para>borrowerbranch</para>
43038 <para>The arrayref is sorted in order of increasing
43041 <para><emphasis role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
43043 <para>my $available_items =</para>
43045 <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
43047 <para>Returns an arrayref of items available to fill hold requests
43048 for the bib identified by $biblionumber. An item is available to
43051 <para>request if and only if:</para>
43055 <para>it is not on loan</para>
43059 <para>it is not withdrawn</para>
43063 <para>it is not marked notforloan</para>
43067 <para>it is not currently in transit</para>
43071 <para>it is not lost</para>
43075 <para>it is not sitting on the hold shelf</para>
43079 <para><emphasis role="bold">MapItemsToHoldRequests</emphasis></para>
43081 <para>MapItemsToHoldRequests($hold_requests,
43082 $available_items);</para>
43084 <para><emphasis role="bold">CreatePickListFromItemMap</emphasis></para>
43086 <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
43088 <para><emphasis role="bold">_get_branches_to_pull_from</emphasis></para>
43090 <para>Query system preferences to get ordered list of branches to
43091 use to fill hold requests.</para>
43095 <section id="expiredholdscron">
43096 <title>Expired Holds</title>
43099 misc/cronjobs/holds/cancel_expired_holds.pl</para>
43101 <para>Does: By default, this cron job will only automatically cancel
43102 holds where the user has set an expiration date. If the library is
43103 using the <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
43104 and <link linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
43105 preferences then this script will also cancel holds that have been
43106 sitting on the hold shelf for too long and will (if the library
43107 does) charge the patron for not picking up the hold.</para>
43109 <para>Frequency suggestion: daily</para>
43112 <section id="unsuspendholdcron">
43113 <title>Unsuspend Holds</title>
43116 misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
43118 <para>Does: This script checks to find holds that should no longer
43119 be suspended and removes the suspension if the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
43120 preference is set to 'allow'. This puts the patron back in to the
43121 queue where they were when the hold was suspended.</para>
43123 <para>Frequency suggestion: daily</para>
43126 <section id="finescronjob">
43127 <title>Fines</title>
43129 <para>Script path: misc/cronjobs/fines.pl</para>
43130 <para>Does: Calculates and posts fines to patron accounts.</para>
43132 <para>Required by: <link linkend="finesMode">finesMode</link> system
43135 <para>Frequency suggestion: nightly</para>
43138 <section id="longoverduecron">
43139 <title>Long Overdues</title>
43141 <para>Script path: misc/cronjobs/longoverdue.pl</para>
43143 <para>Does: allows one to specify delays for changing items to
43144 different lost statuses, and optionally charge for them using the
43145 replacement price listed on the item record.</para>
43147 <para>Frequency suggestion: nightly</para>
43149 <section id="longoverduecronperl">
43150 <title>Perl Documentation</title>
43152 <para><emphasis role="bold">NAME</emphasis></para>
43154 <para>longoverdue.pl cron script to set lost statuses on overdue
43155 materials. Execute without options for help.</para>
43159 <section id="updateissuescron">
43160 <title>Track total checkouts</title>
43162 <para>Script path: misc/cronjobs/update_totalissues.pl</para>
43164 <para>Does: updates the biblioitems.totalissues field in the
43165 database with the latest tally of checkouts.</para>
43167 <para>Frequency suggestion: nightly</para>
43168 <section id="updateissuesperldoc">
43169 <title>Perl Documentation</title>
43170 <para><emphasis role="bold">NAME</emphasis>
43172 <para>update_totalissues.pl </para>
43173 <para><emphasis role="bold">SYNOPSIS</emphasis>
43175 <para>update_totalissues.pl --use-stats </para>
43176 <para>update_totalissues.pl --use-items </para>
43177 <para>update_totalissues.pl --commit=1000 </para>
43178 <para>update_totalissues.pl --since='2012-01-01' </para>
43179 <para>update_totalissues.pl --interval=30d </para>
43180 <para><emphasis role="bold">DESCRIPTION</emphasis>
43182 <para>This batch job populates bibliographic records' total issues count based on
43183 historical issue statistics. </para>
43184 <para>--help Prints this help </para>
43185 <para>-v|--verbose </para>
43186 <para>Provide verbose log information (list every bib modified). </para>
43187 <para>--use-stats </para>
43188 <para>Use the data in the statistics table for populating total issues. </para>
43189 <para>--use-items </para>
43190 <para>Use items.issues data for populating total issues. Note that issues data from the
43191 items table does not respect the --since or --interval options, by definition. Also
43192 note that if both --use-stats and --use-items are specified, the count of biblios
43193 processed will be misleading. </para>
43194 <para>-s|--since=DATE </para>
43195 <para>Only process issues recorded in the statistics table since DATE. </para>
43196 <para>-i|--interval=S </para>
43197 <para>Only process issues recorded in the statistics table in the last N units of time.
43198 The interval should consist of a number with a one- letter unit suffix. The valid
43199 suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
43200 unit is days. </para>
43201 <para>--incremental </para>
43202 <para>Add the number of issues found in the statistics table to the existing total
43203 issues count. Intended so that this script can be used as a cron job to update
43204 popularity information during low-usage periods. If neither --since or --interval are
43205 specified, incremental mode will default to processing the last twenty-four hours. </para>
43206 <para>--commit=N </para>
43207 <para>Commit the results to the database after every N records are processed. </para>
43208 <para>--test </para>
43209 <para>Only test the popularity population script. </para>
43210 <para><emphasis role="bold">WARNING</emphasis>
43212 <para>If the time on your database server does not match the time on your Koha server
43213 you will need to take that into account, and probably use the --since argument instead
43214 of the --interval argument for incremental updating. </para>
43215 <para><emphasis role="bold">CREDITS</emphasis>
43217 <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
43218 Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
43219 Arcadia Public Library. </para>
43220 <para><emphasis role="bold">AUTHOR</emphasis>
43222 <para>Jared Camins-Esakov <jcamins AT cpbibliography DOT com></para>
43225 <section id="offlinecirccron">
43226 <title>Generate Patron File for Offline Circulation</title>
43227 <para>Script path: misc/cronjobs/create_koc_db.pl</para>
43228 <para>Does: Generates the borrowers.db file for use with the <link
43229 linkend="windowsofflinecirc">Koha Offline Circulation</link> tool</para>
43230 <para>Frequency suggestion: weekly</para>
43233 <section id="patroncrons">
43234 <title>Patrons</title>
43236 <section id="deleteexpiredregistrationcron">
43237 <title>Unverified Registrations</title>
43238 <para>Script path: misc/cronjobs/delete_expired_opac_registrations.pl</para>
43239 <para>Does: Deletes patron registrations that were submitted via the OPAC but not reviewed
43240 by the library within the number of days entered in the <link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference.</para>
43241 <para>Frequency suggestion: nightly</para>
43243 <section id="deleteunverifiedcron">
43244 <title>Unconfirmed Registrations</title>
43245 <para>Script path: misc/cronjobs/delete_unverified_opac_registrations.pl </para>
43246 <para>Does: Deletes patron self registrations that were submitted via the OPAC but not
43247 confirmed via email within 24 hours. This is only necessary if you are requiring patrons
43248 to confirm their registrations via email with the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference.</para>
43249 <para>Frequency suggestion: hourly</para>
43251 <section id="anonymizecron">
43252 <title>Anonymize Patron Data</title>
43253 <para>Script path: misc/cronjobs/batch_anonymise.pl</para>
43254 <para>Does: Used to anonymize patron data. This will remove borrowernumbers from
43255 circulation history so that the stats are kept, but the patron information is removed
43256 for privacy reasons.</para>
43258 <section id="j2acron">
43259 <title>Update Child to Adult Patron Type</title>
43260 <para>Script path: misc/cronjobs/j2a.pl</para>
43261 <para>Does: Convert juvenile/child patrons from juvenile patron category and category code
43262 to corresponding adult patron category and category code when they reach the upper age
43263 limit defined in the Patron Categories. </para>
43264 <para>Frequency suggestion: nightly</para>
43265 <section id="j2aperldoc">
43266 <title>Perl Documentation</title>
43267 <para><emphasis role="bold">NAME</emphasis>
43269 <para>juv2adult.pl - convert juvenile/child patrons from juvenile patron category and
43270 category code to corresponding adult patron category and category code when they reach
43271 the upper age limit defined in the Patron Categories. </para>
43272 <para><emphasis role="bold">SYNOPSIS</emphasis>
43274 <para>juv2adult.pl [ -b=<branchcode> -f=<categorycode> -t=<categorycode> ] </para>
43275 <para>Options: </para>
43276 <para>--help brief help message </para>
43277 <para>--man full documentation </para>
43278 <para>-v verbose mode </para>
43279 <para>-n take no action, display only </para>
43280 <para>-b <branchname> only deal with patrons from this library/branch </para>
43281 <para>-f <categorycode> change patron category from this category </para>
43282 <para>-t <categorycode> change patron category to this category </para>
43283 <para>=head1 OPTIONS </para>
43284 <para>--help Print a brief help message and exits. </para>
43285 <para>--man Prints the manual page and exits. </para>
43286 <para>-v Verbose. Without this flag set, only fatal errors are reported. </para>
43287 <para>-n No Action. With this flag set, script will report changes but not actually
43288 execute them on the database. </para>
43289 <para>-b changes patrons for one specific branch. Use the value in the
43290 branches.branchcode table.</para>
43291 <para> -f *required* defines the juvenile category to update. Expects the code from
43292 categories.categorycode. </para>
43293 <para>-t *required* defines the category juvenile patrons will be converted to. Expects
43294 the code from categories.categorycode. </para>
43295 <para><emphasis role="bold">DESCRIPTION</emphasis>
43297 <para>This script is designed to update patrons from juvenile to adult patron types,
43298 remove the guarantor, and update their category codes appropriately when they reach
43299 the upper age limit defined in the Patron Categories. </para>
43300 <para><emphasis role="bold">USAGE EXAMPLES</emphasis>
43302 <para>"juv2adult.pl" - Suggests that you read this help. :) </para>
43303 <para>"juv2adult.pl" -b=<branchcode> -f=<categorycode> -t=<categorycode> -
43304 Processes a single branch, and updates the patron categories from fromcat to tocat. </para>
43305 <para>"juv2adult.pl" -f=<categorycode> -t=<categorycode> -v -n - Processes all
43306 branches, shows all messages, and reports the patrons who would be affected. Takes no
43307 action on the database.</para>
43312 <section id="noticescron">
43313 <title>Notices</title>
43317 <section id="msgqueuecron">
43318 <title>Message Queue</title>
43320 <para>Script path: misc/cronjobs/process_message_queue.pl</para>
43322 <para>Does: processes the message queue to send the check out, check in and hold filled
43323 emails and SMS message to users and sends outgoing emails to patrons. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> to be
43326 <para>Frequency suggestion: 1-4 hours<important>
43327 <para>Item due and Advanced due notices are controlled by the <link linkend="advnoticecron">advance_notices cron</link>.</para>
43328 </important></para>
43331 <section id="advnoticecron">
43332 <title>Advanced Notice</title>
43334 <para>Script path: misc/cronjobs/advance_notices.pl</para>
43336 <para>Does: prepares "pre-due" notices and "item due" notices for
43337 patrons who request them prepares notices for patrons for items just
43338 due or coming due soon. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
43341 <para>Frequency suggestion: nightly</para>
43344 <para>This script does not actually send the notices. It queues
43345 them in the <link linkend="msgqueuecron">message queue</link> for
43349 <section id="advnoticecronperl">
43350 <title>Perl Documentation</title>
43352 <para><emphasis role="bold">NAME</emphasis></para>
43354 <para>advance_notices.pl - cron script to put item due reminders
43355 into message queue</para>
43357 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
43359 <para>./advance_notices.pl -c</para>
43361 <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
43363 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
43365 <para>This script prepares pre-due and item due reminders to be
43366 sent to patrons. It queues them in the message queue, which is
43367 processed by the process_message_queue.pl cronjob. The type and
43368 timing of the messages can be configured by the patrons in their
43369 "My Alerts" tab in the OPAC.</para>
43371 <para><emphasis role="bold">METHODS</emphasis></para>
43373 <para>parse_letter</para>
43377 <section id="overduenoticecron">
43378 <title>Overdue Notice</title>
43380 <para>Script path: misc/cronjobs/overdue_notices.pl</para>
43382 <para>Does: prepares messages to alert patrons of overdue messages
43383 (both via email and print)</para>
43385 <para>Frequency suggestion: nightly</para>
43388 <para>This script does not actually send the notices. It queues
43389 them in the <link linkend="msgqueuecron">message queue</link> for
43390 later or generates the HTML for later printing</para>
43393 <section id="overduenoticecronperl">
43394 <title>Perl Documentation</title>
43396 <para><emphasis role="bold">NAME</emphasis></para>
43398 <para>overdue_notices.pl - prepare messages to be sent to patrons
43399 for overdue items</para>
43401 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
43403 <para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
43404 -library <branchcode>...] [ -max <number of days> ] [
43405 -csv [ <filename> ] ] [-itemscontent <field list>
43408 <para>Options:</para>
43410 <para>-help brief help message</para>
43412 <para>-man full documentation</para>
43414 <para>-n No email will be sent</para>
43416 <para>-max <days> maximum days overdue to deal with</para>
43418 <para>-library <branchname> only deal with overdues from
43419 this library (repeatable : several libraries can be given)</para>
43421 <para>-csv <filename> populate CSV file</para>
43423 <para>-html <filename> Output html to file</para>
43425 <para>-itemscontent <list of fields> item information in
43428 <para>-borcat <categorycode> category code that must be
43431 <para>-borcatout <categorycode> category code that must be
43434 <para><emphasis role="bold">OPTIONS</emphasis></para>
43436 <para>-help Print a brief help message and exits.</para>
43438 <para>-man Prints the manual page and exits.</para>
43440 <para>-v Verbose. Without this flag set, only fatal errors are
43443 <para>-n Do not send any email. Overdue notices that would have
43444 been sent to the patrons or to the admin are printed to standard
43445 out. CSV data (if the -csv flag is set) is written to standard out
43446 or to any csv filename given.</para>
43448 <para>-max Items older than max days are assumed to be handled
43449 somewhere else, probably the longoverdues.pl script. They are
43450 therefore ignored by this program. No notices are sent for them,
43451 and they are not added to any CSV files. Defaults to 90 to match
43452 longoverdues.pl.</para>
43454 <para>-library</para>
43456 <para>select overdues for one specific library. Use the value in
43457 the branches.branchcode table. This option can be repeated in
43458 order to select overdues for a group of libraries.</para>
43460 <para>-csv Produces CSV data. if -n (no mail) flag is set, then
43461 this CSV data is sent to standard out or to a filename if
43462 provided. Otherwise, only overdues that could not be emailed are
43463 sent in CSV format to the admin.</para>
43465 <para>-itemscontent</para>
43467 <para>comma separated list of fields that get substituted into
43468 templates in places of the <<items.content>>
43469 placeholder. This defaults to
43470 issuedate,title,barcode,author</para>
43472 <para>Other possible values come from fields in the biblios,
43473 items, and issues tables.</para>
43475 <para>-borcat Repetable field, that permit to select only few of
43476 patrons categories.</para>
43478 <para>-borcatout</para>
43480 <para>Repetable field, permis to exclude some patrons
43483 <para>-t | --triggered</para>
43485 <para>This option causes a notice to be generated if and only if
43486 an item is overdue by the number of days defined in a notice
43489 <para>By default, a notice is sent each time the script runs,
43490 which is suitable for less frequent run cron script, but requires
43491 syncing notice triggers with the cron schedule to ensure proper
43492 behavior. Add the --triggered option for daily cron, at the risk
43493 of no notice being generated if the cron fails to run on
43496 <para>-list-all</para>
43498 <para>Default items.content lists only those items that fall in
43499 the range of the currently processing notice. Choose list-all to
43500 include all overdue items in the list (limited by -max
43503 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
43505 <para>This script is designed to alert patrons and administrators
43506 of overdue items.</para>
43508 <para>Configuration</para>
43510 <para>This script pays attention to the overdue notice
43511 configuration performed in the "Overdue notice/status triggers"
43512 section of the "Tools" area of the staff interface to Koha. There,
43513 you can choose which letter templates are sent out after a
43514 configurable number of days to patrons of each library. More
43515 information about the use of this section of Koha is available in
43516 the Koha manual.</para>
43518 <para>The templates used to craft the emails are defined in the
43519 "Tools: Notices" section of the staff interface to Koha.</para>
43521 <para>Outgoing emails</para>
43523 <para>Typically, messages are prepared for each patron with
43524 overdue items. Messages for whom there is no email address on file
43525 are collected and sent as attachments in a single email to each
43526 library administrator, or if that is not set, then to the email
43527 address in the "KohaAdminEmailAddress" system preference.</para>
43529 <para>These emails are staged in the outgoing message queue, as
43530 are messages produced by other features of Koha. This message
43531 queue must be processed regularly by the
43532 misc/cronjobs/process_message_queue.pl program.</para>
43534 <para>In the event that the "-n" flag is passed to this program,
43535 no emails are sent. Instead, messages are sent on standard output
43536 from this program. They may be redirected to a file if
43539 <para>Templates</para>
43541 <para>Templates can contain variables enclosed in double angle
43542 brackets like <<this>>. Those variables will be
43543 replaced with values specific to the overdue items or relevant
43544 patron. Available variables are:</para>
43546 <para><<bib>></para>
43548 <para>the name of the library</para>
43550 <para><<items.content>></para>
43552 <para>one line for each item, each line containing a tab separated
43553 list of title, author, barcode, issuedate</para>
43555 <para><<borrowers.*>></para>
43557 <para>any field from the borrowers table</para>
43559 <para><<branches.*>></para>
43561 <para>any field from the branches table</para>
43563 <para>CSV output</para>
43565 <para>The "-csv" command line option lets you specify a file to
43566 which overdues data should be output in CSV format.</para>
43568 <para>With the "-n" flag set, data about all overdues is written
43569 to the file. Without that flag, only information about overdues
43570 that were unable to be sent directly to the patrons will be
43571 written. In other words, this CSV file replaces the data that is
43572 typically sent to the administrator email address.</para>
43574 <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
43576 <para>"overdue_notices.pl" - In this most basic usage, with no
43577 command line arguments, all libraries are processed individually,
43578 and notices are prepared for all patrons with overdue items for
43579 whom we have email addresses. Messages for those patrons for whom
43580 we have no email address are sent in a single attachment to the
43581 library administrator's email address, or to the address in the
43582 KohaAdminEmailAddress system preference.</para>
43584 <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
43585 email and populates /tmp/overdues.csv with information about all
43586 overdue items.</para>
43588 <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
43589 of overdues in the last 2 weeks for the MAIN library.</para>
43591 <para><emphasis role="bold">SEE ALSO</emphasis></para>
43593 <para>The misc/cronjobs/advance_notices.pl program allows you to
43594 send messages to patrons in advance of their items becoming due,
43595 or to alert them of items that have just become due.</para>
43597 <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
43599 <para>These methods are internal to the operation of
43600 overdue_notices.pl.</para>
43602 <para>parse_letter</para>
43604 <para>parses the letter template, replacing the placeholders with
43605 data specific to this patron, biblio, or item</para>
43607 <para>named parameters:</para>
43609 <para>letter - required hashref</para>
43611 <para>borrowernumber - required integer</para>
43613 <para>substitute - optional hashref of other key/value pairs that
43614 should be substituted in the letter content</para>
43616 <para>returns the "letter" hashref, with the content updated to
43617 reflect the substituted keys and values.</para>
43619 <para>prepare_letter_for_printing</para>
43621 <para>returns a string of text appropriate for printing in the
43622 event that an overdue notice will not be sent to the patron's
43623 email address. Depending on the desired output format, this may be
43624 a CSV string, or a human-readable representation of the
43627 <para>required parameters:</para>
43629 <para>letter</para>
43631 <para>borrowernumber</para>
43633 <para>optional parameters:</para>
43635 <para>outputformat</para>
43639 <section id="printholdcron">
43640 <title>Print Hold Notices</title>
43642 <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
43644 <para>Does: looks through the message queue for hold notices that
43645 didn't go through because the patron didn't have an email address
43646 and generates a print notice</para>
43648 <para>Frequency suggestion: nightly</para>
43651 <section id="talkingtechcrons">
43652 <title>Talking Tech</title>
43654 <para>To learn more about setting up this third party product view
43655 the <link linkend="talkingtechappendix">Talking Tech
43656 Appendix</link>.</para>
43658 <section id="talkingtechsendcron">
43659 <title>Sending Notices File</title>
43662 misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
43664 <para>Does: Script to generate Spec C outbound notifications file
43665 for Talking Tech i-tiva phone notification system.</para>
43667 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
43669 <para>Frequency suggestion: nightly</para>
43671 <section id="talkingsendcronperl">
43672 <title>Perl Documentation</title>
43674 <para><emphasis role="bold">USAGE</emphasis></para>
43676 <para>TalkingTech_itiva_outbound.pl</para>
43678 <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
43679 6 --output=/tmp/talkingtech/outbound.csv</para>
43681 <para>TalkingTech_itiva_outbound.pl --type=RESERVE
43682 --type=PREOVERDUE --lang=FR</para>
43684 <para>Script to generate Spec C outbound notifications file for
43685 Talking Tech i-tiva phone notification system.</para>
43687 <para>--help -h</para>
43689 <para>Prints this help</para>
43691 <para>-v Provide verbose log information.</para>
43693 <para>--output -o</para>
43695 <para>Destination for outbound notifications file (CSV format).
43696 If no value is specified, output is dumped to screen.</para>
43698 <para>--lang</para>
43700 <para>Sets the language for all outbound messages. Currently
43701 supported values are EN, FR and ES. If no value is specified, EN
43702 will be used by default.</para>
43704 <para>--type</para>
43706 <para>REQUIRED. Sets which messaging types are to be used. Can
43707 be given multiple times, to specify multiple types in a single
43708 output file. Currently supported values are RESERVE, PREOVERDUE
43709 and OVERDUE. If no value is given, this script will not produce
43710 any outbound notifications.</para>
43712 <para>--waiting-hold-day -w</para>
43714 <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
43715 has been set to waiting on which to call. Use switch as many
43716 times as desired. For example, passing "-w 0 -w 2 -w 6" will
43717 cause calls to be placed on the day the hold was set to waiting,
43718 2 days after the waiting date, and 6 days after. See example
43719 above. If this switch is not used with --type=RESERVE, calls
43720 will be placed every day until the waiting reserve is picked up
43721 or canceled.</para>
43723 <para>--library-code --code -c</para>
43725 <para>OPTIONAL The code of the source library of the message.
43726 The library code is used to group notices together for
43727 consortium purposes and apply library specific settings, such as
43728 prompts, to those notices. This field can be blank if all
43729 messages are from a single library.</para>
43733 <section id="talkingtechreceivecron">
43734 <title>Receiving Notices File</title>
43737 misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
43739 <para>Does: Script to process received Results files for Talking
43740 Tech i-tiva phone notification system.</para>
43742 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
43744 <para>Frequency suggestion: nightly</para>
43746 <section id="talkingreceivecronperl">
43747 <title>Perl Documentation</title>
43749 <para><emphasis role="bold">USAGE</emphasis></para>
43751 <para>TalkingTech_itiva_inbound.pl</para>
43753 <para>TalkingTech_itiva_inbound.pl -v
43754 --input=/tmp/talkingtech/results.csv</para>
43756 <para>Script to process received Results files for Talking Tech
43757 i-tiva phone notification system.</para>
43759 <para>--help -h</para>
43761 <para>Prints this help</para>
43763 <para>-v Provide verbose log information.</para>
43765 <para>--input -i</para>
43767 <para>REQUIRED. Path to incoming results file.</para>
43773 <section id="proccartcron">
43774 <title>In Processing/Book Cart</title>
43776 <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
43778 <para>Does: Updates all items with a location of CART to the item's
43779 permanent location.</para>
43781 <para>Required by: <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
43782 <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
43783 & <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
43784 system preferences</para>
43786 <para>Frequency suggestion: hourly</para>
43788 <section id="proccartcronperl">
43789 <title>Perl Documentation</title>
43791 <para><emphasis role="bold">NAME</emphasis></para>
43793 <para>cart_to_shelf.pl cron script to set items with location of
43794 CART to original shelving location after X hours. Execute without
43795 options for help.</para>
43799 <section id="catalogcron">
43800 <title>Catalog</title>
43804 <section id="checkurlcron">
43805 <title>Check URLs</title>
43807 <para>Script path: misc/cronjobs/check-url.pl</para>
43809 <para>Does: checks URLs in 856$u field. Script output can now be
43810 formatted in CSV or HTML. The HTML version links directly to MARC
43811 biblio record editor.</para>
43813 <para>Frequency suggestion: monthly</para>
43815 <para>Learn more: <ulink url="http://wiki.koha-community.org/wiki/Check-url_enhancements">http://wiki.koha-community.org/wiki/Check-url_enhancements</ulink></para>
43817 <section id="checkurlcronperl">
43818 <title>Perl Documentation</title>
43820 <para><emphasis role="bold">NAME</emphasis></para>
43822 <para>C4::URL::Checker - base object for checking URL stored in
43825 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
43827 <programlisting>use C4::URL::Checker;
43829 my $checker = C4::URL::Checker->new( );
43830 $checker->{ host_default } = 'http://mylib.kohalibrary.com';
43831 my $checked_urls = $checker->check_biblio( 123 );
43832 foreach my $url ( @$checked_urls ) {
43833 print "url: ", $url->{ url A }, "\n",
43834 "is_success: ", $url->{ is_success }, "\n",
43835 "status: ", $url->{ status }, "\n";
43836 } </programlisting>
43838 <para><emphasis role="bold">FUNCTIONS</emphasis></para>
43842 <para>Create a URL Checker. The returned object can be used to set
43843 default host variable :</para>
43845 <programlisting>my $checker = C4::URL::Checker->new( );
43846 $checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
43848 <para>check_biblio</para>
43850 <para>Check all URL from a biblio record. Returns a pointer to an
43851 array containing all URLs with checking for each of them.</para>
43853 <programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
43855 <para>With 2 URLs, the returned array will look like that:</para>
43859 'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
43860 'is_success' => 1,
43861 'status' => 'ok'
43864 'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
43865 'is_success' => 0,
43866 'status' => '404 - Page not found'
43868 ], </programlisting>
43870 <para><emphasis role="bold">NAME</emphasis></para>
43872 <para>check-url.pl - Check URLs from 856$u field.</para>
43874 <para><emphasis role="bold">USAGE</emphasis></para>
43876 <para>check-url.pl [--verbose|--help]
43877 [--host=http://default.tld]</para>
43879 <para>Scan all URLs found in 856$u of bib records and display if
43880 resources are available or not.</para>
43882 <para><emphasis role="bold">PARAMETERS</emphasis></para>
43884 <para>--host=http://default.tld</para>
43886 <para>Server host used when URL doesn't have one, ie doesn't begin
43887 with 'http:'. For example, if --host=http://www.mylib.com, then
43888 when 856$u contains 'img/image.jpg', the url checked is:
43889 http://www.mylib.com/image.jpg'.</para>
43891 <para>--verbose|-v</para>
43893 <para>Outputs both successful and failed URLs.</para>
43895 <para>--html</para>
43897 <para>Formats output in HTML. The result can be redirected to a
43898 file accessible by http. This way, it's possible to link directly
43899 to biblio record in edit mode. With this parameter --host-pro is
43902 <para>--host-pro=http://koha-pro.tld</para>
43904 <para>Server host used to link to biblio record editing
43907 <para>--help|-h</para>
43909 <para>Print this help page.</para>
43913 <section id="mergeauthcron">
43914 <title>Update Authorities</title>
43916 <para>Script path: misc/migration_tools/merge_authority.pl</para>
43918 <para>Does: Updates biblio data with changes to authorities records<note>
43919 <para>The name of this script is misleading. This script does not merge authorities
43920 together it instead merges authority data with linked bib records. Edits to
43921 authority records will be applied to bibliographic records that use that authority
43922 when this script is run.</para>
43925 <para>Required by: <link linkend="dontmerge">dontmerge</link> system
43928 <para>Frequency suggestion: nightly</para>
43931 <section id="serialscron">
43932 <title>Serials Update</title>
43934 <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
43936 <para>Does: checks if there is a "late" issue on active
43937 subscriptions, and if there is, the script will set it as late, and
43938 add the next one as expected.</para>
43940 <para>Frequency suggestion: nightly</para>
43944 <section id="opaccrons">
43945 <title>OPAC</title>
43949 <section id="customrssfeedcron">
43950 <title>RSS Feeds</title>
43952 <para>Script path: misc/cronjobs/rss/rss.pl</para>
43954 <para>Does: Produces an RSS XML document for any SQL query (not used
43955 for search results RSS feed). <link linkend="customrss">Learn
43956 more</link>.</para>
43958 <para>Frequency suggestion: hourly</para>
43961 <section id="authbrowsercron">
43962 <title>Authorities Browser</title>
43964 <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
43966 <para>Does: Generate content for authorities browse in OPAC</para>
43968 <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link> system preference<important>
43969 <para>This preference and cron job should only be used on French systems.</para>
43970 </important></para>
43973 <section id="keywordclouds">
43974 <title>Subject/Author Clouds</title>
43976 <para>Script path: misc/cronjobs/cloud-kw.pl</para>
43978 <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
43979 misc/cronjobs/cloud-sample.conf has a sample of how this script
43982 <para>Frequency: This is the type of script you can run once a month
43983 or so, the content generated isn't going to change very much over
43986 <section id="keywordcloudsperl">
43987 <title>Perl Documentation</title>
43989 <para><emphasis role="bold">NAME</emphasis></para>
43991 <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
43994 <para><emphasis role="bold">USAGE</emphasis></para>
43996 <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
43998 <para>Creates multiple HTML files containing keywords cloud with
43999 top terms sorted by their logarithmic weight. cloud.conf is a YAML
44000 configuration file driving cloud generation process.</para>
44002 <para><emphasis role="bold">PARAMETERS</emphasis></para>
44004 <para>--conf=configuration file</para>
44006 <para>Specify configuration file name</para>
44008 <para>--verbose|-v</para>
44010 <para>Enable script verbose mode.</para>
44012 <para>--help|-h</para>
44014 <para>Print this help page.</para>
44016 <para><emphasis role="bold">CONFIGURATION</emphasis></para>
44018 <para>Configuration file looks like that:</para>
44020 <para><programlisting> ---
44021 # Koha configuration file for a specific installation
44022 # If not present, defaults to KOHA_CONF
44023 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
44024 # Zebra index to scan
44026 # Koha index used to link found kewords with an opac search URL
44028 # Number of top keyword to use for the cloud
44030 # Include CSS style directives with the cloud
44031 # This could be used as a model and then CSS directives are
44032 # put in the appropriate CSS file directly.
44034 # HTML file where to output the cloud
44035 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
44037 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
44038 ZebraIndex: Subject
44042 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis role="bold">IMPROVEMENTS</emphasis></para>
44044 <para>Generated top terms have more informations than those
44045 outputted from the time being. Some parameters could be easily
44046 added to improve this script:</para>
44048 <para>WithCount</para>
44050 <para>In order to output terms with the number of occurrences they
44051 have been found in Koha Catalogue by Zebra.</para>
44053 <para>CloudLevels</para>
44055 <para>Number of levels in the cloud. Now 24 levels are
44058 <para>Weighting</para>
44060 <para>Weighting method used to distribute terms in the cloud. We
44061 could have two values: Logarithmic and Linear. Now it's
44062 Logarithmic by default.</para>
44066 <para>Now terms are outputted in the lexical order. They could be
44067 sorted by their weight.</para>
44072 <section id="systemcron">
44073 <title>System Administration</title>
44077 <section id="cleandbcron">
44078 <title>Clean up Database</title>
44080 <para>Script path: misc/cronjobs/cleanup_database.pl</para>
44082 <para>Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs
44083 and staged MARC files.</para>
44087 <section id="acqcrons">
44088 <title>Acquisitions</title>
44090 <section id="cleansuggcron">
44091 <title>Clean up old suggestions</title>
44093 <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
44095 <para>Does: Removes old (defined by you) suggestions from the
44096 suggestion management area.</para>
44100 <section id="deprecatedcrons">
44101 <title>Deprecated scripts</title>
44103 <para>These should not be run without modification:</para>
44105 <para>Script path: misc/cronjobs/update_items.pl</para>
44107 <para>Script path:misc/cronjobs/smsoverdues.pl</para>
44109 <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
44111 <para>Script path:misc/cronjobs/reservefix.pl</para>
44113 <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
44118 <chapter id="webservices">
44119 <title>Web Services</title>
44123 <section id="OAI-PMHservice">
44124 <title>OAI-PMH</title>
44128 <section id="oaiconfsample">
44129 <title>Sample OAI Conf File</title>
44131 <para><programlisting> format:
44134 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
44135 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
44136 xsl_file: /usr/local/koha/xslt/vs.xsl
44138 metadataPrefix: marxml
44139 metadataNamespace: http://www.loc.gov/MARC21/slim
44140 http://www.loc.gov/standards/marcxml/schema/MARC21slim
44141 schema: http://www.loc.gov/MARC21/slim
44142 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
44144 metadataPrefix: oai_dc
44145 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
44146 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
44148 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
44151 <section id="Rest-services">
44152 <title>REST services</title>
44154 <para>Koha can now be requested by REST http requests. BibLibre wrotes an external module to adds more possibilities than ILS-DI can provide.There is no authentication process, but authorized ips are listed in the config file. Services have been tested in 3.10, 3.12 and 3.14 koha versions. You can find more information about it into README file and opac/rest.pl documentation on http://git.biblibre.com. If you want to add features, send us a patch at dev_patches AT biblibre DOT com.</para>
44155 <para>Services provided in 1.4 version are:
44158 GET user/byid/:borrowernumber/holds
44159 GET user/:user_name/holds
44160 GET user/byid/:borrowernumber/issues
44161 GET user/:user_name/issues
44162 GET user/:user_name/issues_history
44163 GET user/byid/:borrowernumber/issues_history
44167 PUT user/:user_name
44168 GET biblio/:biblionumber/items
44169 GET biblio/:biblionumber/holdable
44170 GET biblio/:biblionumber/items_holdable_status
44171 GET item/:itemnumber/holdable
44172 PUT auth/change_password
44174 GET /suggestions/:suggestionid
44176 PUT /suggestions/:suggestionid
44177 DELETE /suggestions/:suggestionid
44184 <title>Using the SRU server</title>
44186 <section id="usingsru">
44190 <firstname>Nicolas</firstname>
44191 <surname>Morin</surname>
44193 <orgname>BibLibre</orgname>
44198 <firstname>Nicole C.</firstname>
44199 <surname>Engard</surname>
44200 <contrib>Edits where necessary.</contrib>
44204 <pubdate>December 2009</pubdate>
44206 <title>Using the SRU server</title>
44208 <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
44209 information about the protocol itself can be found at <ulink url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
44210 The version implemented is version 1.1.</para>
44212 <section id="sru_explain">
44213 <title>Explain</title>
44215 <para>If you want to have information about the implementation of SRU
44216 on a given server, you should have access to the Explain file using a
44217 request to the server without any parameter. Like
44218 <http://myserver.com:9999/biblios/>. The response from the
44219 server is an XML file that should look like the following and will
44220 give you information about the default settings of the SRU
44224 <zs:explainResponse>
44225 <zs:version>1.1</zs:version>
44227 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
44228 <zs:recordPacking>xml</zs:recordPacking>
44229 <zs:recordData>
44230 <explain xml:base="zebradb/explain-biblios.xml">
44232 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
44234 <serverInfo protocol="SRW/SRU/Z39.50">
44235 <host>biblibre</host>
44236 <port>9999</port>
44237 <database>biblios</database>
44238 </serverInfo>
44239 <databaseInfo>
44240 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
44241 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
44243 <sru>http://biblibre:9999</sru>
44245 </databaseInfo>
44247 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
44248 <title>CQL Standard Set</title>
44250 <index search="true" scan="true" sort="false">
44251 <title lang="en">CQL Server Choice</title>
44253 <name set="cql">serverChoice</name>
44256 <attr type="1" set="bib1">text</attr>
44259 <index search="true" scan="true" sort="false">
44260 <title lang="en">CQL All</title>
44262 <name set="cql">all</name>
44265 <attr type="1" set="bib1">text</attr>
44268 <!-- Record ID index -->
44269 <index search="true" scan="true" sort="false">
44270 <title lang="en">Record ID</title>
44272 <name set="rec">id</name>
44275 <attr type="1" set="bib1">rec:id</attr>
44276 <attr type="4" set="bib1">3</attr>
44282 <section id="sru_search">
44283 <title>Search</title>
44286 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
44287 is composed of the following elements:</para>
44291 <para>base url of the SRU server :
44292 http://myserver.com:9999/biblios?</para>
44296 <para>search part with the 3 required parameters : version,
44297 operation and query. The parameters within the search part should
44298 be of the key=value form, and can be combined with the &
44303 <para>One can add optional parameters to the query, for instance
44304 maximumRecords indicating the maximum number of records to be returned
44306 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
44307 will only get the first 5 results results from the server.</para>
44309 <para><ulink 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>
44310 gives more details about the search operations and in particular the
44311 list of optional parameters for searching.</para>
44313 <section id="sru_search_more_details">
44314 <title>More details about Search</title>
44316 <para>The "operation" key can take two values: scan or
44317 searchRetrieve.</para>
44319 <para>If operation=searchRetrieve, then the search key should be
44320 query. As in : operation=searchRetrieve&query=reefs</para>
44322 <para>If operation=scan, then the search key should be scanClause.
44323 As in : operation=scan&scanClause=reefs</para>
44325 <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
44326 that exist on your system. For instance you'll see that we have
44327 indexes for Subject and for Title: att 21 Subject and att 4 Title
44328 respectively.</para>
44330 <para>In the pqf.properties file located under
44331 etc/zebradb/pqf.properties I see that an access point already uses
44332 my Subject index (index.dc.subject = 1=21) while another uses my
44333 Title index (index.dc.title = 1=4) I know this is my Subject index
44334 because as I've seen just before in my bib1.att file, it's called
44335 with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
44336 my Subject index. And Title was called with 1=4 so index.dc.title =
44337 1=4 correctly points to my Title index. I can now construct my query
44338 just like I would in a search box, just preceding it with the
44339 "query" key: query=Subject=reefs and Title=coral searches "reefs" in
44340 the subject and "coral" in the title. The full url would be
44341 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
44342 and Title=coral If I want to limit the result set to just 5 records,
44344 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
44345 and Title=coral&maximumRecords=5</para>
44347 <para>I can also play with truncate, relations, etc. Those are also
44348 defined in my pqf.properties file. I can see for instance the
44349 position properties defined as:</para>
44352 position.first = 3=1 6=1
44354 position.any = 3=3 6=1
44355 # "any position in field"
44358 <para>So as an example if I want "coral" to be at the beginning of
44359 the title, I can do this query :
44360 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
44365 <section id="sru_retrieve">
44366 <title>Retrieve</title>
44368 <para>My search for
44369 http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
44370 reefs&maximumRecords=1 retrieves just on record. The response
44371 looks like this:</para>
44374 <zs:searchRetrieveResponse>
44375 <zs:version>1.1</zs:version>
44376 <zs:numberOfRecords>1</zs:numberOfRecords>
44379 <zs:recordPacking>xml</zs:recordPacking>
44380 <zs:recordData>
44381 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
44382 <leader> cam a22 4500</leader>
44383 <datafield tag="010" ind1=" " ind2=" ">
44384 <subfield code="a">2-603-01193-6</subfield>
44385 <subfield code="b">rel.</subfield>
44386 <subfield code="d">159 F</subfield>
44388 <datafield tag="020" ind1=" " ind2=" ">
44389 <subfield code="a">FR</subfield>
44390 <subfield code="b">00065351</subfield>
44392 <datafield tag="101" ind1="1" ind2=" ">
44393 <subfield code="c">ita</subfield>
44395 <datafield tag="105" ind1=" " ind2=" ">
44396 <subfield code="a">a z 00|y|</subfield>
44398 <datafield tag="106" ind1=" " ind2=" ">
44399 <subfield code="a">r</subfield>
44401 <datafield tag="100" ind1=" " ind2=" ">
44402 <subfield code="a">20091130 frey50 </subfield>
44404 <datafield tag="200" ind1="1" ind2=" ">
44405 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
44406 <subfield code="b">Texte imprimé</subfield>
44407 <subfield code="e">la faune sous-marine des coraux</subfield>
44408 <subfield code="f">A. et A. Ferrari</subfield>
44410 <datafield tag="210" ind1=" " ind2=" ">
44411 <subfield code="a">Lausanne</subfield>
44412 <subfield code="a">Paris</subfield>
44413 <subfield code="c">Delachaux et Niestlé</subfield>
44414 <subfield code="d">cop. 2000</subfield>
44415 <subfield code="e">impr. en Espagne</subfield>
44417 <datafield tag="215" ind1=" " ind2=" ">
44418 <subfield code="a">287 p.</subfield>
44419 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
44420 <subfield code="d">20 cm</subfield>
44424 <size>4725</size>
44425 <localnumber>2</localnumber>
44426 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
44429 </zs:recordData>
44430 <zs:recordPosition>1</zs:recordPosition>
44432 </zs:records>
44433 </zs:searchRetrieveResponse>
44440 <appendix id="sysprefdefaults">
44441 <title>System Preference Defaults</title>
44445 <section id="isbddefaults">
44446 <title>ISBD Defaults</title>
44450 <section id="isbddefault">
44451 <title>MARC Default</title>
44453 <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
44454 110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
44455 }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
44456 130t }|<br/><br/></para>
44458 <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
44459 245s }{ 245h }|</para>
44461 <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
44464 <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
44466 <para>#245||{ 245c }|</para>
44468 <para>#242||{ = 242c }|</para>
44470 <para>#250| - |{ 250a }{ 250b }|</para>
44472 <para>#254|, |{ 254a }|</para>
44474 <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
44477 <para>#256|, |{ 256a }|</para>
44479 <para>#257|, |{ 257a }|</para>
44481 <para>#258|, |{ 258a }{ 258b }|</para>
44483 <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
44485 <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
44488 <para>#306| - |{ 306a }|</para>
44490 <para>#307| - |{ 307a }{ 307b }|</para>
44492 <para>#310| - |{ 310a }{ 310b }|</para>
44494 <para>#321| - |{ 321a }{ 321b }|</para>
44496 <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
44497 }{ 340h }{ 340i }|</para>
44499 <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
44500 }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
44501 342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
44503 <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
44504 }{ 343h }{ 343i }|</para>
44506 <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
44508 <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
44509 }{ 352i }{ 352q }|</para>
44511 <para>#362| - |{ 362a }{ 351z }|</para>
44513 <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
44515 <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
44517 <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
44518 }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
44519 800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
44521 <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
44522 }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
44523 810s }{ 810t }{ 810u }{ 810v }|.</para>
44525 <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
44526 }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
44529 <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
44530 }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
44533 <para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
44535 <para>#501|<br/><br/>|{ 501a }|</para>
44537 <para>#502|<br/><br/>|{ 502a }|</para>
44539 <para>#504|<br/><br/>|{ 504a }|</para>
44541 <para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
44544 <para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
44545 506d }{ 506u }|</para>
44547 <para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
44549 <para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
44551 <para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
44554 <para>#511|<br/><br/>|{ 511a }|</para>
44556 <para>#513|<br/><br/>|{ 513a }{513b }|</para>
44558 <para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
44559 514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
44562 <para>#515|<br/><br/>|{ 515a }|</para>
44564 <para>#516|<br/><br/>|{ 516a }|</para>
44566 <para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
44568 <para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
44571 <para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
44573 <para>#522|<br/><br/>|{ 522a }|</para>
44575 <para>#524|<br/><br/>|{ 524a }|</para>
44577 <para>#525|<br/><br/>|{ 525a }|</para>
44579 <para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
44580 510d }{\n510x }|</para>
44582 <para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
44583 506d }{\n506u }|</para>
44585 <para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
44586 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
44588 <para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
44589 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
44592 <para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
44595 <para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
44598 <para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
44599 540d }{\n520u }|</para>
44601 <para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
44602 }{\n544d }{\n544e }{\n544n }|</para>
44604 <para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
44606 <para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
44608 <para>#547|<br/><br/>|{\n547a }|</para>
44610 <para>#550|<br/><br/>|{ 550a }|</para>
44612 <para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
44613 552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
44614 }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
44616 <para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
44617 555d }{ 555u }|</para>
44619 <para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
44621 <para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
44623 <para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
44624 565d }{ 565e }|</para>
44626 <para>#567|<br/><br/>|{ 567a }|</para>
44628 <para>#580|<br/><br/>|{ 580a }|</para>
44630 <para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
44632 <para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
44634 <para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
44636 <para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
44638 <para>#020|<br/><br/><label>ISBN: </label>|{
44639 020a }{ 020c }|</para>
44641 <para>#022|<br/><br/><label>ISSN: </label>|{
44644 <para>#222| = |{ 222a }{ 222b }|</para>
44646 <para>#210| = |{ 210a }{ 210b }|</para>
44648 <para>#024|<br/><br/><label>Standard No.:
44649 </label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
44651 <para>#027|<br/><br/><label>Standard Tech. Report.
44652 No.: </label>|{ 027a }|</para>
44654 <para>#028|<br/><br/><label>Publisher. No.:
44655 </label>|{ 028a }{ 028b }|</para>
44657 <para>#013|<br/><br/><label>Patent No.:
44658 </label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
44661 <para>#030|<br/><br/><label>CODEN: </label>|{
44664 <para>#037|<br/><br/><label>Source: </label>|{
44665 037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
44667 <para>#010|<br/><br/><label>LCCN: </label>|{
44670 <para>#015|<br/><br/><label>Nat. Bib. No.:
44671 </label>|{ 015a }{ 0152 }|</para>
44673 <para>#016|<br/><br/><label>Nat. Bib. Agency Control
44674 No.: </label>|{ 016a }{ 0162 }|</para>
44676 <para>#600|<br/><br/><label>Subjects--Personal
44677 Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
44678 }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
44679 }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
44680 }{--600x}{--600z}{--600y}{--600v}|</para>
44682 <para>#610|<br/><br/><label>Subjects--Corporate
44683 Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
44684 }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
44685 }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
44686 }{--610x}{--610z}{--610y}{--610v}|</para>
44688 <para>#611|<br/><br/><label>Subjects--Meeting Names:
44689 </label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
44690 }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
44691 611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
44693 <para>#630|<br/><br/><label>Subjects--Uniform
44694 Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
44695 }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
44696 630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
44698 <para>#648|<br/><br/><label>Subjects--Chronological
44699 Terms: </label>|{\n6483 }{\n648a
44700 }{--648x}{--648z}{--648y}{--648v}|</para>
44702 <para>#650|<br/><br/><label>Subjects--Topical Terms:
44703 </label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
44704 }{--650x}{--650z}{--650y}{--650v}|</para>
44706 <para>#651|<br/><br/><label>Subjects--Geographic
44707 Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
44708 }{--651x}{--651z}{--651y}{--651v}|</para>
44710 <para>#653|<br/><br/><label>Subjects--Index Terms:
44711 </label>|{ 653a }|</para>
44713 <para>#654|<br/><br/><label>Subjects--Facted Index
44714 Terms: </label>|{\n6543
44715 }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
44717 <para>#655|<br/><br/><label>Index Terms--Genre/Form:
44718 </label>|{\n6553 }{\n655a}{--655b}{--655x
44719 }{--655z}{--655y}{--655v}|</para>
44721 <para>#656|<br/><br/><label>Index Terms--Occupation:
44722 </label>|{\n6563
44723 }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
44725 <para>#657|<br/><br/><label>Index Terms--Function:
44726 </label>|{\n6573
44727 }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
44729 <para>#658|<br/><br/><label>Index Terms--Curriculum
44731 </label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
44733 <para>#050|<br/><br/><label>LC Class. No.:
44734 </label>|{ 050a }{ / 050b }|</para>
44736 <para>#082|<br/><br/><label>Dewey Class. No.:
44737 </label>|{ 082a }{ / 082b }|</para>
44739 <para>#080|<br/><br/><label>Universal Decimal Class.
44740 No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
44742 <para>#070|<br/><br/><label>National Agricultural
44743 Library Call No.: </label>|{ 070a }{ / 070b }|</para>
44745 <para>#060|<br/><br/><label>National Library of
44746 Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
44748 <para>#074|<br/><br/><label>GPO Item No.:
44749 </label>|{ 074a }|</para>
44751 <para>#086|<br/><br/><label>Gov. Doc. Class. No.:
44752 </label>|{ 086a }|</para>
44754 <para>#088|<br/><br/><label>Report. No.:
44755 </label>|{ 088a }|</para>
44758 <section id="unimarcdefault">
44759 <title>UNIMARC Default</title>
44761 <para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
44762 200i}|</h2></para>
44764 <para>#461|<label class="ipt">A part of : </label>|<a
44765 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
44766 461h} {v. 461v}{(461d)}<br/>|</para>
44768 <para>#200b|<label class="ipt">Material Designation :
44769 </label>| {200b }|<br/></para>
44771 <para>#101a|<label class="ipt">Language(s): </label>|<a
44772 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
44774 <para>#200f|<label class="ipt">Authors : </label>|<a
44775 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
44776 ; }</a>|<br/></para>
44778 <para>#200g|<label class="ipt">Co-authors : </label>|<a
44779 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
44780 ; }</a>|<br/></para>
44782 <para>#210a|<br/><label class="ipt">Place of pubblication
44783 : </label>|<a
44784 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
44786 <para>#210c|<label class="ipt">Publisher : </label>|<a
44787 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
44788 ; }</a>|<br/></para>
44790 <para>#210d|<label class="ipt">Date of pubblication :
44791 </label>|{ 210d}|<br/></para>
44793 <para>#215|<label class="ipt">Description :
44794 </label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
44796 <para>#225a|<label class="ipt">Series :</label>|<a
44797 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
44798 ;}</a> |</para>
44800 <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
44801 225v}|<br/></para>
44803 <para>#686|<label>Classification : </label>|{ 686a
44804 }|<br/></para>
44806 <para>#608|<label>Form, Genre : </label>|<a
44807 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
44808 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44809 title="Search on {608a}">{
44810 608a}</a>|<br/><br/></para>
44812 <para>#200||<label class="ipt">Subjects :
44813 </label><br/>|<ul></para>
44815 <para>#600|<label class="ipt">Person(s)
44816 </label><br/> |<li><a
44817 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
44818 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44819 title="Search on {600a}">{
44820 600a}</a></li>|<br/></para>
44822 <para>#601|<label class="ipt">Organisation(s)
44823 </label><br/>|<li><a
44824 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
44825 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44826 title="Search on {601a}">{
44827 601a}</a></li>|<br/></para>
44829 <para>#606|<label class="ipt">Term(s)
44830 </label><br/>|<li><a
44831 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
44832 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44833 title="Search on {606a}">{
44834 606a}</a></li>|<br/></para>
44836 <para>#607|<label class="ipt">Place(s)
44837 </label><br/>|<li><a
44838 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
44839 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44840 title="Search on {607a}">{
44841 607a}</a></li>|<br/></para>
44843 <para>#610|<label>Keywords</label><br/>|<li><a
44844 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
44845 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44846 title="Search on {610a}">{ 610a}</a></li>|</para>
44848 <para>#200||</ul>|</para>
44850 <para>#856|<label class="ipt">Electronic resource :
44851 </label>|<a href="{856u}">click here</a> to go to
44852 the external resource<br/></para>
44854 <para>#010|<label class="ipt">ISBN : </label>|{010a
44855 ;}|<br/></para>
44857 <para>#011|<label class="ipt">ISSN : </label>|{011a
44858 ;}|<br/></para>
44860 <para>#200||<label class="ipt">Notes :
44861 </label>|<br/><ul></para>
44863 <para>#300||<li>{300a}</li>|</para>
44865 <para>#307||<li>{307a}</li>|</para>
44867 <para>#310||<li>{310a}</li>|</para>
44869 <para>#326||<li>{326a}</li>|</para>
44871 <para>#327||<li>{327a}</li>|</para>
44873 <para>#333|<li>Public : |{333a}</li>|</para>
44875 <para>#200||</ul>|</para>
44877 <para>#330||<label class="ipt">Abstract :
44878 </label>|<br/></para>
44880 <para>#330||{330a}|<br/></para>
44882 <para>#200||<br/><h2>Items</h2>|</para>
44884 <para>#200|<table>|<th>Call
44885 number</th><th>Copy
44886 note</th><th>Fonds</th><th>Genre
44887 detail</th><th>Circulation
44888 type</th><th>Barcode</th>|</para>
44890 <para>#995||<tr><td> {995k}</td><td>
44891 {995u}</td><td>
44892 {995y}</td><td>{995e} </td><td>
44893 {995o}</td><td>{995f}</td></tr>|</table></para>
44898 <appendix id="receiptprint">
44899 <title>Configuring Receipt Printers</title>
44901 <para>The following instructions are for specific receipt printers, but
44902 can probably be used to help with setup of other brands as well.</para>
44904 <section id="epsonprinters">
44906 <corpauthor>NEKLS</corpauthor>
44908 <pubdate>2008</pubdate>
44910 <bibliosource><ulink url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
44913 <title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
44917 <section id="epsonprintdriver">
44918 <title>In the Print Driver</title>
44920 <para>For these instructions, we are using version 5,0,3,0 of the
44921 Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
44922 Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
44923 Center website</ulink> to gain access to the drivers; go to Technical
44924 Resources, then choose the printer model from the Printers drop-down
44927 <para>Click Start > Printers and Faxes > Right click the receipt
44928 printer > Properties:</para>
44932 <para>Advanced Tab, click Printing Defaults button</para>
44936 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
44940 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
44941 Printable Width</para>
44945 <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
44946 window that appears. Fit to Printable Width should be
44947 automatically selected.</para>
44951 <para>OK your way out of there.</para>
44956 <section id="epsonfirefox">
44957 <title>In Firefox</title>
44959 <para>Under File > Page Setup:</para>
44963 <para>Shrink to fit page on Format & Options tab</para>
44967 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
44968 makes the receipts use all available space on the paper
44973 <para>Set all Headers/Footers to -blank-. This removes all of the
44974 gunk you might normally find on a print from Firefox, such as the
44975 URL, number of pages, etc.</para>
44979 <para>Click OK</para>
44983 <para>Set the default printer settings in Firefox so you don't see a
44984 "Print" dialog:</para>
44988 <para>Go to File > Print</para>
44992 <para>Set the Printer to the receipt printer.</para>
44996 <para>Click the Advanced (or Properties) button</para>
45000 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
45004 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
45005 Printable Width</para>
45009 <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
45010 window that appears. Fit to Printable Width should be
45011 automatically selected.</para>
45015 <para>OK your way out, go ahead and print whatever page you are
45020 <para>Type about:config, in the address bar. Click "I'll be
45021 careful, I promise!" on the warning message.</para>
45025 <para>Type, print.always in Filter.</para>
45029 <para>Look for print.always_print_silent.</para>
45033 <para>If the preference is there then set the value to
45040 <para>If the preference is not there (and it shouldn't be in most
45041 browsers) you have to add the preference.</para>
45045 <para>Right click the preference area and select New >
45050 <para>Type print.always_print_silent in the dialog box and set
45051 the value to True. This sets the print settings in Firefox to
45052 always use the same settings and print without showing a
45060 <para>Setting the print.always_print_silent setting in about:config
45061 DISABLES the ability to choose a printer in Firefox.</para>
45066 <section id="epson2">
45068 <corpauthor>NEKLS</corpauthor>
45070 <pubdate>2008</pubdate>
45072 <bibliosource><ulink url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
45075 <title>For Epson TM-T88II (2) Printers</title>
45077 <para>Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
45078 Center website</ulink> to gain access to the drivers; go to Technical
45079 Resources, then choose the printer model from the Printers drop-down
45082 <section id="epson2firefox">
45083 <title>In Firefox</title>
45085 <para>Under File > Page Setup:</para>
45089 <para>Shrink to fit page on Format & Options tab</para>
45093 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
45094 makes the receipts use all available space on the paper
45099 <para>Set all Headers/Footers to -blank-. This removes all of the
45100 gunk you might normally find on a print from Firefox, such as the
45101 URL, number of pages, etc.</para>
45105 <para>Click OK</para>
45109 <para>Set the default printer settings in Firefox so you don't see a
45110 "Print" dialog:</para>
45114 <para>Go to File > Print</para>
45118 <para>Set the Printer to the receipt printer.</para>
45122 <para>Print whatever page you are on.</para>
45126 <para>Type about:config, in the address bar. Click "I'll be
45127 careful, I promise!" on the warning message.</para>
45131 <para>Type, print.always in Filter.</para>
45135 <para>Look for, print.always_print_silent.</para>
45139 <para>If the preference is there then set the value to
45146 <para>If the preference is not there (and it shouldn't be in most
45147 browsers) you have to add the preference.</para>
45151 <para>Right click the preference area and select New >
45156 <para>Type, print.always_print_silent in the dialog box and
45157 set the value to True. This sets the print settings in Firefox
45158 to always use the same settings and print without showing a
45166 <para>Setting the print.always_print_silent setting in about:config
45167 DISABLES the ability to choose a printer in Firefox.</para>
45172 <section id="starprinter">
45174 <corpauthor>RHCL</corpauthor>
45177 <firstname>Nicole C.</firstname>
45179 <surname>Engard</surname>
45182 <pubdate>2010</pubdate>
45185 <title>For Star SP542 Printers</title>
45187 <section id="installstarprinter">
45188 <title>Installing the Printer</title>
45190 <para>While the following comments are based on the Star SP542 receipt
45191 printer, they probably apply to all printers in the SP5xx
45194 <para>The Star SP542 receipt printer works well with Koha and <emphasis role="bold">Firefox
45195 on Windows XP SP3</emphasis>. This printer, with either the parallel or USB interface,
45196 is fairly easy to install and configure. You will need the following executable file which
45197 is available from numerous places on the Internet:</para>
45199 <para>linemode_2k-xp_20030205.exe</para>
45201 <para>This executable actually does all of the installation; you will
45202 not need to use the Microsoft Windows "Add Printer" program. We
45203 recommend that when installing, the option for the software monitor
45204 not be selected; we have experienced significant pauses and delays in
45205 printing with it. Instead, simply choose to install the receipt
45206 printer without the monitor.</para>
45208 <para>Additionally, the install program may not put the printer on the
45209 correct port, especially if using the USB interface. This is easily
45210 corrected by going to "Start -> Printers and Faxes -> Properties
45211 for the SP542 printer -> Ports", then check the appropriate
45214 <para>A reboot may be required, even if not indicated by the
45215 installation software or the operating system.</para>
45216 <para><emphasis role="bold">Windows 7</emphasis> users should refer to this page: <ulink
45217 url="http://www.starmicronics.com/supports/win7.aspx"
45218 >http://www.starmicronics.com/supports/win7.aspx</ulink>.
45223 <section id="firefoxreceipt">
45225 <corpauthor>VOKAL</corpauthor>
45228 <firstname>Nicole C.</firstname>
45230 <surname>Engard</surname>
45233 <pubdate>2010</pubdate>
45235 <bibliosource><ulink 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>
45238 <title>Configuring Firefox to Print to Receipt Printer</title>
45242 <para>Open File > Page Setup</para>
45246 <para>Make all the headers and footers blank</para>
45250 <para>Set the margins to 0 (zero)</para>
45254 <para>In the address bar of Firefox, type about:config</para>
45258 <para>Search for print.always_print_silent and double click
45263 <para>Change it from false to true</para>
45267 <para>This lets you skip the Print pop up box that comes up, as
45268 well as skipping the step where you have to click OK,
45269 automatically printing the right sized slip.</para>
45275 <para>If print.always_print_silent does not come up</para>
45279 <para>Right click on a blank area of the preference
45284 <para>Select new > Boolean</para>
45288 <para>Enter "print.always_print_silent" as the name (without
45293 <para>Click OK</para>
45297 <para>Select true for the value</para>
45303 <para>You may also want to check what is listed for
45304 print.print_printer</para>
45308 <para>You may have to choose Generic/Text Only (or whatever your
45309 receipt printer might be named)</para>
45316 <appendix id="noticesappendix">
45317 <title>Notice & Slips Guides</title>
45318 <section id="noticesfieldguide">
45322 <firstname>Barton</firstname>
45323 <surname>Chittenden</surname>
45325 <orgname>ByWater Solutions</orgname>
45329 <firstname>Nicole C.</firstname>
45330 <surname>Engard</surname>
45333 <pubdate>2014</pubdate>
45335 <title>Field Guide for Notices & Slips</title>
45336 <para>This guide will break down the notices and slips information in 3 ways. First it will
45337 tell you what file generates the notice, then how you will present the item info in that
45338 notice and finally if the notice can be branch specific or not.</para>
45341 style="border-collapse:collapse;border:1px solid black;font-family:'Times New Roman';letter-spacing:normal;text-indent:0px;text-transform:none;word-spacing:0px">
45344 <th rowspan="1" colspan="1" align="left">Letter Code</th>
45345 <th rowspan="1" colspan="1" align="left">Used In</th>
45346 <th rowspan="1" colspan="1" align="left">Detail tag</th>
45347 <th rowspan="1" colspan="1" align="left">Can be branch specific</th>
45352 <td rowspan="1" colspan="1" align="left">DUE</td>
45353 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45354 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45355 <td rowspan="1" colspan="1" align="left">No</td>
45358 <td rowspan="1" colspan="1" align="left">DUEDGST</td>
45359 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45360 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45361 <td rowspan="1" colspan="1" align="left">No</td>
45364 <td rowspan="1" colspan="1" align="left">PREDUE</td>
45365 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45366 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45367 <td rowspan="1" colspan="1" align="left">No</td>
45370 <td rowspan="1" colspan="1" align="left">PREDUEDGST</td>
45371 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
45372 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
45373 <td rowspan="1" colspan="1" align="left">No</td>
45376 <td rowspan="1" colspan="1" align="left">ODUE*</td>
45377 <td rowspan="1" colspan="1" align="left">overdue_notices.pl</td>
45378 <td rowspan="1" colspan="1" align="left"><<items.content>> or <item>
45380 <td rowspan="1" colspan="1" align="left">Yes</td>
45383 <td rowspan="1" colspan="1" align="left">CHECKOUT</td>
45384 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
45385 <td rowspan="1" colspan="1" align="left">N/A</td>
45386 <td rowspan="1" colspan="1" align="left">Yes</td>
45389 <td rowspan="1" colspan="1" align="left">RENEWAL</td>
45390 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
45391 <td rowspan="1" colspan="1" align="left">N/A</td>
45392 <td rowspan="1" colspan="1" align="left">Yes</td>
45395 <td rowspan="1" colspan="1" align="left">TRANSFERSLIP</td>
45396 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
45397 <td rowspan="1" colspan="1" align="left">N/A</td>
45398 <td rowspan="1" colspan="1" align="left">Yes</td>
45401 <td rowspan="1" colspan="1" align="left">ISSUESLIP</td>
45402 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
45403 <td rowspan="1" colspan="1" align="left">
45404 <para><checkedout> </checkedout> </para>
45405 <para> <overdue> </overdue> </para>
45406 <para> <news> </news> </para>
45408 <td rowspan="1" colspan="1" align="left">Yes</td>
45411 <td rowspan="1" colspan="1" align="left">ISSUEQSLIP</td>
45412 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
45413 <td rowspan="1" colspan="1" align="left"><checkedout> </checkedout></td>
45414 <td rowspan="1" colspan="1" align="left">Yes</td>
45417 <td rowspan="1" colspan="1" align="left">HOLDPLACED</td>
45418 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
45419 <td rowspan="1" colspan="1" align="left">N/A</td>
45420 <td rowspan="1" colspan="1" align="left">Yes</td>
45423 <td rowspan="1" colspan="1" align="left">RESERVESLIP</td>
45424 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
45425 <td rowspan="1" colspan="1" align="left">N/A</td>
45426 <td rowspan="1" colspan="1" align="left">Yes</td>
45429 <td rowspan="1" colspan="1" align="left">ASKED</td>
45430 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45431 <td rowspan="1" colspan="1" align="left">N/A</td>
45432 <td rowspan="1" colspan="1" align="left">Yes</td>
45435 <td rowspan="1" colspan="1" align="left">CHECKED</td>
45436 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45437 <td rowspan="1" colspan="1" align="left">N/A</td>
45438 <td rowspan="1" colspan="1" align="left">Yes</td>
45441 <td rowspan="1" colspan="1" align="left">ACCEPTED</td>
45442 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45443 <td rowspan="1" colspan="1" align="left">N/A</td>
45444 <td rowspan="1" colspan="1" align="left">Yes</td>
45447 <td rowspan="1" colspan="1" align="left">REJECTED</td>
45448 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
45449 <td rowspan="1" colspan="1" align="left">N/A</td>
45450 <td rowspan="1" colspan="1" align="left">Yes</td>
45453 <td rowspan="1" colspan="1" align="left">PREDUE_PHONE</td>
45454 <td rowspan="1" colspan="1" align="left">TalkingTech_itiva_outbound</td>
45455 <td rowspan="1" colspan="1" align="left">N/A</td>
45456 <td rowspan="1" colspan="1" align="left">No</td>
45459 <td rowspan="1" colspan="1" align="left">OVERDUE_PHONE</td>
45460 <td rowspan="1" colspan="1" align="left">TalkingTech_itiva_outbound</td>
45461 <td rowspan="1" colspan="1" align="left">N/A</td>
45462 <td rowspan="1" colspan="1" align="left">No</td>
45465 <td rowspan="1" colspan="1" align="left">HOLD_PHONE</td>
45466 <td rowspan="1" colspan="1" align="left">TalkingTech_itiva_outbound</td>
45467 <td rowspan="1" colspan="1" align="left">N/A</td>
45468 <td rowspan="1" colspan="1" align="left">No</td>
45471 <td rowspan="1" colspan="1" align="left">OPAC_REG_VERIFY</td>
45472 <td rowspan="1" colspan="1" align="left">opac/opac-memberentry.pl</td>
45473 <td rowspan="1" colspan="1" align="left">N/A</td>
45474 <td rowspan="1" colspan="1" align="left">No</td>
45482 <appendix id="samplenotice">
45483 <title>Example Notice</title>
45485 <para>Nicole Engard</para>
45487 <para>410 Library Rd.</para>
45489 <para>Philadelphia, PA 19107</para>
45491 <para>Dear Nicole Engard (23529000035726),</para>
45493 <para>According to our records, at the time of this notice, you have items
45494 that are overdue. Please return or renew them as soon as possible to avoid
45495 increasing late fines.</para>
45497 <para>If you have registered a password with the library, you may use it
45498 with your library card number to renew online.</para>
45500 <para>If you believe you have returned the items below please call at and
45501 library staff will be happy to help resolve the issue.</para>
45503 <para>The following item(s) are currently overdue:</para>
45505 <para>07/08/2008 Creating drug-free schools and communities : 502326000054
45506 Fox, C. Lynn.</para>
45508 <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
45510 <para>Sincerely, Library Staff</para>
45513 <appendix id="sampleserialsapp">
45514 <title>Sample Serials</title>
45518 <section id="readersdigestsample">
45519 <title>Reader's Digest (0034-0375)</title>
45523 <para>Published 12 times a year (monthly)</para>
45527 <para>The Volume number changes every 6 months and the numbers
45528 continues on (requires an advanced pattern).</para>
45531 <screeninfo>Sample Reader's Digest Subscription</screeninfo>
45535 <imagedata fileref="images/serialssamples/readersserial.png"/>
45545 <section id="peoplesample">
45546 <title>People Weekly (1076-0091)</title>
45550 <para>Published weekly</para>
45554 <para>The website says "on Saturday except the first week of
45555 August, Thanksgiving week, the first and last weeks of the year"
45556 but this does not match the pattern for 2007 or 2008</para>
45562 <para>In the Jul-Dec there are 26 issues</para>
45566 <para>In the Jan-Jun there are 25 issues (no issue for the first
45567 week of January)</para>
45571 <para>Since the irregularity on the first # 26 does not skip a week,
45572 this would be set up as to roll over on issue 25. The 26th issue in the
45573 second half of the year would have to be received as a
45574 supplemental.</para>
45576 <para>The irregularity check will complain that 52 issues were expected,
45577 but 25 entered. The current irregularity check can only check that the
45578 first position of the numbering pattern matches the expected issue count
45579 of the periodicity. But we do need to trigger the rollover on the
45580 volume, so we need to define the last two weeks of the year as
45581 irregularities. So we receive 50 issues the first 50 weeks, then one
45582 supplemental issue in week 51, which we have to define the enumeration
45583 for, then the next predicted issue will be the following year's first
45587 <section id="hebrewserialsample">
45588 <title>Et-Mol</title>
45590 <para>This journal is published with the following rules:</para>
45594 <para>6 issues a year (every 2 months)</para>
45598 <para>year changes every 6 issues</para>
45602 <para>we start in 2011</para>
45606 <para>the issue number goes up indefinitely</para>
45610 <para>starting from issue 215</para>
45614 <para>The planning would look like this:</para>
45617 <screeninfo>Sample for this Hebrew Journal</screeninfo>
45621 <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
45626 <section id="backpackerserial">
45627 <title>Backpacker (0277-867X)</title>
45628 <para>Published 9 times a year irregularly. The issues continues while the volume and number
45629 rolls over every 9 issues. If you're holding Volume 41, Number 3, Issue 302 in your hand
45630 the prediction would look like this:</para>
45632 <screeninfo>Backpacker numbering pattern</screeninfo>
45635 <imagedata fileref="images/serialssamples/backpacker.png"/>
45639 <para>And the received issues would number like this:</para>
45640 <para>v. 41, no. 3, iss. 302 </para>
45641 <para>v. 41, no. 4, iss. 303 </para>
45642 <para>v. 41, no. 5, iss. 304 </para>
45643 <para>v. 41, no. 6, iss. 305 </para>
45644 <para>v. 41, no. 7, iss. 306 </para>
45645 <para>v. 41, no. 8, iss. 307</para>
45646 <para>v. 41, no. 9, iss. 308 </para>
45647 <para>v. 42, no. 1, iss. 309 </para>
45648 <para>v. 42, no. 2, iss. 310 </para>
45649 <para>v. 42, no. 3, iss. 311 </para>
45650 <para>v. 42, no. 4, iss. 312</para>
45652 <section id="keatsserial">
45653 <title>Keats-Shelley Journal (0453-4387)</title>
45654 <para>This journal is published once per year in July. The numbering follows this pattern: <itemizedlist>
45656 <para>Vol. 61 2013</para>
45659 <para>Vol. 62 2014</para>
45662 <para>Vol. 63 2015</para>
45664 </itemizedlist> Setup should look like this (if you're starting in July 2014):</para>
45666 <screeninfo>Serial planning</screeninfo>
45669 <imagedata fileref="images/serialssamples/keatsplanning.png"/>
45674 <para>The prediction test will not show the right pattern, but once you receive you will see
45675 that the above does generate the right pattern.</para>
45678 <section id="cilserial">
45679 <title>Computers in Libraries (1041-7915)</title>
45680 <para>Computers in Libraries is published ten times per year (monthly with January/February
45681 and July/August combined issues).</para>
45683 <screeninfo>Subscription details</screeninfo>
45686 <imagedata fileref="images/serialssamples/cilirregular.png"/>
45691 <screeninfo>Serial Planning</screeninfo>
45694 <imagedata fileref="images/serialssamples/cilpattern.png"/>
45699 <screeninfo>Received details</screeninfo>
45702 <imagedata fileref="images/serialssamples/cilreceived.png"/>
45708 <appendix id="samplelistemail">
45709 <title>Sample List & Cart Emails</title>
45710 <section id="examplelistemail">
45711 <title>Example Email from List</title>
45712 <para>Below is an example of an email from a list in
45713 Koha.<programlisting>Hi,
45715 Here is your list called If You Like Jodi Picoult, sent from our online catalog.
45717 Please note that the attached file is a MARC bibliographic records file
45718 which can be imported into a Personal Bibliographic Software like EndNote,
45719 Reference Manager or ProCite.
45720 ---------------------------------------------
45722 Home safe : a novel /
45724 by Berg, Elizabeth.
45726 Published by: Random House,, 260 p. ;, 25 cm.
45727 Copyright year: 2009
45729 In the online catalog:
45730 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12113
45732 North Branch FIC (FIC Ber) TVSN500088894O
45733 Main Library FIC (FIC Boh) TVSN5000921548
45734 South Branch FIC (FIC Boh) TVSN500092156A
45735 West Branch FIC (FIC Boh) TVSN5000921559
45737 ---------------------------------------------
45741 by Brown, Rosellen.
45743 Published by: Farrar, Straus, and Giroux,, 402 p. ;, 24 cm.
45744 Copyright year: 2000
45746 In the online catalog:
45747 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12501
45749 East Branch (813/.54)
45750 South Branch FIC (FIC Bro) TVSN5000451333</programlisting></para>
45752 <section id="examplecartemail">
45753 <title>Example Email from Cart</title>
45754 <para>Below is a sample of what an email from the Cart in Koha will look
45755 like:<programlisting>Hi,
45757 Joaquin D'Planque sent you a cart from our online catalog.
45759 Please note that the attached file is a MARC bibliographic records
45760 file which can be imported into personal bibliographic software like
45761 EndNote, Reference Manager or ProCite.
45763 ---------------------------------------------------------------------
45767 Author(s): Brookfield, Karen. ;
45768 Published by: Knopf : | Distributed by Random House, , 63 p. : ,
45770 Copyright year: 1993
45771 Notes : Includes index.
45775 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=31644
45779 * East Branch (JNF 002 Bro) TVSN500017618A
45781 -----------------------------------------------------------------
45783 2. The 1965 World book year book :
45785 Published by: Field Enterprises Educational Corp., , 628 p. : , 26
45787 Copyright year: 1965
45788 Notes : Includes index. | Spine title: Year book, 1965. | Cover
45789 title: The World book year book, 1965.
45791 http://www.archive.org/details/1965worldbookyea00chic%20%7C%20http://www.openlibrary.org/books/OL24199089M
45794 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=88666
45796 -----------------------------------------------------------------</programlisting></para>
45800 <appendix id="kohacms">
45801 <title>Using Koha as a Content Management System (CMS)</title>
45805 <section id="kohacmssetup">
45806 <title>Setup</title>
45808 <para>These are instructions for taking a default install of Koha and allowing it to function
45809 as a little content management system. This will allow a library to publish an arbitrary
45810 number of pages based on a template. This example uses the template for the main opac page,
45811 but you could just as well use any template you wish with a bit more editing. This may be
45812 appropriate if you have a small library, want to allow librarians to easily add pages, and
45813 do not want to support a complete CMS. </para>
45817 <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
45818 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same directory) </para>
45822 <para>Edit pages.pl in an editor</para>
45826 <para>At approximately line 36 change this code: </para>
45828 <programlisting>template_name => "opac-main.tt",</programlisting>
45832 <para>To this code:</para>
45834 <programlisting>template_name => "pages.tt", </programlisting>
45838 <para>At approximately line 54 after this code: </para>
45839 <programlisting>$template->param(
45840 koha_news => $all_koha_news,
45841 koha_news_count => $koha_news_count
45842 );</programlisting>
45845 <para>Add these lines: </para>
45846 <programlisting> my $page = "page_" . $cgi->param('p'); # go for "p" value in URL and do the concatenation
45847 my $preference = C4::Context->preference($page); # Go for preference
45848 $template->{VARS}->{'page_test'} = $preference # pass variable to template pages.tt</programlisting>
45852 <para>Note pages.pl file must have Webserver user execution permissions, you can use
45853 <ulink url="http://en.wikipedia.org/wiki/Chmod">chmod</ulink> command if you are
45854 actually logged in as such user:
45855 <programlisting> $chmod 711 pages.pl</programlisting></para>
45859 <para>Copy /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/opac-main.tt to
45860 /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tt </para>
45863 <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tt </para>
45866 <para>At approximately line 38, change this:</para>
45867 <programlisting> [% IF ( OpacMainUserBlock ) %]<div id="opacmainuserblock" class="container">[% OpacMainUserBlock %]</div>[% END %]</programlisting>
45868 <para>To this:</para>
45869 <programlisting> [% IF ( page_test ) %]<div id="opacmainuserblock" class="container">[% page_test %]</div>[% END %]</programlisting>
45873 <para>In the browser go to Home > Administration > System Preferences > Local Use and add
45874 a New Preference called "page_test" </para>
45878 <para>Fill it out as so</para>
45882 <para>Explanation: test page for pages tiny cms</para>
45886 <para>Variable: page_test</para>
45890 <para>Value: Lorem ipsum</para>
45894 <para>Click the TextArea link (or enter "TextArea" into the
45895 input field below it)</para>
45899 <para>variable options (last field): 80|50</para>
45905 <para>In a browser go to http://youraddress/cgi-bin/koha/pages.pl?p=test The page should
45906 come up with the words "Lorem ipsum" in the main content area of the page. (replace
45907 "youraddress" with localhost, 127.0.0.1, or your domain name depending on how you have
45908 Apache set up.) </para>
45912 <para>To add more pages simply create a system preference where the title begins with
45913 "page_" followed by any arbitrary letters. You can add any markup you want as the value
45914 of the field. Reference the new page by changing the value of the "p" parameter in the
45918 <para>To learn more visit the Koha wiki page on this topic: <ulink url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
45920 <section id="kohacmstrouble">
45921 <title>Troubleshooting</title>
45923 <para>If you have problems check file permissions on pages.pl and
45924 pages.tmpl. They should have the same user and group as other Koha
45925 files like opac-main.pl.</para>
45928 <section id="kohacmsbonus">
45929 <title>Bonus Points</title>
45931 <para>Instead of using the address
45932 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
45933 http://youraddress/pages.pl?p=test Just open up
45934 /etc/koha/koha-httpd.conf and add the follow at about line
45935 13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
45937 <para>Then restart Apache.</para>
45941 <section id="kohacmsusage">
45942 <title>Usage</title>
45944 <para>After setting up Koha as a CMS you can create new pages following
45945 these instructions:</para>
45947 <section id="kohacmspages">
45948 <title>Adding Pages</title>
45950 <para>To add a new page you need to add a system preference under
45955 <para>Get there: More > Administration > Global System
45956 Preferences > Local Use</para>
45960 <para>Click 'New Preference'</para>
45964 <para>Enter in a description in the Explanation field</para>
45968 <para>Enter a value that starts with 'page_' in the Variable
45973 <para>Enter starting HTML in the Value field</para>
45976 <screeninfo>Add a new preference</screeninfo>
45980 <imagedata fileref="images/appendix-cms/newpreference.png"/>
45987 <para>Set the Variable Type to Textarea</para>
45991 <para>Set the Variable options to something like 20|20 for 20 rows
45992 and 20 columns</para>
45995 <screeninfo>Settings for the new preference</screeninfo>
45999 <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
46007 <section id="kohacmsview">
46008 <title>Viewing your page</title>
46010 <para>You can view your new page at
46011 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
46012 the part you entered after 'page_' in the Variable field.</para>
46015 <section id="kohacmsexpage">
46016 <title>Example</title>
46018 <para>This process can be used to create recommended reading lists
46019 within Koha. So once the code changes have been made per the
46020 instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
46021 instructions above to great a page for 'Recommended Reading
46025 <screeninfo>Create page by modifying a system
46026 preference</screeninfo>
46030 <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
46035 <para>Next we need to create pages for our various classes (or
46036 categories). To do this, return to the 'Adding a New Page' section and
46037 create a preference for the first class.</para>
46040 <screeninfo>Add a new sys pref for another page</screeninfo>
46044 <imagedata fileref="images/appendix-cms/class101-pref.png"/>
46049 <para>Next you'll want to link your first page to your new second
46050 page, go to the page_recommend preference and click 'Edit.' Now you
46051 want to edit the HTML to include a link to your newest page:</para>
46054 <screeninfo>Edit original preference to add new page</screeninfo>
46058 <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
46064 <section id="examplecms">
46065 <title>Live Examples</title>
46069 <para>The Crawford Library at Dallas Christian College is using
46070 this method for their recommended reading lists: <ulink url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
46077 <appendix id="resetkohadb">
46078 <title>Resetting the Koha Database</title>
46080 <para>These notes on how to reset the database for Koha were derived from the following email
46082 url="http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html"
46083 >http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html</ulink></para>
46085 <para>Resetting the database may be useful if you install Koha with the
46086 sample data, and then wish to use real data without reinstalling the
46089 <section id="truncate">
46090 <title>Truncate Tables</title>
46092 <para>Use your preferred MySQL client to <ulink url="http://dev.mysql.com/doc/refman/5.0/en/truncate.html">truncate</ulink>
46093 the following tables:</para>
46101 <para>biblioitems</para>
46109 <para>auth_header</para>
46113 <para>sessions</para>
46117 <para>zebraqueue</para>
46122 <section id="resetzebra">
46123 <title>Reset the Zebra Index</title>
46125 <para>Run the following commands to reset the authorities and biblios
46126 Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
46127 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
46128 <para>If you are running a package install then you'll want to run the following commands to
46129 reset the authorities and biblios Zebra indices
46130 instead:<programlisting>$ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg -g iso2709 -d authorities init
46131 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
46132 <para>Replacing YOURLIBRARY with your Koha installation name.</para>
46136 <appendix id="importantlinks">
46137 <title>Important Links</title>
46141 <section id="koharelatedlinks">
46142 <title>Koha Related</title>
46146 <para>Report Koha Bugs - <ulink url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
46150 <para>Koha Versioning Control - <ulink url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
46154 <para>Database Structure - <ulink 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>
46158 <para>Koha as a CMS - <ulink url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
46162 <para>Kyles's Koha Tools - <ulink url="http://millruntech.com/koha">http://millruntech.com/koha</ulink></para>
46166 <para>Koha Bibliography - <ulink url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
46170 <para>Koha Shared Links - <ulink url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
46174 <para>Koha Presentations - <ulink url="http://www.slideshare.net/group/koha-ils/slideshows">http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
46179 <section id="catalogrelatedlinks">
46180 <title>Cataloging Related</title>
46184 <para>Koha MARC Tutorials - <ulink url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
46188 <para>Z39.50 Server Search - <ulink url="http://targettest.indexdata.com/">http://targettest.indexdata.com/</ulink></para>
46192 <para>Z39.50 Server List - <ulink url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm">http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
46196 <para>Library of Congress Authorities - <ulink url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
46200 <para>MARC Country Codes - <ulink url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
46204 <para>Search the MARC Code List for Organizations - <ulink url="http://www.loc.gov/marc/organizations/org-search.php">http://www.loc.gov/marc/organizations/org-search.php</ulink></para>
46208 <para>Search for Canadian MARC Codes - <ulink 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>
46212 <para>Z39.50 Bib-1 Attribute - <ulink url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink></para>
46217 <section id="enhancedcontentlinks">
46218 <title>Enhanced Content Related</title>
46222 <para>Amazon Associates - <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
46226 <para>Amazon Web Services - <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
46230 <para>WorldCat Affiliate Tools - <ulink url="http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister">http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister</ulink></para>
46234 <para>XISBN - <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
46238 <para>LibraryThing for Libraries - <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
46243 <section id="opaclinks">
46244 <title>Design Related</title>
46248 <para>JQuery Library - <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
46252 <para>Owen Leonard's Koha Blog - <ulink url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
46257 <section id="reportlinks">
46258 <title>Reports Related</title>
46262 <para>SQL Reports Library - <ulink url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink></para>
46266 <para>Database Schema - <ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
46270 <para>Sample reports from NEKLS - <ulink
46271 url="http://www.nexpresslibrary.org/training/reports-training/"
46272 >http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
46277 <section id="installlinks">
46278 <title>Installation Guides</title>
46282 <para>Installing Koha 3 on Ubuntu - <ulink url="http://www.blazingmoon.org/guides/k3-on-u810-1.html">http://www.blazingmoon.org/guides/k3-on-u810-1.html</ulink></para>
46286 <para>Koha on Debian installation documentation - <ulink 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>
46290 <para>Koha 3.2 on Debian Squeeze - <ulink 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>
46295 <section id="misclinks">
46296 <title>Misc</title>
46300 <para>Zotero - <ulink url="http://zotero.org">http://zotero.org</ulink></para>
46304 <para>SOPAC - <ulink url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
46310 <appendix id="XSLTiTypes">
46311 <title>Koha XSLT Item Types</title>
46313 <para>When you have any of the XSLT system preferences (<link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>, <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>, <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>, and/or <link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link>) along with the
46314 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
46315 preference turned on you will see item type icons on the related screen.
46317 <para>These images are coming from values found in your leader, if
46318 your leader is not cataloged properly it might be best to turn off the
46319 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
46320 preference (which can be done while leaving the other XSLT preferences
46322 </important></para>
46325 <screeninfo>Book image</screeninfo>
46329 <imagedata fileref="images/appendix-xslt/book.png"/>
46336 <para>Book [BK]</para>
46340 <para>leader6 = a (and one of the leader7 values below)</para>
46344 <para>leader7 = a</para>
46348 <para>leader7 = c</para>
46352 <para>leader7 = d</para>
46356 <para>leader7 = m</para>
46362 <para>leader6 = t</para>
46369 <screeninfo>Computer Image</screeninfo>
46373 <imagedata fileref="images/appendix-xslt/comp.png"/>
46380 <para>Computer File [CF]</para>
46384 <para>leader6 = m</para>
46391 <screeninfo>Continuing Resource Image</screeninfo>
46395 <imagedata fileref="images/appendix-xslt/cr.png"/>
46402 <para>Continuing Resource [CR]</para>
46406 <para>leader7 = b</para>
46410 <para>leader7 = i</para>
46414 <para>leader7 = s</para>
46421 <screeninfo>Map Image</screeninfo>
46425 <imagedata fileref="images/appendix-xslt/map.png"/>
46432 <para>Map [MP]</para>
46436 <para>leader6 = e</para>
46440 <para>leader6 = f</para>
46447 <screeninfo>Mixed Materials Image</screeninfo>
46451 <imagedata fileref="images/appendix-xslt/mixed.png"/>
46458 <para>Mixed [MX]</para>
46462 <para>leader6 = p</para>
46469 <screeninfo>Sound Image</screeninfo>
46473 <imagedata fileref="images/appendix-xslt/sound.png"/>
46480 <para>Sound [MU]</para>
46484 <para>leader6 = c</para>
46488 <para>leader6 = d</para>
46492 <para>leader6 = i</para>
46496 <para>leader6 = j</para>
46503 <screeninfo>Visual Material Image</screeninfo>
46507 <imagedata fileref="images/appendix-xslt/visual.png"/>
46514 <para>Visual Material [VM]</para>
46518 <para>leader6 = g</para>
46522 <para>leader6 = k</para>
46526 <para>leader6 = r</para>
46533 <screeninfo>Kit Image</screeninfo>
46537 <imagedata fileref="images/appendix-xslt/kit.png"/>
46548 <para>leader6 = o</para>
46555 <appendix id="marcedit">
46556 <title>MarcEdit</title>
46558 <para>Download MarcEdit : <ulink url="http://marcedit.reeset.net/"
46559 >http://marcedit.reeset.net/</ulink></para>
46561 <section id="marceditprefix">
46562 <title>Adding a prefix to call numbers</title>
46564 <para>When bringing data into Koha, you may want to first clean it up.
46565 One common action among Koha users is to add a prefix to the call
46570 <para>Open MarcEdit</para>
46573 <screeninfo>MarcEdit</screeninfo>
46577 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
46584 <para>Click 'MarcEditor'</para>
46588 <para>Go to Tools > Edit Subfield Data</para>
46591 <screeninfo>Edit subfield data</screeninfo>
46595 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
46602 <para>To prepend data the special character is: ^b To simply
46603 prepend data to the beginning of a subfield, add ^b to the Field
46604 Data: textbox and the data to be appended in the Replace</para>
46607 <screeninfo>Prepend data to a field</screeninfo>
46611 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
46618 <para>To prepend data to the beginning of the subfield while
46619 replacing a text string, add ^b[string to replace] to the Field
46620 Data textbox and the data to be appended in the Replace With
46628 <section id="marceditexcel">
46632 <firstname>Kanika</firstname>
46633 <surname>Goyal</surname>
46635 <orgname>Delhi Technological University</orgname>
46640 <firstname>Nicole C.</firstname>
46641 <surname>Engard</surname>
46642 <contrib>Edits where necessary.</contrib>
46646 <pubdate>2010</pubdate>
46648 <bibliosource><ulink url="http://www.botskool.com/geeks/how-import-excel-data-koha">http://www.botskool.com/geeks/how-import-excel-data-koha</ulink></bibliosource>
46650 <title>Importing Excel data into Koha</title>
46652 <para>Suppose you have records of your library in excel data sheet
46653 format and want them to import into Koha. But how will you do this? Koha
46654 will not let you import excel records directly. Well here is a very
46655 simple solution for you which will let you import your excel records in
46656 Koha easily. First, we will convert excel file into Marc file and then
46657 will import it into Koha.</para>
46659 <para>Follow the given steps to import your excel records into
46662 <section id="convertexcel">
46663 <title>Converting from Excel format into .mrk format</title>
46665 <para>First, we will convert excel format into .mrk format. For this we will use MarcEdit.
46666 You can download it from <ulink url="http://marcedit.reeset.net/"
46667 >http://marcedit.reeset.net/</ulink></para>
46669 <para>Now open it and select Add-ins-->Delimited Text
46673 <screeninfo>Delimited Text Translator</screeninfo>
46677 <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
46682 <para>Click Next when the following window appears.</para>
46685 <screeninfo>Delimited Text Translator</screeninfo>
46689 <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
46694 <para>Browse for your excel file.</para>
46697 <screeninfo>Delimited Text Translator</screeninfo>
46701 <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
46706 <para>Locate your excel file by choosing the format Excel
46707 File(*.xls).</para>
46710 <screeninfo>Delimited Text Translator</screeninfo>
46714 <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
46719 <para>Similarly, fill all the other entries such as Output File, Excel
46720 Sheet Name and check UTF-8 Encoded (if required) and Click
46724 <screeninfo>Delimited Text Translator</screeninfo>
46728 <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
46733 <para>Now you will be prompted for mapping the fields to recognise the
46734 fields by standard marc format.</para>
46736 <para>Suppose for Field 0 that is first column I entered Map to:
46737 022$a( Valid ISSN for the continuing resource) and then click on
46741 <screeninfo>Delimited Text Translator</screeninfo>
46745 <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
46751 <para>You can customize Indicators and all other things, for more
46752 information on marc21 format visit the <ulink url="http://www.loc.gov/marc/bibliographic/">official library of
46753 congress site</ulink>.</para>
46756 <para>Similarly map all other fields and then Click on Finish.</para>
46759 <screeninfo>Delimited Text Translator</screeninfo>
46763 <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
46768 <para>And then a window will appear indicating that your Marc Text
46769 File(*.mrk) has been created.</para>
46772 <screeninfo>Delimited Text Translator</screeninfo>
46776 <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
46781 <para>Click Close and we have created a .mrk file from .xls file in
46782 this step. You can view the file by double clicking on it.</para>
46785 <section id="convertmrk">
46786 <title>Convert .mrk file to .mrc</title>
46788 <para>We will convert .mrk file that we have created in the above step
46789 into raw Marc format that can be directly imported into Koha.</para>
46791 <para>For this again open MarcEdit and Select MARC Tools.</para>
46794 <screeninfo>MARC Tools</screeninfo>
46798 <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
46803 <para>Next Select MarcMaker to convert .mrk file into .mrc
46807 <screeninfo>MarcMaker</screeninfo>
46811 <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
46816 <para>Locate your input file and name your output file. Then Click
46820 <screeninfo>MarcMaker</screeninfo>
46824 <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
46829 <para>And it will show you the Result.</para>
46832 <screeninfo>MarcMaker</screeninfo>
46836 <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
46841 <para>Click Close and now we have raw Marc records with us (.mrc
46845 <section id="importmrc">
46846 <title>Import .mrc into Koha</title>
46848 <para>More information on importing records into Koha can be found in
46849 the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
46850 section of this manual.</para>
46852 <para>Finally we will import above created .mrc file into Koha.</para>
46854 <para>Click on Tools in your Koha staff client.</para>
46857 <screeninfo>Koha Staff Client</screeninfo>
46861 <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
46866 <para>Next Click on Stage MARC Records for Import.</para>
46869 <screeninfo>Stage MARC Records for Import</screeninfo>
46873 <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
46878 <para>After this, choose your previously created .mrc file and click
46882 <screeninfo>Stage File</screeninfo>
46886 <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
46891 <para>You can also add comment about file and finally click on Stage
46895 <screeninfo>Stage for Import</screeninfo>
46899 <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
46904 <para>When the import is done, you will get a result something like
46908 <screeninfo>Staged Records Summary</screeninfo>
46912 <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
46917 <para>Next, click on Manage staged records.</para>
46919 <para>Here you can even change matching rules.</para>
46922 <screeninfo>Manage Staged Records</screeninfo>
46926 <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
46931 <para>Click on Import this batch into catalog when you are
46934 <para>Thats it. After all the records get imported, check Status and
46935 it should read "imported"</para>
46938 <screeninfo>Finalize Import</screeninfo>
46942 <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
46947 <para>You can even undo the Import operation.</para>
46949 <para>And within few minutes, we have imported around 10,000 records
46955 <appendix id="talkingtechappendix">
46956 <title>Talking Tech</title>
46958 <para>Talking Tech I-tiva is a third party, proprietary, product that
46959 libraries can subscribe to. Learn more here: <ulink url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
46961 <section id="talkingtechinstall">
46962 <title>Installation and Setup Instructions</title>
46964 <para>Be sure you've run
46965 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
46966 to install the required data pack (new syspref, notice placeholders and
46967 messaging transport preferences)</para>
46969 <para>To use, <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
46970 syspref must be turned on.</para>
46972 <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
46973 need the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
46974 system preference turned on, and patrons to have filled in a preference
46975 for receiving these notices by phone.</para>
46977 <para>For OVERDUE messages, overdue notice triggers must be configured
46978 under Koha -> Tools -> <link linkend="noticetriggers">Overdue
46979 Notice Triggers</link>. Either branch-specific triggers or the default
46980 level triggers may be used (script will select whichever is
46981 appropriate).</para>
46984 <section id="talkingtechsend">
46985 <title>Sending Notices File</title>
46989 <para>Add the <link linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
46990 script to your crontab</para>
46994 <para>Add an FTP/SFTP or other transport method to send the output
46995 file to the I-tiva server</para>
46999 <para>If you wish, archive the sent notices file in another
47000 directory after sending</para>
47004 <para>Run TalkingTech_itiva_outbound.pl --help for more
47008 <section id="talkingtechreceive">
47009 <title>Receiving Results File</title>
47013 <para>Add an FTP/SFTP or other transport method to send the Results
47014 file to a known directory on your Koha server</para>
47018 <para>Add the <link linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
47019 script to your crontab, aimed at that directory</para>
47023 <para>If you wish, archive the results file in another directory
47024 after processing</para>
47028 <para>Run TalkingTech_itiva_inbound.pl --help for more
47032 <appendix id="oclcappendix">
47033 <title>OCLC Connexion Gateway</title>
47034 <para>Koha can be set to work with the OCLC Connextion Gateway. This allows libraries to use
47035 OCLC Connexion as their cataloging tool and simply send those records to Koha with a single
47036 click. The following instructions will help you set up the OCLC Connexion Gateway, if you
47037 have a system administrator you will want to consult with them on this process.</para>
47038 <section id="oclckohasetup">
47042 <firstname>D. Ruth</firstname>
47043 <surname>Bavousett</surname>
47045 <orgname>ByWater Solutions</orgname>
47050 <firstname>Nicole C.</firstname>
47051 <surname>Engard</surname>
47055 <pubdate>2012</pubdate>
47057 <title>Setting up OCLC service on Koha</title>
47058 <para>First, you'll need to create a file somewhere on your system with configuration
47059 information. You could put this anywhere that is visible to the account that will be
47060 running the service. </para>
47061 <para>The file contains 11 lines. The first 6 will be about your Koha
47062 system:<programlisting>host: The IP address of your Koha server
47063 port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
47064 koha: The full URL of your staff client
47065 log: The location (full file specification) of your log for the service
47066 user: The default Koha username to use for importing
47067 password: The password that goes with that username</programlisting></para>
47068 <para>The remaining lines describe how to do the staging:
47069 <programlisting>match: The name of the matching rule from your system to use
47070 overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
47071 nomatch_action: "create_new" or "ignore"-- what to do if there is no match
47072 item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
47073 import_mode: "direct" or "stage"</programlisting></para>
47074 <para> A sample file would look like
47075 this:<programlisting>host: 1.2.3.4
47077 log: /home/koha/koha-dev/var/log/connexion.log
47078 koha: http://kohastaff.myuniversity.edu
47079 user: koha_generic_staff
47082 overlay_action: replace
47083 nomatch_action: create_new
47084 item_action: ignore
47085 import_mode: direct</programlisting></para>
47086 <para>When choosing an 'import_mode' if you use "direct" then the staged record will be
47087 immediately imported into Koha, and should be searchable after your indexes catch up. If
47088 you choose "stage", then the record will be placed in a staged batch for you to later go the
47089 <link linkend="managestaged">Managed Staged MARC Records</link> tool to finish the import. </para>
47090 <para>If you import multiple records, they'll be in the same batch, until that batch is
47091 imported, then a new batch will be created. </para>
47092 <para>In "direct" mode, each record will be in its' own batch. </para>
47093 <para>To start the service, run the script:
47094 <programlisting>/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf</programlisting></para>
47096 <section id="oclcdesktopsetup">
47100 <firstname>D. Ruth</firstname>
47101 <surname>Bavousett</surname>
47103 <orgname>ByWater Solutions</orgname>
47108 <firstname>Heather</firstname>
47109 <surname>Hernandez</surname>
47111 <orgname>San Francisco Maritime National Historical Park</orgname>
47116 <firstname>Nicole C.</firstname>
47117 <surname>Engard</surname>
47121 <pubdate>2012/2014</pubdate>
47123 <title>Setting up your OCLC desktop client</title>
47125 <para>Screenshots are OCLC Connexion Client v.2.50, Koha v.3.12</para>
47127 <para>To set up the OCLC Connexion desktop client to connect to Koha, go to Tools > Options,
47128 then choose the Export tab. <screenshot>
47129 <screeninfo>Connexion Export Tab</screeninfo>
47132 <imagedata fileref="images/appendix-oclc/oclcexporttab.png"/>
47135 </screenshot><itemizedlist>
47137 <para>Click the "Create..." button to set up a new destination, then choose "OCLC
47138 Gateway Export" and click OK.</para>
47141 <para>Enter the following information:</para>
47145 <para>"Host Name:" Your catalog’s appropriate IP address (from your <link
47146 linkend="oclckohasetup">config file above</link>) </para>
47149 <para>"Port:" Your catalog's appropriate port number (from your <link
47150 linkend="oclckohasetup">config file above</link>) </para>
47153 <para>"Login ID:" The cataloger's Koha login </para>
47156 <para>"Password:" The cataloger's Koha password </para>
47159 <para>"Notify Host Before Disconnect" = checked, </para>
47162 <para>"Timeout" = 100, "Retries" = 3, "Delay" = 0 (zero), </para>
47165 <para>"Send Local System Logon ID Password" = checked. </para>
47171 <screeninfo>OCLC Gateway Export Settings</screeninfo>
47174 <imagedata fileref="images/appendix-oclc/oclcgatewaysetup.png"/>
47180 <para>Select "OK" when finished, and you should see your new "Gateway Export" option
47181 listed (The catalog's IP address and port are blacked out in the following
47185 <screeninfo>Gateway Export Added</screeninfo>
47188 <imagedata fileref="images/appendix-oclc/oclcgatewayexport.png"/>
47195 <para>Click on "Record Characteristics" and make sure that the bibliographic records are
47196 using MARC21, UTF-8 Unicode, and click OK to save. </para>
47199 <screeninfo>Record Characteristics</screeninfo>
47202 <imagedata fileref="images/appendix-oclc/oclcrecordchar.png"/>
47208 </itemizedlist></para>
47209 <para>You should be ready to go! To export a record from OCLC Connexion Client to Koha, just
47210 press F5 while the record is on-screen. The export dialog will pop up, and you'll see
47211 Connexion attempting to talk to Koha. You should get a message that the record was added or
47212 overlaid, including its biblio number, and a URL that you can copy into your web browser to
47213 jump straight to the record. </para>
47215 <section id="oclcgateway">
47219 <firstname>Heather</firstname>
47220 <surname>Hernandez</surname>
47222 <orgname>San Francisco Maritime National Historical Park</orgname>
47226 <firstname>Nicole C.</firstname>
47227 <surname>Engard</surname>
47230 <pubdate>2014</pubdate>
47232 <title>Using the OCLC Connexion Gateway</title>
47233 <para>Records can be exported from Connexion either in a batch or one by one. </para>
47234 <section id="oclconeexport">
47235 <title>Exporting records one by one</title>
47236 <para>To export bibliographic records one by one, be sure your "Batch" options are correct:
47237 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
47238 actions in batch" area, "Bibliographic Record Export" should be unchecked<screenshot>
47239 <screeninfo>Connexion batch options</screeninfo>
47242 <imagedata fileref="images/appendix-oclc/oclcoptions.png"/>
47245 </screenshot></para>
47246 <para>When ready to export, from the "Action" menu, select "Export" or use the F5 key. You
47247 will see a screen similar to the following if the import is successful and if the record
47248 is new to the Catalog; you may copy & paste the resulting URL into your Koha catalog
47249 to see the new record.<screenshot>
47250 <screeninfo>Connexion Export</screeninfo>
47253 <imagedata fileref="images/appendix-oclc/oclcstatus.png"/>
47256 </screenshot></para>
47257 <para>If the record was overlaid, you will see a message to that effect in the "OCLC Gateway
47258 Export Status" window<screenshot>
47259 <screeninfo>Overlay confirmation</screeninfo>
47262 <imagedata fileref="images/appendix-oclc/oclcoverlay.png"/>
47265 </screenshot></para>
47267 <section id="oclcbatchexport">
47268 <title>Exporting records in a batch</title>
47269 <para>To export bibliographic records in a batch, be sure your "Batch" options are correct:
47270 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
47271 actions in batch" area, "Bibliographic Record Export" should be checked<screenshot>
47272 <screeninfo>OCLC Batch Export Options</screeninfo>
47275 <imagedata fileref="images/appendix-oclc/oclcexportbatch.png"/>
47278 </screenshot></para>
47279 <para>When a record is ready to export, from the "Action" menu, select "Export" or use the
47280 F5 key, and it’s export status will be "ready." </para>
47281 <para>When ready to export the batch, from the "Batch" menu, select "Process batch" and
47282 check the appropriate "Path" and "Export" boxes<screenshot>
47283 <screeninfo>Batch import process</screeninfo>
47286 <imagedata fileref="images/appendix-oclc/oclcprocessbatch.png"/>
47289 </screenshot></para>
47290 <para>The export will begin, and the bib records will be exported & imported into Koha
47291 one by one; you will see "OCLC Gateway Export Status" windows, as above, showing you the
47292 results of each export. That window will stay there until you select "Close," and then the
47293 next record’s export/import will begin. The process will continue until all records in the
47294 batch are completed. Then you may or may not see the Connexion Client export report
47295 (depending on your Client options for that). </para>
47300 <appendix id="faqs">
47301 <title>FAQs</title>
47305 <section id="displayfaq">
47306 <title>Display</title>
47310 <section id="customicons">
47311 <title>Custom Item Type/Authorized Value Icons</title>
47313 <para><emphasis role="bold">Question:</emphasis> Can I have my own set
47314 of item type images (or authorized value icons)?</para>
47316 <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
47317 additional icons to your system you simply add a new directory to
47318 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
47319 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
47320 directory. Your icons will show up in a new tab as soon as they are in
47321 the folders.</para>
47326 <para>Remember to put the icons in both places (on the OPAC and
47327 the intranet).</para>
47333 <section id="customkohaimages">
47334 <title>Customizing Koha Images</title>
47336 <para><emphasis role="bold">Question</emphasis>: Can I customize the
47337 images in the OPAC?</para>
47339 <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
47340 with a series of original images that you can alter to meet your
47341 needs. The originals can be found in the misc/interface_customization/
47345 <section id="opacdisplayfaq">
47346 <title>OPAC Display Fields</title>
47348 <para><emphasis role="bold">Question</emphasis>: What MARC fields
47349 print to the different OPAC screens in Koha?</para>
47351 <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
47352 must be set as follows for the following fields to show</para>
47356 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
47357 using XSLT stylesheets</para>
47361 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
47362 using XSLT stylesheets</para>
47366 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
47371 <para>The OPAC Results page shows:</para>
47379 <para>100, 110, 111</para>
47383 <para>700, 710, 711</para>
47403 <para>The OPAC Details page shows:</para>
47411 <para>100, 110, 111</para>
47415 <para>700, 710, 711</para>
47419 <para>440, 490</para>
47447 <para>130, 240</para>
47487 <para>plus all of the 5xx fields in the Notes tab at the
47493 <section id="displaysubtitle">
47494 <title>Subtitle Display on Bib Records</title>
47496 <para><emphasis role="bold">Question</emphasis>: How do I get the
47497 subtitle to display on the detail pages for my bib records?</para>
47499 <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
47500 depends on there being a <link linkend="keywordmapping">keyword
47501 mapping</link> for the MARC field in question. Adding a mapping for
47502 "subtitle" -> "245b" for an item's framework results in display of
47503 the subtitle in OPAC and staff client search and detail pages
47504 (although not in all instances where subtitles might be displayed,
47505 e.g. the Cart).</para>
47508 <section id="customlogo">
47512 <firstname>Owen</firstname>
47513 <surname>Leonard</surname>
47515 <orgname>Athens County Public Library</orgname>
47519 <firstname>Nicole C.</firstname>
47520 <surname>Engard</surname>
47523 <pubdate>July 2010</pubdate>
47526 <title>Customize Logo on Staff Client</title>
47528 <para><emphasis role="bold">Question</emphasis>: How do I change the
47529 Koha logo on the Staff Client login page?</para>
47531 <para><emphasis role="bold">Answer</emphasis>: <link linkend="opacsmallimage">Opacsmallimage</link> controls the display of
47532 the Koha logo in the OPAC, but there is no system preference
47533 controlling the logo on the staff client login page. Luckily the logo
47534 is displayed via CSS so it can be easily customized through some
47537 <para>These are the relevant parts of the staff client default CSS:
47538 <programlisting>#login h1 {
47539 background:url("../../img/koha-logo.gif") no-repeat scroll center
47541 margin-bottom:0.5em;
47546 border-bottom:medium none;
47549 text-indent:-1000px;
47550 }</programlisting></para>
47552 <para>If you have access to the file system on your Koha server you
47553 can add a custom CSS file and specify that file using the <link linkend="intranetcolorstylesheet">intranetcolorstylesheet</link>
47554 system preference.</para>
47556 <para>There is no analogue to the <link linkend="OPACUserCSS">OPACUserCSS</link> preference in the staff
47557 client, but you can get around this by putting this in the <link linkend="intranetuserjs">intranetuserjs</link> preference:
47558 <programlisting>//]]>
47560 <style type="text/css">
47561 /* inline styles */
47563 <script type="text/javascript">
47564 //<![CDATA[</programlisting></para>
47566 <para>In the above snippet where it says /* inline styles */ we'll
47567 redeclare the relevant properties from the styles of the login
47568 image:<programlisting>//]]>
47570 <style type="text/css">
47571 /* inline styles */
47574 background:url("../../img/koha-logo.gif") no-repeat scroll center
47582 <script type="text/javascript">
47584 </programlisting></para>
47586 <para>I've only reproduced the properties necessary to make the change
47587 we want. You can see that the "background:" property sets the path to
47588 the default logo. You can change this to point to any image you want,
47589 on the Koha server or anywhere else. Then you just need to change the
47590 #login h1 a's "height" property to match the height of the image you
47593 <para>For example:</para>
47595 <para><programlisting>//]]>
47597 <style type="text/css">
47598 /* inline styles */
47601 background:url("http://www.myacpl.org/sites/all/themes/npl/logo.png")
47602 no-repeat scroll center top transparent;
47609 <script type="text/javascript">
47610 //<![CDATA[</programlisting></para>
47613 <section id="opacbarcodesfaq">
47614 <title>Show patrons the barcodes of items they have checked
47617 <para><emphasis role="bold">Question</emphasis>: Can patrons see the
47618 barcodes for the items they have checked out.</para>
47620 <para><emphasis role="bold">Answer</emphasis>: Not by default, but
47621 with a few edits to the patron record you can make a barcode column
47622 appear on the patron's check out summary in the OPAC. You can set up a
47623 <link linkend="patronattributetypes">patron attribute</link> with the
47624 value of SHOW_BCODE and <link linkend="authorizedvalues">authorized
47625 value</link> of YES_NO to make this happen.</para>
47628 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
47632 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
47637 <para>Then on the <link linkend="editpatrons">patron's record set the
47638 value</link> for SHOW_BCODE to yes.</para>
47641 <screeninfo>Setting value for SHOW_BCODE on patron
47642 record</screeninfo>
47646 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
47651 <para>This will add a column to the check out summary in the OPAC that
47652 shows the patrons the barcodes of the items they have checked
47656 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
47660 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
47665 <para>Clicking on the 'Overdue' tab will show only the items that are
47670 <section id="circfaq">
47671 <title>Circulation/Notices</title>
47675 <section id="dropboxfaq">
47676 <title>Book drop Date</title>
47678 <para><emphasis role="bold">Question</emphasis>: How is the book drop date is determined? Is
47679 it the last open date for the checkout branch? Is it today's date minus one? Can the book
47680 drop checkin date be set?</para>
47682 <para><emphasis role="bold">Answer</emphasis>: If the library is closed for four days for
47683 renovations, for example, there would be more than one day needed for the book drop date.
47684 You will only have one book drop date and that will be the last day that the library open
47685 (determined by the holiday calendar) because there is no real way to know what day the
47686 books were dropped into the box during the 4 closed days. The only way to change the
47687 effective checkin date in book drop mode is to modify the calendar.</para>
47689 <section id="holdsreportsfaq">
47690 <title>Holds to Pull and Holds Queue</title>
47691 <para><emphasis role="bold">Question</emphasis>: What is the difference between the <link linkend="holdsqueue">Holds Queue</link> and <link linkend="holdspull">Holds to
47692 Pull</link>?</para>
47693 <para><emphasis role="bold">Answer</emphasis>: The holds to pull report gives a simple list
47694 of what holds need to be filled with available items. It should only be used in Koha
47695 installations where there is only one library. </para>
47696 <para>The holds queue tries to do the same thing, but in a 'smarter' way. This allows it to
47697 split up the list by library, consult the <link linkend="transportcostmatrix">transport
47698 cost matrix</link> and refresh regularly to provide different pull lists to each
47702 <section id="dupoverduefaq">
47703 <title>Duplicate Overdue Notices</title>
47705 <para><emphasis role="bold">Question</emphasis>: Why are patrons
47706 getting two overdue notices?</para>
47708 <para><emphasis role="bold">Answer</emphasis>: This tool takes all
47709 branches in the overdue rules and sent notifications to them. So, if
47710 you have a default rule & a branch rule, the notification will be
47711 generated twice. A quick fix is to discard "default rule" for
47715 <section id="printoverduefaq">
47716 <title>Printing Overdue Notices</title>
47718 <para><emphasis role="bold">Question</emphasis>: Can I print overdue
47719 notices for patrons without email addresses on file?</para>
47721 <para><emphasis role="bold">Answer</emphasis>: Yes. The <link linkend="overduenoticecron">overdue notice cron job</link> has a
47722 setting to generate the overdue notices as HTML for printing. An
47723 example of this usage would be:</para>
47725 <para><programlisting>overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author </programlisting>In
47726 this example, we wanted to use only certain item fields in our
47727 notices, so we specified itemscontent fields in the cron entry; that's
47728 not a requirement for the feature.</para>
47730 <para>The command line needs to specify a web-accessible directory
47731 where the print notices will go -- they get a filename like
47732 notices-2009-11-24.html (or holdnotices-2009-11-24.html). The overdue
47733 notice itself can be formatted to fit a Z-mailer. Within the notice
47734 file, the text is spaced down or over to where it will print properly
47735 on the form. The script has code that wraps around the notice file to
47736 tell the HTML to obey the formatting, and to do a page break between
47737 notices. That's so that when staff print it out, they get one per
47738 page. We had to add an extra syspref (<link linkend="PrintNoticesMaxLines">PrintNoticesMaxLines</link>) to specify
47739 page length because our client allows a _lot_ of checkouts which meant
47740 some notices were running onto multiple pages. That syspref says to
47741 truncate the print notice at that page length and put in a message
47742 about go check your OPAC account for the full list.</para>
47744 <para>The print and email overdues use the same notice file. The print
47745 notices for holds are different -- there's a separate HOLD_PRINT
47746 notice file and the system uses it if there's no email address. Then a
47747 nightly cron job runs to gather those up from the message queue and
47748 put them in an HTML file in the notice directory, as above.</para>
47750 <para>The cron entry is gather_print_notices.pl /tmp/noticedir</para>
47753 <section id="renewfaq">
47754 <title>Unable to Renew Items</title>
47756 <para><emphasis role="bold">Question</emphasis>: We're trying to renew
47757 some items for our patron. One of the items is on hold and ineligible
47758 for renewal, but the other two items refuse to renew even though they
47759 should be eligible. When I try to use the override renewal limit, it
47760 just returns a little message that says "renewal failed". Any idea
47761 what's going on here?</para>
47763 <para><emphasis role="bold">Answer</emphasis>: At the very least you
47764 will need to set an absolute <link linkend="circfinerules">default
47765 circulation rule</link>. This rule should be set for the default
47766 itemtype, default branchcode and default patron category. That will
47767 catch anyone who doesn't match a specific rule. Patrons who do not
47768 match a specific rule will get blocked from placing holds, since there
47769 was no baseline number of holds to utilize.</para>
47772 <section id="holdsfaq">
47773 <title>Unable to Place Holds</title>
47775 <para><emphasis role="bold">Question</emphasis>: Why can't I place
47776 holds when I have all of the preferences turned on.</para>
47778 <para><emphasis role="bold">Answer</emphasis>: You probably need to
47779 set a default circulation rule. At the very least you will need to set
47780 an default circulation rule. This rule should be set for all item
47781 types, all branches and all patron categories. That will catch all
47782 instances that do not match a specific rule. When checking out if you
47783 do not have a rule for the default branch, default item and default
47784 patron category then you may see patrons getting blocked from placing
47788 <section id="keyboardshort">
47789 <title>Keyboard Shortcuts</title>
47791 <para><emphasis role="bold">Question</emphasis>: Do I have to use my
47792 mouse to access the checkout, checkin and cataloging tabs at the top
47793 of the circulation pages?</para>
47795 <para><emphasis role="bold">Answer</emphasis>: You can jump between
47796 the tabs on the quick search box at the top of the screen by using the
47797 following hot keys (if the tab is available):</para>
47801 <para>jump to the catalog search with Alt+Q</para>
47805 <para>jump to the checkout with Alt+U</para>
47809 <para>this will not work for Mac user</para>
47815 <para>jump to the checkin with Alt+R</para>
47820 <para>Mac users use the OPTION button in place of ALT</para>
47824 <section id="smsnoticefaq">
47825 <title>SMS Notices/Messages</title>
47827 <para><emphasis role="bold">Question</emphasis>: I want Koha to send
47828 notices via SMS, what do I need to do?</para>
47830 <para><emphasis role="bold">Answer</emphasis>: First you need to
47831 choose a SMS service to use with Koha. There is a list available here:
47832 <ulink url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all</ulink>
47833 Not all SMS services available to libraries have Perl drivers, so be
47834 sure to check this list to see if the provider you're considering is
47835 listed. If not you want to ask your provider if they have a Perl
47836 module, if not you should consider another service. Some common
47837 options in the US (that have Perl drivers) are:</para>
47841 <para>AQL (<ulink url="http://www.aql.com">www.aql.com</ulink>)</para>
47845 <para>Wadja (<ulink url="http://wadja.com">wadja.com</ulink>)</para>
47849 <para>Ipipi (<ulink url="http://ipipi.com">ipipi.com</ulink>)</para>
47853 <para>T-mobile</para>
47857 <para>SMSDiscount (<ulink url="http://smsdiscount.com">smsdiscount.com</ulink>)</para>
47861 <para>Clickatell</para>
47867 <section id="catfaq">
47868 <title>Cataloging</title>
47872 <section id="authorityfaq">
47873 <title>Authority Fields</title>
47875 <para><emphasis role="bold">Question: </emphasis>Why can't I edit 1xx,
47876 6xx, or 7xx fields in my catalog record?</para>
47878 <para><emphasis role="bold">Answer:</emphasis> These fields are authority controlled and you
47879 probably have the <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> set
47880 to "Don't allow". When it is set to "Don't allow" these fields will be locked and require
47881 you to search for an existing authority record to populate the field with. To allow typing
47882 in these authority fields set <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> to 'Allow'.<tip>
47883 <para>Fields affected by this preference will show a lock symbol in them</para>
47887 <screeninfo>Fields affected by this preference show a lock in the field</screeninfo>
47891 <imagedata fileref="images/cataloging/lockedauthority.png"/>
47897 <section id="kohamarcfaq">
47898 <title>Koha to MARC Mapping</title>
47900 <para><emphasis role="bold">Question</emphasis>: What's the
47901 relationship between 'Koha to MARC Mapping' and 'MARC Bibliographic
47902 Frameworks'?</para>
47904 <para><emphasis role="bold">Answer</emphasis>: Mapping can be defined
47905 through 'MARC Bibliographic Frameworks' OR 'Koha to MARC Mapping'.
47906 'Koha to MARC Mapping' is just a shortcut to speed up linkage. If you
47907 change a mapping in one of these modules, the mapping will change in
47908 the other as well. (In other words, the two modules 'overwrite' each
47909 other in order to prevent conflicts from existing in Koha).</para>
47912 <section id="itemsperbibfaq">
47913 <title>Number of Items Per Bib Record</title>
47915 <para><emphasis role="bold">Question</emphasis>: Is there a limit on
47916 the number of items I can attach to a bib record?</para>
47918 <para><emphasis role="bold">Answer</emphasis>: There is no explicit limit to the number of
47919 items you can attach to a bibliographic record, but if you attach enough of them, your
47920 MARC record will exceed the maximum file size limit for the ISO 2709 standard, which
47921 breaks indexing for that record. I've found this occurs somewhere between 600 and 1000
47922 items on a 'normal' bibliographic record.</para>
47925 <section id="analyticsfaq">
47926 <title>Analytics</title>
47928 <para><emphasis role="bold">Question</emphasis>: I am using the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> feature,
47929 but my links in the OPAC and Staff Client to 'Show Analytics' are not
47932 <para><emphasis role="bold">Answer</emphasis>: If you plan on using
47933 <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> you
47934 will want to make sure to set your <link linkend="UseControlNumber">UseControlNumber</link> preference to
47935 "Don't use," this will prevent broken links.</para>
47939 <section id="acqfaq">
47940 <title>Acquisitions</title>
47944 <section id="planningcatfaq">
47945 <title>Planning Categories</title>
47947 <para><emphasis role="bold">Question</emphasis>: What is a planning
47950 <para><emphasis role="bold">Answer</emphasis>: When you plan in
47951 advance for the way your budget is going to be spent, you initially
47952 plan for how it's going to be spent over time, that's the most natural
47953 thing to do.</para>
47955 <para>So you plan for $1000 in Jan. $1000 in Feb., $3000 in March,
47956 etc. You can basically do the same thing with a list of values in lieu
47957 of the months.</para>
47959 <para>Say you have a list like this one:</para>
47963 <para>< 1 month</para>
47967 <para>< 6 months</para>
47971 <para>< 1 year</para>
47975 <para>< 3 years</para>
47979 <para>< 10 years</para>
47983 <para>> 10 years</para>
47987 <para>The list is meant to represent when the books acquired where
47988 published. Then you plan for it, saying: we went to spend at list 40%
47989 of our budgets on books published less than a year ago, 10% on books
47990 more than 10 years old, etc.</para>
47992 <para>Upon acquiring new material, you'll be able to select, for a
47993 given item, a value from this list in a drop down. Then, after the
47994 material has been acquired, at the end of the year, you'll be able to
47995 compare the goals set, with what's been achieved.</para>
47999 <section id="serialsfaq">
48000 <title>Serials</title>
48004 <section id="advancedpatternfaq">
48005 <title>Advanced Patterns</title>
48007 <para><emphasis role="bold">Question</emphasis>: What is the 'inner
48008 counter' on the advanced serials pattern interface?</para>
48010 <para><emphasis role="bold">Answer</emphasis>: I think it is better to
48011 give an example to understand this :</para>
48013 <para>Example for a monthly subscription :</para>
48017 <para>First issue publication date : April 2010</para>
48021 <para>Numbering : No {X}, year {Y}</para>
48025 <para>First issue : No 4, year 2010</para>
48029 <para>For the year Y : you will want the year change on January
48032 <para>So, the advanced pattern for Y will be :</para>
48036 <para>Add : 1</para>
48040 <para>once every : 12</para>
48044 <para>When more than 9999999</para>
48048 <para>inner counter : 3</para>
48052 <para>Set back to 0</para>
48056 <para>Begins with 2010</para>
48060 <para>Year is going to change after 12 received issues from April
48061 2010, that is in April 2011 if you don't set inner counter. Set inner
48062 counter to 3 will say to Koha : change year after 12-3 = 9 received
48065 <para>Inner counter says to Koha to take into account the first issues
48066 of the year, even if they are not received with Koha. If you begin
48067 with first issue of the year write nothing or 0.</para>
48071 <section id="reportsfaq">
48072 <title>Reports</title>
48076 <section id="accounttypefaq">
48077 <title>Define Codes Stored in DB</title>
48081 <section id="finescodefaq">
48082 <title>Fines Table</title>
48084 <para><emphasis role="bold">Question:</emphasis> What do the codes
48085 in the accounttype field in the accountlines table stand for?</para>
48087 <para><emphasis role="bold">Answer:</emphasis></para>
48091 <para>A = Account management fee</para>
48095 <para>C = Credit</para>
48099 <para>F = Overdue fine</para>
48103 <para>FOR = Forgiven</para>
48107 <para>FU = Overdue, still acccruing</para>
48111 <para>L = Lost item</para>
48114 <para>LR = Lost item returned/refunded</para>
48118 <para>M = Sundry</para>
48122 <para>N = New card</para>
48126 <para>PAY = Payment</para>
48130 <para>W = Writeoff</para>
48135 <section id="statscodefaq">
48136 <title>Statistics Table</title>
48138 <para><emphasis role="bold">Question: </emphasis>What are the
48139 possible codes for the type field in the statistics table?</para>
48141 <para><emphasis role="bold">Answer:</emphasis></para>
48145 <para>localuse</para>
48149 <para>Registers if an item that had been checked out to a
48150 statistics patron (category type = 'X') is returned</para>
48160 <para>return</para>
48168 <para>writeoff</para>
48172 <para>payment</para>
48176 <para>CreditXXX</para>
48180 <para>The XXX stores different types of fee credits, so a query to catch them all
48181 would include a clause like "type LIKE 'Credit%'"</para>
48188 <section id="rescodefaq">
48189 <title>Reserves Table</title>
48191 <para><emphasis role="bold">Question</emphasis>: What are the
48192 possible codes for the found field in the reserves and old_reserves
48195 <para><emphasis role="bold">Answer</emphasis>:</para>
48199 <para>NULL: means the patron requested the 1st available, and we
48200 haven't chosen the item</para>
48204 <para>T = Transit: the reserve is linked to an item but is in
48205 transit to the pickup branch</para>
48209 <para>W = Waiting: the reserve is linked to an item, is at the pickup branch, and is
48210 waiting on the hold shelf</para>
48214 <para>F = Finished: the reserve has been completed, and is
48220 <section id="reportdicfaq">
48221 <title>Reports Dictionary Table</title>
48223 <para><emphasis role="bold">Question</emphasis>: What are the
48224 possible codes for the area field in the reports_dictionary
48227 <para><emphasis role="bold">Answer</emphasis>:</para>
48231 <para>1 = Circulation</para>
48235 <para>2 = Catalog</para>
48239 <para>3 = Patrons</para>
48243 <para>4 = Acquisitions</para>
48247 <para>5 = Accounts</para>
48252 <section id="msgtablefaq">
48253 <title>Messages Table</title>
48255 <para><emphasis role="bold">Question</emphasis>: What are the
48256 possible codes for the message_type field in the messages
48259 <para><emphasis role="bold">Answer</emphasis>:</para>
48263 <para>L = For Librarians</para>
48267 <para>B = For Patrons/Borrowers</para>
48272 <section id="serialtablefaq">
48273 <title>Serial Table</title>
48275 <para><emphasis role="bold">Question</emphasis>: What are the possible codes for the
48276 status field in the serial table?</para>
48278 <para><emphasis role="bold">Answer</emphasis>:</para>
48282 <para>1 = Expected</para>
48286 <para>2 = Arrived</para>
48290 <para>3 = Late</para>
48294 <para>4 = Missing</para>
48298 <para>5 = Not Available</para>
48302 <para>6 = Delete</para>
48305 <para>7 = Claimed</para>
48308 <para>8 = Stopped</para>
48312 <section id="borrowerprivacyvalues">
48313 <title>Borrowers Table</title>
48314 <para><emphasis role="bold">Question</emphasis>: What are the possible codes for the
48315 privacy field in the borrowers table?</para>
48316 <para><emphasis role="bold">Answer</emphasis>:<itemizedlist>
48318 <para>0 = Forever</para>
48321 <para>1 = Default</para>
48324 <para>2 = Never</para>
48326 </itemizedlist></para>
48330 <section id="runtimefaq">
48331 <title>Runtime Parameters</title>
48333 <para><emphasis role="bold">Question</emphasis>: Is there a way to
48334 filter my custom SQL reports before they run?</para>
48336 <para><emphasis role="bold">Answer</emphasis>: If you feel that your
48337 report might be too resource intensive you might want to consider
48338 using runtime parameters to your query. Runtime parameters basically
48339 make a filter appear before the report is run to save your system
48342 <para>There is a specific syntax that Koha will understand as 'ask for
48343 values when running the report'. The syntax is <<Question to
48344 ask|authorized_value>>.</para>
48348 <para>The << and >> are just delimiters. You must put
48349 << at the beginning and >> at the end of your
48354 <para>The 'Question to ask' will be displayed on the left of the
48355 string to enter.</para>
48359 <para>The authorized_value can be omitted if not applicable. If it
48360 contains an authorized value category, or branches or itemtype or
48361 categorycode, a list with the Koha authorized values will be
48362 displayed instead of a free field Note that you can have more than
48363 one parameter in a given SQL Note that entering nothing at run
48364 time won't probably work as you expect. It will be considered as
48365 "value empty" not as "ignore this parameter". For example entering
48366 nothing for : "title=<<Enter title>>" will display
48367 results with title='' (no title). If you want to have to have
48368 something not mandatory, use "title like <<Enter
48369 title>>" and enter a % at run time instead of nothing</para>
48373 <para>Examples:</para>
48377 <para>SELECT surname,firstname FROM borrowers WHERE
48378 branchcode=<<Enter patrons library|branches>> AND
48379 surname like <<Enter filter for patron surname (% if
48380 none)>></para>
48384 <para>SELECT * FROM items WHERE homebranch = <<Pick your
48385 branch|branches>> and barcode like <<Partial barcode
48386 value here>></para>
48391 <para>To generate a date picker calendar to the right of the field
48392 when running a report you can use the 'date' keyword like this:
48393 <<Enter Date|date>></para>
48396 <screeninfo>Date Picker</screeninfo>
48400 <imagedata fileref="images/reports/datepicker.png"/>
48407 <para>You have to put "%" in a text box to 'leave it blank'.
48408 Otherwise, it literally looks for "" (empty string) as the value for
48413 <para>In addition to using any authorized value code to generate a
48414 dropdown, you can use the following values as well: Branches
48415 (branches), Item Types (itemtypes) and Patron Categories
48416 (categorycode). For example a branch pull down would be generated
48417 like this <<Branch|branches>></para>
48420 <screeninfo>Branch pull down</screeninfo>
48424 <imagedata fileref="images/reports/branchpulldown.png"/>
48428 </important></para>
48431 <section id="reportlimitfaq">
48432 <title>Results Limited</title>
48434 <para><emphasis role="bold">Question</emphasis>: When I download my
48435 report it's limited to 10,000 results, how do I get all of the results
48436 to download?</para>
48438 <para><emphasis role="bold">Answer</emphasis>: There is a limit of
48439 10,000 records put on SQL statements entered in Koha. To get around
48440 this you want to add 'LIMIT 100000' to the end of your SQL statement
48441 (or any other number above 10,000.</para>
48445 <section id="searchfaq">
48446 <title>Searching</title>
48450 <section id="advancedsearchfaq">
48451 <title>Advanced Search</title>
48455 <section id="scanindexfaq">
48456 <title>Scan Indexes</title>
48458 <para><emphasis role="bold">Question</emphasis>: What does 'scan
48459 indexes' on the advanced search page mean?</para>
48461 <para><emphasis role="bold">Answer</emphasis>: When you choose an
48462 index, enter a term, click 'scan indexes' and do the search, Koha
48463 displays the searched term and the following terms found in this
48464 index with the number of corresponding records That is search is not
48465 made directly in the catalog, but first in the indexes It works only
48466 for one index at once, and only with no limit in Location (All
48467 libraries needed)</para>
48470 <section id="searchstartswith">
48471 <title>Searching for Terms that Start With a Character</title>
48473 <para><emphasis role="bold">Question</emphasis>: How do I search for
48474 all titles that start with the letter 'C'?</para>
48476 <para><emphasis role="bold">Answer</emphasis>: You can choose to
48477 search for things that start with a character or series of
48478 characters by using the CCL 'first-in-subfield'</para>
48482 <para>example: ti,first-in-subfield=C</para>
48488 <section id="wildcardsearchfaq">
48489 <title>Wildcard Searching</title>
48491 <para><emphasis role="bold">Question</emphasis>:What is the difference
48492 between a keyword search using the '*' (asterisk) versus a keyword
48493 search using the '%' (percent)? Both work in the catalog, but return
48494 different sets. Why?</para>
48496 <para><emphasis role="bold">Answer</emphasis>: A wildcard is a
48497 character (*,?,%,.) that can be used to represent one or more
48498 characters in a word. Two of the wildcard characters that can be used
48499 in Koha searches are the asterisk ('*') and the percent sign ('%').
48500 However, these two characters act differently when used in
48503 <para>The '*' is going to force a more exact search of the first few
48504 characters you enter prior to the '*'. The asterisk will allow for an
48505 infinite number of characters in the search as long as the first few
48506 characters designated by your search remain the same. For example,
48507 searching for authors using the term, Smi*, will return a list that
48508 may include Smith, Smithers, Smithfield, Smiley, etc depending on the
48509 authors in your database.</para>
48511 <para>The '%' will treat the words you enter in the terms of "is
48512 like". So a search of Smi% will search for words like Smi. This
48513 results in a much more varied results list. For example, a search on
48514 Smi% will return a list containing Smothers, Smith, Smelley,
48515 Smithfield and many others depending on what is your database.</para>
48517 <para>The bottom line in searching with wildcards: '*' is more exact
48518 while '%' searches for like terms.</para>
48520 <section id="titlesearchingfaq">
48521 <title>Title Searching</title>
48522 <para><emphasis role="bold">Question</emphasis>: Why does my Zebra title search for 'Help'
48523 not turn up 'The help' in the first pages of results?</para>
48524 <para><emphasis role="bold">Answer</emphasis>: When doing a title search, you actually want
48525 to search for the title (i.e., 'the help' rather than just 'help'), and it will bubble
48526 right up to the top. If you're just searching for 'help' then the relevance ranking is
48527 going to affect the results you see. </para>
48528 <para>When it comes to relevance in Zebra, here's what's happening. First, the search is
48529 done. If you search for the title "help", then any title that has "help" in it comes back.
48530 Then from those records, separately, it does relevance on the *whole* record. The more
48531 your word appears, the more relevant, and some MARC tags are worth more points than
48532 others. So a self-help book with 505 notes where "help" appears a *lot* will be at the
48533 top, regardless of keyword or title.</para>
48534 <para>But when you add a *second word*, that helps it figure things out, as it's weighing
48535 the relevance of both words and the phrase. Because of the way relevance works, if you
48536 search "the help", then "the help" or "the help I need" are more relevant than "the way to
48537 help", because they appear together in order. Likewise, "help the girl" would be lower
48538 relevance, because it's out of order, and "help for the homeless" would be lower still, as
48539 they're out of order, and apart.</para>
48540 <para>The moral of the story is that single word searches, particularly on common words,
48541 will always struggle a bit; it can't evaluate relevance well, because you've not given it
48542 enough input.</para>
48546 <section id="enhancedcontentfaq">
48547 <title>Enhanced Content</title>
48551 <section id="frbrfaq">
48552 <title>FRBRizing Content</title>
48554 <para><emphasis role="bold">Question: </emphasis>At our public library
48555 we are running a Koha installation and we've tried to turn on all the
48556 nice functionalities in Koha such as the frbrising tool, but do not
48557 get the same result as Nelsonville public library.</para>
48559 <para><emphasis role="bold">Answer: </emphasis>In fact, this feature
48560 is quite tricky to make that right. First it looks at XISBN service.
48561 And then search in your database for that ISBN. So both XISBN and your
48562 internal ISBN (in biblio table) have to be normalized. You could
48563 therefore use the script misc/batchupdateISBNs.pl (it removes all the
48564 - in your local ISBNs)</para>
48567 <section id="amzfaq">
48568 <title>Amazon</title>
48572 <section id="amazonfaq">
48573 <title>All Amazon Content</title>
48575 <para><emphasis role="bold">Question</emphasis>: I have all of the
48576 Amazon preferences turned on and have entered both of my keys, but
48577 none of the content appears in my system, why is that?</para>
48579 <para><emphasis role="bold">Answer</emphasis>: Amazon's API checks
48580 your server time on all requests and if your server time is not set
48581 properly requests will be denied. To resolve this issue be sure to
48582 set your system time appropriately. Once that change in made Amazon
48583 content should appear immediately.</para>
48585 <para>On Debian the the command is <emphasis>date -s "2010-06-30
48586 17:21"</emphasis> (with the proper date and time for your
48592 <section id="systemfaq">
48593 <title>System Administration</title>
48597 <section id="zebracronfaq">
48598 <title>Errors in Zebra Cron</title>
48600 <para><emphasis role="bold">Question</emphasis>: I am noticing some
48601 errors in the koha-zebradaemon-output.log file. When new records are
48602 added it takes a bit longer to index than we think they should.
48603 Running rebuild zebra is often faster. Zebra ends up indexing and
48604 search works, but I am concerned about the errors. Any ideas?</para>
48606 <para><emphasis role="bold">Answer</emphasis>: Rebuild_zebra.pl -r
48607 deletes all of the files in the Zebra db directories (such as
48608 reci-0.mf) and then recreates them. Thus, permissions will be lost,
48609 and the files will be owned by the user who ran rebuild_zebra.pl. If
48610 one rebuilds the zebra indexes as root, the daemons, which typically
48611 run under the user Koha, will not be able to update the indexes. Thus,
48612 it's important then that the zebra rebuilds are put in the cronjob
48613 file of the user Koha, and not root. Also important is that other
48614 users, such as root, don't manually execute rebuilds.</para>
48616 <para>If one desires that another user be able to execute
48617 rebuild_zebra.pl, he should be given the permission to execute 'sudo
48618 -u Koha .../rebuild_zebra.pl,' (if you want to do this, you also have
48619 to edit the sudoers file to pass the PERL5LIB variable with the
48620 env_keep option as by default sudo strips away almost all environment
48621 variables). Or, as root user, one can use a simple 'su koha' and then
48622 the rebuild_zebra.pl command.</para>
48624 <para>I've also tried to set the sticky bit on rebuild_zebra.pl, but
48625 for whatever reason it didn't seem to work due to some problem with
48626 the PERL5LIB variable that I wasn't able to figure. That seems to me
48627 the easiest thing to do, if anybody has any idea how to make it work.
48628 If it worked and were the default, I think it would help folks to
48629 avoid a great deal of the problems that come up with zebra.</para>
48632 <section id="publicztarget">
48633 <title>Making Z39.50 Target Public</title>
48635 <para><emphasis role="bold">Question</emphasis>: Could someone tell me
48636 the exact steps I need to take to configure Zebra to expose my Koha 3
48637 db as a public Z39.50 service?</para>
48639 <para><emphasis role="bold">Answer</emphasis>: Edit the KOHA_CONF file
48640 that your Koha is using. Uncomment the publicserver line like:</para>
48642 <para><!-- <listen id="publicserver"
48643 >tcp:@:9999</listen> --></para>
48645 <para>to be:</para>
48647 <para><listen id="publicserver"
48648 >tcp:@:9999</listen></para>
48650 <para>Then restart zebasrv and connect on the port specified
48654 <section id="authvalfaq">
48655 <title>Shelving Location Authorized Values</title>
48657 <para><emphasis role="bold">Question</emphasis>: When editing an item,
48658 the new shelving location I created is not showing up by default in
48659 the items where I assigned it to.</para>
48661 <para><emphasis role="bold">Answer</emphasis>: This is because you
48662 created the new shelving location with a code value of 0 (zero) Just
48663 FYI the system interprets authorized values of 0 as equaling a null so
48664 when you edit a record in cataloging where the authorized value in a
48665 field was assigned where the code was 0, the value displays as null in
48666 the item editor (or MARC editor) instead of the value the library
48667 meant it to be.</para>
48670 <section id="whyauthvals">
48671 <title>Why do I need Authorized Values?</title>
48673 <para><emphasis role="bold">Question</emphasis>: Why would I want to
48674 define authorized values for MARC tags?</para>
48676 <para><emphasis role="bold">Answer</emphasis>: Authorized Values
48677 create a 'controlled vocabulary' for your staff. As an example, let us
48678 assume that your Koha installation is used by several libraries, and
48679 you use MARC 21. You might want to restrict the 850a MARC subfield to
48680 the institution codes for just those libraries. In that case, you
48681 could define an authorized values category (perhaps called "INST") and
48682 enter the institution codes as the authorized values for that
48686 <para>Koha automatically sets up authorized value categories for
48687 your item types and branch codes, and you can link these authorized
48688 values to MARC subfields when you set up your MARC tag
48693 <section id="sessionstblfaq">
48694 <title>How do I clean up the sessions table?</title>
48696 <para><emphasis role="bold">Question</emphasis>: Is there a periodic
48697 job that can be run to cull old sessions from the table? We don't want
48698 to backup all the useless session data every night.</para>
48700 <para><emphasis role="bold">Answer</emphasis>: You can run <link linkend="cleandbcron">cleanup database cron job</link>.</para>
48702 <para>Or just before doing a backup command (mysqldump), you can
48703 truncate session table: </para>
48705 <para><programlisting>mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'</programlisting></para>
48709 <section id="hardwarefaq">
48710 <title>Hardware</title>
48714 <section id="barcodefaq">
48715 <title>Barcode Scanners</title>
48717 <para><emphasis role="bold">Question</emphasis>: What barcode scanners
48718 have been known to work with Koha?</para>
48720 <para><emphasis role="bold">Answer</emphasis>: The simple rule of
48721 thumb is, does it act like a keyboard device?, if so, it will work.
48722 (i.e. can you take the scanner, scan a barcode and have it show up in
48723 a text editor, if so, it will work.)</para>
48725 <para>The main points to check are that it connects to your PC
48726 conveniently (can be USB or "keyboard wedge" which means it connects
48727 in line with the keyboard, which is useful with older computers), and
48728 that it scans the barcode type that you are using.</para>
48730 <para>It is a good idea to test some 'used' barcodes if you have any,
48731 to see whether the scanner can read scuffed or slightly wrinkled ones
48732 successfully. Most scanners are capable of reading several barcode
48733 types - there are many, and the specification should list the ones it
48734 can read. You may need to adjust settings slightly, such as prefix and
48735 suffix characters, or whether you want to send an 'enter' character or
48738 <para>One more tip - some can be set 'always on' and may come with a
48739 stand, some have triggers under the handle, some have buttons on top,
48740 some are held like a pen. Think about the staff working with the
48741 hardware before choosing, as a button in the wrong place can be very
48742 awkward to use.</para>
48745 <section id="printersfaq">
48746 <title>Printers</title>
48750 <section id="kohaprinters">
48751 <title>Printers used by Koha libraries</title>
48755 <para>POS-X receipt printer</para>
48759 <para>Star Micronics printer (exact model unknown) with a
48760 generic/plain text driver.</para>
48764 <para>Star SP2000 (Nelsonville)</para>
48768 <para>Star TSP-100 futurePRINT (Geauga)</para>
48772 <para>"I know there have been a lot of questions on receipt
48773 printers so I thought I'd pass on my findings. We have been
48774 testing the Star TSP-100 futurePRINT. I found this print to
48775 be VERY easy to configure for Koha. I was even able to
48776 customize the print job by adding our system logo (a .gif)
48777 to the top of every receipt. Also with a bitmap created in
48778 Paint was able to add a message at the bottom of each
48779 receipt with the contact information, hours and website for
48780 the library that the materials were checked out at."</para>
48786 <para>Epson TM 88 IIIP thermal receipt printers</para>
48790 <para>Epson TM-T88IV</para>
48794 <para>1x1 labels using a Dymolabelwriter printer</para>
48799 <section id="braillefaq">
48800 <title>Braille Support</title>
48802 <para><emphasis role="bold">Question</emphasis>: Are there any
48803 braille embosser or printer which has inbuilt braille converter and
48804 it is accessible with UNIX environment?</para>
48806 <para><emphasis role="bold">Answer</emphasis>: You may want to look
48807 into BRLTTY (<ulink url="http://www.emptech.info/product_details.php?ID=1232">http://www.emptech.info/product_details.php?ID=1232</ulink>).</para>
48810 <section id="hardwaresupport">
48811 <title>Additional Support</title>
48815 <para><ulink url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></para>
48823 <appendix id="extending">
48824 <title>Extending Koha</title>
48826 <section id="amzlookup">
48830 <firstname>Cab</firstname>
48831 <surname>Vinton</surname>
48833 <orgname>Sanbornton Public Library</orgname>
48837 <firstname>Nicole C.</firstname>
48838 <surname>Engard</surname>
48842 <pubdate>September 2009</pubdate>
48844 <bibliosource><ulink 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>
48846 <title>Amazon lookup script for Koha libraries</title>
48848 <para>We order most of our materials from Amazon, so I've been looking
48849 for a convenient way to tell if a book under consideration is in our
48850 catalog already.</para>
48852 <para>Greasemonkey & a custom user script fit the bill
48857 <para><ulink url="https://addons.mozilla.org/en-US/firefox/addon/748">https://addons.mozilla.org/en-US/firefox/addon/748</ulink></para>
48861 <para><ulink url="http://userscripts.org/scripts/show/56847">http://userscripts.org/scripts/show/56847</ulink></para>
48865 <para>A few caveats:</para>
48869 <para>Like most scripts, this one was designed to work with Firefox;
48870 I haven't explored getting it to work with other browsers.</para>
48874 <para>I'm not a JavaScript programmer -- this was adapted from
48875 others' work. Just a few lines would have to be changed to get the
48876 script to work with your catalog.</para>
48880 <para>It depends on the existence of ISBN for the item in question,
48881 so movies, older books, etc. would not work.</para>
48885 <para>Others have added all sorts of bells & whistles: XISBN lookups
48886 to search for related titles, custom messages based on the status of
48887 items (on order, on hold, etc.), ... just search the UserScripts site
48888 for Amazon + library. For a later date!</para>
48891 <section id="extendkeywordclouds">
48892 <title>Keyword Clouds</title>
48894 <para>In addition to the traditional tag cloud available in Koha, there
48895 is a way to generate clouds for popular subjects within Koha.</para>
48897 <para>The <link linkend="keywordclouds">Author/Subject Cloud cron
48898 job</link> is used to help with this process. This cron job sends its
48899 output to files.</para>
48903 <para>/home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html</para>
48907 <para>/home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</para>
48911 <para>This means that you can produce clouds for authors, collective
48912 author, all kind of subjects, classifications, etc. And since it works
48913 on zebra indexes, it is quick, even on large DBs. Tags clouds are sent
48914 to files. It's up to library webmaster to deal with those files in order
48915 to include them in <link linkend="OpacMainUserBlock">OPACMainUserBlock</link>, or include them
48916 into their library CMS.</para>
48918 <para>Some libraries even send the file into a Samba shared folder where
48919 webmaster take them, eventually clean them a little bit before
48920 integrating them into navigation widgets or pages.</para>
48923 <section id="newtitlesoption">
48924 <title>Newest Titles Pulldown</title>
48926 <para>Often we want to add a way for our patrons to do searches for the
48927 newest items. In this example I'll show you how to create a pull down
48928 menu of the newest items by item type. These tips will work (with a
48929 couple changes) for collection codes or shelving locations as
48932 <para>First, it's important to note that every link in Koha is a
48933 permanent link. This means if I do a search for everything of a specific
48934 item type sorted by the acquisitions date and bookmark that URL,
48935 whenever I click it I'll see the newest items of that type on the first
48936 few pages of the results.</para>
48938 <para>I took this knowledge and wrote a form takes this functionality in
48939 to consideration. It basically just does a search of your Koha catalog
48940 for a specific item type and sorts the results by acquisitions
48943 <para>The first thing I did was write a MySQL statement to generate a
48944 list of item types for me - why copy and paste when you can use the
48945 power of MySQL?</para>
48947 <para><programlisting>select concat('<option value=\"mc-itype:', itemtype, '\">',description,'</option>') from itemtypes</programlisting></para>
48949 <para>The above looks at the itemtypes table and slaps the necessary
48950 HTML around each item type for me. I then exported that to CSV and
48951 opened it in my text editor and added the other parts of the
48954 <para><programlisting><p><strong>New Items</strong></p>
48955 <p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl">
48956 <input name="idx" value="kw" type="hidden">
48957 <input name="sort_by" value="acqdate_dsc" type="hidden">
48958 <input name="do" value="OK" type="hidden">
48959 <select name="limit" onchange="this.form.submit()">
48960 <option>-- Please choose --</option>
48961 <option value="mc-itype:BOOK">Book</option>
48962 <option value="mc-itype:BOOKCD">Book on CD</option>
48963 <option value="mc-itype:DVD">DVD</option>
48964 <option value="mc-itype:LRG_PRINT">Large print book</option>
48965 <option value="mc-itype:MAGAZINE">Magazine</option>
48966 <option value="mc-itype:NEWSPAPER">Newspaper</option>
48967 <option value="mc-itype:VIDEO">Videocassette</option>
48970 </p></programlisting></para>
48972 <para>Now, what does all of that mean? The important bits are
48975 <para>First the starting of the form.</para>
48977 <para><programlisting><p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl"></programlisting></para>
48979 <para>This tells the browser to take any value selected and put it at
48980 the end of this http://YOURSITE/cgi-bin/koha/opac-search.pl. If you want
48981 to embed this form on your library website (and not on your OPAC) you
48982 can put the full OPAC URL in there.</para>
48984 <para>Next, there is a hidden value that is telling the search to sort
48985 by acquisitions date descending (newest items at the top):</para>
48987 <para><programlisting><input name="sort_by" value="acqdate_dsc" type="hidden"></programlisting></para>
48989 <para>And finally you have an option for each item type you want people
48990 to search.<programlisting><option value="mc-itype:BOOK">Book</option></programlisting></para>
48992 <para>These options each include the string "mc-itype:" which tells Koha
48993 to do an item type search.</para>
48995 <para>Once you have all of that in place you can copy and paste the form
48996 to somewhere on your OPAC. The <ulink url="http://catalog.farmingtonlibraries.org">Farmington Public Libraries
48997 OPAC</ulink> has a few examples of this on the left.</para>
49000 <section id="colorsearch">
49001 <title>Cataloging and Searching by Color</title>
49003 <para>One of the icon sets installed in Koha includes a series of
49004 colors. This set can be used to catalog and search by color if you'd
49005 like. This guide will walk you use changing collection code to color in
49006 Koha so that you can do this.</para>
49008 <para>The following SQL could be used to add these colors to the CCODE
49009 authorized value category in a batch. If you wanted to use these colors
49010 for another authorized value you'd have to edit this to use that
49013 <programlisting> insert into authorised_values (category, authorised_value, lib,
49014 lib_opac, imageurl) values ('CCODE','000000','Black','','colors/000000.png');
49015 insert into authorised_values (category, authorised_value, lib,
49016 lib_opac, imageurl) values ('CCODE','66cc66','Bright Green','','colors/66cc66.png');
49017 insert into authorised_values (category, authorised_value, lib,
49018 lib_opac, imageurl) values ('CCODE','99cc33','Olive','','colors/99cc33.png');
49019 insert into authorised_values (category, authorised_value, lib,
49020 lib_opac, imageurl) values ('CCODE','3333cc','Dark Blue','','colors/3333cc.png');
49021 insert into authorised_values (category, authorised_value, lib,
49022 lib_opac, imageurl) values ('CCODE','006600' ,'Dark Green','','colors/006600.png');
49023 insert into authorised_values (category, authorised_value, lib,
49024 lib_opac, imageurl) values ('CCODE','6600cc','Plum','','colors/6600cc.png');
49025 insert into authorised_values (category, authorised_value, lib,
49026 lib_opac, imageurl) values ('CCODE','6666cc','Purple','','colors/6666cc.png');
49027 insert into authorised_values (category, authorised_value, lib,
49028 lib_opac, imageurl) values ('CCODE','9999cc','Light Purple','','colors/9999cc.png');
49029 insert into authorised_values (category, authorised_value, lib,
49030 lib_opac, imageurl) values ('CCODE','660000' ,'Burgundy','','colors/660000.png');
49031 insert into authorised_values (category, authorised_value, lib,
49032 lib_opac, imageurl) values ('CCODE','663333' ,'Brown','','colors/663333.png');
49033 insert into authorised_values (category, authorised_value, lib,
49034 lib_opac, imageurl) values ('CCODE','990000' ,'Red','','colors/990000.png');
49035 insert into authorised_values (category, authorised_value, lib,
49036 lib_opac, imageurl) values ('CCODE','996633' ,'Tan','','colors/996633.png');
49037 insert into authorised_values (category, authorised_value, lib,
49038 lib_opac, imageurl) values ('CCODE','999999' ,'Gray','','colors/999999.png');
49039 insert into authorised_values (category, authorised_value, lib,
49040 lib_opac, imageurl) values ('CCODE','cc66cc','Pink','','colors/cc66cc.png');
49041 insert into authorised_values (category, authorised_value, lib,
49042 lib_opac, imageurl) values ('CCODE','cc99cc','Bubble Gum','','colors/cc99cc.png');
49043 insert into authorised_values (category, authorised_value, lib,
49044 lib_opac, imageurl) values ('CCODE','cc3333' ,'Orange','','colors/cc3333.png');
49045 insert into authorised_values (category, authorised_value, lib,
49046 lib_opac, imageurl) values ('CCODE','cc6666' ,'Peach','','colors/cc6666.png');
49047 insert into authorised_values (category, authorised_value, lib,
49048 lib_opac, imageurl) values ('CCODE','cc9999' ,'Rose','','colors/cc9999.png');
49049 insert into authorised_values (category, authorised_value, lib,
49050 lib_opac, imageurl) values ('CCODE','cccc00' ,'Gold','','colors/cccc00.png');
49051 insert into authorised_values (category, authorised_value, lib,
49052 lib_opac, imageurl) values ('CCODE','ffff33' ,'Yellow','','colors/ffff33.png');
49053 insert into authorised_values (category, authorised_value, lib,
49054 lib_opac, imageurl) values ('CCODE','ffffcc','Cream','','colors/ffffcc.png');
49055 insert into authorised_values (category, authorised_value, lib,
49056 lib_opac, imageurl) values ('CCODE','ffffff','White','','colors/ffffff.png');</programlisting>
49058 <para>If you would like to choose the colors manually you can do that
49059 via the <link linkend="authorizedvalues">Authorized Values</link>
49060 administration area.</para>
49063 <screeninfo>Colors for CCODE</screeninfo>
49067 <imagedata fileref="images/appendix-extending/colorccode.png"/>
49072 <para>Next you'll want to <link linkend="marcbibframeworks">update the
49073 frameworks</link> so that the 952$8 (if you're using collection code)
49074 label to says Color.</para>
49076 <para>Once you have that in place you can start to catalog items by
49079 <para>Finally you'll want to add the following JQuery to your
49080 preferences so that it will relabel 'Collection' to 'Color'</para>
49082 <para><link linkend="intranetuserjs">intranetuserjs</link></para>
49084 <programlisting>$(document).ready(function(){
49085 $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
49086 $("#holdings th:contains('Collection')").text("Color");
49087 });</programlisting>
49089 <para><link linkend="opacuserjs">opacuserjs</link></para>
49091 <programlisting>$(document).ready(function(){
49092 $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
49093 $('#item_ccode').text("Color");
49094 });</programlisting>
49100 <appendix id="siteintegration">
49101 <title>Koha and Your Website</title>
49103 <para>This appendix will include tips for integrating Koha in to your
49104 library website.</para>
49106 <section id="embedsearch">
49107 <title>Koha search on your site</title>
49109 <para>Often you'll want to add a Koha search box to your library
49110 website. To do so, just copy and paste the following code in to your
49111 library website and update the YOURCATALOG bit with your catalog's URL
49112 and you're set to go.</para>
49114 <para><programlisting>
49115 <form name="searchform" method="get" action="http://YOURCATLOG/cgi-bin/koha/opac-search.pl" id="searchform">
49116 <input id="transl1" name="q" type="text"><p>
49117 <select name="idx" id="masthead_search">
49118 <option value="kw">Keyword</option>
49119 <option value="ti">Title</option>
49120 <option value="au">Author</option>
49121 <option value="su">Subject</option>
49122 <option value="nb">ISBN</option>
49123 <option value="se">Series</option>
49124 <option value="callnum">Call Number</option>
49126 <input value="Search" id="searchsubmit" type="submit">
49127 </p></form>
49128 </programlisting></para>
49132 <appendix id="gpl">
49133 <title><acronym>GNU</acronym> General Public License version 3</title>
49135 <para>Version 3, 29 June 2007</para>
49137 <para>Copyright © 2007 Free Software Foundation, Inc. <ulink url="http://fsf.org/">http://fsf.org/</ulink></para>
49139 <para>Everyone is permitted to copy and distribute verbatim copies of this
49140 license document, but changing it is not allowed.</para>
49142 <bridgehead id="Preamble" renderas="sect1">Preamble</bridgehead>
49144 <para>The <acronym>GNU</acronym> General Public License is a free,
49145 copyleft license for software and other kinds of works.</para>
49147 <para>The licenses for most software and other practical works are
49148 designed to take away your freedom to share and change the works. By
49149 contrast, the <acronym>GNU</acronym> General Public License is intended to
49150 guarantee your freedom to share and change all versions of a program--to
49151 make sure it remains free software for all its users. We, the Free
49152 Software Foundation, use the <acronym>GNU</acronym> General Public License
49153 for most of our software; it applies also to any other work released this
49154 way by its authors. You can apply it to your programs, too.</para>
49156 <para>When we speak of free software, we are referring to freedom, not
49157 price. Our General Public Licenses are designed to make sure that you have
49158 the freedom to distribute copies of free software (and charge for them if
49159 you wish), that you receive source code or can get it if you want it, that
49160 you can change the software or use pieces of it in new free programs, and
49161 that you know you can do these things.</para>
49163 <para>To protect your rights, we need to prevent others from denying you
49164 these rights or asking you to surrender the rights. Therefore, you have
49165 certain responsibilities if you distribute copies of the software, or if
49166 you modify it: responsibilities to respect the freedom of others.</para>
49168 <para>For example, if you distribute copies of such a program, whether
49169 gratis or for a fee, you must pass on to the recipients the same freedoms
49170 that you received. You must make sure that they, too, receive or can get
49171 the source code. And you must show them these terms so they know their
49174 <para>Developers that use the <acronym>GNU</acronym>
49175 <acronym>GPL</acronym> protect your rights with two steps: (1) assert
49176 copyright on the software, and (2) offer you this License giving you legal
49177 permission to copy, distribute and/or modify it.</para>
49179 <para>For the developers' and authors' protection, the
49180 <acronym>GPL</acronym> clearly explains that there is no warranty for this
49181 free software. For both users' and authors' sake, the
49182 <acronym>GPL</acronym> requires that modified versions be marked as
49183 changed, so that their problems will not be attributed erroneously to
49184 authors of previous versions.</para>
49186 <para>Some devices are designed to deny users access to install or run
49187 modified versions of the software inside them, although the manufacturer
49188 can do so. This is fundamentally incompatible with the aim of protecting
49189 users' freedom to change the software. The systematic pattern of such
49190 abuse occurs in the area of products for individuals to use, which is
49191 precisely where it is most unacceptable. Therefore, we have designed this
49192 version of the <acronym>GPL</acronym> to prohibit the practice for those
49193 products. If such problems arise substantially in other domains, we stand
49194 ready to extend this provision to those domains in future versions of the
49195 <acronym>GPL</acronym>, as needed to protect the freedom of users.</para>
49197 <para>Finally, every program is threatened constantly by software patents.
49198 States should not allow patents to restrict development and use of
49199 software on general-purpose computers, but in those that do, we wish to
49200 avoid the special danger that patents applied to a free program could make
49201 it effectively proprietary. To prevent this, the <acronym>GPL</acronym>
49202 assures that patents cannot be used to render the program non-free.</para>
49204 <para>The precise terms and conditions for copying, distribution and
49205 modification follow.</para>
49207 <bridgehead>TERMS AND CONDITIONS</bridgehead>
49209 <bridgehead id="Definitions" renderas="sect1">0. Definitions.</bridgehead>
49211 <para>"This License" refers to version 3 of the <acronym>GNU</acronym>
49212 General Public License.</para>
49214 <para>"Copyright" also means copyright-like laws that apply to other kinds
49215 of works, such as semiconductor masks.</para>
49217 <para>"The Program" refers to any copyrightable work licensed under this
49218 License. Each licensee is addressed as "you". "Licensees" and "recipients"
49219 may be individuals or organizations.</para>
49221 <para>To "modify" a work means to copy from or adapt all or part of the
49222 work in a fashion requiring copyright permission, other than the making of
49223 an exact copy. The resulting work is called a "modified version" of the
49224 earlier work or a work "based on" the earlier work.</para>
49226 <para>A "covered work" means either the unmodified Program or a work based
49227 on the Program.</para>
49229 <para>To "propagate" a work means to do anything with it that, without
49230 permission, would make you directly or secondarily liable for infringement
49231 under applicable copyright law, except executing it on a computer or
49232 modifying a private copy. Propagation includes copying, distribution (with
49233 or without modification), making available to the public, and in some
49234 countries other activities as well.</para>
49236 <para>To "convey" a work means any kind of propagation that enables other
49237 parties to make or receive copies. Mere interaction with a user through a
49238 computer network, with no transfer of a copy, is not conveying.</para>
49240 <para>An interactive user interface displays "Appropriate Legal Notices"
49241 to the extent that it includes a convenient and prominently visible
49242 feature that (1) displays an appropriate copyright notice, and (2) tells
49243 the user that there is no warranty for the work (except to the extent that
49244 warranties are provided), that licensees may convey the work under this
49245 License, and how to view a copy of this License. If the interface presents
49246 a list of user commands or options, such as a menu, a prominent item in
49247 the list meets this criterion.</para>
49249 <bridgehead id="SourceCode" renderas="sect1">1. Source Code.</bridgehead>
49251 <para>The "source code" for a work means the preferred form of the work
49252 for making modifications to it. "Object code" means any non-source form of
49255 <para>A "Standard Interface" means an interface that either is an official
49256 standard defined by a recognized standards body, or, in the case of
49257 interfaces specified for a particular programming language, one that is
49258 widely used among developers working in that language.</para>
49260 <para>The "System Libraries" of an executable work include anything, other
49261 than the work as a whole, that (a) is included in the normal form of
49262 packaging a Major Component, but which is not part of that Major
49263 Component, and (b) serves only to enable use of the work with that Major
49264 Component, or to implement a Standard Interface for which an
49265 implementation is available to the public in source code form. A "Major
49266 Component", in this context, means a major essential component (kernel,
49267 window system, and so on) of the specific operating system (if any) on
49268 which the executable work runs, or a compiler used to produce the work, or
49269 an object code interpreter used to run it.</para>
49271 <para>The "Corresponding Source" for a work in object code form means all
49272 the source code needed to generate, install, and (for an executable work)
49273 run the object code and to modify the work, including scripts to control
49274 those activities. However, it does not include the work's System
49275 Libraries, or general-purpose tools or generally available free programs
49276 which are used unmodified in performing those activities but which are not
49277 part of the work. For example, Corresponding Source includes interface
49278 definition files associated with source files for the work, and the source
49279 code for shared libraries and dynamically linked subprograms that the work
49280 is specifically designed to require, such as by intimate data
49281 communication or control flow between those subprograms and other parts of
49284 <para>The Corresponding Source need not include anything that users can
49285 regenerate automatically from other parts of the Corresponding
49288 <para>The Corresponding Source for a work in source code form is that same
49291 <bridgehead id="BasicPermissions" renderas="sect1">2. Basic
49292 Permissions.</bridgehead>
49294 <para>All rights granted under this License are granted for the term of
49295 copyright on the Program, and are irrevocable provided the stated
49296 conditions are met. This License explicitly affirms your unlimited
49297 permission to run the unmodified Program. The output from running a
49298 covered work is covered by this License only if the output, given its
49299 content, constitutes a covered work. This License acknowledges your rights
49300 of fair use or other equivalent, as provided by copyright law.</para>
49302 <para>You may make, run and propagate covered works that you do not
49303 convey, without conditions so long as your license otherwise remains in
49304 force. You may convey covered works to others for the sole purpose of
49305 having them make modifications exclusively for you, or provide you with
49306 facilities for running those works, provided that you comply with the
49307 terms of this License in conveying all material for which you do not
49308 control copyright. Those thus making or running the covered works for you
49309 must do so exclusively on your behalf, under your direction and control,
49310 on terms that prohibit them from making any copies of your copyrighted
49311 material outside their relationship with you.</para>
49313 <para>Conveying under any other circumstances is permitted solely under
49314 the conditions stated below. Sublicensing is not allowed; section 10 makes
49315 it unnecessary.</para>
49317 <bridgehead id="Protecting" renderas="sect1">3. Protecting Users' Legal
49318 Rights From Anti-Circumvention Law.</bridgehead>
49320 <para>No covered work shall be deemed part of an effective technological
49321 measure under any applicable law fulfilling obligations under article 11
49322 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws
49323 prohibiting or restricting circumvention of such measures.</para>
49325 <para>When you convey a covered work, you waive any legal power to forbid
49326 circumvention of technological measures to the extent such circumvention
49327 is effected by exercising rights under this License with respect to the
49328 covered work, and you disclaim any intention to limit operation or
49329 modification of the work as a means of enforcing, against the work's
49330 users, your or third parties' legal rights to forbid circumvention of
49331 technological measures.</para>
49333 <bridgehead id="ConveyingVerbatim" renderas="sect1">4. Conveying Verbatim
49334 Copies.</bridgehead>
49336 <para>You may convey verbatim copies of the Program's source code as you
49337 receive it, in any medium, provided that you conspicuously and
49338 appropriately publish on each copy an appropriate copyright notice; keep
49339 intact all notices stating that this License and any non-permissive terms
49340 added in accord with section 7 apply to the code; keep intact all notices
49341 of the absence of any warranty; and give all recipients a copy of this
49342 License along with the Program.</para>
49344 <para>You may charge any price or no price for each copy that you convey,
49345 and you may offer support or warranty protection for a fee.</para>
49347 <bridgehead id="ConveyingModified" renderas="sect1">5. Conveying Modified
49348 Source Versions.</bridgehead>
49350 <para>You may convey a work based on the Program, or the modifications to
49351 produce it from the Program, in the form of source code under the terms of
49352 section 4, provided that you also meet all of these conditions:</para>
49354 <orderedlist numeration="loweralpha">
49356 <para>The work must carry prominent notices stating that you modified
49357 it, and giving a relevant date.</para>
49361 <para>The work must carry prominent notices stating that it is
49362 released under this License and any conditions added under section 7.
49363 This requirement modifies the requirement in section 4 to "keep intact
49364 all notices".</para>
49368 <para>You must license the entire work, as a whole, under this License
49369 to anyone who comes into possession of a copy. This License will
49370 therefore apply, along with any applicable section 7 additional terms,
49371 to the whole of the work, and all its parts, regardless of how they
49372 are packaged. This License gives no permission to license the work in
49373 any other way, but it does not invalidate such permission if you have
49374 separately received it.</para>
49378 <para>If the work has interactive user interfaces, each must display
49379 Appropriate Legal Notices; however, if the Program has interactive
49380 interfaces that do not display Appropriate Legal Notices, your work
49381 need not make them do so.</para>
49385 <para>A compilation of a covered work with other separate and independent
49386 works, which are not by their nature extensions of the covered work, and
49387 which are not combined with it such as to form a larger program, in or on
49388 a volume of a storage or distribution medium, is called an "aggregate" if
49389 the compilation and its resulting copyright are not used to limit the
49390 access or legal rights of the compilation's users beyond what the
49391 individual works permit. Inclusion of a covered work in an aggregate does
49392 not cause this License to apply to the other parts of the
49395 <bridgehead id="ConveyingNonSource" renderas="sect1">6. Conveying
49396 Non-Source Forms.</bridgehead>
49398 <para>You may convey a covered work in object code form under the terms of
49399 sections 4 and 5, provided that you also convey the machine-readable
49400 Corresponding Source under the terms of this License, in one of these
49403 <orderedlist numeration="loweralpha">
49405 <para>Convey the object code in, or embodied in, a physical product
49406 (including a physical distribution medium), accompanied by the
49407 Corresponding Source fixed on a durable physical medium customarily
49408 used for software interchange.</para>
49412 <para>Convey the object code in, or embodied in, a physical product
49413 (including a physical distribution medium), accompanied by a written
49414 offer, valid for at least three years and valid for as long as you
49415 offer spare parts or customer support for that product model, to give
49416 anyone who possesses the object code either (1) a copy of the
49417 Corresponding Source for all the software in the product that is
49418 covered by this License, on a durable physical medium customarily used
49419 for software interchange, for a price no more than your reasonable
49420 cost of physically performing this conveying of source, or (2) access
49421 to copy the Corresponding Source from a network server at no
49426 <para>Convey individual copies of the object code with a copy of the
49427 written offer to provide the Corresponding Source. This alternative is
49428 allowed only occasionally and noncommercially, and only if you
49429 received the object code with such an offer, in accord with subsection
49434 <para>Convey the object code by offering access from a designated
49435 place (gratis or for a charge), and offer equivalent access to the
49436 Corresponding Source in the same way through the same place at no
49437 further charge. You need not require recipients to copy the
49438 Corresponding Source along with the object code. If the place to copy
49439 the object code is a network server, the Corresponding Source may be
49440 on a different server (operated by you or a third party) that supports
49441 equivalent copying facilities, provided you maintain clear directions
49442 next to the object code saying where to find the Corresponding Source.
49443 Regardless of what server hosts the Corresponding Source, you remain
49444 obligated to ensure that it is available for as long as needed to
49445 satisfy these requirements.</para>
49449 <para>Convey the object code using peer-to-peer transmission, provided
49450 you inform other peers where the object code and Corresponding Source
49451 of the work are being offered to the general public at no charge under
49452 subsection 6d.</para>
49456 <para>A separable portion of the object code, whose source code is
49457 excluded from the Corresponding Source as a System Library, need not be
49458 included in conveying the object code work.</para>
49460 <para>A "User Product" is either (1) a "consumer product", which means any
49461 tangible personal property which is normally used for personal, family, or
49462 household purposes, or (2) anything designed or sold for incorporation
49463 into a dwelling. In determining whether a product is a consumer product,
49464 doubtful cases shall be resolved in favor of coverage. For a particular
49465 product received by a particular user, "normally used" refers to a typical
49466 or common use of that class of product, regardless of the status of the
49467 particular user or of the way in which the particular user actually uses,
49468 or expects or is expected to use, the product. A product is a consumer
49469 product regardless of whether the product has substantial commercial,
49470 industrial or non-consumer uses, unless such uses represent the only
49471 significant mode of use of the product.</para>
49473 <para>"Installation Information" for a User Product means any methods,
49474 procedures, authorization keys, or other information required to install
49475 and execute modified versions of a covered work in that User Product from
49476 a modified version of its Corresponding Source. The information must
49477 suffice to ensure that the continued functioning of the modified object
49478 code is in no case prevented or interfered with solely because
49479 modification has been made.</para>
49481 <para>If you convey an object code work under this section in, or with, or
49482 specifically for use in, a User Product, and the conveying occurs as part
49483 of a transaction in which the right of possession and use of the User
49484 Product is transferred to the recipient in perpetuity or for a fixed term
49485 (regardless of how the transaction is characterized), the Corresponding
49486 Source conveyed under this section must be accompanied by the Installation
49487 Information. But this requirement does not apply if neither you nor any
49488 third party retains the ability to install modified object code on the
49489 User Product (for example, the work has been installed in
49490 <acronym>ROM</acronym>).</para>
49492 <para>The requirement to provide Installation Information does not include
49493 a requirement to continue to provide support service, warranty, or updates
49494 for a work that has been modified or installed by the recipient, or for
49495 the User Product in which it has been modified or installed. Access to a
49496 network may be denied when the modification itself materially and
49497 adversely affects the operation of the network or violates the rules and
49498 protocols for communication across the network.</para>
49500 <para>Corresponding Source conveyed, and Installation Information
49501 provided, in accord with this section must be in a format that is publicly
49502 documented (and with an implementation available to the public in source
49503 code form), and must require no special password or key for unpacking,
49504 reading or copying.</para>
49506 <bridgehead id="AdditionalTerms" renderas="sect1">7. Additional
49507 Terms.</bridgehead>
49509 <para>"Additional permissions" are terms that supplement the terms of this
49510 License by making exceptions from one or more of its conditions.
49511 Additional permissions that are applicable to the entire Program shall be
49512 treated as though they were included in this License, to the extent that
49513 they are valid under applicable law. If additional permissions apply only
49514 to part of the Program, that part may be used separately under those
49515 permissions, but the entire Program remains governed by this License
49516 without regard to the additional permissions.</para>
49518 <para>When you convey a copy of a covered work, you may at your option
49519 remove any additional permissions from that copy, or from any part of it.
49520 (Additional permissions may be written to require their own removal in
49521 certain cases when you modify the work.) You may place additional
49522 permissions on material, added by you to a covered work, for which you
49523 have or can give appropriate copyright permission.</para>
49525 <para>Notwithstanding any other provision of this License, for material
49526 you add to a covered work, you may (if authorized by the copyright holders
49527 of that material) supplement the terms of this License with terms:</para>
49529 <orderedlist numeration="loweralpha">
49531 <para>Disclaiming warranty or limiting liability differently from the
49532 terms of sections 15 and 16 of this License; or</para>
49536 <para>Requiring preservation of specified reasonable legal notices or
49537 author attributions in that material or in the Appropriate Legal
49538 Notices displayed by works containing it; or</para>
49542 <para>Prohibiting misrepresentation of the origin of that material, or
49543 requiring that modified versions of such material be marked in
49544 reasonable ways as different from the original version; or</para>
49548 <para>Limiting the use for publicity purposes of names of licensors or
49549 authors of the material; or</para>
49553 <para>Declining to grant rights under trademark law for use of some
49554 trade names, trademarks, or service marks; or</para>
49558 <para>Requiring indemnification of licensors and authors of that
49559 material by anyone who conveys the material (or modified versions of
49560 it) with contractual assumptions of liability to the recipient, for
49561 any liability that these contractual assumptions directly impose on
49562 those licensors and authors.</para>
49566 <para>All other non-permissive additional terms are considered "further
49567 restrictions" within the meaning of section 10. If the Program as you
49568 received it, or any part of it, contains a notice stating that it is
49569 governed by this License along with a term that is a further restriction,
49570 you may remove that term. If a license document contains a further
49571 restriction but permits relicensing or conveying under this License, you
49572 may add to a covered work material governed by the terms of that license
49573 document, provided that the further restriction does not survive such
49574 relicensing or conveying.</para>
49576 <para>If you add terms to a covered work in accord with this section, you
49577 must place, in the relevant source files, a statement of the additional
49578 terms that apply to those files, or a notice indicating where to find the
49579 applicable terms.</para>
49581 <para>Additional terms, permissive or non-permissive, may be stated in the
49582 form of a separately written license, or stated as exceptions; the above
49583 requirements apply either way.</para>
49585 <bridgehead id="Termination" renderas="sect1">8. Termination.</bridgehead>
49587 <para>You may not propagate or modify a covered work except as expressly
49588 provided under this License. Any attempt otherwise to propagate or modify
49589 it is void, and will automatically terminate your rights under this
49590 License (including any patent licenses granted under the third paragraph
49591 of section 11).</para>
49593 <para>However, if you cease all violation of this License, then your
49594 license from a particular copyright holder is reinstated (a)
49595 provisionally, unless and until the copyright holder explicitly and
49596 finally terminates your license, and (b) permanently, if the copyright
49597 holder fails to notify you of the violation by some reasonable means prior
49598 to 60 days after the cessation.</para>
49600 <para>Moreover, your license from a particular copyright holder is
49601 reinstated permanently if the copyright holder notifies you of the
49602 violation by some reasonable means, this is the first time you have
49603 received notice of violation of this License (for any work) from that
49604 copyright holder, and you cure the violation prior to 30 days after your
49605 receipt of the notice.</para>
49607 <para>Termination of your rights under this section does not terminate the
49608 licenses of parties who have received copies or rights from you under this
49609 License. If your rights have been terminated and not permanently
49610 reinstated, you do not qualify to receive new licenses for the same
49611 material under section 10.</para>
49613 <bridgehead id="AcceptanceNotRequired" renderas="sect1">9. Acceptance Not
49614 Required for Having Copies.</bridgehead>
49616 <para>You are not required to accept this License in order to receive or
49617 run a copy of the Program. Ancillary propagation of a covered work
49618 occurring solely as a consequence of using peer-to-peer transmission to
49619 receive a copy likewise does not require acceptance. However, nothing
49620 other than this License grants you permission to propagate or modify any
49621 covered work. These actions infringe copyright if you do not accept this
49622 License. Therefore, by modifying or propagating a covered work, you
49623 indicate your acceptance of this License to do so.</para>
49625 <bridgehead id="AutomaticDownstream" renderas="sect1">10. Automatic
49626 Licensing of Downstream Recipients.</bridgehead>
49628 <para>Each time you convey a covered work, the recipient automatically
49629 receives a license from the original licensors, to run, modify and
49630 propagate that work, subject to this License. You are not responsible for
49631 enforcing compliance by third parties with this License.</para>
49633 <para>An "entity transaction" is a transaction transferring control of an
49634 organization, or substantially all assets of one, or subdividing an
49635 organization, or merging organizations. If propagation of a covered work
49636 results from an entity transaction, each party to that transaction who
49637 receives a copy of the work also receives whatever licenses to the work
49638 the party's predecessor in interest had or could give under the previous
49639 paragraph, plus a right to possession of the Corresponding Source of the
49640 work from the predecessor in interest, if the predecessor has it or can
49641 get it with reasonable efforts.</para>
49643 <para>You may not impose any further restrictions on the exercise of the
49644 rights granted or affirmed under this License. For example, you may not
49645 impose a license fee, royalty, or other charge for exercise of rights
49646 granted under this License, and you may not initiate litigation (including
49647 a cross-claim or counterclaim in a lawsuit) alleging that any patent claim
49648 is infringed by making, using, selling, offering for sale, or importing
49649 the Program or any portion of it.</para>
49651 <bridgehead id="Patents" renderas="sect1">11. Patents.</bridgehead>
49653 <para>A "contributor" is a copyright holder who authorizes use under this
49654 License of the Program or a work on which the Program is based. The work
49655 thus licensed is called the contributor's "contributor version".</para>
49657 <para>A contributor's "essential patent claims" are all patent claims
49658 owned or controlled by the contributor, whether already acquired or
49659 hereafter acquired, that would be infringed by some manner, permitted by
49660 this License, of making, using, or selling its contributor version, but do
49661 not include claims that would be infringed only as a consequence of
49662 further modification of the contributor version. For purposes of this
49663 definition, "control" includes the right to grant patent sublicenses in a
49664 manner consistent with the requirements of this License.</para>
49666 <para>Each contributor grants you a non-exclusive, worldwide, royalty-free
49667 patent license under the contributor's essential patent claims, to make,
49668 use, sell, offer for sale, import and otherwise run, modify and propagate
49669 the contents of its contributor version.</para>
49671 <para>In the following three paragraphs, a "patent license" is any express
49672 agreement or commitment, however denominated, not to enforce a patent
49673 (such as an express permission to practice a patent or covenant not to sue
49674 for patent infringement). To "grant" such a patent license to a party
49675 means to make such an agreement or commitment not to enforce a patent
49676 against the party.</para>
49678 <para>If you convey a covered work, knowingly relying on a patent license,
49679 and the Corresponding Source of the work is not available for anyone to
49680 copy, free of charge and under the terms of this License, through a
49681 publicly available network server or other readily accessible means, then
49682 you must either (1) cause the Corresponding Source to be so available, or
49683 (2) arrange to deprive yourself of the benefit of the patent license for
49684 this particular work, or (3) arrange, in a manner consistent with the
49685 requirements of this License, to extend the patent license to downstream
49686 recipients. "Knowingly relying" means you have actual knowledge that, but
49687 for the patent license, your conveying the covered work in a country, or
49688 your recipient's use of the covered work in a country, would infringe one
49689 or more identifiable patents in that country that you have reason to
49690 believe are valid.</para>
49692 <para>If, pursuant to or in connection with a single transaction or
49693 arrangement, you convey, or propagate by procuring conveyance of, a
49694 covered work, and grant a patent license to some of the parties receiving
49695 the covered work authorizing them to use, propagate, modify or convey a
49696 specific copy of the covered work, then the patent license you grant is
49697 automatically extended to all recipients of the covered work and works
49698 based on it.</para>
49700 <para>A patent license is "discriminatory" if it does not include within
49701 the scope of its coverage, prohibits the exercise of, or is conditioned on
49702 the non-exercise of one or more of the rights that are specifically
49703 granted under this License. You may not convey a covered work if you are a
49704 party to an arrangement with a third party that is in the business of
49705 distributing software, under which you make payment to the third party
49706 based on the extent of your activity of conveying the work, and under
49707 which the third party grants, to any of the parties who would receive the
49708 covered work from you, a discriminatory patent license (a) in connection
49709 with copies of the covered work conveyed by you (or copies made from those
49710 copies), or (b) primarily for and in connection with specific products or
49711 compilations that contain the covered work, unless you entered into that
49712 arrangement, or that patent license was granted, prior to 28 March
49715 <para>Nothing in this License shall be construed as excluding or limiting
49716 any implied license or other defenses to infringement that may otherwise
49717 be available to you under applicable patent law.</para>
49719 <bridgehead id="NoSurrender" renderas="sect1">12. No Surrender of Others'
49720 Freedom.</bridgehead>
49722 <para>If conditions are imposed on you (whether by court order, agreement
49723 or otherwise) that contradict the conditions of this License, they do not
49724 excuse you from the conditions of this License. If you cannot convey a
49725 covered work so as to satisfy simultaneously your obligations under this
49726 License and any other pertinent obligations, then as a consequence you may
49727 not convey it at all. For example, if you agree to terms that obligate you
49728 to collect a royalty for further conveying from those to whom you convey
49729 the Program, the only way you could satisfy both those terms and this
49730 License would be to refrain entirely from conveying the Program.</para>
49732 <bridgehead id="UsedWithAGPL" renderas="sect1">13. Use with the
49733 <acronym>GNU</acronym> Affero General Public License.</bridgehead>
49735 <para>Notwithstanding any other provision of this License, you have
49736 permission to link or combine any covered work with a work licensed under
49737 version 3 of the <acronym>GNU</acronym> Affero General Public License into
49738 a single combined work, and to convey the resulting work. The terms of
49739 this License will continue to apply to the part which is the covered work,
49740 but the special requirements of the <acronym>GNU</acronym> Affero General
49741 Public License, section 13, concerning interaction through a network will
49742 apply to the combination as such.</para>
49744 <bridgehead id="RevisedVersions" renderas="sect1">14. Revised Versions of
49745 this License.</bridgehead>
49747 <para>The Free Software Foundation may publish revised and/or new versions
49748 of the <acronym>GNU</acronym> General Public License from time to time.
49749 Such new versions will be similar in spirit to the present version, but
49750 may differ in detail to address new problems or concerns.</para>
49752 <para>Each version is given a distinguishing version number. If the
49753 Program specifies that a certain numbered version of the
49754 <acronym>GNU</acronym> General Public License "or any later version"
49755 applies to it, you have the option of following the terms and conditions
49756 either of that numbered version or of any later version published by the
49757 Free Software Foundation. If the Program does not specify a version number
49758 of the <acronym>GNU</acronym> General Public License, you may choose any
49759 version ever published by the Free Software Foundation.</para>
49761 <para>If the Program specifies that a proxy can decide which future
49762 versions of the <acronym>GNU</acronym> General Public License can be used,
49763 that proxy's public statement of acceptance of a version permanently
49764 authorizes you to choose that version for the Program.</para>
49766 <para>Later license versions may give you additional or different
49767 permissions. However, no additional obligations are imposed on any author
49768 or copyright holder as a result of your choosing to follow a later
49771 <bridgehead id="WarrantyDisclaimer" renderas="sect1">15. Disclaimer of
49772 Warranty.</bridgehead>
49774 <para>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
49775 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
49776 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
49777 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
49778 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
49779 PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
49780 IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
49781 ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
49783 <bridgehead id="LiabilityLimitation" renderas="sect1">16. Limitation of
49784 Liability.</bridgehead>
49786 <para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
49787 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
49788 CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
49789 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
49790 ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT
49791 LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
49792 SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE
49793 WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
49794 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
49796 <bridgehead id="InterpretationSecs1516" renderas="sect1">17.
49797 Interpretation of Sections 15 and 16.</bridgehead>
49799 <para>If the disclaimer of warranty and limitation of liability provided
49800 above cannot be given local legal effect according to their terms,
49801 reviewing courts shall apply local law that most closely approximates an
49802 absolute waiver of all civil liability in connection with the Program,
49803 unless a warranty or assumption of liability accompanies a copy of the
49804 Program in return for a fee.</para>
49806 <bridgehead>END OF TERMS AND CONDITIONS</bridgehead>
49808 <bridgehead id="HowToApply" renderas="sect1">How to Apply These Terms to
49809 Your New Programs</bridgehead>
49811 <para>If you develop a new program, and you want it to be of the greatest
49812 possible use to the public, the best way to achieve this is to make it
49813 free software which everyone can redistribute and change under these
49816 <para>To do so, attach the following notices to the program. It is safest
49817 to attach them to the start of each source file to most effectively state
49818 the exclusion of warranty; and each file should have at least the
49819 "copyright" line and a pointer to where the full notice is found.</para>
49822 <replaceable>one line to give the program's name and a brief idea of what it does.</replaceable>
49823 Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
49825 This program is free software: you can redistribute it and/or modify
49826 it under the terms of the <acronym>GNU</acronym> General Public License as published by
49827 the Free Software Foundation, either version 3 of the License, or
49828 (at your option) any later version.
49830 This program is distributed in the hope that it will be useful,
49831 but WITHOUT ANY WARRANTY; without even the implied warranty of
49832 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
49833 <acronym>GNU</acronym> General Public License for more details.
49835 You should have received a copy of the <acronym>GNU</acronym> General Public License
49836 along with this program. If not, see <ulink url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.
49839 <para>Also add information on how to contact you by electronic and paper
49842 <para>If the program does terminal interaction, make it output a short
49843 notice like this when it starts in an interactive mode:</para>
49846 <replaceable>program</replaceable> Copyright (C) <replaceable>year</replaceable> <replaceable>name of author</replaceable>
49847 This program comes with ABSOLUTELY NO WARRANTY; for details type `<literal>show w</literal>'.
49848 This is free software, and you are welcome to redistribute it
49849 under certain conditions; type `<literal>show c</literal>' for details.
49852 <para>The hypothetical commands `<literal>show w</literal>' and
49853 `<literal>show c</literal>' should show the appropriate parts of the
49854 General Public License. Of course, your program's commands might be
49855 different; for a GUI interface, you would use an "about box".</para>
49857 <para>You should also get your employer (if you work as a programmer) or
49858 school, if any, to sign a "copyright disclaimer" for the program, if
49859 necessary. For more information on this, and how to apply and follow the
49860 <acronym>GNU</acronym> <acronym>GPL</acronym>, see <ulink url="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</ulink>.</para>
49862 <para>The <acronym>GNU</acronym> General Public License does not permit
49863 incorporating your program into proprietary programs. If your program is a
49864 subroutine library, you may consider it more useful to permit linking
49865 proprietary applications with the library. If this is what you want to do,
49866 use the <acronym>GNU</acronym> Lesser General Public License instead of
49867 this License. But first, please read <ulink url="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</ulink>.</para>